DatabaseMetaData
interface DatabaseMetaData : Wrapper
java.sql.DatabaseMetaData |
Comprehensive information about the database as a whole.
This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBCTM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.
A user for this interface is commonly a tool that needs to discover how to deal with the underlying DBMS. This is especially true for applications that are intended to be used with more than one DBMS. For example, a tool might use the method getTypeInfo
to find out what data types can be used in a CREATE TABLE
statement. Or a user might call the method supportsCorrelatedSubqueries
to see if it is possible to use a correlated subquery or supportsBatchUpdates
to see if it is possible to use batch updates.
Some DatabaseMetaData
methods return lists of information in the form of ResultSet
objects. Regular ResultSet
methods, such as getString
and getInt
, can be used to retrieve the data from these ResultSet
objects. If a given form of metadata is not available, an empty ResultSet
will be returned. Additional columns beyond the columns defined to be returned by the ResultSet
object for a given method can be defined by the JDBC driver vendor and must be accessed by their column label.
Some DatabaseMetaData
methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to null
, that argument's criterion will be dropped from the search.
Summary
Constants | |
---|---|
static Short |
Indicates that |
static Short |
Indicates that |
static Short |
Indicates that whether |
static Int |
Indicates that the best row identifier is NOT a pseudo column. |
static Int |
Indicates that the best row identifier is a pseudo column. |
static Int |
Indicates that the scope of the best row identifier is the remainder of the current session. |
static Int |
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used. |
static Int |
Indicates that the scope of the best row identifier is the remainder of the current transaction. |
static Int |
Indicates that the best row identifier may or may not be a pseudo column. |
static Int |
Indicates that the column might not allow |
static Int |
Indicates that the column definitely allows |
static Int |
Indicates that the nullability of columns is unknown. |
static Int |
Indicates that the parameter or column is an IN parameter. |
static Int |
Indicates that the parameter or column is an INOUT parameter. |
static Int |
Indicates that the parameter or column is an OUT parameter. |
static Int |
Indicates that the parameter or column is a column in a result set. |
static Int |
Indicates that type of the parameter or column is unknown. |
static Int |
Indicates that |
static Int |
Indicates that the function does not return a table. |
static Int |
Indicates that |
static Int |
Indicates that whether |
static Int |
Indicates that it is not known whether the function returns a result or a table. |
static Int |
Indicates that the parameter or column is a return value. |
static Int |
Indicates that the function returns a table. |
static Int |
For the column |
static Int |
Indicates deferrability. |
static Int |
Indicates deferrability. |
static Int |
For the columns |
static Int |
Indicates deferrability. |
static Int |
For the column |
static Int |
For the columns |
static Int |
For the columns |
static Int |
Indicates that the column stores IN parameters. |
static Int |
Indicates that the column stores INOUT parameters. |
static Int |
Indicates that the column stores OUT parameters. |
static Int |
Indicates that the column stores results. |
static Int |
Indicates that the column stores return values. |
static Int |
Indicates that type of the column is unknown. |
static Int |
Indicates that |
static Int |
Indicates that the procedure does not return a result. |
static Int |
Indicates that |
static Int |
Indicates that whether |
static Int |
Indicates that it is not known whether the procedure returns a result. |
static Int |
Indicates that the procedure returns a result. |
static Int |
A possible return value for the method |
static Int |
A possible return value for the method |
static Int |
A possible return value for the method |
static Short |
Indicates that this table index is a clustered index. |
static Short |
Indicates that this table index is a hashed index. |
static Short |
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these. |
static Short |
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions. |
static Int |
Indicates that a |
static Int |
Indicates that a |
static Int |
Indicates that it is not known whether a |
static Int |
Indicates that the data type can be only be used in |
static Int |
Indicates that the data type can be only be used in |
static Int |
Indicates that |
static Int |
Indicates that all |
static Int |
Indicates that this version column is NOT a pseudo column. |
static Int |
Indicates that this version column is a pseudo column. |
static Int |
Indicates that this version column may or may not be a pseudo column. |
Public methods | |
---|---|
abstract Boolean |
Retrieves whether the current user can call all the procedures returned by the method |
abstract Boolean |
Retrieves whether the current user can use all the tables returned by the method |
abstract Boolean |
Retrieves whether a |
abstract Boolean |
Retrieves whether a data definition statement within a transaction forces the transaction to commit. |
abstract Boolean |
Retrieves whether this database ignores a data definition statement within a transaction. |
abstract Boolean |
deletesAreDetected(type: Int) Retrieves whether or not a visible row delete can be detected by calling the method |
abstract Boolean |
Retrieves whether the return value for the method |
abstract ResultSet! |
getAttributes(catalog: String!, schemaPattern: String!, typeNamePattern: String!, attributeNamePattern: String!) 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. |
abstract ResultSet! |
getBestRowIdentifier(catalog: String!, schema: String!, table: String!, scope: Int, nullable: Boolean) Retrieves a description of a table's optimal set of columns that uniquely identifies a row. |
abstract String! |
Retrieves the |
abstract String! |
Retrieves the database vendor's preferred term for "catalog". |
abstract ResultSet! |
Retrieves the catalog names available in this database. |
abstract ResultSet! |
Retrieves a list of the client info properties that the driver supports. |
abstract ResultSet! |
getColumnPrivileges(catalog: String!, schema: String!, table: String!, columnNamePattern: String!) Retrieves a description of the access rights for a table's columns. |
abstract ResultSet! |
getColumns(catalog: String!, schemaPattern: String!, tableNamePattern: String!, columnNamePattern: String!) Retrieves a description of table columns available in the specified catalog. |
abstract Connection! |
Retrieves the connection that produced this metadata object. |
abstract ResultSet! |
getCrossReference(parentCatalog: String!, parentSchema: String!, parentTable: String!, foreignCatalog: String!, foreignSchema: String!, foreignTable: String!) 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). |
abstract Int |
Retrieves the major version number of the underlying database. |
abstract Int |
Retrieves the minor version number of the underlying database. |
abstract String! |
Retrieves the name of this database product. |
abstract String! |
Retrieves the version number of this database product. |
abstract Int |
Retrieves this database's default transaction isolation level. |
abstract Int |
Retrieves this JDBC driver's major version number. |
abstract Int |
Retrieves this JDBC driver's minor version number. |
abstract String! |
Retrieves the name of this JDBC driver. |
abstract String! |
Retrieves the version number of this JDBC driver as a |
abstract ResultSet! |
getExportedKeys(catalog: String!, schema: String!, table: String!) Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). |
abstract String! |
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). |
abstract ResultSet! |
getFunctionColumns(catalog: String!, schemaPattern: String!, functionNamePattern: String!, columnNamePattern: String!) Retrieves a description of the given catalog's system or user function parameters and return type. |
abstract ResultSet! |
getFunctions(catalog: String!, schemaPattern: String!, functionNamePattern: String!) Retrieves a description of the system and user functions available in the given catalog. |
abstract String! |
Retrieves the string used to quote SQL identifiers. |
abstract ResultSet! |
getImportedKeys(catalog: String!, schema: String!, table: String!) 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). |
abstract ResultSet! |
getIndexInfo(catalog: String!, schema: String!, table: String!, unique: Boolean, approximate: Boolean) Retrieves a description of the given table's indices and statistics. |
abstract Int |
Retrieves the major JDBC version number for this driver. |
abstract Int |
Retrieves the minor JDBC version number for this driver. |
abstract Int |
Retrieves the maximum number of hex characters this database allows in an inline binary literal. |
abstract Int |
Retrieves the maximum number of characters that this database allows in a catalog name. |
abstract Int |
Retrieves the maximum number of characters this database allows for a character literal. |
abstract Int |
Retrieves the maximum number of characters this database allows for a column name. |
abstract Int |
Retrieves the maximum number of columns this database allows in a |
abstract Int |
Retrieves the maximum number of columns this database allows in an index. |
abstract Int |
Retrieves the maximum number of columns this database allows in an |
abstract Int |
Retrieves the maximum number of columns this database allows in a |
abstract Int |
Retrieves the maximum number of columns this database allows in a table. |
abstract Int |
Retrieves the maximum number of concurrent connections to this database that are possible. |
abstract Int |
Retrieves the maximum number of characters that this database allows in a cursor name. |
abstract Int |
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index. |
abstract Int |
Retrieves the maximum number of characters that this database allows in a procedure name. |
abstract Int |
Retrieves the maximum number of bytes this database allows in a single row. |
abstract Int |
Retrieves the maximum number of characters that this database allows in a schema name. |
abstract Int |
Retrieves the maximum number of characters this database allows in an SQL statement. |
abstract Int |
Retrieves the maximum number of active statements to this database that can be open at the same time. |
abstract Int |
Retrieves the maximum number of characters this database allows in a table name. |
abstract Int |
Retrieves the maximum number of tables this database allows in a |
abstract Int |
Retrieves the maximum number of characters this database allows in a user name. |
abstract String! |
Retrieves a comma-separated list of math functions available with this database. |
abstract ResultSet! |
getPrimaryKeys(catalog: String!, schema: String!, table: String!) Retrieves a description of the given table's primary key columns. |
abstract ResultSet! |
getProcedureColumns(catalog: String!, schemaPattern: String!, procedureNamePattern: String!, columnNamePattern: String!) Retrieves a description of the given catalog's stored procedure parameter and result columns. |
abstract String! |
Retrieves the database vendor's preferred term for "procedure". |
abstract ResultSet! |
getProcedures(catalog: String!, schemaPattern: String!, procedureNamePattern: String!) Retrieves a description of the stored procedures available in the given catalog. |
abstract Int |
Retrieves this database's default holdability for |
abstract RowIdLifetime! |
Indicates whether or not this data source supports the SQL |
abstract String! |
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords. |
abstract Int |
Indicates whether the SQLSTATE returned by |
abstract String! |
Retrieves the database vendor's preferred term for "schema". |
abstract ResultSet! |
Retrieves the schema names available in this database. |
abstract ResultSet! |
getSchemas(catalog: String!, schemaPattern: String!) Retrieves the schema names available in this database. |
abstract String! |
Retrieves the string that can be used to escape wildcard characters. |
abstract String! |
Retrieves a comma-separated list of string functions available with this database. |
abstract ResultSet! |
getSuperTables(catalog: String!, schemaPattern: String!, tableNamePattern: String!) Retrieves a description of the table hierarchies defined in a particular schema in this database. |
abstract ResultSet! |
getSuperTypes(catalog: String!, schemaPattern: String!, typeNamePattern: String!) Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. |
abstract String! |
Retrieves a comma-separated list of system functions available with this database. |
abstract ResultSet! |
getTablePrivileges(catalog: String!, schemaPattern: String!, tableNamePattern: String!) Retrieves a description of the access rights for each table available in a catalog. |
abstract ResultSet! |
Retrieves the table types available in this database. |
abstract ResultSet! |
getTables(catalog: String!, schemaPattern: String!, tableNamePattern: String!, types: Array<String!>!) Retrieves a description of the tables available in the given catalog. |
abstract String! |
Retrieves a comma-separated list of the time and date functions available with this database. |
abstract ResultSet! |
Retrieves a description of all the data types supported by this database. |
abstract ResultSet! |
Retrieves a description of the user-defined types (UDTs) defined in a particular schema. |
abstract String! |
getURL() Retrieves the URL for this DBMS. |
abstract String! |
Retrieves the user name as known to this database. |
abstract ResultSet! |
getVersionColumns(catalog: String!, schema: String!, table: String!) Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. |
abstract Boolean |
insertsAreDetected(type: Int) Retrieves whether or not a visible row insert can be detected by calling the method |
abstract Boolean |
Retrieves whether a catalog appears at the start of a fully qualified table name. |
abstract Boolean |
Retrieves whether this database is in read-only mode. |
abstract Boolean |
Indicates whether updates made to a LOB are made on a copy or directly to the LOB. |
abstract Boolean |
Retrieves whether this database supports concatenations between |
abstract Boolean |
Retrieves whether |
abstract Boolean |
Retrieves whether |
abstract Boolean |
Retrieves whether |
abstract Boolean |
Retrieves whether |
abstract Boolean |
othersDeletesAreVisible(type: Int) Retrieves whether deletes made by others are visible. |
abstract Boolean |
othersInsertsAreVisible(type: Int) Retrieves whether inserts made by others are visible. |
abstract Boolean |
othersUpdatesAreVisible(type: Int) Retrieves whether updates made by others are visible. |
abstract Boolean |
ownDeletesAreVisible(type: Int) Retrieves whether a result set's own deletes are visible. |
abstract Boolean |
ownInsertsAreVisible(type: Int) Retrieves whether a result set's own inserts are visible. |
abstract Boolean |
ownUpdatesAreVisible(type: Int) Retrieves whether for the given type of |
abstract Boolean |
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case. |
abstract Boolean |
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case. |
abstract Boolean |
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case. |
abstract Boolean |
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case. |
abstract Boolean |
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case. |
abstract Boolean |
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case. |
abstract Boolean |
Retrieves whether this database supports the ANSI92 entry level SQL grammar. |
abstract Boolean |
Retrieves whether this database supports the ANSI92 full SQL grammar supported. |
abstract Boolean |
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported. |
abstract Boolean |
Retrieves whether this database supports |
abstract Boolean |
Retrieves whether this database supports |
abstract Boolean |
Retrieves whether this database supports batch updates. |
abstract Boolean |
Retrieves whether a catalog name can be used in a data manipulation statement. |
abstract Boolean |
Retrieves whether a catalog name can be used in an index definition statement. |
abstract Boolean |
Retrieves whether a catalog name can be used in a privilege definition statement. |
abstract Boolean |
Retrieves whether a catalog name can be used in a procedure call statement. |
abstract Boolean |
Retrieves whether a catalog name can be used in a table definition statement. |
abstract Boolean |
Retrieves whether this database supports column aliasing. |
abstract Boolean |
Retrieves whether this database supports the JDBC scalar function |
abstract Boolean |
supportsConvert(fromType: Int, toType: Int) Retrieves whether this database supports the JDBC scalar function |
abstract Boolean |
Retrieves whether this database supports the ODBC Core SQL grammar. |
abstract Boolean |
Retrieves whether this database supports correlated subqueries. |
abstract Boolean |
Retrieves whether this database supports both data definition and data manipulation statements within a transaction. |
abstract Boolean |
Retrieves whether this database supports only data manipulation statements within a transaction. |
abstract Boolean |
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables. |
abstract Boolean |
Retrieves whether this database supports expressions in |
abstract Boolean |
Retrieves whether this database supports the ODBC Extended SQL grammar. |
abstract Boolean |
Retrieves whether this database supports full nested outer joins. |
abstract Boolean |
Retrieves whether auto-generated keys can be retrieved after a statement has been executed |
abstract Boolean |
Retrieves whether this database supports some form of |
abstract Boolean |
Retrieves whether this database supports using columns not included in the |
abstract Boolean |
Retrieves whether this database supports using a column that is not in the |
abstract Boolean |
Retrieves whether this database supports the SQL Integrity Enhancement Facility. |
abstract Boolean |
Retrieves whether this database supports specifying a |
abstract Boolean |
Retrieves whether this database provides limited support for outer joins. |
abstract Boolean |
Retrieves whether this database supports the ODBC Minimum SQL grammar. |
abstract Boolean |
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case. |
abstract Boolean |
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case. |
abstract Boolean |
Retrieves whether it is possible to have multiple |
abstract Boolean |
Retrieves whether this database supports getting multiple |
abstract Boolean |
Retrieves whether this database allows having multiple transactions open at once (on different connections). |
abstract Boolean |
Retrieves whether this database supports named parameters to callable statements. |
abstract Boolean |
Retrieves whether columns in this database may be defined as non-nullable. |
abstract Boolean |
Retrieves whether this database supports keeping cursors open across commits. |
abstract Boolean |
Retrieves whether this database supports keeping cursors open across rollbacks. |
abstract Boolean |
Retrieves whether this database supports keeping statements open across commits. |
abstract Boolean |
Retrieves whether this database supports keeping statements open across rollbacks. |
abstract Boolean |
Retrieves whether this database supports using a column that is not in the |
abstract Boolean |
Retrieves whether this database supports some form of outer join. |
abstract Boolean |
Retrieves whether this database supports positioned |
abstract Boolean |
Retrieves whether this database supports positioned |
abstract Boolean |
supportsResultSetConcurrency(type: Int, concurrency: Int) Retrieves whether this database supports the given concurrency type in combination with the given result set type. |
abstract Boolean |
supportsResultSetHoldability(holdability: Int) Retrieves whether this database supports the given result set holdability. |
abstract Boolean |
supportsResultSetType(type: Int) Retrieves whether this database supports the given result set type. |
abstract Boolean |
Retrieves whether this database supports savepoints. |
abstract Boolean |
Retrieves whether a schema name can be used in a data manipulation statement. |
abstract Boolean |
Retrieves whether a schema name can be used in an index definition statement. |
abstract Boolean |
Retrieves whether a schema name can be used in a privilege definition statement. |
abstract Boolean |
Retrieves whether a schema name can be used in a procedure call statement. |
abstract Boolean |
Retrieves whether a schema name can be used in a table definition statement. |
abstract Boolean |
Retrieves whether this database supports |
abstract Boolean |
Retrieves whether this database supports statement pooling. |
abstract Boolean |
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax. |
abstract Boolean |
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax. |
abstract Boolean |
Retrieves whether this database supports subqueries in comparison expressions. |
abstract Boolean |
Retrieves whether this database supports subqueries in |
abstract Boolean |
Retrieves whether this database supports subqueries in |
abstract Boolean |
Retrieves whether this database supports subqueries in quantified expressions. |
abstract Boolean |
Retrieves whether this database supports table correlation names. |
abstract Boolean |
supportsTransactionIsolationLevel(level: Int) Retrieves whether this database supports the given transaction isolation level. |
abstract Boolean |
Retrieves whether this database supports transactions. |
abstract Boolean |
Retrieves whether this database supports SQL |
abstract Boolean |
Retrieves whether this database supports SQL |
abstract Boolean |
updatesAreDetected(type: Int) Retrieves whether or not a visible row update can be detected by calling the method |
abstract Boolean |
Retrieves whether this database uses a file for each table. |
abstract Boolean |
Retrieves whether this database stores tables in a local file. |
Inherited functions | |
---|---|
Constants
attributeNoNulls
static val attributeNoNulls: Short
Indicates that NULL
values might not be allowed.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getAttributes
.
Value: 0
attributeNullable
static val attributeNullable: Short
Indicates that NULL
values are definitely allowed.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getAttributes
.
Value: 1
attributeNullableUnknown
static val attributeNullableUnknown: Short
Indicates that whether NULL
values are allowed is not known.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getAttributes
.
Value: 2
bestRowNotPseudo
static val bestRowNotPseudo: Int
Indicates that the best row identifier is NOT a pseudo column.
A possible value for the column PSEUDO_COLUMN
in the ResultSet
object returned by the method getBestRowIdentifier
.
Value: 1
bestRowPseudo
static val bestRowPseudo: Int
Indicates that the best row identifier is a pseudo column.
A possible value for the column PSEUDO_COLUMN
in the ResultSet
object returned by the method getBestRowIdentifier
.
Value: 2
bestRowSession
static val bestRowSession: Int
Indicates that the scope of the best row identifier is the remainder of the current session.
A possible value for the column SCOPE
in the ResultSet
object returned by the method getBestRowIdentifier
.
Value: 2
bestRowTemporary
static val bestRowTemporary: Int
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.
A possible value for the column SCOPE
in the ResultSet
object returned by the method getBestRowIdentifier
.
Value: 0
bestRowTransaction
static val bestRowTransaction: Int
Indicates that the scope of the best row identifier is the remainder of the current transaction.
A possible value for the column SCOPE
in the ResultSet
object returned by the method getBestRowIdentifier
.
Value: 1
bestRowUnknown
static val bestRowUnknown: Int
Indicates that the best row identifier may or may not be a pseudo column.
A possible value for the column PSEUDO_COLUMN
in the ResultSet
object returned by the method getBestRowIdentifier
.
Value: 0
columnNoNulls
static val columnNoNulls: Int
Indicates that the column might not allow NULL
values.
A possible value for the column NULLABLE
in the ResultSet
returned by the method getColumns
.
Value: 0
columnNullable
static val columnNullable: Int
Indicates that the column definitely allows NULL
values.
A possible value for the column NULLABLE
in the ResultSet
returned by the method getColumns
.
Value: 1
columnNullableUnknown
static val columnNullableUnknown: Int
Indicates that the nullability of columns is unknown.
A possible value for the column NULLABLE
in the ResultSet
returned by the method getColumns
.
Value: 2
functionColumnIn
static val functionColumnIn: Int
Indicates that the parameter or column is an IN parameter.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
Value: 1
functionColumnInOut
static val functionColumnInOut: Int
Indicates that the parameter or column is an INOUT parameter.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
Value: 2
functionColumnOut
static val functionColumnOut: Int
Indicates that the parameter or column is an OUT parameter.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
Value: 3
functionColumnResult
static val functionColumnResult: Int
Indicates that the parameter or column is a column in a result set.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
Value: 5
functionColumnUnknown
static val functionColumnUnknown: Int
Indicates that type of the parameter or column is unknown.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
Value: 0
functionNoNulls
static val functionNoNulls: Int
Indicates that NULL
values are not allowed.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getFunctionColumns
.
Value: 0
functionNoTable
static val functionNoTable: Int
Indicates that the function does not return a table.
A possible value for column FUNCTION_TYPE
in the ResultSet
object returned by the method getFunctions
.
Value: 1
functionNullable
static val functionNullable: Int
Indicates that NULL
values are allowed.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getFunctionColumns
.
Value: 1
functionNullableUnknown
static val functionNullableUnknown: Int
Indicates that whether NULL
values are allowed is unknown.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getFunctionColumns
.
Value: 2
functionResultUnknown
static val functionResultUnknown: Int
Indicates that it is not known whether the function returns a result or a table.
A possible value for column FUNCTION_TYPE
in the ResultSet
object returned by the method getFunctions
.
Value: 0
functionReturn
static val functionReturn: Int
Indicates that the parameter or column is a return value.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
Value: 4
functionReturnsTable
static val functionReturnsTable: Int
Indicates that the function returns a table.
A possible value for column FUNCTION_TYPE
in the ResultSet
object returned by the method getFunctions
.
Value: 2
importedKeyCascade
static val importedKeyCascade: Int
For the column UPDATE_RULE
, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it. For the column DELETE_RULE
, it indicates that when the primary key is deleted, rows that imported that key are deleted.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 0
importedKeyInitiallyDeferred
static val importedKeyInitiallyDeferred: Int
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 5
importedKeyInitiallyImmediate
static val importedKeyInitiallyImmediate: Int
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 6
importedKeyNoAction
static val importedKeyNoAction: Int
For the columns UPDATE_RULE
and DELETE_RULE
, indicates that if the primary key has been imported, it cannot be updated or deleted.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 3
importedKeyNotDeferrable
static val importedKeyNotDeferrable: Int
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 7
importedKeyRestrict
static val importedKeyRestrict: Int
For the column UPDATE_RULE
, indicates that a primary key may not be updated if it has been imported by another table as a foreign key. For the column DELETE_RULE
, indicates that a primary key may not be deleted if it has been imported by another table as a foreign key.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 1
importedKeySetDefault
static val importedKeySetDefault: Int
For the columns UPDATE_RULE
and DELETE_RULE
, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 4
importedKeySetNull
static val importedKeySetNull: Int
For the columns UPDATE_RULE
and DELETE_RULE
, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to NULL
.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the ResultSet
objects returned by the methods getImportedKeys
, getExportedKeys
, and getCrossReference
.
Value: 2
procedureColumnIn
static val procedureColumnIn: Int
Indicates that the column stores IN parameters.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
Value: 1
procedureColumnInOut
static val procedureColumnInOut: Int
Indicates that the column stores INOUT parameters.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
Value: 2
procedureColumnOut
static val procedureColumnOut: Int
Indicates that the column stores OUT parameters.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
Value: 4
procedureColumnResult
static val procedureColumnResult: Int
Indicates that the column stores results.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
Value: 3
procedureColumnReturn
static val procedureColumnReturn: Int
Indicates that the column stores return values.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
Value: 5
procedureColumnUnknown
static val procedureColumnUnknown: Int
Indicates that type of the column is unknown.
A possible value for the column COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
Value: 0
procedureNoNulls
static val procedureNoNulls: Int
Indicates that NULL
values are not allowed.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getProcedureColumns
.
Value: 0
procedureNoResult
static val procedureNoResult: Int
Indicates that the procedure does not return a result.
A possible value for column PROCEDURE_TYPE
in the ResultSet
object returned by the method getProcedures
.
Value: 1
procedureNullable
static val procedureNullable: Int
Indicates that NULL
values are allowed.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getProcedureColumns
.
Value: 1
procedureNullableUnknown
static val procedureNullableUnknown: Int
Indicates that whether NULL
values are allowed is unknown.
A possible value for the column NULLABLE
in the ResultSet
object returned by the method getProcedureColumns
.
Value: 2
procedureResultUnknown
static val procedureResultUnknown: Int
Indicates that it is not known whether the procedure returns a result.
A possible value for column PROCEDURE_TYPE
in the ResultSet
object returned by the method getProcedures
.
Value: 0
procedureReturnsResult
static val procedureReturnsResult: Int
Indicates that the procedure returns a result.
A possible value for column PROCEDURE_TYPE
in the ResultSet
object returned by the method getProcedures
.
Value: 2
sqlStateSQL
static val sqlStateSQL: Int
A possible return value for the method DatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the method SQLException.getSQLState
is an SQLSTATE value.
Value: 2
sqlStateSQL99
static val sqlStateSQL99: Int
A possible return value for the method DatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the method SQLException.getSQLState
is an SQL99 SQLSTATE value.
Note:This constant remains only for compatibility reasons. Developers should use the constant sqlStateSQL
instead.
Value: 2
sqlStateXOpen
static val sqlStateXOpen: Int
A possible return value for the method DatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the method SQLException.getSQLState
is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.
Value: 1
tableIndexClustered
static val tableIndexClustered: Short
Indicates that this table index is a clustered index.
A possible value for column TYPE
in the ResultSet
object returned by the method getIndexInfo
.
Value: 1
tableIndexHashed
static val tableIndexHashed: Short
Indicates that this table index is a hashed index.
A possible value for column TYPE
in the ResultSet
object returned by the method getIndexInfo
.
Value: 2
tableIndexOther
static val tableIndexOther: Short
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
A possible value for column TYPE
in the ResultSet
object returned by the method getIndexInfo
.
Value: 3
tableIndexStatistic
static val tableIndexStatistic: Short
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
A possible value for column TYPE
in the ResultSet
object returned by the method getIndexInfo
.
Value: 0
typeNoNulls
static val typeNoNulls: Int
Indicates that a NULL
value is NOT allowed for this data type.
A possible value for column NULLABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 0
typeNullable
static val typeNullable: Int
Indicates that a NULL
value is allowed for this data type.
A possible value for column NULLABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 1
typeNullableUnknown
static val typeNullableUnknown: Int
Indicates that it is not known whether a NULL
value is allowed for this data type.
A possible value for column NULLABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 2
typePredBasic
static val typePredBasic: Int
Indicates that the data type can be only be used in WHERE
search clauses that do not use LIKE
predicates.
A possible value for column SEARCHABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 2
typePredChar
static val typePredChar: Int
Indicates that the data type can be only be used in WHERE
search clauses that use LIKE
predicates.
A possible value for column SEARCHABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 1
typePredNone
static val typePredNone: Int
Indicates that WHERE
search clauses are not supported for this type.
A possible value for column SEARCHABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 0
typeSearchable
static val typeSearchable: Int
Indicates that all WHERE
search clauses can be based on this type.
A possible value for column SEARCHABLE
in the ResultSet
object returned by the method getTypeInfo
.
Value: 3
versionColumnNotPseudo
static val versionColumnNotPseudo: Int
Indicates that this version column is NOT a pseudo column.
A possible value for the column PSEUDO_COLUMN
in the ResultSet
object returned by the method getVersionColumns
.
Value: 1
versionColumnPseudo
static val versionColumnPseudo: Int
Indicates that this version column is a pseudo column.
A possible value for the column PSEUDO_COLUMN
in the ResultSet
object returned by the method getVersionColumns
.
Value: 2
versionColumnUnknown
static val versionColumnUnknown: Int
Indicates that this version column may or may not be a pseudo column.
A possible value for the column PSEUDO_COLUMN
in the ResultSet
object returned by the method getVersionColumns
.
Value: 0
Public methods
allProceduresAreCallable
abstract fun allProceduresAreCallable(): Boolean
Retrieves whether the current user can call all the procedures returned by the method getProcedures
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
allTablesAreSelectable
abstract fun allTablesAreSelectable(): Boolean
Retrieves whether the current user can use all the tables returned by the method getTables
in a SELECT
statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
autoCommitFailureClosesAllResultSets
abstract fun autoCommitFailureClosesAllResultSets(): Boolean
Retrieves whether a SQLException
while autoCommit is true
inidcates that all open ResultSets are closed, even ones that are holdable. When a SQLException
occurs while autocommit is true
, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
dataDefinitionCausesTransactionCommit
abstract fun dataDefinitionCausesTransactionCommit(): Boolean
Retrieves whether a data definition statement within a transaction forces the transaction to commit.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
dataDefinitionIgnoredInTransactions
abstract fun dataDefinitionIgnoredInTransactions(): Boolean
Retrieves whether this database ignores a data definition statement within a transaction.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
deletesAreDetected
abstract fun deletesAreDetected(type: Int): Boolean
Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted
. If the method deletesAreDetected
returns false
, it means that deleted rows are removed from the result set.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if deletes are detected by the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
doesMaxRowSizeIncludeBlobs
abstract fun doesMaxRowSizeIncludeBlobs(): Boolean
Retrieves whether the return value for the method getMaxRowSize
includes the SQL data types LONGVARCHAR
and LONGVARBINARY
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getAttributes
abstract fun getAttributes(
catalog: String!,
schemaPattern: String!,
typeNamePattern: String!,
attributeNamePattern: String!
): ResultSet!
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.
Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by TYPE_CAT
, TYPE_SCHEM
, TYPE_NAME
and ORDINAL_POSITION
. This description does not contain inherited attributes.
The ResultSet
object that is returned has the following columns:
- TYPE_CAT String => type catalog (may be
null
) - TYPE_SCHEM String => type schema (may be
null
) - TYPE_NAME String => type name
- ATTR_NAME String => attribute name
- DATA_TYPE int => attribute type SQL type from java.sql.Types
- ATTR_TYPE_NAME String => Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type.
- ATTR_SIZE int => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => whether NULL is allowed
- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null
) - ATTR_DEF String => default value (may be
null
) - SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1)
- IS_NULLABLE String => ISO rules are used to determine the nullability for a attribute.
- YES --- if the attribute can include NULLs
- NO --- if the attribute cannot include NULLs
- empty string --- if the nullability for the attribute is unknown
- SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_TABLE String => table name that is the scope of a reference attribute (
null
if the DATA_TYPE isn't REF) - 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)
Parameters | |
---|---|
catalog |
String!: 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 |
String!: 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 |
typeNamePattern |
String!: a type name pattern; must match the type name as it is stored in the database |
attributeNamePattern |
String!: an attribute name pattern; must match the attribute name as it is declared in the database |
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is an attribute description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getBestRowIdentifier
abstract fun getBestRowIdentifier(
catalog: String!,
schema: String!,
table: String!,
scope: Int,
nullable: Boolean
): ResultSet!
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.
Each column description has the following columns:
- SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => not used
- DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
- PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified 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 |
String!: 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 |
schema |
String!: a schema name; 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 |
table |
String!: a table name; must match the table name as it is stored in the database |
scope |
Int: the scope of interest; use same values as SCOPE |
nullable |
Boolean: include columns that are nullable. |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getCatalogSeparator
abstract fun getCatalogSeparator(): String!
Retrieves the String
that this database uses as the separator between a catalog and table name.
Return | |
---|---|
String! |
the separator string |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getCatalogTerm
abstract fun getCatalogTerm(): String!
Retrieves the database vendor's preferred term for "catalog".
Return | |
---|---|
String! |
the vendor term for "catalog" |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getCatalogs
abstract fun getCatalogs(): ResultSet!
Retrieves the catalog names available in this database. The results are ordered by catalog name.
The catalog column is:
- TABLE_CAT String => catalog name
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row has a single String column that is a catalog name |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getClientInfoProperties
abstract fun getClientInfoProperties(): ResultSet!
Retrieves a list of the client info properties that the driver supports. The result set contains the following columns
- NAME String=> The name of the client info property
- MAX_LEN int=> The maximum length of the value for the property
- DEFAULT_VALUE String=> The default value of the property
- 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
Return | |
---|---|
ResultSet! |
A ResultSet object; each row is a supported client info property
|
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getColumnPrivileges
abstract fun getColumnPrivileges(
catalog: String!,
schema: String!,
table: String!,
columnNamePattern: String!
): ResultSet!
Retrieves a description of the access rights for a table's columns.
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- GRANTOR String => grantor of access (may be
null
) - GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not;
null
if unknown
Parameters | |
---|---|
catalog |
String!: 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 |
schema |
String!: a schema name; 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 |
table |
String!: a table name; must match the table name as it is stored in the database |
columnNamePattern |
String!: a column name pattern; must match the column name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a column privilege description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getColumns
abstract fun getColumns(
catalog: String!,
schemaPattern: String!,
tableNamePattern: String!,
columnNamePattern: String!
): ResultSet!
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:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
- COLUMN_SIZE int => column size.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => is NULL allowed.
- columnNoNulls - might not allow
NULL
values - columnNullable - definitely allows
NULL
values - columnNullableUnknown - nullability unknown
- columnNoNulls - might not allow
- REMARKS String => comment describing column (may be
null
) - 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
) - SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table (starting at 1)
- 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
- SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (
null
if the DATA_TYPE isn't REF) - SCOPE_TABLE String => table name that this the scope of a reference attribute (
null
if the DATA_TYPE isn't REF) - 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) - 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
- 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 |
String!: 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 |
String!: 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 |
String!: a table name pattern; must match the table name as it is stored in the database |
columnNamePattern |
String!: a column name pattern; must match the column name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getConnection
abstract fun getConnection(): Connection!
Retrieves the connection that produced this metadata object.
Return | |
---|---|
Connection! |
the connection that produced this metadata object |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getCrossReference
abstract fun getCrossReference(
parentCatalog: String!,
parentSchema: String!,
parentTable: String!,
foreignCatalog: String!,
foreignSchema: String!,
foreignTable: String!
): 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). The number of columns returned from the parent table must match the number of columns that make up the foreign key. They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:
- PKTABLE_CAT String => parent key table catalog (may be
null
) - PKTABLE_SCHEM String => parent key table schema (may be
null
) - PKTABLE_NAME String => parent key table name
- PKCOLUMN_NAME String => parent key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null
) being exported (may benull
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) being exported (may benull
) - FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
- UPDATE_RULE short => What happens to foreign key when parent key is updated:
- importedNoAction - do not allow update of parent key if it has been imported
- importedKeyCascade - change imported key to agree with parent key update
- importedKeySetNull - change imported key to
NULL
if its parent key has been updated - importedKeySetDefault - change imported key to default values if its parent key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to the foreign key when parent key is deleted.
- importedKeyNoAction - do not allow delete of parent key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its parent key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => parent key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
Parameters | |
---|---|
parentCatalog |
String!: a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria |
parentSchema |
String!: a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria |
parentTable |
String!: the name of the table that exports the key; must match the table name as it is stored in the database |
foreignCatalog |
String!: a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria |
foreignSchema |
String!: a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria |
foreignTable |
String!: the name of the table that imports the key; must match the table name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a foreign key column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getDatabaseMajorVersion
abstract fun getDatabaseMajorVersion(): Int
Retrieves the major version number of the underlying database.
Return | |
---|---|
Int |
the underlying database's major version |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getDatabaseMinorVersion
abstract fun getDatabaseMinorVersion(): Int
Retrieves the minor version number of the underlying database.
Return | |
---|---|
Int |
underlying database's minor version |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getDatabaseProductName
abstract fun getDatabaseProductName(): String!
Retrieves the name of this database product.
Return | |
---|---|
String! |
database product name |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getDatabaseProductVersion
abstract fun getDatabaseProductVersion(): String!
Retrieves the version number of this database product.
Return | |
---|---|
String! |
database version number |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getDefaultTransactionIsolation
abstract fun getDefaultTransactionIsolation(): Int
Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection
.
Return | |
---|---|
Int |
the default isolation level |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getDriverMajorVersion
abstract fun getDriverMajorVersion(): Int
Retrieves this JDBC driver's major version number.
Return | |
---|---|
Int |
JDBC driver major version |
getDriverMinorVersion
abstract fun getDriverMinorVersion(): Int
Retrieves this JDBC driver's minor version number.
Return | |
---|---|
Int |
JDBC driver minor version number |
getDriverName
abstract fun getDriverName(): String!
Retrieves the name of this JDBC driver.
Return | |
---|---|
String! |
JDBC driver name |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getDriverVersion
abstract fun getDriverVersion(): String!
Retrieves the version number of this JDBC driver as a String
.
Return | |
---|---|
String! |
JDBC driver version |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getExportedKeys
abstract fun getExportedKeys(
catalog: String!,
schema: String!,
table: String!
): 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). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be
null
) - PKTABLE_SCHEM String => primary key table schema (may be
null
) - PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null
) being exported (may benull
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) being exported (may benull
) - FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
- UPDATE_RULE short => What happens to foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => primary key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
Parameters | |
---|---|
catalog |
String!: a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search |
schema |
String!: a schema name; 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 |
table |
String!: a table name; must match the table name as it is stored in this database |
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is a foreign key column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getExtraNameCharacters
abstract fun getExtraNameCharacters(): String!
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
Return | |
---|---|
String! |
the string containing the extra characters |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getFunctionColumns
abstract fun getFunctionColumns(
catalog: String!,
schemaPattern: String!,
functionNamePattern: String!,
columnNamePattern: String!
): ResultSet!
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.
Each row in the ResultSet
is a parameter description, column description or return type description with the following fields:
- FUNCTION_CAT String => function catalog (may be
null
) - FUNCTION_SCHEM String => function schema (may be
null
) - FUNCTION_NAME String => function name. This is the name used to invoke the function
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- functionColumnUnknown - nobody knows
- functionColumnIn - IN parameter
- functionColumnInOut - INOUT parameter
- functionColumnOut - OUT parameter
- functionColumnReturn - function return value
- functionColumnResult - Indicates that the parameter or column is a column in the
ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale - null is returned for data types where SCALE is not applicable.
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- functionNoNulls - does not allow NULL values
- functionNullable - allows NULL values
- functionNullableUnknown - nullability unknown
- REMARKS String => comment describing column/parameter
- CHAR_OCTET_LENGTH int => the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL
- ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1.
- IS_NULLABLE String => ISO rules are used to determine the nullability for a parameter or column.
- YES --- if the parameter or column can include NULLs
- NO --- if the parameter or column cannot include NULLs
- empty string --- if the nullability for the parameter or column is unknown
- 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
The PRECISION column represents the specified column size for the given parameter or 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 |
String!: 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 |
String!: 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 |
functionNamePattern |
String!: a procedure name pattern; must match the function name as it is stored in the database |
columnNamePattern |
String!: a parameter name pattern; must match the parameter or column name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row describes a user function parameter, column or return type |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getFunctions
abstract fun getFunctions(
catalog: String!,
schemaPattern: String!,
functionNamePattern: String!
): ResultSet!
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
.
Each function description has the the following columns:
- FUNCTION_CAT String => function catalog (may be
null
) - FUNCTION_SCHEM String => function schema (may be
null
) - FUNCTION_NAME String => function name. This is the name used to invoke the function
- REMARKS String => explanatory comment on the function
- 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
- 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
A user may not have permission to execute any of the functions that are returned by getFunctions
Parameters | |
---|---|
catalog |
String!: 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 |
String!: 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 |
functionNamePattern |
String!: a function name pattern; must match the function name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a function description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getIdentifierQuoteString
abstract fun getIdentifierQuoteString(): String!
Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.
Return | |
---|---|
String! |
the quoting string or a space if quoting is not supported |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getImportedKeys
abstract fun getImportedKeys(
catalog: String!,
schema: String!,
table: String!
): 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). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.
Each primary key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog being imported (may be
null
) - PKTABLE_SCHEM String => primary key table schema being imported (may be
null
) - PKTABLE_NAME String => primary key table name being imported
- PKCOLUMN_NAME String => primary key column name being imported
- FKTABLE_CAT String => foreign key table catalog (may be
null
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) - FKTABLE_NAME String => foreign key table name
- FKCOLUMN_NAME String => foreign key column name
- KEY_SEQ short => sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
- UPDATE_RULE short => What happens to a foreign key when the primary key is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => primary key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
Parameters | |
---|---|
catalog |
String!: 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 |
schema |
String!: a schema name; 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 |
table |
String!: a table name; must match the table name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a primary key column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getIndexInfo
abstract fun getIndexInfo(
catalog: String!,
schema: String!,
table: String!,
unique: Boolean,
approximate: Boolean
): ResultSet!
Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.
Each index column description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic
- INDEX_QUALIFIER String => index catalog (may be
null
);null
when TYPE is tableIndexStatistic - INDEX_NAME String => index name;
null
when TYPE is tableIndexStatistic - TYPE short => index type:
- tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
- COLUMN_NAME String => column name;
null
when TYPE is tableIndexStatistic - ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be
null
if sort sequence is not supported;null
when TYPE is tableIndexStatistic - CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
- PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
- FILTER_CONDITION String => Filter condition, if any. (may be
null
)
Parameters | |
---|---|
catalog |
String!: a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search |
schema |
String!: a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search |
table |
String!: a table name; must match the table name as it is stored in this database |
unique |
Boolean: when true, return only indices for unique values; when false, return indices regardless of whether unique or not |
approximate |
Boolean: when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate |
Return | |
---|---|
ResultSet! |
ResultSet - each row is an index column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getJDBCMajorVersion
abstract fun getJDBCMajorVersion(): Int
Retrieves the major JDBC version number for this driver.
Return | |
---|---|
Int |
JDBC version major number |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getJDBCMinorVersion
abstract fun getJDBCMinorVersion(): Int
Retrieves the minor JDBC version number for this driver.
Return | |
---|---|
Int |
JDBC version minor number |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxBinaryLiteralLength
abstract fun getMaxBinaryLiteralLength(): Int
Retrieves the maximum number of hex characters this database allows in an inline binary literal.
Return | |
---|---|
Int |
max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxCatalogNameLength
abstract fun getMaxCatalogNameLength(): Int
Retrieves the maximum number of characters that this database allows in a catalog name.
Return | |
---|---|
Int |
the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxCharLiteralLength
abstract fun getMaxCharLiteralLength(): Int
Retrieves the maximum number of characters this database allows for a character literal.
Return | |
---|---|
Int |
the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxColumnNameLength
abstract fun getMaxColumnNameLength(): Int
Retrieves the maximum number of characters this database allows for a column name.
Return | |
---|---|
Int |
the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxColumnsInGroupBy
abstract fun getMaxColumnsInGroupBy(): Int
Retrieves the maximum number of columns this database allows in a GROUP BY
clause.
Return | |
---|---|
Int |
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxColumnsInIndex
abstract fun getMaxColumnsInIndex(): Int
Retrieves the maximum number of columns this database allows in an index.
Return | |
---|---|
Int |
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxColumnsInOrderBy
abstract fun getMaxColumnsInOrderBy(): Int
Retrieves the maximum number of columns this database allows in an ORDER BY
clause.
Return | |
---|---|
Int |
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxColumnsInSelect
abstract fun getMaxColumnsInSelect(): Int
Retrieves the maximum number of columns this database allows in a SELECT
list.
Return | |
---|---|
Int |
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxColumnsInTable
abstract fun getMaxColumnsInTable(): Int
Retrieves the maximum number of columns this database allows in a table.
Return | |
---|---|
Int |
the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxConnections
abstract fun getMaxConnections(): Int
Retrieves the maximum number of concurrent connections to this database that are possible.
Return | |
---|---|
Int |
the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxCursorNameLength
abstract fun getMaxCursorNameLength(): Int
Retrieves the maximum number of characters that this database allows in a cursor name.
Return | |
---|---|
Int |
the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxIndexLength
abstract fun getMaxIndexLength(): Int
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.
Return | |
---|---|
Int |
the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxProcedureNameLength
abstract fun getMaxProcedureNameLength(): Int
Retrieves the maximum number of characters that this database allows in a procedure name.
Return | |
---|---|
Int |
the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxRowSize
abstract fun getMaxRowSize(): Int
Retrieves the maximum number of bytes this database allows in a single row.
Return | |
---|---|
Int |
the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxSchemaNameLength
abstract fun getMaxSchemaNameLength(): Int
Retrieves the maximum number of characters that this database allows in a schema name.
Return | |
---|---|
Int |
the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxStatementLength
abstract fun getMaxStatementLength(): Int
Retrieves the maximum number of characters this database allows in an SQL statement.
Return | |
---|---|
Int |
the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxStatements
abstract fun getMaxStatements(): Int
Retrieves the maximum number of active statements to this database that can be open at the same time.
Return | |
---|---|
Int |
the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxTableNameLength
abstract fun getMaxTableNameLength(): Int
Retrieves the maximum number of characters this database allows in a table name.
Return | |
---|---|
Int |
the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxTablesInSelect
abstract fun getMaxTablesInSelect(): Int
Retrieves the maximum number of tables this database allows in a SELECT
statement.
Return | |
---|---|
Int |
the maximum number of tables allowed in a SELECT statement; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getMaxUserNameLength
abstract fun getMaxUserNameLength(): Int
Retrieves the maximum number of characters this database allows in a user name.
Return | |
---|---|
Int |
the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getNumericFunctions
abstract fun getNumericFunctions(): String!
Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.
Return | |
---|---|
String! |
the list of math functions supported by this database |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getPrimaryKeys
abstract fun getPrimaryKeys(
catalog: String!,
schema: String!,
table: String!
): ResultSet!
Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.
Each primary key column description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- KEY_SEQ short => sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key).
- PK_NAME String => primary key name (may be
null
)
Parameters | |
---|---|
catalog |
String!: 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 |
schema |
String!: a schema name; 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 |
table |
String!: a table name; must match the table name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a primary key column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getProcedureColumns
abstract fun getProcedureColumns(
catalog: String!,
schemaPattern: String!,
procedureNamePattern: String!,
columnNamePattern: String!
): ResultSet!
Retrieves a description of the given catalog's stored procedure parameter and result columns.
Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_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.
Each row in the ResultSet
is a parameter description or column description with the following fields:
- PROCEDURE_CAT String => procedure catalog (may be
null
) - PROCEDURE_SCHEM String => procedure schema (may be
null
) - PROCEDURE_NAME String => procedure name
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale - null is returned for data types where SCALE is not applicable.
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String => comment describing parameter/column
- 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
)- The string NULL (not enclosed in quotes) - if NULL was specified as the default value
- TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
- NULL - if a default value was not specified
- SQL_DATA_TYPE int => reserved for future use
- SQL_DATETIME_SUB int => reserved for future use
- CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL
- ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 is returned if this row describes the procedure's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. If there are multiple result sets, the column ordinal positions are implementation defined.
- 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
- SPECIFIC_NAME String => the name which uniquely identifies this procedure within its schema.
Note: Some databases may not return the column descriptions for a procedure.
The PRECISION column represents the specified 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 |
String!: 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 |
String!: 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 |
procedureNamePattern |
String!: a procedure name pattern; must match the procedure name as it is stored in the database |
columnNamePattern |
String!: a column name pattern; must match the column name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row describes a stored procedure parameter or column |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getProcedureTerm
abstract fun getProcedureTerm(): String!
Retrieves the database vendor's preferred term for "procedure".
Return | |
---|---|
String! |
the vendor term for "procedure" |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getProcedures
abstract fun getProcedures(
catalog: String!,
schemaPattern: String!,
procedureNamePattern: String!
): ResultSet!
Retrieves a description of the stored procedures available in the given catalog.
Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_CAT
, PROCEDURE_SCHEM
, PROCEDURE_NAME
and SPECIFIC_ NAME
.
Each procedure description has the the following columns:
- PROCEDURE_CAT String => procedure catalog (may be
null
) - PROCEDURE_SCHEM String => procedure schema (may be
null
) - PROCEDURE_NAME String => procedure name
- reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String => explanatory comment on the procedure
- PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - Cannot determine if a return value will be returned
- procedureNoResult - Does not return a return value
- procedureReturnsResult - Returns a return value
- SPECIFIC_NAME String => The name which uniquely identifies this procedure within its schema.
A user may not have permissions to execute any of the procedures that are returned by getProcedures
Parameters | |
---|---|
catalog |
String!: 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 |
String!: 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 |
procedureNamePattern |
String!: a procedure name pattern; must match the procedure name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a procedure description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getResultSetHoldability
abstract fun getResultSetHoldability(): Int
Retrieves this database's default holdability for ResultSet
objects.
Return | |
---|---|
Int |
the default holdability; either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getRowIdLifetime
abstract fun getRowIdLifetime(): RowIdLifetime!
Indicates whether or not this data source supports the SQL ROWID
type, and if so the lifetime for which a RowId
object remains valid.
The returned int values have the following relationship:
ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION < ROWID_VALID_SESSION < ROWID_VALID_FOREVER
if (metadata.getRowIdLifetime() > DatabaseMetaData.ROWID_VALID_TRANSACTION)
Return | |
---|---|
RowIdLifetime! |
the status indicating the lifetime of a RowId |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getSQLKeywords
abstract fun getSQLKeywords(): String!
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.
Return | |
---|---|
String! |
the list of this database's keywords that are not also SQL:2003 keywords |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getSQLStateType
abstract fun getSQLStateType(): Int
Indicates whether the SQLSTATE returned by SQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003.
Return | |
---|---|
Int |
the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getSchemaTerm
abstract fun getSchemaTerm(): String!
Retrieves the database vendor's preferred term for "schema".
Return | |
---|---|
String! |
the vendor term for "schema" |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getSchemas
abstract fun getSchemas(): ResultSet!
Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG
and TABLE_SCHEM
.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null
)
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is a schema description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getSchemas
abstract fun getSchemas(
catalog: String!,
schemaPattern: String!
): ResultSet!
Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG
and TABLE_SCHEM
.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null
)
Parameters | |
---|---|
catalog |
String!: a catalog name; must match the catalog name as it is stored in the database;"" retrieves those without a catalog; null means catalog name should not be used to narrow down the search. |
schemaPattern |
String!: a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search. |
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is a schema description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getSearchStringEscape
abstract fun getSearchStringEscape(): String!
Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).
The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
Return | |
---|---|
String! |
the string used to escape wildcard characters |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getStringFunctions
abstract fun getStringFunctions(): String!
Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.
Return | |
---|---|
String! |
the list of string functions supported by this database |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getSuperTables
abstract fun getSuperTables(
catalog: String!,
schemaPattern: String!,
tableNamePattern: String!
): ResultSet!
Retrieves a description of the table hierarchies defined in a particular schema in this database.
Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.
Each type description has the following columns:
- TABLE_CAT String => the type's catalog (may be
null
) - TABLE_SCHEM String => type's schema (may be
null
) - TABLE_NAME String => type name
- SUPERTABLE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
Parameters | |
---|---|
catalog |
String!: a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria |
schemaPattern |
String!: a schema name pattern; "" retrieves those without a schema |
tableNamePattern |
String!: a table name pattern; may be a fully-qualified name |
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is a type description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getSuperTypes
abstract fun getSuperTypes(
catalog: String!,
schemaPattern: String!,
typeNamePattern: String!
): 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.
Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.
If a UDT does not have a direct super type, it is not listed here. A row of the ResultSet
object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:
- TYPE_CAT String => the UDT's catalog (may be
null
) - TYPE_SCHEM String => UDT's schema (may be
null
) - TYPE_NAME String => type name of the UDT
- SUPERTYPE_CAT String => the direct super type's catalog (may be
null
) - SUPERTYPE_SCHEM String => the direct super type's schema (may be
null
) - SUPERTYPE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
Parameters | |
---|---|
catalog |
String!: a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria |
schemaPattern |
String!: a schema name pattern; "" retrieves those without a schema |
typeNamePattern |
String!: a UDT name pattern; may be a fully-qualified name |
Return | |
---|---|
ResultSet! |
a ResultSet object in which a row gives information about the designated UDT |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getSystemFunctions
abstract fun getSystemFunctions(): String!
Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.
Return | |
---|---|
String! |
a list of system functions supported by this database |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getTablePrivileges
abstract fun getTablePrivileges(
catalog: String!,
schemaPattern: String!,
tableNamePattern: String!
): ResultSet!
Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)
Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_CAT
, TABLE_SCHEM
, TABLE_NAME
, and PRIVILEGE
.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- GRANTOR String => grantor of access (may be
null
) - GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not;
null
if unknown
Parameters | |
---|---|
catalog |
String!: 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 |
String!: 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 |
String!: a table name pattern; must match the table name as it is stored in the database |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a table privilege description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getTableTypes
abstract fun getTableTypes(): ResultSet!
Retrieves the table types available in this database. The results are ordered by table type.
The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row has a single String column that is a table type |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getTables
abstract fun getTables(
catalog: String!,
schemaPattern: String!,
tableNamePattern: String!,
types: Array<String!>!
): ResultSet!
Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE
, TABLE_CAT
, TABLE_SCHEM
and TABLE_NAME
.
Each table description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- REMARKS String => explanatory comment on the table
- TYPE_CAT String => the types catalog (may be
null
) - TYPE_SCHEM String => the types schema (may be
null
) - TYPE_NAME String => type name (may be
null
) - SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be
null
) - REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be
null
)
Note: Some databases may not return information for all tables.
Parameters | |
---|---|
catalog |
String!: 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 |
String!: 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 |
String!: a table name pattern; must match the table name as it is stored in the database |
types |
Array<String!>!: a list of table types, which must be from the list of table types returned from getTableTypes ,to include; null returns all types |
Return | |
---|---|
ResultSet! |
ResultSet - each row is a table description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getTimeDateFunctions
abstract fun getTimeDateFunctions(): String!
Retrieves a comma-separated list of the time and date functions available with this database.
Return | |
---|---|
String! |
the list of time and date functions supported by this database |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getTypeInfo
abstract fun getTypeInfo(): ResultSet!
Retrieves a description of all the data types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.
If the database supports SQL distinct types, then getTypeInfo() will return a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT. If the database supports SQL structured types, then getTypeInfo() will return a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.
If SQL distinct or structured types are supported, then information on the individual types may be obtained from the getUDTs() method.
Each type description has the following columns:
- TYPE_NAME String => Type name
- DATA_TYPE int => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal (may be
null
) - LITERAL_SUFFIX String => suffix used to quote a literal (may be
null
) - CREATE_PARAMS String => parameters used in creating the type (may be
null
) - NULLABLE short => can you use NULL for this type.
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive.
- SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned.
- FIXED_PREC_SCALE boolean => can it be a money value.
- AUTO_INCREMENT boolean => can it be used for an auto-increment value.
- LOCAL_TYPE_NAME String => localized version of type name (may be
null
) - MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
The PRECISION column represents the maximum column size that the server supports for the given datatype. 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.
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is an SQL type description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getUDTs
abstract fun getUDTs(
catalog: String!,
schemaPattern: String!,
typeNamePattern: String!,
types: IntArray!
): ResultSet!
Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT
, STRUCT
, or DISTINCT
.
Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE
, TYPE_CAT
, TYPE_SCHEM
and TYPE_NAME
. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be
null
) - TYPE_SCHEM String => type's schema (may be
null
) - TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
- BASE_TYPE short => type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (
null
if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty result set is returned.
Parameters | |
---|---|
catalog |
String!: 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 |
String!: a schema pattern name; 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 |
typeNamePattern |
String!: a type name pattern; must match the type name as it is stored in the database; may be a fully qualified name |
types |
IntArray!: a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include; null returns all types |
Return | |
---|---|
ResultSet! |
ResultSet object in which each row describes a UDT |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
getURL
abstract fun getURL(): String!
Retrieves the URL for this DBMS.
Return | |
---|---|
String! |
the URL for this DBMS or null if it cannot be generated |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getUserName
abstract fun getUserName(): String!
Retrieves the user name as known to this database.
Return | |
---|---|
String! |
the database user name |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
getVersionColumns
abstract fun getVersionColumns(
catalog: String!,
schema: String!,
table: String!
): ResultSet!
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.
Each column description has the following columns:
- SCOPE short => is not used
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from
java.sql.Types
- TYPE_NAME String => Data source-dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
- PSEUDO_COLUMN short => whether this is pseudo column like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified 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 |
String!: 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 |
schema |
String!: a schema name; 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 |
table |
String!: a table name; must match the table name as it is stored in the database |
Return | |
---|---|
ResultSet! |
a ResultSet object in which each row is a column description |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
insertsAreDetected
abstract fun insertsAreDetected(type: Int): Boolean
Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted
.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if changes are detected by the specified result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
isCatalogAtStart
abstract fun isCatalogAtStart(): Boolean
Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.
Return | |
---|---|
Boolean |
true if the catalog name appears at the beginning of a fully qualified table name; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
isReadOnly
abstract fun isReadOnly(): Boolean
Retrieves whether this database is in read-only mode.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
locatorsUpdateCopy
abstract fun locatorsUpdateCopy(): Boolean
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.
Return | |
---|---|
Boolean |
true if updates are made to a copy of the LOB; false if updates are made directly to the LOB |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
nullPlusNonNullIsNull
abstract fun nullPlusNonNullIsNull(): Boolean
Retrieves whether this database supports concatenations between NULL
and non-NULL
values being NULL
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
nullsAreSortedAtEnd
abstract fun nullsAreSortedAtEnd(): Boolean
Retrieves whether NULL
values are sorted at the end regardless of sort order.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
nullsAreSortedAtStart
abstract fun nullsAreSortedAtStart(): Boolean
Retrieves whether NULL
values are sorted at the start regardless of sort order.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
nullsAreSortedHigh
abstract fun nullsAreSortedHigh(): Boolean
Retrieves whether NULL
values are sorted high. Sorted high means that NULL
values sort higher than any other value in a domain. In an ascending order, if this method returns true
, NULL
values will appear at the end. By contrast, the method nullsAreSortedAtEnd
indicates whether NULL
values are sorted at the end regardless of sort order.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
nullsAreSortedLow
abstract fun nullsAreSortedLow(): Boolean
Retrieves whether NULL
values are sorted low. Sorted low means that NULL
values sort lower than any other value in a domain. In an ascending order, if this method returns true
, NULL
values will appear at the beginning. By contrast, the method nullsAreSortedAtStart
indicates whether NULL
values are sorted at the beginning regardless of sort order.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
othersDeletesAreVisible
abstract fun othersDeletesAreVisible(type: Int): Boolean
Retrieves whether deletes made by others are visible.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if deletes made by others are visible for the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
othersInsertsAreVisible
abstract fun othersInsertsAreVisible(type: Int): Boolean
Retrieves whether inserts made by others are visible.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if inserts made by others are visible for the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
othersUpdatesAreVisible
abstract fun othersUpdatesAreVisible(type: Int): Boolean
Retrieves whether updates made by others are visible.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if updates made by others are visible for the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
ownDeletesAreVisible
abstract fun ownDeletesAreVisible(type: Int): Boolean
Retrieves whether a result set's own deletes are visible.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if deletes are visible for the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
ownInsertsAreVisible
abstract fun ownInsertsAreVisible(type: Int): Boolean
Retrieves whether a result set's own inserts are visible.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if inserts are visible for the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
ownUpdatesAreVisible
abstract fun ownUpdatesAreVisible(type: Int): Boolean
Retrieves whether for the given type of ResultSet
object, the result set's own updates are visible.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if updates are visible for the given result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
storesLowerCaseIdentifiers
abstract fun storesLowerCaseIdentifiers(): Boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
storesLowerCaseQuotedIdentifiers
abstract fun storesLowerCaseQuotedIdentifiers(): Boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
storesMixedCaseIdentifiers
abstract fun storesMixedCaseIdentifiers(): Boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
storesMixedCaseQuotedIdentifiers
abstract fun storesMixedCaseQuotedIdentifiers(): Boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
storesUpperCaseIdentifiers
abstract fun storesUpperCaseIdentifiers(): Boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
storesUpperCaseQuotedIdentifiers
abstract fun storesUpperCaseQuotedIdentifiers(): Boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsANSI92EntryLevelSQL
abstract fun supportsANSI92EntryLevelSQL(): Boolean
Retrieves whether this database supports the ANSI92 entry level SQL grammar.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsANSI92FullSQL
abstract fun supportsANSI92FullSQL(): Boolean
Retrieves whether this database supports the ANSI92 full SQL grammar supported.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsANSI92IntermediateSQL
abstract fun supportsANSI92IntermediateSQL(): Boolean
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsAlterTableWithAddColumn
abstract fun supportsAlterTableWithAddColumn(): Boolean
Retrieves whether this database supports ALTER TABLE
with add column.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsAlterTableWithDropColumn
abstract fun supportsAlterTableWithDropColumn(): Boolean
Retrieves whether this database supports ALTER TABLE
with drop column.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsBatchUpdates
abstract fun supportsBatchUpdates(): Boolean
Retrieves whether this database supports batch updates.
Return | |
---|---|
Boolean |
true if this database supports batch upcates; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsCatalogsInDataManipulation
abstract fun supportsCatalogsInDataManipulation(): Boolean
Retrieves whether a catalog name can be used in a data manipulation statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsCatalogsInIndexDefinitions
abstract fun supportsCatalogsInIndexDefinitions(): Boolean
Retrieves whether a catalog name can be used in an index definition statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsCatalogsInPrivilegeDefinitions
abstract fun supportsCatalogsInPrivilegeDefinitions(): Boolean
Retrieves whether a catalog name can be used in a privilege definition statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsCatalogsInProcedureCalls
abstract fun supportsCatalogsInProcedureCalls(): Boolean
Retrieves whether a catalog name can be used in a procedure call statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsCatalogsInTableDefinitions
abstract fun supportsCatalogsInTableDefinitions(): Boolean
Retrieves whether a catalog name can be used in a table definition statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsColumnAliasing
abstract fun supportsColumnAliasing(): Boolean
Retrieves whether this database supports column aliasing.
If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsConvert
abstract fun supportsConvert(): Boolean
Retrieves whether this database supports the JDBC scalar function CONVERT
for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined in java.sql.Types
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsConvert
abstract fun supportsConvert(
fromType: Int,
toType: Int
): Boolean
Retrieves whether this database supports the JDBC scalar function CONVERT
for conversions between the JDBC types fromType and toType. The JDBC types are the generic SQL data types defined in java.sql.Types
.
Parameters | |
---|---|
fromType |
Int: the type to convert from; one of the type codes from the class java.sql.Types |
toType |
Int: the type to convert to; one of the type codes from the class java.sql.Types |
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
supportsCoreSQLGrammar
abstract fun supportsCoreSQLGrammar(): Boolean
Retrieves whether this database supports the ODBC Core SQL grammar.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsCorrelatedSubqueries
abstract fun supportsCorrelatedSubqueries(): Boolean
Retrieves whether this database supports correlated subqueries.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsDataDefinitionAndDataManipulationTransactions
abstract fun supportsDataDefinitionAndDataManipulationTransactions(): Boolean
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsDataManipulationTransactionsOnly
abstract fun supportsDataManipulationTransactionsOnly(): Boolean
Retrieves whether this database supports only data manipulation statements within a transaction.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsDifferentTableCorrelationNames
abstract fun supportsDifferentTableCorrelationNames(): Boolean
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsExpressionsInOrderBy
abstract fun supportsExpressionsInOrderBy(): Boolean
Retrieves whether this database supports expressions in ORDER BY
lists.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsExtendedSQLGrammar
abstract fun supportsExtendedSQLGrammar(): Boolean
Retrieves whether this database supports the ODBC Extended SQL grammar.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsFullOuterJoins
abstract fun supportsFullOuterJoins(): Boolean
Retrieves whether this database supports full nested outer joins.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsGetGeneratedKeys
abstract fun supportsGetGeneratedKeys(): Boolean
Retrieves whether auto-generated keys can be retrieved after a statement has been executed
Return | |
---|---|
Boolean |
true if auto-generated keys can be retrieved after a statement has executed; false otherwise
If |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsGroupBy
abstract fun supportsGroupBy(): Boolean
Retrieves whether this database supports some form of GROUP BY
clause.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsGroupByBeyondSelect
abstract fun supportsGroupByBeyondSelect(): Boolean
Retrieves whether this database supports using columns not included in the SELECT
statement in a GROUP BY
clause provided that all of the columns in the SELECT
statement are included in the GROUP BY
clause.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsGroupByUnrelated
abstract fun supportsGroupByUnrelated(): Boolean
Retrieves whether this database supports using a column that is not in the SELECT
statement in a GROUP BY
clause.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsIntegrityEnhancementFacility
abstract fun supportsIntegrityEnhancementFacility(): Boolean
Retrieves whether this database supports the SQL Integrity Enhancement Facility.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsLikeEscapeClause
abstract fun supportsLikeEscapeClause(): Boolean
Retrieves whether this database supports specifying a LIKE
escape clause.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsLimitedOuterJoins
abstract fun supportsLimitedOuterJoins(): Boolean
Retrieves whether this database provides limited support for outer joins. (This will be true
if the method supportsFullOuterJoins
returns true
).
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsMinimumSQLGrammar
abstract fun supportsMinimumSQLGrammar(): Boolean
Retrieves whether this database supports the ODBC Minimum SQL grammar.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsMixedCaseIdentifiers
abstract fun supportsMixedCaseIdentifiers(): Boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsMixedCaseQuotedIdentifiers
abstract fun supportsMixedCaseQuotedIdentifiers(): Boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsMultipleOpenResults
abstract fun supportsMultipleOpenResults(): Boolean
Retrieves whether it is possible to have multiple ResultSet
objects returned from a CallableStatement
object simultaneously.
Return | |
---|---|
Boolean |
true if a CallableStatement object can return multiple ResultSet objects simultaneously; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a datanase access error occurs |
supportsMultipleResultSets
abstract fun supportsMultipleResultSets(): Boolean
Retrieves whether this database supports getting multiple ResultSet
objects from a single call to the method execute
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsMultipleTransactions
abstract fun supportsMultipleTransactions(): Boolean
Retrieves whether this database allows having multiple transactions open at once (on different connections).
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsNamedParameters
abstract fun supportsNamedParameters(): Boolean
Retrieves whether this database supports named parameters to callable statements.
Return | |
---|---|
Boolean |
true if named parameters are supported; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsNonNullableColumns
abstract fun supportsNonNullableColumns(): Boolean
Retrieves whether columns in this database may be defined as non-nullable.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsOpenCursorsAcrossCommit
abstract fun supportsOpenCursorsAcrossCommit(): Boolean
Retrieves whether this database supports keeping cursors open across commits.
Return | |
---|---|
Boolean |
true if cursors always remain open; false if they might not remain open |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsOpenCursorsAcrossRollback
abstract fun supportsOpenCursorsAcrossRollback(): Boolean
Retrieves whether this database supports keeping cursors open across rollbacks.
Return | |
---|---|
Boolean |
true if cursors always remain open; false if they might not remain open |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsOpenStatementsAcrossCommit
abstract fun supportsOpenStatementsAcrossCommit(): Boolean
Retrieves whether this database supports keeping statements open across commits.
Return | |
---|---|
Boolean |
true if statements always remain open; false if they might not remain open |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsOpenStatementsAcrossRollback
abstract fun supportsOpenStatementsAcrossRollback(): Boolean
Retrieves whether this database supports keeping statements open across rollbacks.
Return | |
---|---|
Boolean |
true if statements always remain open; false if they might not remain open |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsOrderByUnrelated
abstract fun supportsOrderByUnrelated(): Boolean
Retrieves whether this database supports using a column that is not in the SELECT
statement in an ORDER BY
clause.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsOuterJoins
abstract fun supportsOuterJoins(): Boolean
Retrieves whether this database supports some form of outer join.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsPositionedDelete
abstract fun supportsPositionedDelete(): Boolean
Retrieves whether this database supports positioned DELETE
statements.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsPositionedUpdate
abstract fun supportsPositionedUpdate(): Boolean
Retrieves whether this database supports positioned UPDATE
statements.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsResultSetConcurrency
abstract fun supportsResultSetConcurrency(
type: Int,
concurrency: Int
): Boolean
Retrieves whether this database supports the given concurrency type in combination with the given result set type.
Parameters | |
---|---|
type |
Int: defined in java.sql.ResultSet |
concurrency |
Int: type defined in java.sql.ResultSet |
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
supportsResultSetHoldability
abstract fun supportsResultSetHoldability(holdability: Int): Boolean
Retrieves whether this database supports the given result set holdability.
Parameters | |
---|---|
holdability |
Int: one of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT |
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
supportsResultSetType
abstract fun supportsResultSetType(type: Int): Boolean
Retrieves whether this database supports the given result set type.
Parameters | |
---|---|
type |
Int: defined in java.sql.ResultSet |
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
supportsSavepoints
abstract fun supportsSavepoints(): Boolean
Retrieves whether this database supports savepoints.
Return | |
---|---|
Boolean |
true if savepoints are supported; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSchemasInDataManipulation
abstract fun supportsSchemasInDataManipulation(): Boolean
Retrieves whether a schema name can be used in a data manipulation statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSchemasInIndexDefinitions
abstract fun supportsSchemasInIndexDefinitions(): Boolean
Retrieves whether a schema name can be used in an index definition statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSchemasInPrivilegeDefinitions
abstract fun supportsSchemasInPrivilegeDefinitions(): Boolean
Retrieves whether a schema name can be used in a privilege definition statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSchemasInProcedureCalls
abstract fun supportsSchemasInProcedureCalls(): Boolean
Retrieves whether a schema name can be used in a procedure call statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSchemasInTableDefinitions
abstract fun supportsSchemasInTableDefinitions(): Boolean
Retrieves whether a schema name can be used in a table definition statement.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSelectForUpdate
abstract fun supportsSelectForUpdate(): Boolean
Retrieves whether this database supports SELECT FOR UPDATE
statements.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsStatementPooling
abstract fun supportsStatementPooling(): Boolean
Retrieves whether this database supports statement pooling.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsStoredFunctionsUsingCallSyntax
abstract fun supportsStoredFunctionsUsingCallSyntax(): Boolean
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsStoredProcedures
abstract fun supportsStoredProcedures(): Boolean
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSubqueriesInComparisons
abstract fun supportsSubqueriesInComparisons(): Boolean
Retrieves whether this database supports subqueries in comparison expressions.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSubqueriesInExists
abstract fun supportsSubqueriesInExists(): Boolean
Retrieves whether this database supports subqueries in EXISTS
expressions.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSubqueriesInIns
abstract fun supportsSubqueriesInIns(): Boolean
Retrieves whether this database supports subqueries in IN
expressions.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsSubqueriesInQuantifieds
abstract fun supportsSubqueriesInQuantifieds(): Boolean
Retrieves whether this database supports subqueries in quantified expressions.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsTableCorrelationNames
abstract fun supportsTableCorrelationNames(): Boolean
Retrieves whether this database supports table correlation names.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsTransactionIsolationLevel
abstract fun supportsTransactionIsolationLevel(level: Int): Boolean
Retrieves whether this database supports the given transaction isolation level.
Parameters | |
---|---|
level |
Int: one of the transaction isolation levels defined in java.sql.Connection |
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
See Also
supportsTransactions
abstract fun supportsTransactions(): Boolean
Retrieves whether this database supports transactions. If not, invoking the method commit
is a noop, and the isolation level is TRANSACTION_NONE
.
Return | |
---|---|
Boolean |
true if transactions are supported; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsUnion
abstract fun supportsUnion(): Boolean
Retrieves whether this database supports SQL UNION
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
supportsUnionAll
abstract fun supportsUnionAll(): Boolean
Retrieves whether this database supports SQL UNION ALL
.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
updatesAreDetected
abstract fun updatesAreDetected(type: Int): Boolean
Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated
.
Parameters | |
---|---|
type |
Int: the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Return | |
---|---|
Boolean |
true if changes are detected by the result set type; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
usesLocalFilePerTable
abstract fun usesLocalFilePerTable(): Boolean
Retrieves whether this database uses a file for each table.
Return | |
---|---|
Boolean |
true if this database uses a local file for each table; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
usesLocalFiles
abstract fun usesLocalFiles(): Boolean
Retrieves whether this database stores tables in a local file.
Return | |
---|---|
Boolean |
true if so; false otherwise |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |