Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Library] >  [JDBCCatalog]
Private  Storage   

JDBC Catalog Queries

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
74 25


Summary

Methods
ATClose ATExecute ATFetch BRClose BRExecute
BRFetch CAClose CAExecute CAFetch CFClose
CFExecute CFFetch CHClose CHExecute CHFetch
COClose COExecute COFetch CPClose CPExecute
CPFetch CRClose CRExecute CRFetch EKClose
EKExecute EKFetch FCClose FCExecute FCFetch
FNClose FNExecute FNFetch IIClose IIExecute
IIFetch IKClose IKExecute IKFetch MakePat
PCClose PCExecute PCFetch PKClose PKExecute
PKFetch PRClose PRExecute PRFetch SCClose
SCExecute SCFetch SLClose SLExecute SLFetch
SYClose SYExecute SYFetch TAClose TAExecute
TAFetch TIClose TIExecute TIFetch TPClose
TPExecute TPFetch TTExecute TTFetch UTExecute
UTFetch VCClose VCExecute VCFetch


Methods

• classmethod ATClose(ByRef qh As %Binary) as %Status
• classmethod ATExecute(ByRef qh As %Binary, catalog As %String, schemaPattern As %String, typeNamePattern As %String, attributeNamePattern As %String) as %Status
• classmethod ATFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod BRClose(qh As %Binary) as %Status
• classmethod BRExecute(ByRef qh As %Binary, table As %String = " ", schema As %String) as %Status
• classmethod BRFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod CAClose(ByRef qh As %Binary) as %Status
• classmethod CAExecute(ByRef qh As %Binary) as %Status
• classmethod CAFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod CFClose(qh As %Binary) as %Status
• classmethod CFExecute(ByRef qh As %Binary) as %Status
• classmethod CFFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod CHClose(qh As %Binary) as %Status
• classmethod CHExecute(ByRef qh As %Binary, table As %String, column As %String, schema As %String) as %Status
• classmethod CHFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod COClose(qh As %Binary) as %Status
• classmethod COExecute(ByRef qh As %Binary, table As %String, column As %String, schema As %String) as %Status
• classmethod COFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod CPClose(qh As %Binary) as %Status
• classmethod CPExecute(ByRef qh As %Binary, table As %String, column As %String, schema As %String) as %Status
• classmethod CPFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod CRClose(qh As %Binary) as %Status
• classmethod CRExecute(ByRef qh As %Binary, primary As %String, foreign As %String, pkschema As %String, fkschema As %String) as %Status
• classmethod CRFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod EKClose(qh As %Binary) as %Status
• classmethod EKExecute(ByRef qh As %Binary, table As %String, schema As %String) as %Status
• classmethod EKFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod FCClose(qh As %Binary) as %Status
• classmethod FCExecute(ByRef qh As %Binary, procedure As %String, column As %String, schema As %String) as %Status
• classmethod FCFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod FNClose(qh As %Binary) as %Status
• classmethod FNExecute(ByRef qh As %Binary, name As %String, schema As %String) as %Status
• classmethod FNFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod IIClose(qh As %Binary) as %Status
• classmethod IIExecute(ByRef qh As %Binary, table As %String, schema As %String, nonunique As %SmallInt) as %Status
• classmethod IIFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod IKClose(qh As %Binary) as %Status
• classmethod IKExecute(ByRef qh As %Binary, table As %String, schema As %String) as %Status
• classmethod IKFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod MakePat(like As %String, esc As %String) as %String
• classmethod PCClose(qh As %Binary) as %Status
• classmethod PCExecute(ByRef qh As %Binary, procedure As %String, column As %String, schema As %String) as %Status
• classmethod PCFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod PKClose(qh As %Binary) as %Status
• classmethod PKExecute(ByRef qh As %Binary, table As %String, schema As %String) as %Status
• classmethod PKFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod PRClose(qh As %Binary) as %Status
• classmethod PRExecute(ByRef qh As %Binary, name As %String, schema As %String) as %Status
• classmethod PRFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod SCClose(qh As %Binary) as %Status
• classmethod SCExecute(ByRef qh As %Binary, schemaPattern As %String = "") as %Status
• classmethod SCFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod SLClose(ByRef qh As %Binary) as %Status
• classmethod SLExecute(ByRef qh As %Binary, catalog As %String, schemaPattern As %String, typeNamePattern As %String) as %Status
• classmethod SLFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod SYClose(ByRef qh As %Binary) as %Status
• classmethod SYExecute(ByRef qh As %Binary, catalog As %String, schemaPattern As %String, typeNamePattern As %String) as %Status
• classmethod SYFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod TAClose(qh As %Binary) as %Status
• classmethod TAExecute(ByRef qh As %Binary, name As %String, ttype As %String, schema As %String) as %Status
• classmethod TAFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod TIClose(qh As %Binary) as %Status
• classmethod TIExecute(ByRef qh As %Binary) as %Status
• classmethod TIFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod TPClose(qh As %Binary) as %Status
• classmethod TPExecute(ByRef qh As %Binary, name As %String, schema As %String) as %Status
• classmethod TPFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod TTExecute(ByRef qh As %Binary) as %Status
• classmethod TTFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod UTExecute(ByRef qh As %Binary) as %Status
• classmethod UTFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status
• classmethod VCClose(qh As %Binary) as %Status
• classmethod VCExecute(ByRef qh As %Binary, table As %String, schema As %String) as %Status
• classmethod VCFetch(ByRef qh As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status

Queries

• query AT(catalog As %String(MAXLEN=128), schemaPattern As %String(MAXLEN=128), typeNamePattern As %String(MAXLEN=128), attributeNamePattern As %String(MAXLEN=128))
Selects TYPE_CAT As %String(MAXLEN=128), TYPE_SCHEM As %String(MAXLEN=128), TYPE_NAME As %String(MAXLEN=128), ATTR_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, ATTR_TYPE_NAME As %String(MAXLEN=128), ATTR_SIZE As %Integer, DECIMAL_DIGITS As %Integer, NUM_PREC_RADIX As %Integer, NULLABLE As %Integer, REMARKS As %String(MAXLEN=128), ATTR_DEF As %String(MAXLEN=128), SQL_DATA_TYPE As %Integer, SQL_DATETIME_SUB As %Integer, CHAR_OCTET_LENGTH As %Integer, ORDINAL_POSITION As %Integer, IS_NULLABLE As %String(MAXLEN=128), SCOPE_CATALOG As %String(MAXLEN=128), SCOPE_SCHEMA As %String(MAXLEN=128), SCOPE_TABLE As %String(MAXLEN=128), SOURCE_DATA_TYPE As %SmallInt
Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog *************************************************************************** %JDBCCatalog_AT Stored Procedure for (JDBC 3.x) getAttributes() (AND246) ***************************************************************************
• query BR(table As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects SCOPE As %SmallInt, COLUMN_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, TYPE_NAME As %String(MAXLEN=128), COLUMN_SIZE As %Integer, BUFFER_LENGTH As %Integer, DECIMAL_DIGITS As %SmallInt, PSEUDO_COLUMN As %SmallInt
Get a description of a table's optimal set of columns that uniquely identifies a row. *************************************************************************** %JDBCCatalog_BR Stored Procedure for getBestRowIdentifier() ***************************************************************************
• query CA()
Selects TABLE_CAT As %String(MAXLEN=128)
Gets the catalog names available in the database. *************************************************************************** %JDBCCatalog_CA Stored Procedure for getCatalogs() ***************************************************************************
• query CF()
Selects NAME As %String(MAXLEN=128), MAXLEN As %Integer, DEFAULT_VALUE As %String(MAXLEN=128), DESCRIPTION As %String(MAXLEN=128)
Retrieves a list of the client info properties that the driver supports. *************************************************************************** %JDBCCatalog_CF Stored Procedure for getClientInfoProperties() The result set contains the following columns 1. NAME String=> The name of the client info property 2. MAX_LEN int=> The maximum length of the value for the property 3. DEFAULT_VALUE String=> The default value of the property 4. DESCRIPTION String=> A description of the property. This will typically contain information as to where this property is stored in the database. The ResultSet is sorted by the NAME column ***************************************************************************
• query CH(table As %String(MAXLEN=128), column As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), COLUMN_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, COLUMN_SIZE As %Integer, DECIMAL_DIGITS As %Integer, NUM_PREC_RADIX As %Integer, COLUMN_USAGE As %String, REMARKS As %String(MAXLEN=254), CHAR_OCTET_LENGTH As %Integer, IS_NULLABLE As %String(MAXLEN=3)
Get hidden columns info from the catalog, sorted by table name and column name position *************************************************************************** %JDBCCatalog_CH Stored Procedure for getPseudoColumns() Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema. Pseudo or hidden columns may not always be stored within a table and are not visible in a ResultSet unless they are specified in the query's outermost SELECT list. Pseudo or hidden columns may not necessarily be able to be modified. If there are no pseudo or hidden columns, an empty ResultSet is returned. Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,TABLE_SCHEM, TABLE_NAME and COLUMN_NAME. Each column description has the following columns: ***************************************************************************
• query CO(table As %String(MAXLEN=128), column As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), COLUMN_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, TYPE_NAME As %String(MAXLEN=128), COLUMN_SIZE As %Integer, BUFFER_LENGTH As %Integer, DECIMAL_DIGITS As %Integer, NUM_PREC_RADIX As %Integer, NULLABLE As %Integer, REMARKS As %String(MAXLEN=254), COLUMN_DEF As %String(MAXLEN=4096), SQL_DATA_TYPE As %Integer, SQL_DATETIME_SUB As %Integer, CHAR_OCTET_LENGTH As %Integer, ORDINAL_POSITION As %Integer, IS_NULLABLE As %String(MAXLEN=3), SCOPE_CATALOG As %String(MAXLEN=128), SCOPE_SCHEMA As %String(MAXLEN=128), SCOPE_TABLE As %String(MAXLEN=128), SOURCE_DATA_TYPE As %SmallInt, IS_AUTOINCREMENT As %Library.String(MAXLEN=3), IS_GENERATEDCOLUMN As %Library.String(MAXLEN=3)
Get columns info from the catalog, sorted by table name and ordinal position *************************************************************************** %JDBCCatalog_CO Stored Procedure for getColumns() ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Retrieves a description of table columns available in the specified catalog. Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION. Each column description has the following columns: 1 - TABLE_CAT String => table catalog (may be null) 2 - TABLE_SCHEM String => table schema (may be null) 3 - TABLE_NAME String => table name 4 - COLUMN_NAME String => column name 5 - DATA_TYPE int => SQL type from java.sql.Types 6 - TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified 7 - COLUMN_SIZE int => column size. 8 - BUFFER_LENGTH is not used. 9 - DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. 10 - NUM_PREC_RADIX int => Radix (typically either 10 or 2) 11 - NULLABLE int => is NULL allowed. columnNoNulls - might not allow NULL values columnNullable - definitely allows NULL values columnNullableUnknown - nullability unknown 12 - REMARKS String => comment describing column (may be null) 13 - COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) 14 - SQL_DATA_TYPE int => unused 15 - SQL_DATETIME_SUB int => unused 16 - CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column 17 - ORDINAL_POSITION int => index of column in table (starting at 1) 18 - IS_NULLABLE String => ISO rules are used to determine the nullability for a column. YES --- if the column can include NULLs NO --- if the column cannot include NULLs empty string --- if the nullability for the column is unknown 19 - SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) 20 - SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF) 21 - SCOPE_TABLE String => table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF) 22 - SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF) 23 - IS_AUTOINCREMENT String => Indicates whether this column is auto incremented YES --- if the column is auto incremented NO --- if the column is not auto incremented empty string --- if it cannot be determined whether the column is auto incremented 24 - IS_GENERATEDCOLUMN String => Indicates whether this is a generated column YES --- if this a generated column NO --- if this not a generated column empty string --- if it cannot be determined whether this is a generated column The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable. Parameters: catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search tableNamePattern - a table name pattern; must match the table name as it is stored in the database columnNamePattern - a column name pattern; must match the column name as it is stored in the database ***************************************************************************
• query CP(table As %String(MAXLEN=128), column As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), COLUMN_NAME As %String(MAXLEN=128), GRANTOR As %String(MAXLEN=128), GRANTEE As %String(MAXLEN=128), PRIVILEGE As %String(MAXLEN=128), IS_GRANTABLE As %String(MAXLEN=3)
Gets column privileges, sorted by column name and privilege *************************************************************************** %JDBCCatalog_CP Stored Procedure for getColumnPrivileges() ***************************************************************************
• query CR(primary As %String(MAXLEN=128), foreign As %String(MAXLEN=128), pkschema As %String(MAXLEN=128), fkschema As %String(MAXLEN=128))
Selects PKTABLE_CAT As %String(MAXLEN=128), PKTABLE_SCHEM As %String(MAXLEN=128), PKTABLE_NAME As %String(MAXLEN=128), PKCOLUMN_NAME As %String(MAXLEN=128), FKTABLE_CAT As %String(MAXLEN=128), FKTABLE_SCHEM As %String(MAXLEN=128), FKTABLE_NAME As %String(MAXLEN=128), FKCOLUMN_NAME As %String(MAXLEN=128), KEY_SEQ As %SmallInt, UPDATE_RULE As %SmallInt, DELETE_RULE As %SmallInt, FK_NAME As %String(MAXLEN=128), PK_NAME As %String(MAXLEN=128), DEFERRABILITY As %SmallInt
Describes how one table imports the keys of another table. *************************************************************************** %JDBCCatalog_CR Stored Procedure for getCrossReference() ***************************************************************************
• query EK(table As %String(MAXLEN=128), schema As %String(MAXLEN=128))
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 %SmallInt, UPDATE_RULE As %SmallInt, DELETE_RULE As %SmallInt, FK_NAME As %String, PK_NAME As %String, DEFERRABILITY As %SmallInt
Gets a description of the foreign key columns that reference the primary key columns in table TABLE. *************************************************************************** %JDBCCatalog_EK Stored Procedure for getExportedKeys() ***************************************************************************
• query FC(procedure As %String(MAXLEN=128), column As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects FUNCTION_CAT As %String(MAXLEN=128), FUNCTION_SCHEM As %String(MAXLEN=128), FUNCTION_NAME As %String(MAXLEN=128), COLUMN_NAME As %String(MAXLEN=128), COLUMN_TYPE As %SmallInt, DATA_TYPE As %SmallInt, TYPE_NAME As %String(MAXLEN=128), PRECISION As %Integer, LENGTH As %Integer, SCALE As %SmallInt, RADIX As %Integer, NULLABLE As %SmallInt, REMARKS As %String(MAXLEN=254), CHAR_OCTET_LENGTH As %Integer, ORDINAL_POSITION As %Integer, IS_NULLABLE As %Library.String(MAXLEN=4), SPECIFIC_NAME As %Library.String(MAXLEN=128)
Retrieves a description of the given catalog's system or user function parameters and return type. Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order. *************************************************************************** %JDBCCatalog_FC Stored Procedure for getFunctionColumns() (DPV2968) ***************************************************************************
• query FN(name As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects FUNCTION_CAT As %String(MAXLEN=128), FUNCTION_SCHEM As %String(MAXLEN=128), FUNCTION_NAME As %String(MAXLEN=128), REMARKS As %String(MAXLEN=254), FUNCTION_TYPE As %SmallInt, SPECIFIC_NAME As %String(MAXLEN=128)
Retrieves a description of the system and user functions available in the given catalog Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME. *************************************************************************** %JDBCCatalog_FN Stored Procedure for getFunctions() (DPV2968) Each function description has the the following columns: 1. FUNCTION_CAT String => function catalog (may be null) 2. FUNCTION_SCHEM String => function schema (may be null) 3. FUNCTION_NAME String => function name. This is the name used to invoke the function 4. REMARKS String => explanatory comment on the function 5. FUNCTION_TYPE short => kind of function: * functionResultUnknown - Cannot determine if a return value or table will be returned * functionNoTable- Does not return a table * functionReturnsTable - Returns a table 6. SPECIFIC_NAME String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions ***************************************************************************
• query II(table As %String(MAXLEN=128), schema As %String(MAXLEN=128), nonunique As %SmallInt(MAXLEN=128))
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 description of table's indices and statistics *************************************************************************** %JDBCCatalog_II Stored Procedure for getIndexInfo() ***************************************************************************
• query IK(table As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects PKTABLE_CAT As %String(MAXLEN=128), PKTABLE_SCHEM As %String(MAXLEN=128), PKTABLE_NAME As %String(MAXLEN=128), PKCOLUMN_NAME As %String(MAXLEN=128), FKTABLE_CAT As %String(MAXLEN=128), FKTABLE_SCHEM As %String(MAXLEN=128), FKTABLE_NAME As %String(MAXLEN=128), FKCOLUMN_NAME As %String(MAXLEN=128), KEY_SEQ As %SmallInt, UPDATE_RULE As %SmallInt, DELETE_RULE As %SmallInt, FK_NAME As %String(MAXLEN=128), PK_NAME As %String(MAXLEN=128), DEFERRABILITY As %SmallInt
Gets a description of the primary key columns that are referenced by the foreign key columns in table TABLE. *************************************************************************** %JDBCCatalog_IK Stored Procedure for getImportedKeys() ***************************************************************************
• query PC(procedure As %String(MAXLEN=128), column As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects PROCEDURE_CAT As %String(MAXLEN=128), PROCEDURE_SCHEM As %String(MAXLEN=128), PROCEDURE_NAME As %String(MAXLEN=128), COLUMN_NAME As %String(MAXLEN=128), COLUMN_TYPE As %SmallInt, DATA_TYPE As %SmallInt, TYPE_NAME As %String(MAXLEN=128), PRECISION As %Integer, LENGTH As %Integer, SCALE As %SmallInt, RADIX As %Integer, NULLABLE As %SmallInt, REMARKS As %String(MAXLEN=254), COLUMN_DEF As %String(MAXLEN=254), SQL_DATA_TYPE As %Integer, SQL_DATETIME_SUB As %Integer, CHAR_OCTET_LENGTH As %Integer, ORDINAL_POSITION As %Integer, IS_NULLABLE As %Library.String(MAXLEN=4), SPECIFIC_NAME As %Library.String(MAXLEN=128)
Gets a description of the input, output and results associated with certain stored procedures available in the catalog. *************************************************************************** %JDBCCatalog_PC Stored Procedure for getProcedureColumns() ***************************************************************************
• query PK(table As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), COLUMN_NAME As %String(MAXLEN=128), KEY_SEQ As %SmallInt, PK_NAME As %String(MAXLEN=128)
Gets a description of a table's primary key columns. *************************************************************************** %JDBCCatalog_PK Stored Procedure for getPrimaryKeys() ***************************************************************************
• query PR(name As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects PROCEDURE_CAT As %String(MAXLEN=128), PROCEDURE_SCHEM As %String(MAXLEN=128), PROCEDURE_NAME As %String(MAXLEN=128), R1 As %String(MAXLEN=1), R2 As %String(MAXLEN=1), R3 As %String(MAXLEN=1), REMARKS As %String(MAXLEN=254), PROCEDURE_TYPE As %SmallInt, SPECIFIC_NAME As %String(MAXLEN=128)
Gets a description of the stored procedures available in the catalog. *************************************************************************** %JDBCCatalog_PR Stored Procedure for getProcedures() ***************************************************************************
• query SC(schemaPattern As %String(MAXLEN=128))
Selects TABLE_SCHEM As %String(MAXLEN=128), TABLE_CATALOG As %String(MAXLEN=128)
Gets the schema names available in the database. *************************************************************************** %JDBCCatalog_SC Stored Procedure for getSchemas() ***************************************************************************
• query SL(catalog As %String(MAXLEN=128), schemaPattern As %String(MAXLEN=128), typeNamePattern As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), SUPERTABLE_NAME As %String(MAXLEN=128)
Retrieves a description of the table hierarchies defined in a particular schema in this database *************************************************************************** %JDBCCatalog_SL Stored Procedure for (JDBC 3.x) getSuperTables() (AND246) ***************************************************************************
• query SY(catalog As %String(MAXLEN=128), schemaPattern As %String(MAXLEN=128), typeNamePattern As %String(MAXLEN=128))
Selects TYPE_CAT As %String(MAXLEN=128), TYPE_SCHEM As %String(MAXLEN=128), TYPE_NAME As %String(MAXLEN=128), SUPERTYPE_CAT As %String(MAXLEN=128), SUPERTYPE_SCHEM As %String(MAXLEN=128), SUPERTYPE_NAME As %String(MAXLEN=128)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/sub type relationship is modeled *************************************************************************** %JDBCCatalog_SY Stored Procedure for (JDBC 3.x) getSuperTypes() (AND246) ***************************************************************************
• query TA(name As %String(MAXLEN=128), ttype As %String, schema As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), TABLE_TYPE As %String(MAXLEN=128), REMARKS As %String(MAXLEN=254), TYPE_CAT As %String(MAXLEN=128), TYPE_SCHEM As %String(MAXLEN=128), TYPE_NAME As %String(MAXLEN=128), SELF_REFERENCING_COL_NAME As %String(MAXLEN=128), REF_GENERATION As %String(MAXLEN=7)
Gets a description of the tables available in the catalog. *************************************************************************** %JDBCCatalog_TA Stored Procedure for getTables() ***************************************************************************
• query TI()
Selects TYPE_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, PRECISION As %Integer, LITERAL_PREFIX As %String(MAXLEN=128), LITERAL_SUFFIX As %String(MAXLEN=128), CREATE_PARAMS As %String(MAXLEN=128), NULLABLE As %Integer, CASE_SENSITIVE As %SmallInt, SEARCHABLE As %SmallInt, UNSIGNED_ATTRIBUTE As %SmallInt, FIXED_PREC_SCALE As %SmallInt, AUTO_INCREMENT As %SmallInt, LOCAL_TYPE_NAME As %String(MAXLEN=128), MINIMUM_SCALE As %SmallInt, MAXIMUM_SCALE As %SmallInt, SQL_DATA_TYPE As %Integer, SQL_DATETIME_SUB As %Integer, NUM_PREC_RADIX As %Integer
Gets a description of all the datatypes supported by the database. *************************************************************************** %JDBCCatalog_TI Stored Procedure for getTypeInfo() ***************************************************************************
• query TP(name As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects TABLE_CAT As %String(MAXLEN=128), TABLE_SCHEM As %String(MAXLEN=128), TABLE_NAME As %String(MAXLEN=128), GRANTOR As %String(MAXLEN=128), GRANTEE As %String(MAXLEN=128), PRIVILEGE As %String(MAXLEN=128), IS_GRANTABLE As %String(MAXLEN=3)
Gets a description of the access rights for each table available in the catalog. *************************************************************************** %JDBCCatalog_TP Stored Procedure for getTablePrivileges() ***************************************************************************
• query TT()
Selects TABLE_TYPE As %String(MAXLEN=128)
Gets the table types available in this database. *************************************************************************** %JDBCCatalog_TT Stored Procedure for TableTypes() ***************************************************************************
• query UT()
Selects TYPE_CAT As %String(MAXLEN=128), TYPE_SCHEM As %String(MAXLEN=128), TYPE_NAME As %String(MAXLEN=128), CLASS_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, REMARKS As %String(MAXLEN=254), BASE_TYPE As %SmallInt
Gets a description of UDTs. *************************************************************************** %JDBCCatalog_UT Stored Procedure for getUDTs() ***************************************************************************
• query VC(table As %String(MAXLEN=128), schema As %String(MAXLEN=128))
Selects SCOPE As %SmallInt, COLUMN_NAME As %String(MAXLEN=128), DATA_TYPE As %SmallInt, TYPE_NAME As %String(MAXLEN=128), COLUMN_SIZE As %Integer, BUFFER_LENGTH As %Integer, DECIMAL_DIGITS As %SmallInt, PSEUDO_COLUMN As %SmallInt
Gets a description of the columns in a table that are automatically updated when any value in a row is updated. *************************************************************************** %JDBCCatalog_VC Stored Procedure for getVersionColumns() ***************************************************************************


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.