Skip to main content

%XDBC.Gateway.ODBC.DatabaseMetaData

class %XDBC.Gateway.ODBC.DatabaseMetaData extends %XDBC.Gateway.DatabaseMetaData

Property Inventory

Method Inventory

Properties

property connection as %XDBC.Gateway.ODBC.Connection;
Property methods: connectionGet(), connectionGetSwizzled(), connectionIsValid(), connectionNewObject(), connectionSet()

Methods

method %OnNew(conn As %XDBC.Gateway.ODBC.Connection) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method GetCatalogs() as ResultSet
Retrieves the catalog names available in this database.
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.
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
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)
method GetDatabaseProductNameAndVersion() as %String
Retrieves the name and version number of this database
method GetDriverName() as %String
Inherited description: Retrieves the name of this JDBC driver.
method GetDriverVersion() as %String
Retrieves the version number of this driver as a String
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).
method GetFunctionColumns(catalog As %String, schemaPattern As %String, functionNamePattern As %String, columnNamePattern As %String) as ResultSet
Method Not Supported
method GetFunctions(catalog As %String, schemaPattern As %String, functionNamePattern As %String) as ResultSet
Method Not Supported
method GetImportedKeys(catalog As %String, schema As %String, table As %String) as ResultSet
Retrieves the string used to quote SQL identifiers.
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
method GetNumericFunctions() as %String
Retrieves a comma-separated list of math functions available with this database.
method GetPrimaryKeys(catalog As %String, schema As %String, table As %String) as ResultSet
Retrieves a description of the given table's primary key columns.
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.
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.
method GetPseudoColumns(catalog As %String, schemaPattern As %String, tableNamePattern As %String, columnNamePattern As %String) as ResultSet
Method Not Supported
method GetSQLKeywords() as %String
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.
method GetSchemaTerm() as %String
Method Not Supported
method GetSchemas(catalog As %String = "", schemaPattern As %String = "") as ResultSet
Method Not Supported
method GetStringFunctions() as %String
Retrieves a comma-separated list of string functions available with this database.
method GetSuperTables(catalog As %String, schemaPattern As %String, tableNamePattern As %String) as ResultSet
Method Not Supported
method GetSuperTypes(catalog As %String, schemaPattern As %String, typeNamePattern As %String) as ResultSet
Method Not Supported
method GetSystemFunctions() as %String
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
method GetTablePrivileges(catalog As %String, schemaPattern As %String, tableNamePattern As %String) as ResultSet
Retrieves tables priviligies.
method GetTableTypes() as ResultSet
Retrieves a description of the tables available in the given catalog.
method GetTables(catalog As %String, schemaPattern As %String, tableNamePattern As %String, types As %List) as ResultSet
Retrieves a description of the access rights for each table available in a catalog.
method GetTimeDateFunctions() as %String
Retrieves the table types available in this database. Retrieves a comma-separated list of the time and date functions available with this database.
method GetTypeInfo() as ResultSet
Retrieves a description of all the data types supported by this database.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab