DatabaseMetaData

attributeNoNulls

short attributeNoNulls

Indicates that NULL values might not be allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

Constant Value: 0 (0x00000000)

attributeNullable

short attributeNullable

Indicates that NULL values are definitely allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.

Constant Value: 1 (0x00000001)

attributeNullableUnknown

short attributeNullableUnknown

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.

Constant Value: 2 (0x00000002)

bestRowNotPseudo

int bestRowNotPseudo

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.

Constant Value: 1 (0x00000001)

bestRowPseudo

int bestRowPseudo

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.

Constant Value: 2 (0x00000002)

bestRowSession

int bestRowSession

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.

Constant Value: 2 (0x00000002)

bestRowTemporary

int bestRowTemporary

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.

Constant Value: 0 (0x00000000)

bestRowTransaction

int bestRowTransaction

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.

Constant Value: 1 (0x00000001)

bestRowUnknown

int bestRowUnknown

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.

Constant Value: 0 (0x00000000)

columnNoNulls

int columnNoNulls

Indicates that the column might not allow NULL values.

A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

Constant Value: 0 (0x00000000)

columnNullable

int columnNullable

Indicates that the column definitely allows NULL values.

A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

Constant Value: 1 (0x00000001)

columnNullableUnknown

int columnNullableUnknown

Indicates that the nullability of columns is unknown.

A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.

Constant Value: 2 (0x00000002)

functionColumnIn

int functionColumnIn

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.

Constant Value: 1 (0x00000001)

functionColumnInOut

int functionColumnInOut

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.

Constant Value: 2 (0x00000002)

functionColumnOut

int functionColumnOut

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.

Constant Value: 3 (0x00000003)

functionColumnResult

int functionColumnResult

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.

Constant Value: 5 (0x00000005)

functionColumnUnknown

int functionColumnUnknown

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.

Constant Value: 0 (0x00000000)

functionNoNulls

int functionNoNulls

Indicates that NULL values are not allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.

Constant Value: 0 (0x00000000)

functionNoTable

int functionNoTable

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.

Constant Value: 1 (0x00000001)

functionNullable

int functionNullable

Indicates that NULL values are allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.

Constant Value: 1 (0x00000001)

functionNullableUnknown

int functionNullableUnknown

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.

Constant Value: 2 (0x00000002)

functionResultUnknown

int functionResultUnknown

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.

Constant Value: 0 (0x00000000)

functionReturn

int functionReturn

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.

Constant Value: 4 (0x00000004)

functionReturnsTable

int functionReturnsTable

Indicates that the function returns a table.

A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.

Constant Value: 2 (0x00000002)

importedKeyCascade

int importedKeyCascade

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.

Constant Value: 0 (0x00000000)

importedKeyInitiallyDeferred

int importedKeyInitiallyDeferred

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.

Constant Value: 5 (0x00000005)

importedKeyInitiallyImmediate

int importedKeyInitiallyImmediate

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.

Constant Value: 6 (0x00000006)

importedKeyNoAction

int importedKeyNoAction

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.

Constant Value: 3 (0x00000003)

importedKeyNotDeferrable

int importedKeyNotDeferrable

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.

Constant Value: 7 (0x00000007)

importedKeyRestrict

int importedKeyRestrict

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.

Constant Value: 1 (0x00000001)

importedKeySetDefault

int importedKeySetDefault

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.

Constant Value: 4 (0x00000004)

importedKeySetNull

int importedKeySetNull

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.

Constant Value: 2 (0x00000002)

procedureColumnIn

int procedureColumnIn

Indicates that the column stores IN parameters.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 1 (0x00000001)

procedureColumnInOut

int procedureColumnInOut

Indicates that the column stores INOUT parameters.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 2 (0x00000002)

procedureColumnOut

int procedureColumnOut

Indicates that the column stores OUT parameters.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 4 (0x00000004)

procedureColumnResult

int procedureColumnResult

Indicates that the column stores results.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 3 (0x00000003)

procedureColumnReturn

int procedureColumnReturn

Indicates that the column stores return values.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 5 (0x00000005)

procedureColumnUnknown

int procedureColumnUnknown

Indicates that type of the column is unknown.

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.

Constant Value: 0 (0x00000000)

procedureNoNulls

int procedureNoNulls

Indicates that NULL values are not allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

Constant Value: 0 (0x00000000)

procedureNoResult

int procedureNoResult

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.

Constant Value: 1 (0x00000001)

procedureNullable

int procedureNullable

