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

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

Include dependency graph for dbmi_base/column.c:

Functions
dbValue *	db_get_column_value (dbColumn *column)
	Returns column value for given column structure.

dbValue *	db_get_column_default_value (dbColumn *column)
	Returns column default value for given column structure.

void	db_set_column_sqltype (dbColumn *column, int sqltype)
	Define column sqltype for column.

void	db_set_column_host_type (dbColumn *column, int type)
	Set column host data type.

int	db_get_column_scale (dbColumn *column)
	Get column scale.

void	db_set_column_scale (dbColumn *column, int scale)
	Set column scale.

int	db_get_column_precision (dbColumn *column)
	Get column precision.

void	db_set_column_precision (dbColumn *column, int precision)
	Set column precision.

int	db_get_column_sqltype (dbColumn *column)
	Returns column sqltype for column.

int	db_get_column_host_type (dbColumn *column)
	Get column host type.

void	db_set_column_has_defined_default_value (dbColumn *column)
	Set default value identificator.

void	db_set_column_has_undefined_default_value (dbColumn *column)
	Unset default value identificator.

void	db_unset_column_has_default_value (dbColumn *column)
	Unset default value identificator.

int	db_test_column_has_default_value (dbColumn *column)
	Check if column has defined default value.

int	db_test_column_has_defined_default_value (dbColumn *column)
	Check if column has defined default value.

int	db_test_column_has_undefined_default_value (dbColumn *column)
	Check if column has defined default value.

void	db_set_column_use_default_value (dbColumn *column)
	Set default value to be used.

void	db_unset_column_use_default_value (dbColumn *column)
	Unset default value to be used.

int	db_test_column_use_default_value (dbColumn *column)
	Checks if default value is used.

void	db_set_column_null_allowed (dbColumn *column)
	Set null value to be allowed.

void	db_unset_column_null_allowed (dbColumn *column)
	Unset null value to be allowed.

int	db_test_column_null_allowed (dbColumn *column)
	Checks if null value is allowed.

int	db_get_column_length (dbColumn *column)
	Get column's length.

void	db_set_column_length (dbColumn *column, int length)
	Set column's length.

void	db_set_column_select_priv_granted (dbColumn *column)
	Set select privileges to be granted.

void	db_set_column_select_priv_not_granted (dbColumn *column)
	Unset select privileges.

int	db_get_column_select_priv (dbColumn *column)
	Get select privileges.

void	db_set_column_update_priv_granted (dbColumn *column)
	Set update privileges to be granted.

void	db_set_column_update_priv_not_granted (dbColumn *column)
	Unset update privileges.

int	db_get_column_update_priv (dbColumn *column)
	Get update privileges.

void	db_init_column (dbColumn *column)
	Initialize dbColumn.

int	db_set_column_name (dbColumn column, const char name)
	Set column name.

const char *	db_get_column_name (dbColumn *column)
	Returns column name for given column.

int	db_set_column_description (dbColumn column, const char description)
	Set column description.

const char *	db_get_column_description (dbColumn *column)
	Returns column description for given column.

void	db_free_column (dbColumn *column)
	Frees column structure.

dbColumn *	db_copy_column (dbColumn dest, dbColumn src)
	Copy a db column from source to destination.

Detailed Description

DBMI Library (base) - columns management.

SPDX-FileCopyrightText: 1999-2009, 2011 GRASS Development Team SPDX-License-Identifier: GPL-2.0-or-later

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

Definition in file dbmi_base/column.c.

Function Documentation

◆ db_copy_column()

dbColumn * db_copy_column	(	dbColumn *	dest,
		dbColumn *	src
	)

Copy a db column from source to destination.

Parameters

src	The column to copy from
dest	An allocated column to copy to which will be initialized. In case dest is NULL a new column will be allocated and returned

Returns: The pointer of copied/allocated column

Definition at line 470 of file dbmi_base/column.c.

References _db_column::columnName, _db_column::dataLen, db_calloc(), db_copy_string(), db_copy_value(), db_init_column(), _db_column::defaultValue, _db_column::description, _db_column::hasDefaultValue, _db_column::hostDataType, NULL, _db_column::nullAllowed, _db_column::precision, _db_column::scale, _db_column::select, _db_column::sqlDataType, _db_column::update, _db_column::useDefaultValue, and _db_column::value.

Referenced by db_append_table_column(), db_clone_table(), db_get_column(), and db_set_table_column().

◆ db_free_column()

void db_free_column ( dbColumn * column )

Frees column structure.

Parameters

column pointer to dbColumn

Definition at line 452 of file dbmi_base/column.c.

References db_free_string().

Referenced by db_d_add_column(), db_free_table(), Vect_net_build_graph(), and Vect_net_ttb_build_graph().

◆ db_get_column_default_value()

dbValue * db_get_column_default_value ( dbColumn * column )

Returns column default value for given column structure.

Parameters

column pointer to dbColumn

Returns: pointer to dbValue

Definition at line 37 of file dbmi_base/column.c.

Referenced by db__recv_column_default_value(), db__send_column_default_value(), db_convert_column_default_value_to_string(), and db_convert_Cstring_to_column_default_value().

◆ db_get_column_description()

const char * db_get_column_description ( dbColumn * column )

Returns column description for given column.

Parameters

column pointer to dbColumn

Returns: pointer to string with column's description

Definition at line 442 of file dbmi_base/column.c.

References db_get_string().

Referenced by db_print_column_definition().

◆ db_get_column_host_type()

int db_get_column_host_type ( dbColumn * column )

Get column host type.

Parameters

column pointer to dbColumn

Returns: data type (see include/dbmi.h)

Definition at line 152 of file dbmi_base/column.c.

◆ db_get_column_length()

int db_get_column_length ( dbColumn * column )

Get column's length.

Parameters

column pointer to dbColumn

Returns: length

Definition at line 301 of file dbmi_base/column.c.

Referenced by db_print_column_definition(), and db_table_to_sql().

◆ db_get_column_name()

const char * db_get_column_name ( dbColumn * column )

Returns column name for given column.

Parameters

column pointer to dbColumn

Returns: pointer to string with column name

Definition at line 416 of file dbmi_base/column.c.

References db_get_string().

Referenced by db_column_sqltype(), db_get_column(), db_print_column_definition(), db_table_to_sql(), Vect_get_column_names(), Vect_get_column_names_types(), and Vect_write_ascii().

◆ db_get_column_precision()

int db_get_column_precision ( dbColumn * column )

Get column precision.

Parameters

column pointer to dbColumn

Returns: precision

Definition at line 115 of file dbmi_base/column.c.

Referenced by db_print_column_definition().

◆ db_get_column_scale()

int db_get_column_scale ( dbColumn * column )

Get column scale.

Parameters

column pointer to dbColumn

Returns: scale

Definition at line 92 of file dbmi_base/column.c.

Referenced by db_print_column_definition().

◆ db_get_column_select_priv()

int db_get_column_select_priv ( dbColumn * column )

Get select privileges.

Parameters

column pointer to dbColumn

Returns: privileges

Definition at line 344 of file dbmi_base/column.c.

Referenced by db_get_table_select_priv(), and db_print_column_definition().

◆ db_get_column_sqltype()

int db_get_column_sqltype ( dbColumn * column )

Returns column sqltype for column.

The function db_sqltype_name() returns sqltype description.

Parameters

column pointer to dbColumn

Returns: sql data type (see include/dbmi.h)

Definition at line 140 of file dbmi_base/column.c.

Referenced by db__recv_column_default_value(), db__recv_column_value(), db__send_column_default_value(), db__send_column_value(), db_column_sqltype(), db_convert_column_default_value_to_string(), db_convert_column_value_to_string(), db_convert_Cstring_to_column_default_value(), db_convert_Cstring_to_column_value(), db_print_column_definition(), db_select_CatValArray(), db_select_int(), db_table_to_sql(), P_Aux_to_Vector(), Vect_get_column_names_types(), Vect_get_column_types(), Vect_net_build_graph(), and Vect_net_ttb_build_graph().

◆ db_get_column_update_priv()

int db_get_column_update_priv ( dbColumn * column )

Get update privileges.

Parameters

column pointer to dbColumn

Returns: privileges

Definition at line 376 of file dbmi_base/column.c.

Referenced by db_get_table_update_priv(), and db_print_column_definition().

◆ db_get_column_value()

dbValue * db_get_column_value ( dbColumn * column )

Returns column value for given column structure.

Parameters

column pointer to dbColumn

Returns: pointer to dbValue

Definition at line 25 of file dbmi_base/column.c.

Referenced by db__recv_column_value(), db__send_column_value(), db_convert_column_value_to_string(), db_convert_Cstring_to_column_value(), db_select_CatValArray(), db_select_int(), db_select_value(), NetA_init_distinct(), NetA_init_timetable_from_db(), P_Aux_to_Vector(), and Vect_write_ascii().

◆ db_init_column()

void db_init_column ( dbColumn * column )

Initialize dbColumn.

Parameters

column pointer to dbColumn to be initialized

Definition at line 386 of file dbmi_base/column.c.

References db_init_string(), and db_zero().

Referenced by db_alloc_table(), db_copy_column(), and db_d_add_column().

◆ db_set_column_description()

int db_set_column_description	(	dbColumn *	column,
		const char *	description
	)

Set column description.

Parameters

column	pointer to dbColumn
description	column's description

Returns: DB_OK on success; error code on failure

Definition at line 430 of file dbmi_base/column.c.

References db_set_string().

◆ db_set_column_has_defined_default_value()

void db_set_column_has_defined_default_value ( dbColumn * column )

Set default value identificator.

Parameters

column pointer to dbColumn

Definition at line 162 of file dbmi_base/column.c.

◆ db_set_column_has_undefined_default_value()

void db_set_column_has_undefined_default_value ( dbColumn * column )

Unset default value identificator.

Todo:: Replace by db_unset_column_has_default_value() ?

Parameters

column pointer to dbColumn

Definition at line 174 of file dbmi_base/column.c.

◆ db_set_column_host_type()

void db_set_column_host_type	(	dbColumn *	column,
		int	type
	)

Set column host data type.

Parameters

column	pointer to dbColumn
type	data type

Definition at line 80 of file dbmi_base/column.c.

◆ db_set_column_length()

void db_set_column_length	(	dbColumn *	column,
		int	length
	)

Set column's length.

Parameters

column	pointer to dbColumn
length	value

Definition at line 312 of file dbmi_base/column.c.

◆ db_set_column_name()

int db_set_column_name	(	dbColumn *	column,
		const char *	name
	)

Set column name.

Parameters

column	pointer to dbColumn
name	column name

Returns: DB_OK on success; error code on failure

Definition at line 404 of file dbmi_base/column.c.

References db_set_string(), and name.

Referenced by P_Create_Aux2_Table(), and P_Create_Aux4_Table().

◆ db_set_column_null_allowed()

void db_set_column_null_allowed ( dbColumn * column )

Set null value to be allowed.

Parameters

column pointer to dbColumn

Definition at line 266 of file dbmi_base/column.c.

◆ db_set_column_precision()

void db_set_column_precision	(	dbColumn *	column,
		int	precision
	)

Set column precision.

Parameters

column	pointer to dbColumn
precision	value

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

◆ db_set_column_scale()

void db_set_column_scale	(	dbColumn *	column,
		int	scale
	)

Set column scale.

Parameters

column	pointer to dbColumn
scale	column scale value

Definition at line 103 of file dbmi_base/column.c.

◆ db_set_column_select_priv_granted()

void db_set_column_select_priv_granted ( dbColumn * column )

Set select privileges to be granted.

Parameters

column pointer to dbColumn

Definition at line 322 of file dbmi_base/column.c.

References DB_GRANTED.

Referenced by db_set_table_select_priv_granted().

◆ db_set_column_select_priv_not_granted()

void db_set_column_select_priv_not_granted ( dbColumn * column )

Unset select privileges.

Parameters

column pointer to dbColumn

Definition at line 332 of file dbmi_base/column.c.

References DB_NOT_GRANTED.

Referenced by db_set_table_select_priv_not_granted().

◆ db_set_column_sqltype()

void db_set_column_sqltype	(	dbColumn *	column,
		int	sqltype
	)

Define column sqltype for column.

The function db_sqltype_name() returns sqltype description.

#define DB_SQL_TYPE_UNKNOWN          0
 
#define DB_SQL_TYPE_CHARACTER        1
#define DB_SQL_TYPE_SMALLINT         2
#define DB_SQL_TYPE_INTEGER          3
#define DB_SQL_TYPE_REAL             4
#define DB_SQL_TYPE_DOUBLE_PRECISION 6
#define DB_SQL_TYPE_DECIMAL          7
#define DB_SQL_TYPE_NUMERIC          8
#define DB_SQL_TYPE_DATE             9
#define DB_SQL_TYPE_TIME            10
#define DB_SQL_TYPE_TIMESTAMP       11
#define DB_SQL_TYPE_INTERVAL        12
#define DB_SQL_TYPE_TEXT            13
 
#define DB_SQL_TYPE_SERIAL          21

Parameters

column	pointer to dbColumn
sqltype	SQL data type (see list)

Definition at line 69 of file dbmi_base/column.c.

