File db.h¶

#include "config.h"
#include <stdio.h>
#include "error_manager.h"
#include "intl_support.h"
#include "db_date.h"
#include "object_domain.h"
#include "log_comm.h"
#include "dbtype_def.h"
#include "db_admin.h"

Public Attributes¶

Type	Name
int	db_Connect_status
int	db_Disable_modifications
bool	db_Keep_session
int	db_Row_count
SESSION_ID	db_Session_id

Public Functions¶

Type	Name
int	db_abort_to_savepoint_internal (const char * savepoint_name)
int	db_add_attribute_internal (MOP class_, const char * name, const char * domain, DB_VALUE * default_value, SM_NAME_SPACE name_space)
int	db_add_super_internal (DB_OBJECT * classobj, DB_OBJECT * super)
DB_DOMAIN *	db_attdesc_domain (DB_ATTDESC * desc)
void	db_close_session_local (DB_SESSION * session)
int	db_col_optimize (DB_COLLECTION * col)
int	db_compile_and_execute_local (const char * CSQL_query, void * result, DB_QUERY_ERROR * query_error)
int	db_compile_and_execute_queries_internal (const char * CSQL_query, void * result, DB_QUERY_ERROR * query_error, int include_oid, int execute, bool is_new_statement)
int	db_compile_statement_local (DB_SESSION * session)
BTID *	db_constraint_index (DB_CONSTRAINT * constraint, BTID * index)
DB_OBJECT *	db_create_by_name_internal (const char * name)
DB_OBJECT *	db_create_internal (DB_OBJECT * obj)
int	db_dput_internal (DB_OBJECT * obj, DB_ATTDESC * attribute, DB_VALUE * value)
void	db_drop_all_statements (DB_SESSION * session)
int	db_drop_attribute_internal (DB_OBJECT * classobj, const char * name)
int	db_drop_set_attribute_domain (MOP class_, const char * name, int class_attribute, const char * domain)
int	db_error_code_test (void)
const char *	db_error_string_test (int level)
int	db_execute_statement_local (DB_SESSION * session, int stmt, DB_QUERY_RESULT ** result)
DB_VALUE *	db_get_hostvars (DB_SESSION * session)
int	db_get_line_col_of_1st_error (DB_SESSION * session, DB_QUERY_ERROR * linecol)
int	db_get_line_of_statement (DB_SESSION * session, int stmt_id)
char **	db_get_lock_classes (DB_SESSION * session)
int	db_get_parser_line_col (DB_SESSION * session, int * line, int * col)
DB_NODE *	db_get_statement (DB_SESSION * session, int id)
int	db_init (const char * program, int print_version, const char * dbname, const char * db_path, const char * vol_path, const char * log_path, const char * lob_path, const char * host_name, const bool overwrite, const char * comments, const char * addmore_vols_file, int npages, int desired_pagesize, int log_npages, int desired_log_page_size, const char * lang_charset)
DB_SESSION *	db_make_session_for_one_statement_execution (FILE * file)
int	db_open_buffer_and_compile_first_statement (const char * CSQL_query, DB_QUERY_ERROR * query_error, int include_oid, DB_SESSION session, int** * stmt_no)
DB_SESSION *	db_open_buffer_local (const char * buffer)
int	db_parse_one_statement (DB_SESSION * session)
int	db_put_internal (DB_OBJECT * obj, const char * name, DB_VALUE * value)
int	db_rename_internal (DB_OBJECT * classobj, const char * name, int class_namespace, const char * newname)
int	db_savepoint_transaction_internal (const char * savepoint_name)
int	db_set_otmpl_timestamps (DB_OTMPL * otmpl)
int	db_set_system_generated_statement (DB_SESSION * session)
int	db_update_obj_timestamp (DB_OBJECT * obj)
int	db_update_otmpl_timestamp (DB_OTMPL * otmpl)
void *	db_value_eh_key (DB_VALUE * value)
DB_DATA *	db_value_get_db_data (DB_VALUE * value)
int	db_value_put_db_data (DB_VALUE * value, const DB_DATA * data)
DB_OTMPL *	dbt_create_object_internal (DB_OBJECT * classobj)
int	dbt_dput_internal (DB_OTMPL * def, DB_ATTDESC * attribute, DB_VALUE * value)
int	dbt_put_internal (DB_OTMPL * def, const char * name, DB_VALUE * value)
int	parse_one_statement (int state)

Macros¶

Type	Name
define	CHECK_1ARG_ERROR (obj) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj,[ER\_OBJ\_INVALID\_ARGUMENTS](error__code_8h.md#define-er_obj_invalid_arguments))`
define	CHECK_1ARG_ERROR_WITH_TYPE (obj, TYPE) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj,([TYPE](broker__monitor_8c.md#function-timeout))[ER\_OBJ\_INVALID\_ARGUMENTS](error__code_8h.md#define-er_obj_invalid_arguments))`
define	CHECK_1ARG_FALSE (obj) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj,[false](broker__monitor_8c.md#function-timeout))`
define	CHECK_1ARG_MINUSONE (obj) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj,-1)`
define	CHECK_1ARG_NULL (obj) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj, [NULL](freelistheap_8h.md#define-null))`
define	CHECK_1ARG_RETURN_EXPR (obj, expr) `/* multi line expression */`
define	CHECK_1ARG_TRUE (obj) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj, [true](broker__monitor_8c.md#function-timeout))`
define	CHECK_1ARG_UNKNOWN (obj1) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)([obj1](broker__monitor_8c.md#function-timeout), DB\_TYPE\_UNKNOWN)`
define	CHECK_1ARG_ZERO (obj) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)(obj, 0)`
define	CHECK_1ARG_ZERO_WITH_TYPE (obj1, RETURN_TYPE) `[CHECK\_1ARG\_RETURN\_EXPR](db_8h.md#define-check_1arg_return_expr)([obj1](broker__monitor_8c.md#function-timeout), ([RETURN\_TYPE](broker__monitor_8c.md#function-timeout)) 0)`
define	CHECK_2ARGS_ERROR (obj1, obj2) `[CHECK\_2ARGS\_RETURN\_EXPR](db_8h.md#define-check_2args_return_expr)([obj1](broker__monitor_8c.md#function-timeout), [obj2](broker__monitor_8c.md#function-timeout), [ER\_OBJ\_INVALID\_ARGUMENTS](error__code_8h.md#define-er_obj_invalid_arguments))`
define	CHECK_2ARGS_NULL (obj1, obj2) `[CHECK\_2ARGS\_RETURN\_EXPR](db_8h.md#define-check_2args_return_expr)([obj1](broker__monitor_8c.md#function-timeout),[obj2](broker__monitor_8c.md#function-timeout),[NULL](freelistheap_8h.md#define-null))`
define	CHECK_2ARGS_RETURN_EXPR (obj1, obj2, expr) `/* multi line expression */`
define	CHECK_2ARGS_ZERO (obj1, obj2) `[CHECK\_2ARGS\_RETURN\_EXPR](db_8h.md#define-check_2args_return_expr)([obj1](broker__monitor_8c.md#function-timeout),[obj2](broker__monitor_8c.md#function-timeout), 0)`
define	CHECK_3ARGS_ERROR (obj1, obj2, obj3) `[CHECK\_3ARGS\_RETURN\_EXPR](db_8h.md#define-check_3args_return_expr)([obj1](broker__monitor_8c.md#function-timeout), [obj2](broker__monitor_8c.md#function-timeout), [obj3](broker__monitor_8c.md#function-timeout), [ER\_OBJ\_INVALID\_ARGUMENTS](error__code_8h.md#define-er_obj_invalid_arguments))`
define	CHECK_3ARGS_NULL (obj1, obj2, obj3) `[CHECK\_3ARGS\_RETURN\_EXPR](db_8h.md#define-check_3args_return_expr)([obj1](broker__monitor_8c.md#function-timeout),[obj2](broker__monitor_8c.md#function-timeout),[obj3](broker__monitor_8c.md#function-timeout),[NULL](freelistheap_8h.md#define-null))`
define	CHECK_3ARGS_RETURN_EXPR (obj1, obj2, obj3, expr) `/* multi line expression */`
define	CHECK_CONNECT_AND_RETURN_EXPR (return_expr_) `/* multi line expression */`
define	CHECK_CONNECT_ERROR () `[CHECK\_CONNECT\_AND\_RETURN\_EXPR](db_8h.md#define-check_connect_and_return_expr)(([DB\_TYPE](dbtype__def_8h.md#enum-db_type)) [ER\_OBJ\_NO\_CONNECT](error__code_8h.md#define-er_obj_no_connect))`
define	CHECK_CONNECT_FALSE () `[CHECK\_CONNECT\_AND\_RETURN\_EXPR](db_8h.md#define-check_connect_and_return_expr)([false](broker__monitor_8c.md#function-timeout))`
define	CHECK_CONNECT_MINUSONE () `[CHECK\_CONNECT\_AND\_RETURN\_EXPR](db_8h.md#define-check_connect_and_return_expr)(-1)`
define	CHECK_CONNECT_NULL () `[CHECK\_CONNECT\_AND\_RETURN\_EXPR](db_8h.md#define-check_connect_and_return_expr)([NULL](freelistheap_8h.md#define-null))`
define	CHECK_CONNECT_VOID () `/* multi line expression */`
define	CHECK_CONNECT_ZERO () `[CHECK\_CONNECT\_AND\_RETURN\_EXPR](db_8h.md#define-check_connect_and_return_expr)(0)`
define	CHECK_CONNECT_ZERO_TYPE (TYPE) `[CHECK\_CONNECT\_AND\_RETURN\_EXPR](db_8h.md#define-check_connect_and_return_expr)(([TYPE](broker__monitor_8c.md#function-timeout))0)`
define	CHECK_MODIFICATION_AND_RETURN_EXPR (return_expr_) `/* multi line expression */`
define	CHECK_MODIFICATION_ERROR () `[CHECK\_MODIFICATION\_AND\_RETURN\_EXPR](db_8h.md#define-check_modification_and_return_expr)([ER\_DB\_NO\_MODIFICATIONS](error__code_8h.md#define-er_db_no_modifications))`
define	CHECK_MODIFICATION_MINUSONE () `[CHECK\_MODIFICATION\_AND\_RETURN\_EXPR](db_8h.md#define-check_modification_and_return_expr)(-1)`
define	CHECK_MODIFICATION_NO_RETURN (error) `[error](gencat_8c.md#function-error) = [NO\_ERROR](error__code_8h.md#define-no_error);`
define	CHECK_MODIFICATION_NULL () `[CHECK\_MODIFICATION\_AND\_RETURN\_EXPR](db_8h.md#define-check_modification_and_return_expr)([NULL](freelistheap_8h.md#define-null))`
define	CHECK_MODIFICATION_VOID () `/* multi line expression */`
define	DB_CONNECTION_STATUS_CONNECTED `1`
define	DB_CONNECTION_STATUS_NOT_CONNECTED `0`
define	DB_CONNECTION_STATUS_RESET `-1`
define	_DB_DISABLE_MODIFICATIONS_

Public Attributes Documentation¶

variable db_Connect_status¶

int db_Connect_status;

variable db_Disable_modifications¶

int db_Disable_modifications;

variable db_Keep_session¶

bool db_Keep_session;

variable db_Row_count¶

int db_Row_count;

variable db_Session_id¶

SESSION_ID db_Session_id;

Public Functions Documentation¶

function db_abort_to_savepoint_internal¶

int db_abort_to_savepoint_internal (
    const  char * savepoint_name
)

function db_add_attribute_internal¶

int db_add_attribute_internal (
    MOP class_,
    const  char * name,
    const  char * domain,
    DB_VALUE * default_value,
    SM_NAME_SPACE name_space
)

function db_add_super_internal¶

int db_add_super_internal (
    DB_OBJECT * classobj,
    DB_OBJECT * super
)

function db_attdesc_domain¶

DB_DOMAIN * db_attdesc_domain (
    DB_ATTDESC * desc
)

function db_close_session_local¶

void db_close_session_local (
    DB_SESSION * session
)

function db_col_optimize¶

int db_col_optimize (
    DB_COLLECTION * col
)

function db_compile_and_execute_local¶

int db_compile_and_execute_local (
    const  char * CSQL_query,
    void * result,
    DB_QUERY_ERROR * query_error
)

function db_compile_and_execute_queries_internal¶

int db_compile_and_execute_queries_internal (
    const  char * CSQL_query,
    void * result,
    DB_QUERY_ERROR * query_error,
    int include_oid,
    int execute,
    bool is_new_statement
)

function db_compile_statement_local¶

int db_compile_statement_local (
    DB_SESSION * session
)

function db_constraint_index¶

BTID * db_constraint_index (
    DB_CONSTRAINT * constraint,
    BTID * index
)

function db_create_by_name_internal¶

DB_OBJECT * db_create_by_name_internal (
    const  char * name
)

function db_create_internal¶

DB_OBJECT * db_create_internal (
    DB_OBJECT * obj
)

function db_dput_internal¶

int db_dput_internal (
    DB_OBJECT * obj,
    DB_ATTDESC * attribute,
    DB_VALUE * value
)

function db_drop_all_statements¶

void db_drop_all_statements (
    DB_SESSION * session
)

function db_drop_attribute_internal¶

int db_drop_attribute_internal (
    DB_OBJECT * classobj,
    const  char * name
)

function db_drop_set_attribute_domain¶

int db_drop_set_attribute_domain (
    MOP class_,
    const  char * name,
    int class_attribute,
    const  char * domain
)

function db_error_code_test¶

int db_error_code_test (
    void
)

function db_error_string_test¶

const  char * db_error_string_test (
    int level
)

function db_execute_statement_local¶

int db_execute_statement_local (
    DB_SESSION * session,
    int stmt,
    DB_QUERY_RESULT ** result
)

function db_get_hostvars¶

DB_VALUE * db_get_hostvars (
    DB_SESSION * session
)

function db_get_line_col_of_1st_error¶

int db_get_line_col_of_1st_error (
    DB_SESSION * session,
    DB_QUERY_ERROR * linecol
)

function db_get_line_of_statement¶

int db_get_line_of_statement (
    DB_SESSION * session,
    int stmt_id
)

function db_get_lock_classes¶

char ** db_get_lock_classes (
    DB_SESSION * session
)

function db_get_parser_line_col¶

int db_get_parser_line_col (
    DB_SESSION * session,
    int * line,
    int * col
)

function db_get_statement¶

DB_NODE * db_get_statement (
    DB_SESSION * session,
    int id
)

function db_init¶

int db_init (
    const  char * program,
    int print_version,
    const  char * dbname,
    const  char * db_path,
    const  char * vol_path,
    const  char * log_path,
    const  char * lob_path,
    const  char * host_name,
    const  bool overwrite,
    const  char * comments,
    const  char * addmore_vols_file,
    int npages,
    int desired_pagesize,
    int log_npages,
    int desired_log_page_size,
    const  char * lang_charset
)

function db_make_session_for_one_statement_execution¶

DB_SESSION * db_make_session_for_one_statement_execution (
    FILE * file
)

function db_open_buffer_and_compile_first_statement¶

int db_open_buffer_and_compile_first_statement (
    const  char * CSQL_query,
    DB_QUERY_ERROR * query_error,
    int include_oid,
    DB_SESSION ** session,
    int * stmt_no
)

function db_open_buffer_local¶

DB_SESSION * db_open_buffer_local (
    const  char * buffer
)

function db_parse_one_statement¶

int db_parse_one_statement (
    DB_SESSION * session
)

function db_put_internal¶

int db_put_internal (
    DB_OBJECT * obj,
    const  char * name,
    DB_VALUE * value
)

function db_rename_internal¶

int db_rename_internal (
    DB_OBJECT * classobj,
    const  char * name,
    int class_namespace,
    const  char * newname
)

function db_savepoint_transaction_internal¶

int db_savepoint_transaction_internal (
    const  char * savepoint_name
)

function db_set_otmpl_timestamps¶

int db_set_otmpl_timestamps (
    DB_OTMPL * otmpl
)

function db_set_system_generated_statement¶

int db_set_system_generated_statement (
    DB_SESSION * session
)

function db_update_obj_timestamp¶

int db_update_obj_timestamp (
    DB_OBJECT * obj
)

function db_update_otmpl_timestamp¶

int db_update_otmpl_timestamp (
    DB_OTMPL * otmpl
)

function db_value_eh_key¶

void * db_value_eh_key (
    DB_VALUE * value
)

function db_value_get_db_data¶

DB_DATA * db_value_get_db_data (
    DB_VALUE * value
)

function db_value_put_db_data¶

int db_value_put_db_data (
    DB_VALUE * value,
    const  DB_DATA * data
)

function dbt_create_object_internal¶

DB_OTMPL * dbt_create_object_internal (
    DB_OBJECT * classobj
)

function dbt_dput_internal¶

int dbt_dput_internal (
    DB_OTMPL * def,
    DB_ATTDESC * attribute,
    DB_VALUE * value
)

function dbt_put_internal¶

int dbt_put_internal (
    DB_OTMPL * def,
    const  char * name,
    DB_VALUE * value
)

function parse_one_statement¶

int parse_one_statement (
    int state
)

Macro Definition Documentation¶

define CHECK_1ARG_ERROR¶

#define CHECK_1ARG_ERROR (
    obj
) `CHECK_1ARG_RETURN_EXPR (obj, ER_OBJ_INVALID_ARGUMENTS )`

define CHECK_1ARG_ERROR_WITH_TYPE¶

#define CHECK_1ARG_ERROR_WITH_TYPE (
    obj,
    TYPE
) `CHECK_1ARG_RETURN_EXPR (obj,( TYPE ) ER_OBJ_INVALID_ARGUMENTS )`

define CHECK_1ARG_FALSE¶

#define CHECK_1ARG_FALSE (
    obj
) `CHECK_1ARG_RETURN_EXPR (obj, false )`

define CHECK_1ARG_MINUSONE¶

#define CHECK_1ARG_MINUSONE (
    obj
) `CHECK_1ARG_RETURN_EXPR (obj,-1)`

define CHECK_1ARG_NULL¶

#define CHECK_1ARG_NULL (
    obj
) `CHECK_1ARG_RETURN_EXPR (obj, NULL )`

define CHECK_1ARG_RETURN_EXPR¶

#define CHECK_1ARG_RETURN_EXPR (
    obj,
    expr
) `/* multi line expression */`

define CHECK_1ARG_TRUE¶

#define CHECK_1ARG_TRUE (
    obj
) `CHECK_1ARG_RETURN_EXPR (obj, true )`

define CHECK_1ARG_UNKNOWN¶

#define CHECK_1ARG_UNKNOWN (
    obj1
) `CHECK_1ARG_RETURN_EXPR ( obj1 , DB_TYPE_UNKNOWN )`

define CHECK_1ARG_ZERO¶

#define CHECK_1ARG_ZERO (
    obj
) `CHECK_1ARG_RETURN_EXPR (obj, 0)`

define CHECK_1ARG_ZERO_WITH_TYPE¶

#define CHECK_1ARG_ZERO_WITH_TYPE (
    obj1,
    RETURN_TYPE
) `CHECK_1ARG_RETURN_EXPR ( obj1 , ( RETURN_TYPE ) 0)`

define CHECK_2ARGS_ERROR¶

#define CHECK_2ARGS_ERROR (
    obj1,
    obj2
) `CHECK_2ARGS_RETURN_EXPR ( obj1 , obj2 , ER_OBJ_INVALID_ARGUMENTS )`