Indicates that NULL values are allowed.

A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.

Constant Value: 1 (0x00000001)

procedureNullableUnknown

int procedureNullableUnknown

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.

Constant Value: 2 (0x00000002)

procedureResultUnknown

int procedureResultUnknown

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.

Constant Value: 0 (0x00000000)

procedureReturnsResult

int procedureReturnsResult

Indicates that the procedure returns a result.

A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.

Constant Value: 2 (0x00000002)

sqlStateSQL

int sqlStateSQL

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.

Constant Value: 2 (0x00000002)

sqlStateSQL99

int sqlStateSQL99

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.

Constant Value: 2 (0x00000002)

sqlStateXOpen

int sqlStateXOpen

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.

Constant Value: 1 (0x00000001)

tableIndexClustered

short tableIndexClustered

Indicates that this table index is a clustered index.

A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

Constant Value: 1 (0x00000001)

tableIndexHashed

short tableIndexHashed

Indicates that this table index is a hashed index.

A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.

Constant Value: 2 (0x00000002)

tableIndexOther

short tableIndexOther

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.

Constant Value: 3 (0x00000003)

tableIndexStatistic

short tableIndexStatistic

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.

Constant Value: 0 (0x00000000)

typeNoNulls

int typeNoNulls

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.

Constant Value: 0 (0x00000000)

typeNullable

int typeNullable

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.

Constant Value: 1 (0x00000001)

typeNullableUnknown

int typeNullableUnknown

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.

Constant Value: 2 (0x00000002)

typePredBasic

int typePredBasic

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.

Constant Value: 2 (0x00000002)

typePredChar

int typePredChar

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.

Constant Value: 1 (0x00000001)

typePredNone

int typePredNone

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.

Constant Value: 0 (0x00000000)

typeSearchable

int typeSearchable

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.

Constant Value: 3 (0x00000003)

versionColumnNotPseudo

int versionColumnNotPseudo

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.

Constant Value: 1 (0x00000001)

versionColumnPseudo

int versionColumnPseudo

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.

Constant Value: 2 (0x00000002)

versionColumnUnknown

int versionColumnUnknown

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.

Constant Value: 0 (0x00000000)

allProceduresAreCallable

boolean allProceduresAreCallable ()

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

allTablesAreSelectable

boolean allTablesAreSelectable ()

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

autoCommitFailureClosesAllResultSets

boolean autoCommitFailureClosesAllResultSets ()

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

boolean dataDefinitionCausesTransactionCommit ()

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

dataDefinitionIgnoredInTransactions

boolean dataDefinitionIgnoredInTransactions ()

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

deletesAreDetected

boolean deletesAreDetected (int type)

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

boolean doesMaxRowSizeIncludeBlobs ()

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

getAttributes

ResultSet getAttributes (String catalog, 
                String schemaPattern, 
                String typeNamePattern, 
                String attributeNamePattern)

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

ResultSet getBestRowIdentifier (String catalog, 
                String schema, 
                String table, 
                int scope, 
                boolean nullable)

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

String getCatalogSeparator ()

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

getCatalogTerm

String getCatalogTerm ()

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

getCatalogs

ResultSet getCatalogs ()

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

ResultSet getClientInfoProperties ()

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

ResultSet getColumnPrivileges (String catalog, 
                String schema, 
                String table, 
                String columnNamePattern)

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

ResultSet getColumns (String catalog, 
                String schemaPattern, 
                String tableNamePattern, 
                String columnNamePattern)

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

Connection getConnection ()

Retrieves the connection that produced this metadata object.

getCrossReference

ResultSet getCrossReference (String parentCatalog, 
                String parentSchema, 
                String parentTable, 
                String foreignCatalog, 
                String foreignSchema, 
                String foreignTable)

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

int getDatabaseMajorVersion ()

Retrieves the major version number of the underlying database.

getDatabaseMinorVersion

int getDatabaseMinorVersion ()

Retrieves the minor version number of the underlying database.

getDatabaseProductName

String getDatabaseProductName ()

Retrieves the name of this database product.

getDatabaseProductVersion

String getDatabaseProductVersion ()

Retrieves the version number of this database product.

getDefaultTransactionIsolation

int getDefaultTransactionIsolation ()

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

getDriverMajorVersion

int getDriverMajorVersion ()

Retrieves this JDBC driver's major version number.

getDriverMinorVersion

int getDriverMinorVersion ()

Retrieves this JDBC driver's minor version number.

getDriverName

String getDriverName ()

Retrieves the name of this JDBC driver.

