Java Doc for DatabaseMetaData.java in  » 6.0-JDK-Core » sql » java » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBC^TM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.

A user for this interface is commonly a tool that needs to discover how to deal with the underlying DBMS. This is especially true for applications that are intended to be used with more than one DBMS. For example, a tool might use the method getTypeInfo to find out what data types can be used in a CREATE TABLE statement. Or a user might call the method supportsCorrelatedSubqueries to see if it is possible to use a correlated subquery or supportsBatchUpdates to see if it is possible to use batch updates.

Some DatabaseMetaData methods return lists of information in the form of ResultSet objects. Regular ResultSet methods, such as getString and getInt, can be used to retrieve the data from these ResultSet objects. If a given form of metadata is not available, an empty ResultSet will be returned. Additional columns beyond the columns defined to be returned by the ResultSet object for a given method can be defined by the JDBC driver vendor and must be accessed by their column label.

Some DatabaseMetaData methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to null, that argument's criterion will be dropped from the search.

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

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

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

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

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

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

Note:This constant remains only for compatibility reasons.

Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria.

Only privileges matching the column name criteria are returned.

Only column descriptions matching the catalog, schema, table and column name criteria are returned.

Only descriptions matching the schema, function and parameter name criteria are returned.

Only system and user function descriptions matching the schema and function name criteria are returned.

Only descriptions matching the schema, procedure and parameter name criteria are returned.

Only procedure descriptions matching the schema and procedure name criteria are returned.

Only supertable information for tables matching the catalog, schema and table name are returned.

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

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

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

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.

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

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

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

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
since:
   1.6

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
since:
   1.6

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
since:
   1.6

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
since:
   1.6

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

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

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

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

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

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

A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
since:
   1.6

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

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

A possible value for the columns UPDATE_RULE and DELETE_RULE in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.

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

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

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

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

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

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

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

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

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

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

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

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

since:
   1.6

Note:This constant remains only for compatibility reasons. Developers should use the constant sqlStateSQL instead.
since:
   1.4

since:
   1.4

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

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

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

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

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

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

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

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.

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)

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.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  table - a table name; must match the table name as it is stored in the database
Parameters:
  scope - the scope of interest; use same values as SCOPE
Parameters:
  nullable - include columns that are nullable. ResultSet - each row is a column description
exception:
  SQLException - if a database access error occurs

The catalog column is:

1. TABLE_CAT String => catalog name

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

A ResultSet object; each row is a supported client infoproperty

exception:
  SQLException - if a database access error occurs

since:
   1.6

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

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 parameter can include NULLs
    • NO --- if the parameter cannot include NULLs
    • empty string --- if the nullability for the parameter is unknown
19. SCOPE_CATLOG 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 attribure (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 parameter is unknown

The COLUMN_SIZE column the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  tableNamePattern - a table name pattern; must match thetable name as it is stored in the database
Parameters:
  columnNamePattern - a column name pattern; must match the columnname as it is stored in the database ResultSet - each row is a column description
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   

the connection that produced this metadata object
exception:
  SQLException - if a database access error occurs
since:
   1.2

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

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

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.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  functionNamePattern - a procedure name pattern; must match thefunction name as it is stored in the database
Parameters:
  columnNamePattern - a parameter name pattern; must match the parameter or column name as it is stored in the database ResultSet - each row describes a user function parameter, column or return type
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   
since:
   1.6

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
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  functionNamePattern - a function name pattern; must match thefunction name as it is stored in the database ResultSet - each row is a function description
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   
since:
   1.6

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

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)

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)

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 parameter can include NULLs
    • NO --- if the parameter cannot include NULLs
    • empty string --- if the nullability for the parameter 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.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  procedureNamePattern - a procedure name pattern; must match theprocedure name as it is stored in the database
Parameters:
  columnNamePattern - a column name pattern; must match the column nameas it is stored in the database ResultSet - each row describes a stored procedure parameter or column
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   

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
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  procedureNamePattern - a procedure name pattern; must match theprocedure name as it is stored in the database ResultSet - each row is a procedure description
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   

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)
 

The schema columns are:

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

The schema columns are:

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

The '_' character represents any single character; the '%' character represents any sequence of zero or more characters. the string used to escape wildcard characters
exception:
  SQLException - if a database access error occurs

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.
Parameters:
  catalog - a catalog name; "" retrieves those without a catalog;null means drop catalog name from the selection criteria
Parameters:
  schemaPattern - a schema name pattern; "" retrieves those without a schema
Parameters:
  tableNamePattern - a table name pattern; may be a fully-qualifiedname a ResultSet object in which each row is a type description
throws:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   
since:
   1.4

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.
Parameters:
  catalog - a catalog name; "" retrieves those without a catalog;null means drop catalog name from the selection criteria
Parameters:
  schemaPattern - a schema name pattern; "" retrieves those without a schema
Parameters:
  typeNamePattern - a UDT name pattern; may be a fully-qualifiedname a ResultSet object in which a row gives informationabout the designated UDT
throws:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   
since:
   1.4

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

The table type is:

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

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.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  tableNamePattern - a table name pattern; must match thetable name as it is stored in the database
Parameters:
  types - a list of table types, which must be from the list of table types returned from DatabaseMetaData.getTableTypes,to include; null returnsall types ResultSet - each row is a table description
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   

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. a ResultSet object in which each row is an SQL type description
exception:
  SQLException - if a database access error occurs

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.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schemaPattern - a schema pattern name; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  typeNamePattern - a type name pattern; must match the type nameas it is stored in the database; may be a fully qualified name
Parameters:
  types - a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include; null returns all types ResultSet object in which each row describes a UDT
exception:
  SQLException - if a database access error occurs
See Also:   DatabaseMetaData.getSearchStringEscape
See Also:   
since:
   1.2

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.
Parameters:
  catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be used to narrowthe search
Parameters:
  schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without a schema;null means that the schema name should not be used to narrowthe search
Parameters:
  table - a table name; must match the table name as it is stored in the database a ResultSet object in which each row is a column description
exception:
  SQLException - if a database access error occurs