Skip to main content

%Library.GTWCatalog

Class %Library.GTWCatalog [ System = 3 ]

Gateway Catalog Queries

Methods​

GetInfo​

ClassMethod GetInfo(dsn As %String, infoType As %Integer, ByRef info As %String) As %Status

Calls SQLGriverConnect and SQLGetInfo for the corresponding datasource;

dsn<var\> is the DSN, infoType<var\> is the info type

SQLFieldsExecute​

ClassMethod SQLFieldsExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, schema As %String, catalog As %String = "") As %Status

Get a List of all Fields from a table for an ODBC based SQL Gateway connection;

dsn<var\> is the SQLGateway connection name, tname<var\> is the string search pattern for table names, schema is the string search pattern for schema names

SQLFieldsFetch​

ClassMethod SQLFieldsFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLFieldsClose​

ClassMethod SQLFieldsClose(QHandle As %Binary) As %Status

SQLTablesExecute​

ClassMethod SQLTablesExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String = "", ttype As %String = "", schema As %String = "", catalog As %String = "") As %Status

Get a List of all tables for an ODBC based SQL Gateway connection;

dsn<var\> is the SQLGateway connection name, tname<var\> is the string search pattern for table names, schema is the string search pattern for schema names, ttype<var\> - list of table types to match

SQLTablesFetch​

ClassMethod SQLTablesFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLTablesClose​

ClassMethod SQLTablesClose(QHandle As %Binary) As %Status

SQLProceduresExecute​

ClassMethod SQLProceduresExecute(ByRef QHandle As %Binary, dsn As %String, pname As %String, schname As %String = "", catalog As %String = "") As %Status

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

SQLProceduresFetch​

ClassMethod SQLProceduresFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLProceduresClose​

ClassMethod SQLProceduresClose(QHandle As %Binary) As %Status

SQLProcedureColumnsExecute​

ClassMethod SQLProcedureColumnsExecute(ByRef QHandle As %Binary, dsn As %String, schname As %String, procname As %String, catalog As %String = "") As %Status

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 Get a List of all procedures

SQLProcedureColumnsFetch​

ClassMethod SQLProcedureColumnsFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLProcedureColumnsClose​

ClassMethod SQLProcedureColumnsClose(QHandle As %Binary) As %Status

SQLPrimaryKeysExecute​

ClassMethod SQLPrimaryKeysExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, catalog As %String = "") As %Status

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

SQLPrimaryKeysFetch​

ClassMethod SQLPrimaryKeysFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLPrimaryKeysClose​

ClassMethod SQLPrimaryKeysClose(QHandle As %Binary) As %Status

SQLForeignKeysJExecute​

ClassMethod SQLForeignKeysJExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, catalog As %String = "") As %Status

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

SQLForeignKeysJFetch​

ClassMethod SQLForeignKeysJFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLForeignKeysJClose​

ClassMethod SQLForeignKeysJClose(QHandle As %Binary) As %Status

SQLForeignKeysExecute​

ClassMethod SQLForeignKeysExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, catalog As %String = "") As %Status

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

SQLForeignKeysFetch​

ClassMethod SQLForeignKeysFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLForeignKeysClose​

ClassMethod SQLForeignKeysClose(QHandle As %Binary) As %Status

SQLSpecialColumnsExecute​

ClassMethod SQLSpecialColumnsExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, catalog As %String = "") As %Status

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

SQLSpecialColumnsFetch​

ClassMethod SQLSpecialColumnsFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLSpecialColumnsClose​

ClassMethod SQLSpecialColumnsClose(QHandle As %Binary) As %Status

SQLDataSourcesExecute​

ClassMethod SQLDataSourcesExecute(ByRef QHandle As %Binary, direction As %Integer) As %Status

return list of ODBC datasources

direction could be one of the following: <br\>SQL_FETCH_NEXT 1 <br\>SQL_FETCH_FIRST 2 <br\>SQL_FETCH_FIRST_USER 31 <br\>SQL_FETCH_FIRST_SYSTEM 32