getDriverVersion

String getDriverVersion ()

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

getExportedKeys

ResultSet getExportedKeys (String catalog, 
                String schema, 
                String table)

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

String getExtraNameCharacters ()

Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

getFunctionColumns

ResultSet getFunctionColumns (String catalog, 
                String schemaPattern, 
                String functionNamePattern, 
                String columnNamePattern)

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

ResultSet getFunctions (String catalog, 
                String schemaPattern, 
                String functionNamePattern)

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

String getIdentifierQuoteString ()

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

getImportedKeys

ResultSet getImportedKeys (String catalog, 
                String schema, 
                String table)

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

ResultSet getIndexInfo (String catalog, 
                String schema, 
                String table, 
                boolean unique, 
                boolean approximate)

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

int getJDBCMajorVersion ()

Retrieves the major JDBC version number for this driver.

getJDBCMinorVersion

int getJDBCMinorVersion ()

Retrieves the minor JDBC version number for this driver.

getMaxBinaryLiteralLength

int getMaxBinaryLiteralLength ()

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

getMaxCatalogNameLength

int getMaxCatalogNameLength ()

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

getMaxCharLiteralLength

int getMaxCharLiteralLength ()

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

getMaxColumnNameLength

int getMaxColumnNameLength ()

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

getMaxColumnsInGroupBy

int getMaxColumnsInGroupBy ()

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

getMaxColumnsInIndex

int getMaxColumnsInIndex ()

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

getMaxColumnsInOrderBy

int getMaxColumnsInOrderBy ()

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

getMaxColumnsInSelect

int getMaxColumnsInSelect ()

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

getMaxColumnsInTable

int getMaxColumnsInTable ()

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

getMaxConnections

int getMaxConnections ()

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

getMaxCursorNameLength

int getMaxCursorNameLength ()

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

getMaxIndexLength

int getMaxIndexLength ()

Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

getMaxProcedureNameLength

int getMaxProcedureNameLength ()

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

getMaxRowSize

int getMaxRowSize ()

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

getMaxSchemaNameLength

int getMaxSchemaNameLength ()

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

getMaxStatementLength

int getMaxStatementLength ()

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

getMaxStatements

int getMaxStatements ()

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

getMaxTableNameLength

int getMaxTableNameLength ()

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

getMaxTablesInSelect

int getMaxTablesInSelect ()

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

getMaxUserNameLength

int getMaxUserNameLength ()

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

getNumericFunctions

String getNumericFunctions ()

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

ResultSet getPrimaryKeys (String catalog, 
                String schema, 
                String table)

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

ResultSet getProcedureColumns (String catalog, 
                String schemaPattern, 
                String procedureNamePattern, 
                String columnNamePattern)

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.

getProcedureTerm

String getProcedureTerm ()

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

getProcedures

ResultSet getProcedures (String catalog, 
                String schemaPattern, 
                String procedureNamePattern)

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:

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. reserved for future use
5. reserved for future use
6. reserved for future use
7. REMARKS String => explanatory comment on the procedure
8. 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
9. 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

getResultSetHoldability

int getResultSetHoldability ()

Retrieves this database's default holdability for ResultSet objects.

getRowIdLifetime

RowIdLifetime getRowIdLifetime ()

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)
 

getSQLKeywords

String getSQLKeywords ()

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

getSQLStateType

int getSQLStateType ()

Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

getSchemaTerm

String getSchemaTerm ()

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

getSchemas

ResultSet getSchemas (String catalog, 
                String schemaPattern)

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

1. TABLE_SCHEM String => schema name
2. TABLE_CATALOG String => catalog name (may be null)

getSchemas

ResultSet getSchemas ()

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

1. TABLE_SCHEM String => schema name
2. TABLE_CATALOG String => catalog name (may be null)

getSearchStringEscape

String getSearchStringEscape ()

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.

getStringFunctions

String getStringFunctions ()

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.

getSuperTables

ResultSet getSuperTables (String catalog, 
                String schemaPattern, 
                String tableNamePattern)

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:

1. TABLE_CAT String => the type's catalog (may be null)
2. TABLE_SCHEM String => type's schema (may be null)
3. TABLE_NAME String => type name
4. SUPERTABLE_NAME String => the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

getSuperTypes

ResultSet getSuperTypes (String catalog, 
                String schemaPattern, 
                String typeNamePattern)

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:

