Java Doc for DatabaseMetaData.java in  » Apache-Harmony-Java-SE » java-package » java » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This interface is implemented by JDBC driver writers in order to provide information about the underlying Database capabilities and the JDBC driver capabilities taken together.

Some of the methods in this interface take String parameters which are Patterns. Within these string Patterns, '%' and '_' characters have special meanings. '%' means "match any substring of 0 or more characters". '_' means "match any one character". Only metadata entries that match the pattern are returned. If such a search pattern string is set to null, that argument's criteria are dropped from the search.

The descriptions are returned as a ResultSet conforming to the following data layout, with one row per table column:

1. TABLE_CAT - String - Catalog name (possibly null)
2. TABLE_SCHEM - String - Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. COLUMN_NAME - String - The Column name
5. DATA_TYPE - int - The SQL type as specified in java.sql.Types
6. TYPE_NAME - String - Name for the data type, depends on database, UDT names are fully qualified
7. COLUMN_SIZE - int - Column size - the precision for numeric types, max characters for char and date types
8. BUFFER_LENGTH - int - Not used
9. DECIMAL_DIGITS - int - maximum number of fractional digits
10. NUM_PREC_RADIX - int - the Radix
11. NULLABLE - int - does the column allow nulls:
    • DatabaseMetaData.columnNoNulls = may not allow NULLs
    • DatabaseMetaData.columnNullable = does allow NULLs
    • DatabaseMetaData.columnNullableUnknown = unknown NULL status
12. REMARKS - String - A description of the column (possibly null)
13. COLUMN_DEF - String - Default value for the column (possibly null)
14. SQL_DATA_TYPE - int - not used
15. SQL_DATETIME_SUB - int - not used
16. CHAR_OCTET_LENGTH - int - maximum number of bytes in the char type columns
17. ORDINAL_POSITION - int - Column index in the table (1 based)
18. IS_NULLABLE - String - "NO" = column does not allow NULLs, "YES" = column allows NULLs "" = NULL status unknown
19. SCOPE_CATALOG - String - Catalog for table, SCOPE of Reference attribute.

The list is returned as a ResultSet with a row for each of the foreign key columns, ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ, with the format for each row being:

1. PKTABLE_CAT - String - primary key table : Catalog (possibly null)
2. PKTABLE_SCHEM - String - primary key table : Schema (possibly 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 name being exported (possibly null)
6. FKTABLE_SCHEM - String - foreign key table : Schema name being exported (possibly 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 in the foreign key
10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - the deletion should also delete rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - it should set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - deletion sets the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
12. FK_NAME - String - foreign key name (possibly null)
13. PK_NAME - String - primary key name (possibly null)
14. DEFERRABILITY - short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

The list returned is a ResultSet with a row entry for each primary key column, ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ, with the following format:

1. PKTABLE_CAT - String - primary key Catalog name being imported (possibly null)
2. PKTABLE_SCHEM - String - primary key Schema name being imported (possibly 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 name (possibly null)
6. FKTABLE_SCHEM - String - foreign key table Schema name (possibly null)
7. FKTABLE_NAME - String - foreign key table name
8. FKCOLUMN_NAME - String - foreign key column name
9. KEY_SEQ - short - sequence number in the foreign key
10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - delete those rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
12. FK_NAME - String - foreign key name (possibly null)
13. PK_NAME - String - primary key name (possibly null)
14. DEFERRABILITY - short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

The list is returned as a ResultSet, with one row for each index or statistic.

The list is returned as a ResultSet with one row for each primary key column, ordered by COLUMN_NAME, with each row having the structure as follows:

1. TABLE_CAT - String - table catalog name (possibly null)
2. TABLE_SCHEM - String - Table Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. COLUMN_NAME - String - The Column name
5. KEY_SEQ - short - the sequence number for this column in the primary key
6. PK_NAME - String - the primary key name (possibly null)

The list is returned as a ResultSet with one row for each parameter or result column.

The list is returned as a ResultSet with one row for each stored procedure, ordered by PROCEDURE_SCHEME and PROCEDURE_NAME, with the data in each row as follows:

1. PROCEDURE_CAT - String : the procedure catalog name
2. PROCEDURE_SCHEM - String : the procedure schema name (possibly null)
3. PROCEDURE_NAME - String : the procedure name
4. Reserved
5. Reserved
6. Reserved
7. REMARKS - String - information about the procedure
8. PROCEDURE_TYPE - short : one of:
   • DatabaseMetaData.procedureResultUnknown - procedure may return a result
   • DatabaseMetaData.procedureNoResult - procedure does not return a result
   • DatabaseMetaData.procedureReturnsResult - procedure definitely returns a result

The listing only contains entries for tables that have a super table. Super and sub tables must be defined in the same Catalog and Schema.

The list is returned as a ResultSet with one row per table type, ordered by the table type.

The descriptions are returned as rows in a ResultSet, one row for each Table.

The types matching the supplied the specified Catalog, Schema, Type Name and Type are returned as rows in a ResultSet with columns of information as follows:

1. TABLE_CAT - String - Catalog name (possibly null)
2. TABLE_SCHEM - String - Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. CLASS_NAME - String - The Java class name
5. DATA_TYPE - int - The SQL type as specified in java.sql.Types.

The result is laid-out in the following columns:

1. SCOPE - short - not used
2. COLUMN_NAME - String - Column name
3. DATA_TYPE - int - The SQL data type, as defined in java.sql.Types
4. TYPE_NAME - String - The SQL type name, data source dependent
5. COLUMN_SIZE - int - Precision for numeric types
6. BUFFER_LENGTH - int - Length of a column value in bytes
7. DECIMAL_DIGITS - short - Number of digits after the decimal point
8. PSEUDO_COLUMN - short - If this is a pseudo-column (for example, an Oracle ROWID):
   • DatabaseMetaData.bestRowUnknown - don't know whether this is a pseudo column
   • DatabaseMetaData.bestRowNotPseudo - column is not pseudo
   • DatabaseMetaData.bestRowPseudo - column is a pseudo column

The returned ResultSet object has rows with the following column names and meanings:

1. TYPE_CAT - String - the Type Catalog name (possibly null)
2. TYPE_SCHEM - String - the Type Schema name (possibly null)
3. TYPE_NAME - String - the Type name
4. ATTR_NAME - String - the Attribute name
5. DATA_TYPE - int - the Attribute type as defined in java.sql.Types
6. ATTR_TYPE_NAME - String - the Attribute type name. This depends on the data source. For a UDT the name is fully qualified. For a REF it is both fully qualified and represents the target type of the reference.
7. ATTR_SIZE - int - the Column size. When referring to char and date types this value is the maximum number of characters. When referring to numeric types is is the precision.
8. DECIMAL_DIGITS - int - how many fractional digits are supported
9. NUM_PREC_RADIX - int - numeric values radix
10. NULLABLE - int - whether NULL is permitted:
    • DatabaseMetaData.attributeNoNulls - might not allow NULLs
    • DatabaseMetaData.attributeNullable - NULLs definitely permitted
    • DatabaseMetaData.attributeNullableUnknown - unknown
11. REMARKS - String - A comment describing the attribute (possibly null)
12. ATTR_DEF - String - Default value for the attribute (possibly null)
13. SQL_DATA_TYPE - int - not used
14. SQL_DATETIME_SUB - int - not used
15. CHAR_OCTET_LENGTH - int - For CHAR types, the max number of bytes in the column
16. ORDINAL_POSITION - int - The Index of the column in the Table (based on 1)
17. IS_NULLABLE - String - "NO" = column does not allow NULLs, "YES" = column allows NULLs "" = NULL status unknown
18. SCOPE_CATALOG - String - Catalog for table, SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
19. SCOPE_SCHEMA - String - Schema for table, SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
20. SCOPE_TABLE - String - Table name for SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
21. SOURCE_DATA_TYPE - String - The source type for user generated REF type or for a Distinct type. (NULL if DATA_TYPE is not DISTINCT or user generated REF)

The results are returned as a table, with one entry for each column, as follows:

1. SCOPE - short - the SCOPE of the result, as follows:
   • DatabaseMetaData.bestRowTemporary - very temporary, while using row
   • DatabaseMetaData.bestRowTransaction - good for remainder of current transaction
   • DatabaseMetaData.bestRowSession - good for remainder of database session
2. COLUMN_NAME - String - the column name
3. DATA_TYPE - int - the Type of the data, as defined in java.sql.Types
4. TYPE_NAME - String - Name of the type - database dependent. For UDT types the name is fully qualified
5. COLUMN_SIZE - int - The precision of the data in the column
6. BUFFER_LENGTH - int - not used
7. DECIMAL_DIGITS - short - number of fractional digits
8. PSEUDO_COLUMN - short - whether this is a pseudo column eg. and Oracle ROWID:
   • DatabaseMetaData.bestRowUnknown - don't know whether this is a pseudo column
   • DatabaseMetaData.bestRowNotPseudo - column is not pseudo
   • DatabaseMetaData.bestRowPseudo - column is a pseudo column

The description is returned as a ResultSet with rows of data for each access right, with columns as follows:

1. TABLE_CAT - String - Catalog name (possibly null)
2. TABLE_SCHEM - String - Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. COLUMN_NAME - String - The Column name
5. GRANTOR - String - The grantor of access (possibly null)
6. PRIVILEGE - String - Access right - one of SELECT, INSERT, UPDATE, REFERENCES,...
7. IS_GRANTABLE - String - "YES" implies that the receiver can grant access to others, "NO" if the receiver cannot grant access to others, null if unknown.

The descriptions are returned as a ResultSet conforming to the following data layout, with one row per table column:

1. TABLE_CAT - String - Catalog name (possibly null)
2. TABLE_SCHEM - String - Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. COLUMN_NAME - String - The Column name
5. DATA_TYPE - int - The SQL type as specified in java.sql.Types
6. TYPE_NAME - String - Name for the data type, depends on database, UDT names are fully qualified
7. COLUMN_SIZE - int - Column size - the precision for numeric types, max characters for char and date types
8. BUFFER_LENGTH - int - Not used
9. DECIMAL_DIGITS - int - maximum number of fractional digits
10. NUM_PREC_RADIX - int - the Radix
11. NULLABLE - int - does the column allow nulls:
    • DatabaseMetaData.columnNoNulls = may not allow NULLs
    • DatabaseMetaData.columnNullable = does allow NULLs
    • DatabaseMetaData.columnNullableUnknown = unknown NULL status
12. REMARKS - String - A description of the column (possibly null)
13. COLUMN_DEF - String - Default value for the column (possibly null)
14. SQL_DATA_TYPE - int - not used
15. SQL_DATETIME_SUB - int - not used
16. CHAR_OCTET_LENGTH - int - maximum number of bytes in the char type columns
17. ORDINAL_POSITION - int - Column index in the table (1 based)
18. IS_NULLABLE - String - "NO" = column does not allow NULLs, "YES" = column allows NULLs "" = NULL status unknown
19. SCOPE_CATALOG - String - Catalog for table, SCOPE of Reference attribute. NULL if DATA_TYPE is not REF.
20. SCOPE_SCHEMA - String - Schema for table, scope of Reference attribute. NULL if DATA_TYPE is not REF.
21. SCOPE_TABLE - String - Table name for scope of Reference attribute. NULL if DATA_TYPE is not REF.
22. SOURCE_DATA_TYPE - String - The source type for user generated REF type or for a Distinct type. (NULL if DATA_TYPE is not DISTINCT or user generated REF)

The descriptions are returned as a ResultSet with one row for each Foreign key, with the following layout:

1. PKTABLE_CAT - String - from the primary key table : Catalog (possibly null)
2. PKTABLE_SCHEM - String - from the primary key table : Schema (possibly null)
3. PKTABLE_NAME - String - primary key table : name
4. PKCOLUMN_NAME - String - primary key column : name
5. FKTABLE_CAT - String - from the foreign key table : the catalog name being exported (possibly null)
6. FKTABLE_SCHEM - String - foreign key table : Schema name being exported (possibly null)
7. FKTABLE_NAME - String - foreign key table : the name being exported
8. FKCOLUMN_NAME - String - foreign key column : the name being exported
9. KEY_SEQ - short - sequence number (in the foreign key)
10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - delete those rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
12. FK_NAME - String - foreign key name (possibly null)
13. PK_NAME - String - primary key name (possibly null)
14. DEFERRABILITY - short - can foreign key constraints be deferred until commit (see SQL92 specification for definitions)?:
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

The list is returned as a ResultSet with a row for each of the foreign key columns, ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ, with the format for each row being:

1. PKTABLE_CAT - String - primary key table : Catalog (possibly null)
2. PKTABLE_SCHEM - String - primary key table : Schema (possibly 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 name being exported (possibly null)
6. FKTABLE_SCHEM - String - foreign key table : Schema name being exported (possibly 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 in the foreign key
10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - the deletion should also delete rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - it should set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - deletion sets the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
12. FK_NAME - String - foreign key name (possibly null)
13. PK_NAME - String - primary key name (possibly null)
14. DEFERRABILITY - short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

The list returned is a ResultSet with a row entry for each primary key column, ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ, with the following format:

1. PKTABLE_CAT - String - primary key Catalog name being imported (possibly null)
2. PKTABLE_SCHEM - String - primary key Schema name being imported (possibly 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 name (possibly null)
6. FKTABLE_SCHEM - String - foreign key table Schema name (possibly null)
7. FKTABLE_NAME - String - foreign key table name
8. FKCOLUMN_NAME - String - foreign key column name
9. KEY_SEQ - short - sequence number in the foreign key
10. UPDATE_RULE - short - how to treat foreign key when primary key is updated:
    • DatabaseMetaData.importedKeyNoAction - don't allow update of primary key if imported
    • DatabaseMetaData.importedKeyCascade - change imported key to match the primary key update
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
11. DELETE_RULE - short - how to treat foreign key when primary key is deleted:
    • DatabaseMetaData.importedKeyNoAction - don't allow delete of primary key if imported
    • DatabaseMetaData.importedKeyCascade - delete those rows that import a deleted key
    • DatabaseMetaData.importedKeySetNull - set the imported key to null
    • DatabaseMetaData.importedKeySetDefault - set the imported key to default values
    • DatabaseMetaData.importedKeyRestrict - same as importedKeyNoAction
12. FK_NAME - String - foreign key name (possibly null)
13. PK_NAME - String - primary key name (possibly null)
14. DEFERRABILITY - short - defines whether foreign key constraints can be deferred until commit (see SQL92 specification for definitions):
    • DatabaseMetaData.importedKeyInitiallyDeferred
    • DatabaseMetaData.importedKeyInitiallyImmediate
    • DatabaseMetaData.importedKeyNotDeferrable

The list is returned as a ResultSet, with one row for each index or statistic. The list is ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION. Each row has the following format:

1. TABLE_CAT - String - table catalog name (possibly null)
2. TABLE_SCHEM - String - Table Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. NON_UNIQUE - boolean - true when index values can be non-unique. Must be false when TYPE is tableIndexStatistic
5. INDEX_QUALIFIER - String : index catalog name. null when TYPE is 'tableIndexStatistic'
6. INDEX_NAME - String : index name. null when TYPE is 'tableIndexStatistic'
7. TYPE - short - the index type. One of:
   • DatabaseMetaData.tableIndexStatistic - table statistics returned with Index descriptions
   • DatabaseMetaData.tableIndexClustered - a clustered Index
   • DatabaseMetaData.tableIndexHashed - a hashed Index
   • DatabaseMetaData.tableIndexOther - other style of Index
8. ORDINAL_POSITION - short - column sequence within Index. 0 when TYPE is tableIndexStatistic
9. COLUMN_NAME - String - the column name. null when TYPE is tableIndexStatistic
10. ASC_OR_DESC - String - column sort sequence. null if sequencing not supported or TYPE is tableIndexStatistic; otherwise "A" means sort ascending and "D" means sort descending.
11. CARDINALITY - int - Number of unique values in the Index. If TYPE is tableIndexStatistic, this is number of rows in the table.
12. PAGES - int - Number of pages for current Index. If TYPE is tableIndexStatistic, this is number of pages used for the table.
13. FILTER_CONDITION - String - Filter condition. (possibly null)

The list is returned as a ResultSet with one row for each primary key column, ordered by COLUMN_NAME, with each row having the structure as follows:

1. TABLE_CAT - String - table catalog name (possibly null)
2. TABLE_SCHEM - String - Table Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. COLUMN_NAME - String - The Column name
5. KEY_SEQ - short - the sequence number for this column in the primary key
6. PK_NAME - String - the primary key name (possibly null)

The list is returned as a ResultSet with one row for each parameter or result column. The data is ordered by PROCEDURE_SCHEM and PROCEDURE_NAME, while for each procedure, the return value (if any) is first, followed by the parameters in the order they appear in the stored procedure call, followed by ResultSet columns in column number order. Each row has the following structure:

1. PROCEDURE_CAT - String - the procedure catalog name
2. PROCEDURE_SCHEM - String - the procedure schema name (possibly null)
3. PROCEDURE_NAME - String - the procedure name
4. COLUMN_NAME - String - the name of the column
5. COLUMN_TYPE - short - the kind of column or parameter, as follows:
   • DatabaseMetaData.procedureColumnUnknown - type unknown
   • DatabaseMetaData.procedureColumnIn - an IN parameter
   • DatabaseMetaData.procedureColumnInOut - an INOUT parameter
   • DatabaseMetaData.procedureColumnOut - an OUT parameter
   • DatabaseMetaData.procedureColumnReturn - a return value
   • DatabaseMetaData.procedureReturnsResult - a result column in a result set
6. DATA_TYPE - int - the SQL type of the data, as in java.sql.Types
7. TYPE_NAME - String - the SQL type name, for a UDT it is fully qualified
8. PRECISION - int - the precision
9. LENGTH - int - the length of the data in bytes
10. SCALE - short - the scale for numeric types
11. RADIX - short - the Radix for numeric data (typically 2 or 10)
12. NULLABLE - short - can the data contain null:
    • DatabaseMetaData.procedureNoNulls - NULLs not permitted
    • DatabaseMetaData.procedureNullable - NULLs are permitted
    • DatabaseMetaData.procedureNullableUnknown - NULL status unknown
13. REMARKS - String - an explanatory comment about the data item

The list is returned as a ResultSet with one row for each stored procedure, ordered by PROCEDURE_SCHEME and PROCEDURE_NAME, with the data in each row as follows:

1. PROCEDURE_CAT - String : the procedure catalog name
2. PROCEDURE_SCHEM - String : the procedure schema name (possibly null)
3. PROCEDURE_NAME - String : the procedure name
4. Reserved
5. Reserved
6. Reserved
7. REMARKS - String - information about the procedure
8. PROCEDURE_TYPE - short : one of:
   • DatabaseMetaData.procedureResultUnknown - procedure may return a result
   • DatabaseMetaData.procedureNoResult - procedure does not return a result
   • DatabaseMetaData.procedureReturnsResult - procedure definitely returns a result

1. TABLE_SCHEM - String - the Schema name
2. TABLE_CATALOG - String - the Catalog name (possibly null)

The listing only contains entries for tables that have a super table. Super and sub tables must be defined in the same Catalog and Schema. The list is returned as a ResultSet, with one row for each table that has a super table, in the following format:

1. TABLE_CAT - String - table catalog name (possibly null)
2. TABLE_SCHEM - String - Table Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. SUPERTABLE_NAME - String - The Super Table name

The listing is returned as a ResultSet where there is one row for a specific UDT which describes its supertype, with the data organized in columns as follows:

1. TYPE_CAT - String - the UDT Catalog name (possibly null)
2. TYPE_SCHEM - String - the UDT Schema name (possibly null)
3. TYPE_NAME - String - the UDT type name
4. SUPERTYPE_CAT - String - direct supertype's Catalog name (possibly null)
5. SUPERTYPE_SCHEM - String - direct supertype's Schema name (possibly null)
6. SUPERTYPE_NAME - String - direct supertype's name

The privileges are returned as a ResultSet, with one row for each privilege, ordered by TABLE_SCHEM, TABLE_NAME, PRIVILEGE, and each row has data as defined in the following column definitions:

1. TABLE_CAT - String - table catalog name (possibly null)
2. TABLE_SCHEM - String - Table Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. GRANTOR - String - who granted the access
5. GRANTEE - String - who received the access grant
6. PRIVILEGE - String - the type of access granted - one of SELECT, INSERT, UPDATE, REFERENCES,...
7. IS_GRANTABLE - String - "YES" implies the grantee can grant access to others, "NO" implies guarantee cannot grant access to others, null means this status is unknown

The list is returned as a ResultSet with one row per table type, ordered by the table type. The information in the ResultSet is structured into a single column per row, as follows:

1. TABLE_TYPE - String - the Table Type. Typical names include "TABLE", "VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL TEMPORARY"

The descriptions are returned as rows in a ResultSet, one row for each Table. The ResultSet is ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME. Each row in the ResultSet consists of a series of columns as follows:

1. TABLE_CAT - String - table catalog name (possibly null)
2. TABLE_SCHEM - String - Table Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. TABLE_TYPE - String - Typical names include "TABLE", "VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL TEMPORARY"
5. REMARKS - String - A comment describing the table
6. TYPE_CAT - String - the 'Types' catalog(possibly null)
7. TYPE_SCHEM - String - the 'Types' schema(possibly null)
8. TYPE_NAME - String - the 'Types' name (possibly null)
9. SELF_REFERENCING_COL_NAME - String - the name of a designated identifier column in a typed table (possibly null)
10. REF_GENERATION - String - one of the following values : "SYSTEM" | "USER" | "DERIVED" - specifies how values in the SELF_REFERENCING_COL_NAME are created (possibly null)

1. TYPE_NAMR - String : the Type name
2. DATA_TYPE - int : the SQL data type value as defined in java.sql.Types
3. PRECISION - int - the maximum precision of the type
4. LITERAL_PREFIX - String : the prefix to be used when quoting a literal value (possibly null)
5. LITERAL_SUFFIX - String : the suffix to be used when quoting a literal value (possibly null)
6. CREATE_PARAMS - String : params used when creating the type (possibly null)
7. NULLABLE - short : shows if the value is null-able:
   • DatabaseMetaData.typeNoNulls : NULLs not permitted
   • DatabaseMetaData.typeNullable : NULLs are permitted
   • DatabaseMetaData.typeNullableUnknown : NULL status unknown
8. CASE_SENSITIVE - boolean : true if the type is case sensitive
9. SEARCHABLE - short : how this type can be used with WHERE clauses:
   • DatabaseMetaData.typePredNone - cannot be used
   • DatabaseMetaData.typePredChar - support for WHERE...LIKE only
   • DatabaseMetaData.typePredBasic - support except for WHERE...LIKE
   • DatabaseMetaData.typeSearchable - support for all WHERE clauses
10. UNSIGNED_ATTRIBUTE - boolean - the type is unsigned or not
11. FIXED_PREC_SCALE - boolean - fixed precision = it can be used as a money value
12. AUTO_INCREMENT - boolean - can be used as an auto-increment value
13. LOCAL_TYPE_NAME - String - a localized version of the type name (possibly null)
14. MINIMUM_SCALE - short - the minimum scale supported
15. MAXIMUM_SCALE - short - the maximum scale supported
16. SQL_DATA_TYPE - int - not used
17. SQL_DATETIME_SUB - int - not used
18. NUM_PREC_RADIX - int - number radix (typically 2 or 10)

The types matching the supplied the specified Catalog, Schema, Type Name and Type are returned as rows in a ResultSet with columns of information as follows:

1. TABLE_CAT - String - Catalog name (possibly null)
2. TABLE_SCHEM - String - Schema name (possibly null)
3. TABLE_NAME - String - The Table name
4. CLASS_NAME - String - The Java class name
5. DATA_TYPE - int - The SQL type as specified in java.sql.Types. One of DISTINCT, STRUCT and JAVA_OBJECT
6. REMARKS - String - A comment which describes the type
7. BASE_TYPE - short - A type code. For a DISTINCT type, the source type. For a structured type this is the type that implements the user generated reference type of the SELF_REFERENCING_COLUMN. This is defined in java.sql.Types, and will be null if the DATA_TYPE does not match these criteria.

The result is laid-out in the following columns:

1. SCOPE - short - not used
2. COLUMN_NAME - String - Column name
3. DATA_TYPE - int - The SQL data type, as defined in java.sql.Types
4. TYPE_NAME - String - The SQL type name, data source dependent
5. COLUMN_SIZE - int - Precision for numeric types
6. BUFFER_LENGTH - int - Length of a column value in bytes
7. DECIMAL_DIGITS - short - Number of digits after the decimal point
8. PSEUDO_COLUMN - short - If this is a pseudo-column (for example, an Oracle ROWID):
   • DatabaseMetaData.bestRowUnknown - don't know whether this is a pseudo column
   • DatabaseMetaData.bestRowNotPseudo - column is not pseudo
   • DatabaseMetaData.bestRowPseudo - column is a pseudo column

If aliasing is supported, then the SQL AS clause is used to provide names for computed columns and provide alias names for columns. true if column aliasing is supported,false otherwise.
throws:
  SQLException - a database error occurred