DatabaseMetaData

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

allProceduresAreCallable

abstract fun allProceduresAreCallable(): Boolean

Retrieves whether the current user can call all the procedures returned by the method getProcedures.

allTablesAreSelectable

abstract fun allTablesAreSelectable(): Boolean

Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

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.

dataDefinitionCausesTransactionCommit

abstract fun dataDefinitionCausesTransactionCommit(): Boolean

Retrieves whether a data definition statement within a transaction forces the transaction to commit.

dataDefinitionIgnoredInTransactions

abstract fun dataDefinitionIgnoredInTransactions(): Boolean

Retrieves whether this database ignores a data definition statement within a transaction.

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.

doesMaxRowSizeIncludeBlobs

abstract fun doesMaxRowSizeIncludeBlobs(): Boolean

Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

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:

1. TYPE_CAT String => type catalog (may be null)
2. TYPE_SCHEM String => type schema (may be null)
3. TYPE_NAME String => type name
4. ATTR_NAME String => attribute name
5. DATA_TYPE int => attribute type SQL type from java.sql.Types
6. 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.
7. 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.
8. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
9. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
10. NULLABLE int => whether NULL is allowed
    • attributeNoNulls - might not allow NULL values
    • attributeNullable - definitely allows NULL values
    • attributeNullableUnknown - nullability unknown
11. REMARKS String => comment describing column (may be null)
12. ATTR_DEF String => default value (may be null)
13. SQL_DATA_TYPE int => unused
14. SQL_DATETIME_SUB int => unused
15. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
16. ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1)
17. 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
18. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
19. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
20. SCOPE_TABLE String => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
21. 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)

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:

1. 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
2. COLUMN_NAME String => column name
3. DATA_TYPE int => SQL data type from java.sql.Types
4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
5. COLUMN_SIZE int => precision
6. BUFFER_LENGTH int => not used
7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
8. 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.

getCatalogSeparator

abstract fun getCatalogSeparator(): String!

Retrieves the String that this database uses as the separator between a catalog and table name.

getCatalogTerm

abstract fun getCatalogTerm(): String!

Retrieves the database vendor's preferred term for "catalog".

getCatalogs

abstract fun getCatalogs(): ResultSet!

Retrieves the catalog names available in this database. The results are ordered by catalog name.

The catalog column is:

1. TABLE_CAT String => catalog name

getClientInfoProperties

abstract fun getClientInfoProperties(): ResultSet!

Retrieves a list of the client info properties that the driver supports. The result set contains the following columns

1. NAME String=> The name of the client info property
   
2. MAX_LEN int=> The maximum length of the value for the property
   
3. DEFAULT_VALUE String=> The default value of the property
   
4. DESCRIPTION String=> A description of the property. This will typically contain information as to where this property is stored in the database.

The ResultSet is sorted by the NAME column

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:

1. TABLE_CAT String => table catalog (may be null)
2. TABLE_SCHEM String => table schema (may be null)
3. TABLE_NAME String => table name
4. COLUMN_NAME String => column name
5. GRANTOR String => grantor of access (may be null)
6. GRANTEE String => grantee of access
7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

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:

1. TABLE_CAT String => table catalog (may be null)
2. TABLE_SCHEM String => table schema (may be null)
3. TABLE_NAME String => table name
4. COLUMN_NAME String => column name
5. DATA_TYPE int => SQL type from java.sql.Types
6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
7. COLUMN_SIZE int => column size.
8. BUFFER_LENGTH is not used.
9. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
11. NULLABLE int => is NULL allowed.
    • columnNoNulls - might not allow NULL values
    • columnNullable - definitely allows NULL values
    • columnNullableUnknown - nullability unknown
12. REMARKS String => comment describing column (may be null)
13. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
14. SQL_DATA_TYPE int => unused
15. SQL_DATETIME_SUB int => unused
16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
17. ORDINAL_POSITION int => index of column in table (starting at 1)
18. IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
    • YES --- if the column can include NULLs
    • NO --- if the column cannot include NULLs
    • empty string --- if the nullability for the column is unknown
19. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
20. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
21. SCOPE_TABLE String => table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF)
22. SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)
23. IS_AUTOINCREMENT String => Indicates whether this column is auto incremented
    • YES --- if the column is auto incremented
    • NO --- if the column is not auto incremented
    • empty string --- if it cannot be determined whether the column is auto incremented
24. IS_GENERATEDCOLUMN String => Indicates whether this is a generated column
    • YES --- if this a generated column
    • NO --- if this not a generated column
    • empty string --- if it cannot be determined whether this is a generated column

The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

getConnection

abstract fun getConnection(): Connection!

Retrieves the connection that produced this metadata object.

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:

1. PKTABLE_CAT String => parent key table catalog (may be null)
2. PKTABLE_SCHEM String => parent key table schema (may be null)
3. PKTABLE_NAME String => parent key table name
4. PKCOLUMN_NAME String => parent key column name
5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
7. FKTABLE_NAME String => foreign key table name being exported
8. FKCOLUMN_NAME String => foreign key column name being exported
9. 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).
10. 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)
11. 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
12. FK_NAME String => foreign key name (may be null)
13. PK_NAME String => parent key name (may be null)
14. 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

getDatabaseMajorVersion

abstract fun getDatabaseMajorVersion(): Int

Retrieves the major version number of the underlying database.

getDatabaseMinorVersion

abstract fun getDatabaseMinorVersion(): Int

Retrieves the minor version number of the underlying database.

getDatabaseProductName

abstract fun getDatabaseProductName(): String!

Retrieves the name of this database product.

getDatabaseProductVersion

abstract fun getDatabaseProductVersion(): String!

Retrieves the version number of this database product.

getDefaultTransactionIsolation

abstract fun getDefaultTransactionIsolation(): Int

Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.

getDriverMajorVersion

abstract fun getDriverMajorVersion(): Int

Retrieves this JDBC driver's major version number.

getDriverMinorVersion

abstract fun getDriverMinorVersion(): Int

Retrieves this JDBC driver's minor version number.

getDriverName

abstract fun getDriverName(): String!

Retrieves the name of this JDBC driver.

getDriverVersion

abstract fun getDriverVersion(): String!

Retrieves the version number of this JDBC driver as a String.

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:

1. PKTABLE_CAT String => primary key table catalog (may be null)
2. PKTABLE_SCHEM String => primary key table schema (may be null)
3. PKTABLE_NAME String => primary key table name
4. PKCOLUMN_NAME String => primary key column name
5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
7. FKTABLE_NAME String => foreign key table name being exported
8. FKCOLUMN_NAME String => foreign key column name being exported
9. 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).
10. 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)
11. 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
12. FK_NAME String => foreign key name (may be null)
13. PK_NAME String => primary key name (may be null)
14. 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

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 _).

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:

1. FUNCTION_CAT String => function catalog (may be null)
2. FUNCTION_SCHEM String => function schema (may be null)
3. FUNCTION_NAME String => function name. This is the name used to invoke the function
4. COLUMN_NAME String => column/parameter name
5. 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
6. DATA_TYPE int => SQL type from java.sql.Types
7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
8. PRECISION int => precision
9. LENGTH int => length in bytes of data
10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
11. RADIX short => radix
12. NULLABLE short => can it contain NULL.
    • functionNoNulls - does not allow NULL values
    • functionNullable - allows NULL values
    • functionNullableUnknown - nullability unknown
13. REMARKS String => comment describing column/parameter
14. 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
15. 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.
16. 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
17. 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.

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:

1. FUNCTION_CAT String => function catalog (may be null)
2. FUNCTION_SCHEM String => function schema (may be null)
3. FUNCTION_NAME String => function name. This is the name used to invoke the function
4. REMARKS String => explanatory comment on the function
5. FUNCTION_TYPE short => kind of function:
   • functionResultUnknown - Cannot determine if a return value or table will be returned
   • functionNoTable- Does not return a table
   • functionReturnsTable - Returns a table
6. SPECIFIC_NAME String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions

A user may not have permission to execute any of the functions that are returned by getFunctions

getIdentifierQuoteString

abstract fun getIdentifierQuoteString(): String!

Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.

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:

1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
2. PKTABLE_SCHEM String => primary key table schema being imported (may be null)
3. PKTABLE_NAME String => primary key table name being imported
4. PKCOLUMN_NAME String => primary key column name being imported
5. FKTABLE_CAT String => foreign key table catalog (may be null)
6. FKTABLE_SCHEM String => foreign key table schema (may be null)
7. FKTABLE_NAME String => foreign key table name
8. FKCOLUMN_NAME String => foreign key column name
9. 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).
10. 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)
11. 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
12. FK_NAME String => foreign key name (may be null)
13. PK_NAME String => primary key name (may be null)
14. 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

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:

