skip to main content
OpenAccess SDK SQL Engine Core Functions API : Function Reference : dam_getSchemaObjectList
 

dam_getSchemaObjectList

This function returns the list of schema objects of the specified type. Use this function in the DDL IP function to retrieve information about tables, columns, indexes and foreign key references used in CREATE TABLE and CREATE INDEX statements. This function should also be used for DROP TABLE and DROP INDEX statements.
DAM_OBJ_LIST dam_getSchemaObjectList(
DAM_HSTMT hstmt,
int iSchemaType)
Table 153. Parameters for dam_getSchemaObjectList
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
The statement handle.
iSchemaType
int
The type of schema information requested. All types are returned as a DAM_OBJ type which should be cast to the requested type.
DAMOBJ_TYPE_TABLE - return a list with a single entry for a table to be created or dropped. Each entry is of type damobj_table.
DAMOBJ_TYPE_COLUMN - return a list with an entry for each column to be created. Each entry is of type damobj_column.
DAMOBJ_TYPE_STAT - return a list with an entry for each index column to be created by a CREATE INDEX statement or one entry for the index to be dropped. Each entry is of type damobj_stat.
DAMOBJ_TYPE_FKEY - return a list with an entry for each foreign key relationship. Each entry is of type damobj_fkey.
RETURN
DAM_OBJ_LIST
A list of requested schema types. NULL if no objects of that type exist.