SQLDataSourcesFetch​

ClassMethod SQLDataSourcesFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLDataSourcesClose​

ClassMethod SQLDataSourcesClose(QHandle As %Binary) As %Status

SQLDataSourcesSortedExecute​

ClassMethod SQLDataSourcesSortedExecute(ByRef QHandle As %Binary, direction As %Integer) As %Status

return list of ODBC datasources, lexicographically sorted

direction could be one of the following: <br\>SQL_FETCH_NEXT 1 <br\>SQL_FETCH_FIRST 2 <br\>SQL_FETCH_FIRST_USER 31 <br\>SQL_FETCH_FIRST_SYSTEM 32

SQLDataSourcesSortedFetch​

ClassMethod SQLDataSourcesSortedFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLDataSourcesSortedClose​

ClassMethod SQLDataSourcesSortedClose(QHandle As %Binary) As %Status

SQLTablesJExecute​

ClassMethod SQLTablesJExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String = "", ttype As %String = "", schema As %String = "", catalog As %String = "") As %Status

Get a List of all tables for a JDBC based SQL Gateway connection

dsn<var\> is the SQLGateway connection name, tname<var\> is the string search pattern for table names, schema is the string search pattern for schema names, ttype<var\> - list of table types to match

SQLTablesJFetch​

ClassMethod SQLTablesJFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLTablesJClose​

ClassMethod SQLTablesJClose(QHandle As %Binary) As %Status

SQLFieldsJExecute​

ClassMethod SQLFieldsJExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, schema As %String, catalog As %String = "") As %Status

Get a List of all fields in a table for a JDBC based SQL Gateway connection

dsn<var\> is the SQLGateway connection name, tname<var\> is the string search pattern for table names, schema is the string search pattern for schema names

SQLFieldsJFetch​

ClassMethod SQLFieldsJFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status [ ProcedureBlock = 1 ]

SQLFieldsJClose​

ClassMethod SQLFieldsJClose(QHandle As %Binary) As %Status

SQLPrimaryKeysJExecute​

ClassMethod SQLPrimaryKeysJExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, catalog As %String = "") As %Status

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

SQLPrimaryKeysJFetch​

ClassMethod SQLPrimaryKeysJFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLPrimaryKeysJClose​

ClassMethod SQLPrimaryKeysJClose(QHandle As %Binary) As %Status

SQLProcedureColumnsJExecute​

ClassMethod SQLProcedureColumnsJExecute(ByRef QHandle As %Binary, dsn As %String, schname As %String, procname As %String, catalog As %String = "") As %Status

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

SQLProcedureColumnsJFetch​

ClassMethod SQLProcedureColumnsJFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLProcedureColumnsJClose​

ClassMethod SQLProcedureColumnsJClose(QHandle As %Binary) As %Status

SQLProceduresJExecute​

ClassMethod SQLProceduresJExecute(ByRef QHandle As %Binary, dsn As %String, pname As %String, schname As %String, catalog As %String = "") As %Status

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

SQLProceduresJFetch​

ClassMethod SQLProceduresJFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

SQLProceduresJClose​

ClassMethod SQLProceduresJClose(QHandle As %Binary) As %Status

getIndexInfoExecute​

ClassMethod getIndexInfoExecute(ByRef QHandle As %Binary, dsn As %String, tname As %String, schema As %String, nonunique As %Boolean, approximate As %Boolean = "", catalog As %String = "") As %Status

Get a List of all indices in a table for a JDBC based SQL Gateway connection

dsn<var\> is the SQLGateway connection name, tname<var\> is the string search pattern for table names, schema is the string search pattern for schema names

getIndexInfoFetch​

ClassMethod getIndexInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, AtEnd As %Integer) As %Status

getIndexInfoClose​

ClassMethod getIndexInfoClose(QHandle As %Binary) As %Status