Referenced by P_Create_Aux2_Table(), and P_Create_Aux4_Table().

◆ db_set_column_update_priv_granted()

void db_set_column_update_priv_granted ( dbColumn * column )

Set update privileges to be granted.

Parameters

column pointer to dbColumn

Definition at line 354 of file dbmi_base/column.c.

References DB_GRANTED.

Referenced by db_set_table_update_priv_granted().

◆ db_set_column_update_priv_not_granted()

void db_set_column_update_priv_not_granted ( dbColumn * column )

Unset update privileges.

Parameters

column pointer to dbColumn

Definition at line 364 of file dbmi_base/column.c.

References DB_NOT_GRANTED.

Referenced by db_set_table_update_priv_not_granted().

◆ db_set_column_use_default_value()

void db_set_column_use_default_value ( dbColumn * column )

Set default value to be used.

Parameters

column pointer to dbColumn

Definition at line 233 of file dbmi_base/column.c.

◆ db_test_column_has_default_value()

int db_test_column_has_default_value ( dbColumn * column )

Check if column has defined default value.

Parameters

column pointer to dbColumn

Returns: 1 if true; 0 if false

Definition at line 197 of file dbmi_base/column.c.

Referenced by db_print_column_definition().

◆ db_test_column_has_defined_default_value()

int db_test_column_has_defined_default_value ( dbColumn * column )

Check if column has defined default value.

Parameters

column pointer to dbColumn

Returns: 1 if true; 0 if false

Definition at line 210 of file dbmi_base/column.c.

◆ db_test_column_has_undefined_default_value()

int db_test_column_has_undefined_default_value ( dbColumn * column )

Check if column has defined default value.

Parameters

column pointer to dbColumn

Returns: 1 if false; 0 if true

Definition at line 223 of file dbmi_base/column.c.

◆ db_test_column_null_allowed()

int db_test_column_null_allowed ( dbColumn * column )

Checks if null value is allowed.

Parameters

column pointer to dbColumn

Returns: 1 if true; 0 if false

Definition at line 289 of file dbmi_base/column.c.

Referenced by db_print_column_definition().

◆ db_test_column_use_default_value()

int db_test_column_use_default_value ( dbColumn * column )

Checks if default value is used.

Parameters

column pointer to dbColumn

Returns: 1 if true; 0 if false

Definition at line 256 of file dbmi_base/column.c.

◆ db_unset_column_has_default_value()

void db_unset_column_has_default_value ( dbColumn * column )

Unset default value identificator.

Parameters

column pointer to dbColumn

Definition at line 184 of file dbmi_base/column.c.

◆ db_unset_column_null_allowed()

void db_unset_column_null_allowed ( dbColumn * column )

Unset null value to be allowed.

Parameters

column pointer to dbColumn

Definition at line 276 of file dbmi_base/column.c.

◆ db_unset_column_use_default_value()

void db_unset_column_use_default_value ( dbColumn * column )

Unset default value to be used.

Parameters

column pointer to dbColumn

Definition at line 243 of file dbmi_base/column.c.

Functions

Detailed Description

Function Documentation

◆ db_copy_column()

◆ db_free_column()

◆ db_get_column_default_value()

◆ db_get_column_description()

◆ db_get_column_host_type()

◆ db_get_column_length()

◆ db_get_column_name()

◆ db_get_column_precision()

◆ db_get_column_scale()

◆ db_get_column_select_priv()

◆ db_get_column_sqltype()

◆ db_get_column_update_priv()

◆ db_get_column_value()

◆ db_init_column()

◆ db_set_column_description()

◆ db_set_column_has_defined_default_value()

◆ db_set_column_has_undefined_default_value()

◆ db_set_column_host_type()

◆ db_set_column_length()

◆ db_set_column_name()

◆ db_set_column_null_allowed()

◆ db_set_column_precision()

◆ db_set_column_scale()

◆ db_set_column_select_priv_granted()

◆ db_set_column_select_priv_not_granted()

◆ db_set_column_sqltype()

◆ db_set_column_update_priv_granted()

◆ db_set_column_update_priv_not_granted()

◆ db_set_column_use_default_value()

◆ db_test_column_has_default_value()

◆ db_test_column_has_defined_default_value()

◆ db_test_column_has_undefined_default_value()

◆ db_test_column_null_allowed()

◆ db_test_column_use_default_value()

◆ db_unset_column_has_default_value()

◆ db_unset_column_null_allowed()

◆ db_unset_column_use_default_value()