|
Parameter
|
Type
|
Description
|
|
IN
|
|
|
|
table_qualifier
|
String
|
The name of the database in which the table falls. Can be used to distribute tables into physically different databases. You would normally specify SCHEMA. If you want to expose this field as an empty value, then return 0 when OAIP_getInfo(SQL_MAX_QUALIFIER_NAME) is called and set this field value to NULL.
|
|
table_owner
|
String
|
The owner of the table. You would normally set it to SYSTEM or USER.
SYSTEM – the table is managed by the OpenAccess SDK SQL Engine.
OAUSER – the table is managed by the IP.
The value for this parameter and OA_COLUMNS must match.
If you want to expose this field as an empty value, then return 0 when OAIP_getInfo(SQL_MAX_OWNER_NAME) is called and set this field value to NULL.
|
|
table_name
|
String
|
The name of the table. This is how the end user refers to it.
|
|
table_type
|
String
|
Affects how the table is handled. Set to:
SYSTEM TABLE – This table is managed by the CSV IP.
TABLE – The table is managed by the IP.
TABLE FUNCTION – The table function is managed by the IP.
|
|
table_path
|
String
|
The full pathname of the file holding this table (if any). File name by itself defaults to the current directory. You can use the relative path specifier to define a file name relative to the schema path as defined in the DataSourceIPSchemaPath data source attribute.
Place a single period (.) to indicate the schema directory.
Place a forward or backward slash and follow by remainder of the name. For example: ./mem_db/test.dbf expands to {schema_path}/mem_db/test.dbf, where schema_path is as defined in the DataSourceIPPath data source attribute.
|
|
table_userdata
|
String
|
A place for the IP to maintain IP-specific data. The IP can read it by using the dam_describeTable function.
|
|
function_support
|
String
|
A place for the IP to maintain the functionality it supports for the table (SELECT, INSERT and so on). The OpenAccess SDK SQL Engine allows a user to perform only these operations for the table. This value is used if the GETSUPPORT function returns false for that capability.
The value in this field is specified as a hex number with the 0x convention. It is bitwise OR of the following bit masks:
IP_TABLE_SUPPORT_SELECT - 0x01
IP_TABLE_SUPPORT_INSERT - 0x02
IP_TABLE_SUPPORT_UPDATE - 0x04
IP_TABLE_SUPPORT_DELETE - 0x08
IP_TABLE_SUPPORT_SELECT_FOR_UPDATE - 0x10
For example, set this field to '0x1F' to indicate full support. This number is the result of 0x01 | 0x02 | 0x04 | 0x08 | 0x10 where the '|' indicates bitwise OR.
|
|
remarks
|
String
|
The description of the table.
|
|
RETURN
|
|
|
|
|
NONE
|
|