%Library.GTWCatalog
class %Library.GTWCatalog
Gateway Catalog Queries
Method Inventory
MethodsCopy link to this section
Calls SQLGriverConnect and SQLGetInfo for the corresponding datasource;
dsn is the DSN, infoType is the info type
classmethod SQLDataSourcesClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLDataSourcesExecute(ByRef QHandle As %Binary , direction As %Integer ) as %Status
Copy link to this section
classmethod SQLDataSourcesSortedClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLDataSourcesSortedExecute(ByRef QHandle As %Binary , direction As %Integer ) as %Status
Copy link to this section
classmethod SQLDataSourcesSortedFetch(ByRef QHandle As %Binary , ByRef Row As %List , AtEnd As %Integer ) as %Status
Copy link to this section
classmethod SQLFieldsClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLFieldsJClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLForeignKeysClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLForeignKeysJClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLPrimaryKeysClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLPrimaryKeysJClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLProcedureColumnsClose(QHandle As %Binary ) as %Status
Copy link to this section
Get a List of all procedures
classmethod SQLProcedureColumnsFetch(ByRef QHandle As %Binary , ByRef Row As %List , AtEnd As %Integer ) as %Status
Copy link to this section
classmethod SQLProcedureColumnsJClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLProcedureColumnsJFetch(ByRef QHandle As %Binary , ByRef Row As %List , AtEnd As %Integer ) as %Status
Copy link to this section
classmethod SQLProceduresClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLProceduresJClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLSpecialColumnsClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLSpecialColumnsFetch(ByRef QHandle As %Binary , ByRef Row As %List , AtEnd As %Integer ) as %Status
Copy link to this section
classmethod SQLTablesClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod SQLTablesJClose(QHandle As %Binary ) as %Status
Copy link to this section
classmethod getIndexInfoClose(QHandle As %Binary ) as %Status
Copy link to this section
QueriesCopy link to this section
query SQLDataSources (direction As %Integer )
Copy link to this section
return list of ODBC datasources
direction could be one of the following:
SQL_FETCH_NEXT 1
SQL_FETCH_FIRST 2
SQL_FETCH_FIRST_USER 31
SQL_FETCH_FIRST_SYSTEM 32
query SQLDataSourcesSorted (direction As %Integer )
Copy link to this section
return list of ODBC datasources, lexicographically sorted
direction could be one of the following:
SQL_FETCH_NEXT 1
SQL_FETCH_FIRST 2
SQL_FETCH_FIRST_USER 31
SQL_FETCH_FIRST_SYSTEM 32
Selects
CATALOG_NAME As %String , SCHEMA_NAME As %String , TABLE_NAME As %String , COLUMN_NAME As %String , DATATYPE As %Integer , DATATYPE_NAME As %String , COLUMN_SIZE As %Integer , DECIMAL_DIGITS As %Integer , NULLABLE As %String , REMARKS As %String , SUPPORTED As %Boolean , SQLCOLUMNNUMBER As %Integer
Get a List of all Fields from a table for an ODBC based SQL Gateway connection;
dsn is the SQLGateway connection name, tname is the string search pattern for table names,
schema is the string search pattern for schema names
Selects
CATALOG_NAME As %String , SCHEMA_NAME As %String , TABLE_NAME As %String , COLUMN_NAME As %String , DATATYPE As %Integer , DATATYPE_NAME As %String , COLUMN_SIZE As %Integer , DECIMAL_DIGITS As %Integer , NULLABLE As %String , REMARKS As %String , COLUMN_DEF As %String , SUPPORTED As %Boolean , SQLCOLUMNNUMBER As %Integer
Get a List of all fields in a table for a JDBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the string search pattern for table names,
schema is the string search pattern for schema names
query SQLForeignKeys (dsn As %String , tname As %String , catalog As %String = "")
Copy link to this section
Selects
PKTABLE_CAT As %String , PKTABLE_SCHEM As %String , PKTABLE_NAME As %String , PKCOLUMN_NAME As %String , FKTABLE_CAT As %String , FKTABLE_SCHEM As %String , FKTABLE_NAME As %String , FKCOLUMN_NAME As %String , KEY_SEQ As %Integer , UPDATE_RULE As %Integer , DELETE_RULE As %Integer , FK_NAME As %String , PK_NAME As %String
Get a List of foreign keys for an ODBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the table name in the format SCHEMA_NAME.TABLE_NAME
query SQLForeignKeysJ (dsn As %String , tname As %String , catalog As %String = "")
Copy link to this section
Selects
PKTABLE_CAT As %String , PKTABLE_SCHEM As %String , PKTABLE_NAME As %String , PKCOLUMN_NAME As %String , FKTABLE_CAT As %String , FKTABLE_SCHEM As %String , FKTABLE_NAME As %String , FKCOLUMN_NAME As %String , KEY_SEQ As %Integer , UPDATE_RULE As %Integer , DELETE_RULE As %Integer , FK_NAME As %String , PK_NAME As %String
Get a List of foreign keys for an JDBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the table name in the format SCHEMA_NAME.TABLE_NAME
query SQLPrimaryKeys (dsn As %String , tname As %String , catalog As %String = "")
Copy link to this section
Get a List of primary keys for an ODBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the table name in the format SCHEMA_NAME.TABLE_NAME
query SQLPrimaryKeysJ (dsn As %String , tname As %String , catalog As %String = "")
Copy link to this section
Get a List of primary keys for a JDBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the table name in the format SCHEMA_NAME.TABLE_NAME
Selects
CATALOG_NAME As %String , SCHEMA_NAME As %String , PROC_NAME As %String , COL_NAME As %String , COL_TYPE As %Integer , DATA_TYPE As %Integer , TYPE_NAME As %String , COL_SIZE As %Integer , DEC_DIGITS As %Integer , RADIX As %Integer , NULLABLE As %Integer , REMARKS As %String , SUPPORTED As %Boolean
return a list of the procedure columns for an ODBC based SQL Gateway connection
dsn is the SQLGateway connection name,
procname is the string search pattern for procedure names, schema is the string search pattern for schema names
Selects
CATALOG_NAME As %String , SCHEMA_NAME As %String , PROC_NAME As %String , COL_NAME As %String , COL_TYPE As %Integer , DATA_TYPE As %Integer , TYPE_NAME As %String , COL_SIZE As %Integer , DEC_DIGITS As %Integer , RADIX As %Integer , NULLABLE As %Integer , REMARKS As %String , COLUMN_DEF As %String , SUPPORTED As %Boolean
return a list of the procedure columns for a JDBC based SQL Gateway connection
dsn is the SQLGateway connection name,
procname is the string search pattern for procedure names, schema is the string search pattern for schema names
Get a List of all procedures for an ODBC based SQL Gateway connection
dsn is the SQLGateway connection name,
pname is the string search pattern for procedure names, schema is the string search pattern for schema names
Get a List of all procedures for a JDBC based SQL Gateway connection
dsn is the SQLGateway connection name,
pname is the string search pattern for procedure names, schema is the string search pattern for schema names
query SQLSpecialColumns (dsn As %String , tname As %String , catalog As %String = "")
Copy link to this section
Get a List of special columns for an ODBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the table name in the format SCHEMA_NAME.TABLE_NAME
Get a List of all tables for an ODBC based SQL Gateway connection;
dsn is the SQLGateway connection name, tname is the string search pattern for table names,
schema is the string search pattern for schema names, ttype - list of table types to match
Get a List of all tables for a JDBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the string search pattern for table names,
schema is the string search pattern for schema names, ttype - list of table types to match
Selects
TABLE_CAT As %String (MAXLEN=128), TABLE_SCHEM As %String (MAXLEN=128), TABLE_NAME As %String (MAXLEN=128), NON_UNIQUE As %SmallInt , INDEX_QUALIFIER As %String (MAXLEN=128), INDEX_NAME As %String (MAXLEN=128), TYPE As %SmallInt , ORDINAL_POSITION As %SmallInt , COLUMN_NAME As %String (MAXLEN=128), ASC_OR_DESC As %String (MAXLEN=1), CARDINALITY As %Integer , PAGES As %Integer , FILTER_CONDITION As %String (MAXLEN=128)
Get a List of all indices in a table for a JDBC based SQL Gateway connection
dsn is the SQLGateway connection name, tname is the string search pattern for table names,
schema is the string search pattern for schema names