1. TABLE_CAT String => table catalog (may be null)
2. TABLE_SCHEM String => table schema (may be null)
3. TABLE_NAME String => table name
4. NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic
5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
7. 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
8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
10. 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
11. 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.
12. 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.
13. FILTER_CONDITION String => Filter condition, if any. (may be null)

getJDBCMajorVersion

abstract fun getJDBCMajorVersion(): Int

Retrieves the major JDBC version number for this driver.

getJDBCMinorVersion

abstract fun getJDBCMinorVersion(): Int

Retrieves the minor JDBC version number for this driver.

getMaxBinaryLiteralLength

abstract fun getMaxBinaryLiteralLength(): Int

Retrieves the maximum number of hex characters this database allows in an inline binary literal.

getMaxCatalogNameLength

abstract fun getMaxCatalogNameLength(): Int

Retrieves the maximum number of characters that this database allows in a catalog name.

getMaxCharLiteralLength

abstract fun getMaxCharLiteralLength(): Int

Retrieves the maximum number of characters this database allows for a character literal.

getMaxColumnNameLength

abstract fun getMaxColumnNameLength(): Int

Retrieves the maximum number of characters this database allows for a column name.

getMaxColumnsInGroupBy

abstract fun getMaxColumnsInGroupBy(): Int

Retrieves the maximum number of columns this database allows in a GROUP BY clause.

getMaxColumnsInIndex

abstract fun getMaxColumnsInIndex(): Int

Retrieves the maximum number of columns this database allows in an index.

getMaxColumnsInOrderBy

abstract fun getMaxColumnsInOrderBy(): Int

Retrieves the maximum number of columns this database allows in an ORDER BY clause.

getMaxColumnsInSelect

abstract fun getMaxColumnsInSelect(): Int

Retrieves the maximum number of columns this database allows in a SELECT list.

getMaxColumnsInTable

abstract fun getMaxColumnsInTable(): Int

Retrieves the maximum number of columns this database allows in a table.

getMaxConnections

abstract fun getMaxConnections(): Int

Retrieves the maximum number of concurrent connections to this database that are possible.

getMaxCursorNameLength

abstract fun getMaxCursorNameLength(): Int

Retrieves the maximum number of characters that this database allows in a cursor name.

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.

getMaxProcedureNameLength

abstract fun getMaxProcedureNameLength(): Int

Retrieves the maximum number of characters that this database allows in a procedure name.

getMaxRowSize

abstract fun getMaxRowSize(): Int

Retrieves the maximum number of bytes this database allows in a single row.

getMaxSchemaNameLength

abstract fun getMaxSchemaNameLength(): Int

Retrieves the maximum number of characters that this database allows in a schema name.

getMaxStatementLength

abstract fun getMaxStatementLength(): Int

Retrieves the maximum number of characters this database allows in an SQL statement.

getMaxStatements

abstract fun getMaxStatements(): Int

Retrieves the maximum number of active statements to this database that can be open at the same time.

getMaxTableNameLength

abstract fun getMaxTableNameLength(): Int

Retrieves the maximum number of characters this database allows in a table name.

getMaxTablesInSelect

abstract fun getMaxTablesInSelect(): Int

Retrieves the maximum number of tables this database allows in a SELECT statement.

getMaxUserNameLength

abstract fun getMaxUserNameLength(): Int

Retrieves the maximum number of characters this database allows in a user name.

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.

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:

1. TABLE_CAT String => table catalog (may be null)
2. TABLE_SCHEM String => table schema (may be null)
3. TABLE_NAME String => table name
4. COLUMN_NAME String => column name
5. 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).
6. PK_NAME String => primary key name (may be null)

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:

1. PROCEDURE_CAT String => procedure catalog (may be null)
2. PROCEDURE_SCHEM String => procedure schema (may be null)
3. PROCEDURE_NAME String => procedure name
4. COLUMN_NAME String => column/parameter name
5. 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
6. DATA_TYPE int => SQL type from java.sql.Types
7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
8. PRECISION int => precision
9. LENGTH int => length in bytes of data
10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
11. RADIX short => radix
12. NULLABLE short => can it contain NULL.
    • procedureNoNulls - does not allow NULL values
    • procedureNullable - allows NULL values
    • procedureNullableUnknown - nullability unknown
13. REMARKS String => comment describing parameter/column
14. 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
15. SQL_DATA_TYPE int => reserved for future use
16. SQL_DATETIME_SUB int => reserved for future use
17. CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL
18. 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.
19. 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
20. 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.