dam_getSchemaObjectList
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This method returns the list of schema objects of the specified type. Use this method in the ipDDL method to retrieve information about tables, columns, indexes and foreign key references used in CREATE TABLE and CREATE INDEX statements. This method should also be used for DROP TABLE and DROP INDEX statements.
int64 dam_getSchemaObjectList(
int64 hstmt,
int iSchemaType)
Parameters for dam_getSchemaObjectList method
| Parameter | Type | Description |
| IN | ||
| hstmt | int64 | 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 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 | ||
| int64 | List of requested schema types. NULL if no objects of that type exist. |