1. TYPE_CAT String => the UDT's catalog (may be null)
2. TYPE_SCHEM String => UDT's schema (may be null)
3. TYPE_NAME String => type name of the UDT
4. SUPERTYPE_CAT String => the direct super type's catalog (may be null)
5. SUPERTYPE_SCHEM String => the direct super type's schema (may be null)
6. SUPERTYPE_NAME String => the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

getSystemFunctions

String getSystemFunctions ()

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.

getTablePrivileges

ResultSet getTablePrivileges (String catalog, 
                String schemaPattern, 
                String tableNamePattern)

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:

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. GRANTOR String => grantor of access (may be null)
5. GRANTEE String => grantee of access
6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

getTableTypes

ResultSet getTableTypes ()

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

The table type is:

1. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

getTables

ResultSet getTables (String catalog, 
                String schemaPattern, 
                String tableNamePattern, 
                String[] types)

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:

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. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
5. REMARKS String => explanatory comment on the table
6. TYPE_CAT String => the types catalog (may be null)
7. TYPE_SCHEM String => the types schema (may be null)
8. TYPE_NAME String => type name (may be null)
9. SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
10. 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.

getTimeDateFunctions

String getTimeDateFunctions ()

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

getTypeInfo

ResultSet getTypeInfo ()

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:

1. TYPE_NAME String => Type name
2. DATA_TYPE int => SQL data type from java.sql.Types
3. PRECISION int => maximum precision
4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
6. CREATE_PARAMS String => parameters used in creating the type (may be null)
7. NULLABLE short => can you use NULL for this type.
   • typeNoNulls - does not allow NULL values
   • typeNullable - allows NULL values
   • typeNullableUnknown - nullability unknown
8. CASE_SENSITIVE boolean=> is it case sensitive.
9. 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 ..
10. UNSIGNED_ATTRIBUTE boolean => is it unsigned.
11. FIXED_PREC_SCALE boolean => can it be a money value.
12. AUTO_INCREMENT boolean => can it be used for an auto-increment value.
13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
14. MINIMUM_SCALE short => minimum scale supported
15. MAXIMUM_SCALE short => maximum scale supported
16. SQL_DATA_TYPE int => unused
17. SQL_DATETIME_SUB int => unused
18. 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.

getUDTs

ResultSet getUDTs (String catalog, 
                String schemaPattern, 
                String typeNamePattern, 
                int[] types)

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:

1. TYPE_CAT String => the type's catalog (may be null)
2. TYPE_SCHEM String => type's schema (may be null)
3. TYPE_NAME String => type name
4. CLASS_NAME String => Java class name
5. DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
6. REMARKS String => explanatory comment on the type
7. 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.

getURL

String getURL ()

Retrieves the URL for this DBMS.

getUserName

String getUserName ()

Retrieves the user name as known to this database.

getVersionColumns

ResultSet getVersionColumns (String catalog, 
                String schema, 
                String table)

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:

1. SCOPE short => is not used
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
5. COLUMN_SIZE int => precision
6. BUFFER_LENGTH int => length of column value in bytes
7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
8. 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.

insertsAreDetected

boolean insertsAreDetected (int type)

Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

isCatalogAtStart

boolean isCatalogAtStart ()

Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.

isReadOnly

boolean isReadOnly ()

Retrieves whether this database is in read-only mode.

locatorsUpdateCopy

boolean locatorsUpdateCopy ()

Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

nullPlusNonNullIsNull

boolean nullPlusNonNullIsNull ()

Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

nullsAreSortedAtEnd

boolean nullsAreSortedAtEnd ()

Retrieves whether NULL values are sorted at the end regardless of sort order.

nullsAreSortedAtStart

boolean nullsAreSortedAtStart ()

Retrieves whether NULL values are sorted at the start regardless of sort order.

nullsAreSortedHigh

boolean nullsAreSortedHigh ()

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.

nullsAreSortedLow

boolean nullsAreSortedLow ()

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.

othersDeletesAreVisible

boolean othersDeletesAreVisible (int type)

Retrieves whether deletes made by others are visible.

othersInsertsAreVisible

boolean othersInsertsAreVisible (int type)

Retrieves whether inserts made by others are visible.

othersUpdatesAreVisible

boolean othersUpdatesAreVisible (int type)

Retrieves whether updates made by others are visible.

ownDeletesAreVisible

boolean ownDeletesAreVisible (int type)

Retrieves whether a result set's own deletes are visible.

ownInsertsAreVisible

boolean ownInsertsAreVisible (int type)

Retrieves whether a result set's own inserts are visible.

ownUpdatesAreVisible