define CHECK_2ARGS_NULL¶

#define CHECK_2ARGS_NULL (
    obj1,
    obj2
) `CHECK_2ARGS_RETURN_EXPR ( obj1 , obj2 , NULL )`

define CHECK_2ARGS_RETURN_EXPR¶

#define CHECK_2ARGS_RETURN_EXPR (
    obj1,
    obj2,
    expr
) `/* multi line expression */`

define CHECK_2ARGS_ZERO¶

#define CHECK_2ARGS_ZERO (
    obj1,
    obj2
) `CHECK_2ARGS_RETURN_EXPR ( obj1 , obj2 , 0)`

define CHECK_3ARGS_ERROR¶

#define CHECK_3ARGS_ERROR (
    obj1,
    obj2,
    obj3
) `CHECK_3ARGS_RETURN_EXPR ( obj1 , obj2 , obj3 , ER_OBJ_INVALID_ARGUMENTS )`

define CHECK_3ARGS_NULL¶

#define CHECK_3ARGS_NULL (
    obj1,
    obj2,
    obj3
) `CHECK_3ARGS_RETURN_EXPR ( obj1 , obj2 , obj3 , NULL )`

define CHECK_3ARGS_RETURN_EXPR¶

#define CHECK_3ARGS_RETURN_EXPR (
    obj1,
    obj2,
    obj3,
    expr
) `/* multi line expression */`

