%XDBC.Gateway.DatabaseMetaData

Class %XDBC.Gateway.DatabaseMetaData Extends %RegisteredObject [ Abstract, System = 4 ]

FOR INTERNAL USE - do not invoke directly

Methods

GetCatalogs

Method GetCatalogs() As ResultSet

Retrieves the catalog names available in this database.

GetColumnPrivileges

Method GetColumnPrivileges(catalog As %String, schema As %String, table As %String, columnNamePattern As %String) As ResultSet

Retrieves a description of the access rights for a table's columns.

GetColumns

Method GetColumns(catalog As %String, schemaPattern As %String, tableNamePattern As %String, columnNamePattern As %String) As ResultSet

Retrieves a description of table columns available in the specified catalog

GetCrossReference

Method GetCrossReference(parentCatalog As %String, parentSchema As %String, parentTable As %String, foreignCatalog As %String, foreignSchema As %String, foreignTable As %String) As ResultSet

Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table)

GetDatabaseProductNameAndVersion

Method GetDatabaseProductNameAndVersion() As %String

Retrieves the name and version number of this database

GetDriverName

Method GetDriverName() As %String

Retrieves the name of this JDBC driver.

GetDriverVersion

Method GetDriverVersion() As %String

Retrieves the version number of this driver as a String

GetExportedKeys

Method GetExportedKeys(catalog As %String, schema As %String, table As %String) As ResultSet

Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).

GetFunctionColumns

Method GetFunctionColumns(catalog As %String, schemaPattern As %String, functionNamePattern As %String, columnNamePattern As %String) As ResultSet

Retrieves a description of the given catalog's system or user function parameters and return type.

GetFunctions

Method GetFunctions(catalog As %String, schemaPattern As %String, functionNamePattern As %String) As ResultSet

Retrieves a description of the system and user functions available in the given catalog.

GetImportedKeys

Method GetImportedKeys(catalog As %String, schema As %String, table As %String) As ResultSet

Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table).

GetIndexInfo

Method GetIndexInfo(catalog As %String, schema As %String, table As %String, unique As %Boolean, approximate As %Boolean) As ResultSet

Retrieves a description of the given table's indices and statistics

GetNumericFunctions

Method GetNumericFunctions() As %String

Retrieves a comma-separated list of math functions available with this database.

GetPrimaryKeys

Method GetPrimaryKeys(catalog As %String, schema As %String, table As %String) As ResultSet

Retrieves a description of the given table's primary key columns.

GetProcedureColumns

Method GetProcedureColumns(catalog As %String, schemaPattern As %String, procedureNamePattern As %String, columnNamePattern As %String) As ResultSet

Retrieves a description of the given catalog's stored procedure parameter and result columns.

GetProcedures

Method GetProcedures(catalog As %String, schemaPattern As %String, procedureNamePattern As %String) As ResultSet

Retrieves a description of the stored procedures available in the given catalog.

GetPseudoColumns

Method GetPseudoColumns(catalog As %String, schemaPattern As %String, tableNamePattern As %String, columnNamePattern As %String) As ResultSet

Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema.

GetSchemas

Method GetSchemas(catalog As %String = "", schemaPattern As %String = "") As ResultSet

Retrieves the schema names available in this database

GetSchemaTerm

Method GetSchemaTerm() As %String

Retrieves the preferred term for 'schema' in this database

GetSQLKeywords

Method GetSQLKeywords() As %String

Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.

GetStringFunctions

Method GetStringFunctions() As %String

Retrieves a comma-separated list of string functions available with this database.

GetSuperTables

Method GetSuperTables(catalog As %String, schemaPattern As %String, tableNamePattern As %String) As ResultSet

Retrieves a description of the table hierarchies defined in a particular schema in this database.

GetSuperTypes

Method GetSuperTypes(catalog As %String, schemaPattern As %String, typeNamePattern As %String) As ResultSet

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.

GetSystemFunctions

Method GetSystemFunctions() As %String

Retrieves a comma-separated list of system functions available with this database.

GetTablePrivileges

Method GetTablePrivileges(catalog As %String, schemaPattern As %String, tableNamePattern As %String) As ResultSet

Retrieves a description of the access rights for each table available in a catalog.

GetTables

Method GetTables(catalog As %String, schemaPattern As %String, tableNamePattern As %String, types As %List) As ResultSet

Retrieves a description of the tables available in the given catalog.

GetTableTypes

Method GetTableTypes() As ResultSet

Retrieves the table types available in this database. The results are ordered by table type.

GetTimeDateFunctions

Method GetTimeDateFunctions() As %String

Retrieves a comma-separated list of the time and date functions available with this database.

GetTypeInfo

Method GetTypeInfo() As ResultSet

Retrieves a description of all the data types supported by this database.