DBMI Library (base) - table management. More...

#include <stdlib.h>
#include <string.h>
#include <grass/gis.h>
#include <grass/dbmi.h>

Include dependency graph for dbmi_base/table.c:

Functions
dbTable *	db_alloc_table (int ncols)
	Allocate a table with a specific number of columns. More...

void	db_init_table (dbTable *table)
	Initialize the table to zero. More...

void	db_free_table (dbTable *table)
	Free the table. More...

int	db_set_table_name (dbTable table, const char name)
	Set the name of the table. More...

const char *	db_get_table_name (dbTable *table)
	Get the name of the table. More...

int	db_set_table_description (dbTable table, const char description)
	Set the description of the table. More...

const char *	db_get_table_description (dbTable *table)
	Get the description of the table. More...

int	db_get_table_number_of_columns (dbTable *table)
	Return the number of columns of the table. More...

void	db_set_table_select_priv_granted (dbTable *table)
	Grant selection privileges for all columns. More...

void	db_set_table_select_priv_not_granted (dbTable *table)
	Set selection privileges not granted for all columns. More...

int	db_get_table_select_priv (dbTable *table)
	Get table select privileges. More...

void	db_set_table_update_priv_granted (dbTable *table)
	Grant update privileges for all columns. More...

void	db_set_table_update_priv_not_granted (dbTable *table)
	Set update privileges not granted for all columns. More...

int	db_get_table_update_priv (dbTable *table)
	Get table update privileges. More...

void	db_set_table_insert_priv_granted (dbTable *table)
	Grant insert privileges for table. More...

void	db_set_table_insert_priv_not_granted (dbTable *table)
	Set insert privileges not granted for table. More...

int	db_get_table_insert_priv (dbTable *table)
	Get table insert privileges. More...

void	db_set_table_delete_priv_granted (dbTable *table)
	Grant delete privileges for table. More...

void	db_set_table_delete_priv_not_granted (dbTable *table)
	Set delete privileges not granted for table. More...

int	db_get_table_delete_priv (dbTable *table)
	Get table delete privileges. More...

dbColumn *	db_get_table_column (dbTable *table, int idx)
	Returns column structure for given table and column number. More...

dbColumn *	db_get_table_column_by_name (dbTable table, const char name)
	Returns column structure for given table and column name. More...

int	db_set_table_column (dbTable table, int idx, dbColumn column)
	Set a specific column for given table and column number. More...

int	db_append_table_column (dbTable table, dbColumn column)
	Append a specific column to given table. More...

dbTable *	db_clone_table (dbTable *src)
	Make a new exact copy of an existing table. More...

int	db_table_to_sql (dbTable table, dbString sql)
	Create SQL CREATE string from table definition. More...

Detailed Description

DBMI Library (base) - table management.

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author: Joel Jones (CERL/UIUC), Radim Blazek; Doxygenized by Martin Landa <landa.martin gmail.com> (2011)

Definition in file dbmi_base/table.c.

Function Documentation

◆ db_alloc_table()

dbTable* db_alloc_table ( int ncols )

Allocate a table with a specific number of columns.

Parameters

ncols number of columns which should be allocated

Returns: allocated dbTable; NULL in case of an error

Definition at line 28 of file dbmi_base/table.c.

Referenced by db_clone_table(), P_Create_Aux2_Table(), and P_Create_Aux4_Table().

◆ db_append_table_column()

int db_append_table_column	(	dbTable *	table,
		dbColumn *	column
	)

Append a specific column to given table.

Parameters

table	Pointer to dbTable
column	Pointer to a dbColumn to append. A copy of the column is stored, so the original column can be deleted.

Returns: DB_OK on success; DB_FAILURE on error

Definition at line 374 of file dbmi_base/table.c.

◆ db_clone_table()

dbTable* db_clone_table ( dbTable * src )

Make a new exact copy of an existing table.

New memory is allocated for the clone, the columns-content will be copied too.

Parameters

src	Pointer to dbTable

Returns: A new alloacted clone of the given table on success; NULL on error

Definition at line 396 of file dbmi_base/table.c.

References db_alloc_table(), db_copy_column(), db_copy_string(), db_get_table_number_of_columns(), NULL, and src.

◆ db_free_table()

void db_free_table ( dbTable * table )

Free the table.

Parameters

table pointer to dbTable

Definition at line 68 of file dbmi_base/table.c.

Referenced by db_free_cursor().

◆ db_get_table_column()

dbColumn* db_get_table_column	(	dbTable *	table,
		int	idx
	)

Returns column structure for given table and column number.

Parameters

table	pointer to dbTable
idx	column index (starting with '0')

Returns: pointer to dbColumn; NULL if not found

Definition at line 309 of file dbmi_base/table.c.

Referenced by P_Create_Aux2_Table(), and P_Create_Aux4_Table().

◆ db_get_table_column_by_name()

dbColumn* db_get_table_column_by_name	(	dbTable *	table,
		const char *	name
	)

Returns column structure for given table and column name.

Parameters

table	pointer to dbTable
name	the name of the column

Returns: pointer to dbColumn; NULL if not found

Definition at line 325 of file dbmi_base/table.c.

◆ db_get_table_delete_priv()

int db_get_table_delete_priv ( dbTable * table )

Get table delete privileges.

Parameters

table pointer to dbTable

Returns: privileges

Definition at line 295 of file dbmi_base/table.c.

◆ db_get_table_description()

const char* db_get_table_description ( dbTable * table )

Get the description of the table.

Parameters

table pointer to dbTable

Returns: description of the table

Definition at line 126 of file dbmi_base/table.c.

◆ db_get_table_insert_priv()

int db_get_table_insert_priv ( dbTable * table )

Get table insert privileges.