define CHECK_CONNECT_AND_RETURN_EXPR¶

#define CHECK_CONNECT_AND_RETURN_EXPR (
    return_expr_
) `/* multi line expression */`

define CHECK_CONNECT_ERROR¶

#define CHECK_CONNECT_ERROR (

) `CHECK_CONNECT_AND_RETURN_EXPR (( DB_TYPE ) ER_OBJ_NO_CONNECT )`

define CHECK_CONNECT_FALSE¶

#define CHECK_CONNECT_FALSE (

) `CHECK_CONNECT_AND_RETURN_EXPR ( false )`

define CHECK_CONNECT_MINUSONE¶

#define CHECK_CONNECT_MINUSONE (

) `CHECK_CONNECT_AND_RETURN_EXPR (-1)`

define CHECK_CONNECT_NULL¶

#define CHECK_CONNECT_NULL (

) `CHECK_CONNECT_AND_RETURN_EXPR ( NULL )`

define CHECK_CONNECT_VOID¶

#define CHECK_CONNECT_VOID (

) `/* multi line expression */`

define CHECK_CONNECT_ZERO¶

#define CHECK_CONNECT_ZERO (

) `CHECK_CONNECT_AND_RETURN_EXPR (0)`

define CHECK_CONNECT_ZERO_TYPE¶

