skip to main content
OpenAccess SDK SQL Engine core methods for Java : Exchanging data : dam_getSchemaObjectList
 

dam_getSchemaObjectList

This method returns the list of schema objects of the specified type. Use this method in the ipDDL method to find information about tables, columns, indexes, and foreign key references used in CREATE TABLE and CREATE INDEX statements. Also use this method for DROP TABLE and DROP INDEX statements.
long dam_getSchemaObjectList(
     long hstmt,
     int  iSchemaType)
Table 216. Parameters for dam_getSchemaObjectList
Parameter
Type
Description
INPUT
hstmt
long
The statement handle.
iSchemaType
int
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 schemaobj_table.
DAMOBJ_TYPE_COLUMN - return a list with an entry for each column to be created. Each entry is of type schemaobj_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 schemaobj_stat.
DAMOBJ_TYPE_FKEY - return a list with an entry for each foreign key relationship. Each entry is of type schemaobj_fkey.
RETURN
DAM_OBJ_LIST
List of requested schema types. NULL if no objects of that type exist.

See also

*ipDDL