boolean ownUpdatesAreVisible (int type)

Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

storesLowerCaseIdentifiers

boolean storesLowerCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

storesLowerCaseQuotedIdentifiers

boolean storesLowerCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

storesMixedCaseIdentifiers

boolean storesMixedCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

storesMixedCaseQuotedIdentifiers

boolean storesMixedCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

storesUpperCaseIdentifiers

boolean storesUpperCaseIdentifiers ()

Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

storesUpperCaseQuotedIdentifiers

boolean storesUpperCaseQuotedIdentifiers ()

Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

supportsANSI92EntryLevelSQL

boolean supportsANSI92EntryLevelSQL ()

Retrieves whether this database supports the ANSI92 entry level SQL grammar.

supportsANSI92FullSQL

boolean supportsANSI92FullSQL ()

Retrieves whether this database supports the ANSI92 full SQL grammar supported.

supportsANSI92IntermediateSQL

boolean supportsANSI92IntermediateSQL ()

Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

supportsAlterTableWithAddColumn

boolean supportsAlterTableWithAddColumn ()

Retrieves whether this database supports ALTER TABLE with add column.

supportsAlterTableWithDropColumn

boolean supportsAlterTableWithDropColumn ()

Retrieves whether this database supports ALTER TABLE with drop column.

supportsBatchUpdates

boolean supportsBatchUpdates ()

Retrieves whether this database supports batch updates.

supportsCatalogsInDataManipulation

boolean supportsCatalogsInDataManipulation ()

Retrieves whether a catalog name can be used in a data manipulation statement.

supportsCatalogsInIndexDefinitions

boolean supportsCatalogsInIndexDefinitions ()

Retrieves whether a catalog name can be used in an index definition statement.

supportsCatalogsInPrivilegeDefinitions

boolean supportsCatalogsInPrivilegeDefinitions ()

Retrieves whether a catalog name can be used in a privilege definition statement.

supportsCatalogsInProcedureCalls

boolean supportsCatalogsInProcedureCalls ()

Retrieves whether a catalog name can be used in a procedure call statement.

supportsCatalogsInTableDefinitions

boolean supportsCatalogsInTableDefinitions ()

Retrieves whether a catalog name can be used in a table definition statement.

supportsColumnAliasing

boolean supportsColumnAliasing ()

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.

supportsConvert

boolean supportsConvert (int fromType, 
                int toType)

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.

supportsConvert

boolean supportsConvert ()

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.

supportsCoreSQLGrammar

boolean supportsCoreSQLGrammar ()

Retrieves whether this database supports the ODBC Core SQL grammar.

supportsCorrelatedSubqueries

boolean supportsCorrelatedSubqueries ()

Retrieves whether this database supports correlated subqueries.

supportsDataDefinitionAndDataManipulationTransactions

boolean supportsDataDefinitionAndDataManipulationTransactions ()

Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

supportsDataManipulationTransactionsOnly

boolean supportsDataManipulationTransactionsOnly ()

Retrieves whether this database supports only data manipulation statements within a transaction.

supportsDifferentTableCorrelationNames

boolean supportsDifferentTableCorrelationNames ()

Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

supportsExpressionsInOrderBy

boolean supportsExpressionsInOrderBy ()

Retrieves whether this database supports expressions in ORDER BY lists.

supportsExtendedSQLGrammar

boolean supportsExtendedSQLGrammar ()

Retrieves whether this database supports the ODBC Extended SQL grammar.

supportsFullOuterJoins

boolean supportsFullOuterJoins ()

Retrieves whether this database supports full nested outer joins.

supportsGetGeneratedKeys

boolean supportsGetGeneratedKeys ()

Retrieves whether auto-generated keys can be retrieved after a statement has been executed

supportsGroupBy

boolean supportsGroupBy ()

Retrieves whether this database supports some form of GROUP BY clause.

supportsGroupByBeyondSelect

boolean supportsGroupByBeyondSelect ()

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.

supportsGroupByUnrelated

boolean supportsGroupByUnrelated ()

Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

supportsIntegrityEnhancementFacility

boolean supportsIntegrityEnhancementFacility ()

Retrieves whether this database supports the SQL Integrity Enhancement Facility.

supportsLikeEscapeClause

boolean supportsLikeEscapeClause ()

Retrieves whether this database supports specifying a LIKE escape clause.

supportsLimitedOuterJoins

boolean supportsLimitedOuterJoins ()

Retrieves whether this database provides limited support for outer joins. (This will be true if the method supportsFullOuterJoins returns true).