Parameters

table pointer to dbTable

Returns: prilileges

Definition at line 263 of file dbmi_base/table.c.

◆ db_get_table_name()

const char* db_get_table_name ( dbTable * table )

Get the name of the table.

Parameters

table pointer to dbTable

Returns: name of the table

Definition at line 101 of file dbmi_base/table.c.

◆ db_get_table_number_of_columns()

int db_get_table_number_of_columns ( dbTable * table )

Return the number of columns of the table.

Parameters

table pointer to dbTable

Returns: number of columns

Definition at line 138 of file dbmi_base/table.c.

Referenced by db_clone_table().

◆ db_get_table_select_priv()

int db_get_table_select_priv ( dbTable * table )

Get table select privileges.

Parameters

table pointer to dbTable

Returns: privileges

Definition at line 199 of file dbmi_base/table.c.

◆ db_get_table_update_priv()

int db_get_table_update_priv ( dbTable * table )

Get table update privileges.

Parameters

table pointer to dbTable

Returns: privileges

Definition at line 231 of file dbmi_base/table.c.

◆ db_init_table()

void db_init_table ( dbTable * table )

Initialize the table to zero.

Parameters

table pointer to dbTable

Definition at line 56 of file dbmi_base/table.c.

◆ db_set_table_column()

int db_set_table_column	(	dbTable *	table,
		int	idx,
		dbColumn *	column
	)

Set a specific column for given table and column number.

Parameters

table	Pointer to dbTable
idx	Column index (starting with '0'). The index must be in range.
column	Pointer to a dbColumn to insert. A copy of the column stored, so the original column can be deleted.

Returns: DB_OK on success; DB_FAILURE on error

Definition at line 356 of file dbmi_base/table.c.

◆ db_set_table_delete_priv_granted()

void db_set_table_delete_priv_granted ( dbTable * table )

Grant delete privileges for table.

Parameters

table pointer to dbTable

Definition at line 273 of file dbmi_base/table.c.

◆ db_set_table_delete_priv_not_granted()

void db_set_table_delete_priv_not_granted ( dbTable * table )

Set delete privileges not granted for table.

Parameters

table pointer to dbTable

Definition at line 283 of file dbmi_base/table.c.

◆ db_set_table_description()

int db_set_table_description	(	dbTable *	table,
		const char *	description
	)

Set the description of the table.

Parameters

table	pointer to dbTable
name	description of the table

Returns: DB_OK

Definition at line 114 of file dbmi_base/table.c.

Referenced by P_Create_Aux2_Table(), and P_Create_Aux4_Table().

◆ db_set_table_insert_priv_granted()

void db_set_table_insert_priv_granted ( dbTable * table )

Grant insert privileges for table.

Parameters

table pointer to dbTable

Definition at line 241 of file dbmi_base/table.c.

◆ db_set_table_insert_priv_not_granted()

void db_set_table_insert_priv_not_granted ( dbTable * table )

Set insert privileges not granted for table.

Parameters

table pointer to dbTable

Definition at line 251 of file dbmi_base/table.c.

◆ db_set_table_name()

int db_set_table_name	(	dbTable *	table,
		const char *	name
	)

Set the name of the table.

Parameters

table	pointer to dbTable
name	The name of the table

Returns: DB_OK on success

Definition at line 89 of file dbmi_base/table.c.

Referenced by P_Create_Aux2_Table(), and P_Create_Aux4_Table().

◆ db_set_table_select_priv_granted()

void db_set_table_select_priv_granted ( dbTable * table )

Grant selection privileges for all columns.

Parameters

table pointer to dbTable

Definition at line 177 of file dbmi_base/table.c.

◆ db_set_table_select_priv_not_granted()

void db_set_table_select_priv_not_granted ( dbTable * table )

Set selection privileges not granted for all columns.

Parameters

table pointer to dbTable

Definition at line 187 of file dbmi_base/table.c.

◆ db_set_table_update_priv_granted()

void db_set_table_update_priv_granted ( dbTable * table )

Grant update privileges for all columns.

Parameters

table pointer to dbTable

Definition at line 209 of file dbmi_base/table.c.

◆ db_set_table_update_priv_not_granted()

void db_set_table_update_priv_not_granted ( dbTable * table )

Set update privileges not granted for all columns.

Parameters

table pointer to dbTable

Definition at line 219 of file dbmi_base/table.c.

◆ db_table_to_sql()

int db_table_to_sql	(	dbTable *	table,
		dbString *	sql
	)

Create SQL CREATE string from table definition.

Parameters

table	pointer to dbTable
sql	dbString to store the SQL CREATE string

Returns: DB_OK on success; DB_FAILED on error

Definition at line 428 of file dbmi_base/table.c.

Functions

Detailed Description

Function Documentation

◆ db_alloc_table()

◆ db_append_table_column()

◆ db_clone_table()

◆ db_free_table()

◆ db_get_table_column()

◆ db_get_table_column_by_name()

◆ db_get_table_delete_priv()

◆ db_get_table_description()

◆ db_get_table_insert_priv()

◆ db_get_table_name()

◆ db_get_table_number_of_columns()

◆ db_get_table_select_priv()

◆ db_get_table_update_priv()

◆ db_init_table()

◆ db_set_table_column()

◆ db_set_table_delete_priv_granted()

◆ db_set_table_delete_priv_not_granted()

◆ db_set_table_description()

◆ db_set_table_insert_priv_granted()

◆ db_set_table_insert_priv_not_granted()

◆ db_set_table_name()

◆ db_set_table_select_priv_granted()

◆ db_set_table_select_priv_not_granted()

◆ db_set_table_update_priv_granted()

◆ db_set_table_update_priv_not_granted()

◆ db_table_to_sql()