#define CHECK_CONNECT_ZERO_TYPE (
    TYPE
) `CHECK_CONNECT_AND_RETURN_EXPR (( TYPE )0)`

define CHECK_MODIFICATION_AND_RETURN_EXPR¶

#define CHECK_MODIFICATION_AND_RETURN_EXPR (
    return_expr_
) `/* multi line expression */`

define CHECK_MODIFICATION_ERROR¶

#define CHECK_MODIFICATION_ERROR (

) `CHECK_MODIFICATION_AND_RETURN_EXPR ( ER_DB_NO_MODIFICATIONS )`

define CHECK_MODIFICATION_MINUSONE¶

#define CHECK_MODIFICATION_MINUSONE (

) `CHECK_MODIFICATION_AND_RETURN_EXPR (-1)`

define CHECK_MODIFICATION_NO_RETURN¶

#define CHECK_MODIFICATION_NO_RETURN (
    error
) `error = NO_ERROR ;`

define CHECK_MODIFICATION_NULL¶

#define CHECK_MODIFICATION_NULL (

) `CHECK_MODIFICATION_AND_RETURN_EXPR ( NULL )`

define CHECK_MODIFICATION_VOID¶

#define CHECK_MODIFICATION_VOID (

) `/* multi line expression */`

define DB_CONNECTION_STATUS_CONNECTED¶

#define DB_CONNECTION_STATUS_CONNECTED `1`

define DB_CONNECTION_STATUS_NOT_CONNECTED¶

#define DB_CONNECTION_STATUS_NOT_CONNECTED `0`

define DB_CONNECTION_STATUS_RESET¶

#define DB_CONNECTION_STATUS_RESET `-1`

define _DB_DISABLE_MODIFICATIONS_¶

#define _DB_DISABLE_MODIFICATIONS_

The documentation for this class was generated from the following file cubrid/src/compat/db.h