java.sql.DatabaseMetaData |
An interface which provides comprehensive information about the database.
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.
Value | ||||
---|---|---|---|---|
short | attributeNoNulls | States that it may not be permitted to store NULL values. |
0 | 0x00000000 |
short | attributeNullable | States that NULL values are definitely permitted. |
1 | 0x00000001 |
short | attributeNullableUnknown | States that whether NULL values are permitted is unknown. |
2 | 0x00000002 |
int | bestRowNotPseudo | States the best row identifier is NOT a pseudo column. | 1 | 0x00000001 |
int | bestRowPseudo | States that the best row identifier is a pseudo column. | 2 | 0x00000002 |
int | bestRowSession | States that the remainder of the current session is used as the scope for the best row identifier. | 2 | 0x00000002 |
int | bestRowTemporary | States that best row identifier scope lasts only while the row is being used. | 0 | 0x00000000 |
int | bestRowTransaction | States that the remainder of the current transaction is used as the scope for the best row identifier. | 1 | 0x00000001 |
int | bestRowUnknown | States that the best row identifier may or may not be a pseudo column. | 0 | 0x00000000 |
int | columnNoNulls | States that the column might not allow NULL values. |
0 | 0x00000000 |
int | columnNullable | States that the column definitely allows NULL values. |
1 | 0x00000001 |
int | columnNullableUnknown | States that it is unknown whether the columns may be nulled. | 2 | 0x00000002 |
int | importedKeyCascade | For the column UPDATE_RULE, States that when the primary key is updated, the foreign key (imported key) is changed to agree with it. | 0 | 0x00000000 |
int | importedKeyInitiallyDeferred | States deferrability. | 5 | 0x00000005 |
int | importedKeyInitiallyImmediate | States defer-ability. | 6 | 0x00000006 |
int | importedKeyNoAction | For the columns UPDATE_RULE and DELETE_RULE, States that if the primary key has been imported, it cannot be updated or deleted. | 3 | 0x00000003 |
int | importedKeyNotDeferrable | States defer-ability. | 7 | 0x00000007 |
int | importedKeyRestrict | States that a primary key must not be updated when imported as a foreign key by some other table. | 1 | 0x00000001 |
int | importedKeySetDefault | States that when the primary key is modified (updated or deleted) the foreign (imported) key is changed to its default value. | 4 | 0x00000004 |
int | importedKeySetNull | States that when the primary key is modified (updated or deleted) the
foreign (imported) key is changed to NULL . |
2 | 0x00000002 |
int | procedureColumnIn | States that this column stores IN type parameters. | 1 | 0x00000001 |
int | procedureColumnInOut | States that this column stores INOUT type parameters. | 2 | 0x00000002 |
int | procedureColumnOut | States that this column stores OUT type parameters. | 4 | 0x00000004 |
int | procedureColumnResult | States that the column stores results | 3 | 0x00000003 |
int | procedureColumnReturn | States that the column stores return values. | 5 | 0x00000005 |
int | procedureColumnUnknown | States that type of the column is unknown. | 0 | 0x00000000 |
int | procedureNoNulls | States that NULL values are not permitted. |
0 | 0x00000000 |
int | procedureNoResult | States that the procedure does not return a result. | 1 | 0x00000001 |
int | procedureNullable | States that NULL values are permitted. |
1 | 0x00000001 |
int | procedureNullableUnknown | States that whether NULL values are permitted is unknown. |
2 | 0x00000002 |
int | procedureResultUnknown | States that it is unknown whether or not the procedure returns a result. | 0 | 0x00000000 |
int | procedureReturnsResult | States that the procedure returns a result. | 2 | 0x00000002 |
int | sqlStateSQL99 | States that the value is an SQL99 SQLSTATE value. | 2 | 0x00000002 |
int | sqlStateXOpen | States that the value is an SQL CLI SQLSTATE value as defined by X/Open (who are now know as Open Group) . | 1 | 0x00000001 |
short | tableIndexClustered | States that this table index is a clustered index. | 1 | 0x00000001 |
short | tableIndexHashed | States that this table index is a hashed index. | 2 | 0x00000002 |
short | tableIndexOther | States this table's index is neither a clustered index, not a hashed index, and not a table statistics index; i.e. | 3 | 0x00000003 |
short | tableIndexStatistic | States this column has the table's statistics, and that it is returned in conjunction with the table's index description. | 0 | 0x00000000 |
int | typeNoNulls | States that a NULL value is NOT permitted for
this data type. |
0 | 0x00000000 |
int | typeNullable | States that a NULL value is permitted for this data type. |
1 | 0x00000001 |
int | typeNullableUnknown | States that it is unknown if a NULL value is permitted for
this data type. |
2 | 0x00000002 |
int | typePredBasic | States that one can base all WHERE search clauses except WHERE . | 2 | 0x00000002 |
int | typePredChar | States that WHERE is the only WHERE search clause that may
be based on this type. |
1 | 0x00000001 |
int | typePredNone | States that this type does not support WHERE search
clauses. |
0 | 0x00000000 |
int | typeSearchable | States that all WHERE search clauses may be based on this type. | 3 | 0x00000003 |
int | versionColumnNotPseudo | States that the version column is known to be not a pseudo column. | 1 | 0x00000001 |
int | versionColumnPseudo | States that this version column is known to be a pseudo column. | 2 | 0x00000002 |
int | versionColumnUnknown | States that the version column may be a pseudo column or not. | 0 | 0x00000000 |
boolean | allProceduresAreCallable() | |||||
Returns whether all procedures returned by getProcedures
can be called by the current user. |
||||||
boolean | allTablesAreSelectable() | |||||
Returns whether all the tables returned by getTables can
be used by the current user in a SELECT statement. |
||||||
boolean | dataDefinitionCausesTransactionCommit() | |||||
Returns if a data definition statement in a transaction forces a commit of the transaction. | ||||||
boolean | dataDefinitionIgnoredInTransactions() | |||||
Returns whether the database ignores data definition statements within a transaction. | ||||||
boolean | deletesAreDetected(int type) | |||||
Returns whether a visible row delete can be detected by calling
ResultSet.rowDeleted . |
||||||
boolean | doesMaxRowSizeIncludeBlobs() | |||||
Returns whether the return value of getMaxRowSize includes
the SQL data types LONGVARCHAR and
LONGVARBINARY . |
||||||
ResultSet | getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) | |||||
Returns a description of the specified attribute of the specified type for an SQL User Defined Type (UDT) for a specified schema and catalog. | ||||||
ResultSet | getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) | |||||
Returns a list of a table's optimal set of columns that uniquely identifies a row. | ||||||
String | getCatalogSeparator() | |||||
Returns the separator that this database uses between a catalog name and table name. | ||||||
String | getCatalogTerm() | |||||
Returns the term that the database vendor prefers term for "catalog". | ||||||
ResultSet | getCatalogs() | |||||
Returns the set of catalog names available in this database. | ||||||
ResultSet | getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) | |||||
Returns a description of access rights for a table's columns. | ||||||
ResultSet | getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) | |||||
Returns a description of table columns available in a specified catalog. | ||||||
Connection | getConnection() | |||||
Returns the database connection that created this metadata. | ||||||
ResultSet | getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) | |||||
Returns a list of foreign key columns in a given foreign key table that reference the primary key columns of a supplied primary key table. | ||||||
int | getDatabaseMajorVersion() | |||||
Returns the major version number of the database software. | ||||||
int | getDatabaseMinorVersion() | |||||
Returns the minor version number of the database software. | ||||||
String | getDatabaseProductName() | |||||
Returns the name of the database software. | ||||||
String | getDatabaseProductVersion() | |||||
Returns the version number of this database software. | ||||||
int | getDefaultTransactionIsolation() | |||||
Returns the default transaction isolation level for this database. | ||||||
int | getDriverMajorVersion() | |||||
Returns the JDBC driver's major version number. | ||||||
int | getDriverMinorVersion() | |||||
Returns the JDBC driver's minor version number. | ||||||
String | getDriverName() | |||||
Returns the name of this JDBC driver. | ||||||
String | getDriverVersion() | |||||
Returns the version number of this JDBC driver. | ||||||
ResultSet | getExportedKeys(String catalog, String schema, String table) | |||||
Returns a list of the foreign key columns that reference the primary key columns of a specified table (the foreign keys exported by a table). | ||||||
String | getExtraNameCharacters() | |||||
Returns a string of characters that may be used in unquoted identifier names. | ||||||
String | getIdentifierQuoteString() | |||||
Returns the string used to quote SQL identifiers. | ||||||
ResultSet | getImportedKeys(String catalog, String schema, String table) | |||||
Returns a list columns in a table that are both primary keys and referenced by the table's foreign key columns (that is, the primary keys imported by a table). | ||||||
ResultSet | getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) | |||||
Returns a list of indices and statistics for a specified table. | ||||||
int | getJDBCMajorVersion() | |||||
Returns this driver's major JDBC version number. | ||||||
int | getJDBCMinorVersion() | |||||
Returns the minor JDBC version number for this driver. | ||||||
int | getMaxBinaryLiteralLength() | |||||
Get the maximum number of hex characters in an in-line binary literal for this database. | ||||||
int | getMaxCatalogNameLength() | |||||
Returns the maximum size of a Catalog name in this database. | ||||||
int | getMaxCharLiteralLength() | |||||
Returns the maximum size for a character literal in this database. | ||||||
int | getMaxColumnNameLength() | |||||
Returns the maximum size for a Column name for this database. | ||||||
int | getMaxColumnsInGroupBy() | |||||
Get the maximum number of columns in a GROUP BY clause for this database. | ||||||
int | getMaxColumnsInIndex() | |||||
Returns the maximum number of columns in an Index for this database. | ||||||
int | getMaxColumnsInOrderBy() | |||||
Returns the maximum number of columns in an ORDER BY clause for this database. | ||||||
int | getMaxColumnsInSelect() | |||||
Returns the maximum number of columns in a SELECT list for this database. | ||||||
int | getMaxColumnsInTable() | |||||
Returns the maximum number of columns in a table for this database. | ||||||
int | getMaxConnections() | |||||
Returns the database's maximum number of concurrent connections. | ||||||
int | getMaxCursorNameLength() | |||||
Returns the maximum length of a cursor name for this database. | ||||||
int | getMaxIndexLength() | |||||
Returns the maximum length in bytes for an Index for this database. | ||||||
int | getMaxProcedureNameLength() | |||||
Returns the maximum number of characters for a procedure name in this database. | ||||||
int | getMaxRowSize() | |||||
Returns the maximum number of bytes within a single row for this database. | ||||||
int | getMaxSchemaNameLength() | |||||
Returns the maximum number of characters in a schema name for this database. | ||||||
int | getMaxStatementLength() | |||||
Returns the maximum number of characters in an SQL statement for this database. | ||||||
int | getMaxStatements() | |||||
Get the maximum number of simultaneously open active statements for this database. | ||||||
int | getMaxTableNameLength() | |||||
Returns the maximum size for a table name in the database. | ||||||
int | getMaxTablesInSelect() | |||||
Returns the maximum number of tables permitted in a SELECT statement for the database. | ||||||
int | getMaxUserNameLength() | |||||
Returns the maximum number of characters in a user name for the database. | ||||||
String | getNumericFunctions() | |||||
Returns a list of the math functions available with this database. | ||||||
ResultSet | getPrimaryKeys(String catalog, String schema, String table) | |||||
Returns a list of the primary key columns of a specified table. | ||||||
ResultSet | getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) | |||||
Returns a list of parameter and result columns for the stored procedures belonging to a specified Catalog. | ||||||
String | getProcedureTerm() | |||||
Returns the database vendor's preferred name for "procedure". | ||||||
ResultSet | getProcedures(String catalog, String schemaPattern, String procedureNamePattern) | |||||
Returns a list of the stored procedures available in a specified catalog. | ||||||
int | getResultSetHoldability() | |||||
Returns the result set's default hold-ability. | ||||||
String | getSQLKeywords() | |||||
Returns a list of all the SQL keywords that are NOT also SQL92 keywords for the database. | ||||||
int | getSQLStateType() | |||||
States the type of SQLState value returned by SQLException.getSQLState. | ||||||
String | getSchemaTerm() | |||||
Returns the database vendor's preferred term for "schema". | ||||||
ResultSet | getSchemas() | |||||
Returns a list of the schema names in the database. | ||||||
String | getSearchStringEscape() | |||||
Returns the string that is used to escape wildcard characters. | ||||||
String | getStringFunctions() | |||||
Returns a list of string functions available with the database. | ||||||
ResultSet | getSuperTables(String catalog, String schemaPattern, String tableNamePattern) | |||||
Returns a listing of the hierarchies of tables in a specified schema in the database. | ||||||
ResultSet | getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) | |||||
Returns the User Defined Type (UDT) hierarchies for a given schema. | ||||||
String | getSystemFunctions() | |||||
Returns a list of system functions available with the database. | ||||||
ResultSet | getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) | |||||
Returns a description of access rights for each table present in a catalog. | ||||||
ResultSet | getTableTypes() | |||||
Returns a list of table types supported by the database. | ||||||
ResultSet | getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) | |||||
Returns a description of the tables in a specified catalog. | ||||||
String | getTimeDateFunctions() | |||||
Returns a list of time and date functions available for the database. | ||||||
ResultSet | getTypeInfo() | |||||
Get a list of the standard SQL Types supported by this database. | ||||||
ResultSet | getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) | |||||
Returns a description of the User Defined Types (UDTs) defined in a given schema, which includes the types DISTINCT, STRUCT and JAVA_OBJECT. | ||||||
String | getURL() | |||||
Returns the URL for this database. | ||||||
String | getUserName() | |||||
Determine the user name as known by the database. | ||||||
ResultSet | getVersionColumns(String catalog, String schema, String table) | |||||
Returns which of a table's columns are automatically updated when any value in a row is updated. | ||||||
boolean | insertsAreDetected(int type) | |||||
Determine if a visible row insert can be detected by calling ResultSet.rowInserted. | ||||||
boolean | isCatalogAtStart() | |||||
Determine whether a fully qualified table name is prefixed or suffixed to a fully qualified table name. | ||||||
boolean | isReadOnly() | |||||
Determine if the database is in read-only mode. | ||||||
boolean | locatorsUpdateCopy() | |||||
Determine if updates are made to a copy of, or directly on, Large Objects (LOBs). | ||||||
boolean | nullPlusNonNullIsNull() | |||||
Determine if the database handles concatenations between
NULL and non-NULL values by producing a
NULL output. |
||||||
boolean | nullsAreSortedAtEnd() | |||||
Determine if NULL values are always sorted to the end of
sorted results regardless of requested sort order. |
||||||
boolean | nullsAreSortedAtStart() | |||||
Determine if NULL values are always sorted at the start of
the sorted list, irrespective of the sort order. |
||||||
boolean | nullsAreSortedHigh() | |||||
Determine if NULL values are sorted high - i.e. |
||||||
boolean | nullsAreSortedLow() | |||||
Determine if NULL values are sorted low - ie they are
sorted as if they are lower than any other values. |
||||||
boolean | othersDeletesAreVisible(int type) | |||||
Determine if deletes made by others are visible, for a specified ResultSet type. | ||||||
boolean | othersInsertsAreVisible(int type) | |||||
Determine if inserts made by others are visible, for a specified ResultSet type. | ||||||
boolean | othersUpdatesAreVisible(int type) | |||||
Determine if updates made by others are visible, for a specified ResultSet type. | ||||||
boolean | ownDeletesAreVisible(int type) | |||||
Determine if a ResultSet's own deletes are visible, for a specified ResultSet type. | ||||||
boolean | ownInsertsAreVisible(int type) | |||||
Determine if its own inserts are visible to a given ResultSet type. | ||||||
boolean | ownUpdatesAreVisible(int type) | |||||
Determine if for a supplied type of ResultSet, the ResultSet's own updates are visible. | ||||||
boolean | storesLowerCaseIdentifiers() | |||||
Determine whether the database treats SQL identifiers that are in mixed case (and unquoted) as case insensitive. | ||||||
boolean | storesLowerCaseQuotedIdentifiers() | |||||
Determine whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in lower case. | ||||||
boolean | storesMixedCaseIdentifiers() | |||||
Determine whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case. | ||||||
boolean | storesMixedCaseQuotedIdentifiers() | |||||
Determine whether the database considers identifiers as case insensitive if they are mixed case quoted SQL. | ||||||
boolean | storesUpperCaseIdentifiers() | |||||
Determine whether the database considers mixed case unquoted SQL identifiers as case insensitive and stores them in upper case. | ||||||
boolean | storesUpperCaseQuotedIdentifiers() | |||||
Determine whether the database considers mixed case quoted SQL identifiers as case insensitive and stores them in upper case. | ||||||
boolean | supportsANSI92EntryLevelSQL() | |||||
Determine if the database supports the ANSI92 entry level SQL grammar. | ||||||
boolean | supportsANSI92FullSQL() | |||||
Determine if the database supports the ANSI92 full SQL grammar. | ||||||
boolean | supportsANSI92IntermediateSQL() | |||||
Determine if the database supports the ANSI92 intermediate SQL Grammar. | ||||||
boolean | supportsAlterTableWithAddColumn() | |||||
Determine if the database supports ALTER TABLE operation with add column. | ||||||
boolean | supportsAlterTableWithDropColumn() | |||||
Determine if the database supports ALTER TABLE operation with drop column. | ||||||
boolean | supportsBatchUpdates() | |||||
Determine if the database supports Batch Updates. | ||||||
boolean | supportsCatalogsInDataManipulation() | |||||
Determine whether catalog names may be used in data manipulation statements. | ||||||
boolean | supportsCatalogsInIndexDefinitions() | |||||
Determine if catalog names can be used in Index Definition statements. | ||||||
boolean | supportsCatalogsInPrivilegeDefinitions() | |||||
Determine if catalog names can be used in privilege definition statements. | ||||||
boolean | supportsCatalogsInProcedureCalls() | |||||
Determine if catalog names can be used in procedure call statements. | ||||||
boolean | supportsCatalogsInTableDefinitions() | |||||
Determine if catalog names may be used in table definition statements. | ||||||
boolean | supportsColumnAliasing() | |||||
Determine if the database supports column aliasing. | ||||||
boolean | supportsConvert(int fromType, int toType) | |||||
Determine if the database supports CONVERT operation for two supplied SQL types. | ||||||
boolean | supportsConvert() | |||||
Determine if the database supports the CONVERT operation between SQL types. | ||||||
boolean | supportsCoreSQLGrammar() | |||||
Determine if the database supports the Core SQL Grammar for ODBC. | ||||||
boolean | supportsCorrelatedSubqueries() | |||||
Determine if the database supports correlated sub-queries. | ||||||
boolean | supportsDataDefinitionAndDataManipulationTransactions() | |||||
Determine if the database allows both data definition and data manipulation statements inside a transaction. | ||||||
boolean | supportsDataManipulationTransactionsOnly() | |||||
Determine if the database only allows data manipulation statements inside a transaction. | ||||||
boolean | supportsDifferentTableCorrelationNames() | |||||
Determine if table correlation names are restricted to be different from the names of the tables, when they are supported. | ||||||
boolean | supportsExpressionsInOrderBy() | |||||
Determine whether expressions in ORDER BY lists are supported. | ||||||
boolean | supportsExtendedSQLGrammar() | |||||
Determine whether the Extended SQL Grammar for ODBC is supported. | ||||||
boolean | supportsFullOuterJoins() | |||||
Determine if the database supports full nested outer joins. | ||||||
boolean | supportsGetGeneratedKeys() | |||||
Determine if auto generated keys can be returned when a statement executes. | ||||||
boolean | supportsGroupBy() | |||||
Determine if the database supports a form of GROUP BY clause. | ||||||
boolean | supportsGroupByBeyondSelect() | |||||
Determine if the database supports using a column name in a GROUP BY clause not included in the SELECT statement as long as all of the columns in the SELECT statement are used in the GROUP BY clause. | ||||||
boolean | supportsGroupByUnrelated() | |||||
Determine if the database supports using a column name in a GROUP BY clause that is not in the SELECT statement. | ||||||
boolean | supportsIntegrityEnhancementFacility() | |||||
Determine whether the database supports SQL Integrity Enhancement Facility. | ||||||
boolean | supportsLikeEscapeClause() | |||||
Determine if the database supports using a LIKE escape clause. | ||||||
boolean | supportsLimitedOuterJoins() | |||||
Determine if the database provides limited support for outer Join operations. | ||||||
boolean | supportsMinimumSQLGrammar() | |||||
Determine if the database supports Minimum SQL Grammar for ODBC. | ||||||
boolean | supportsMixedCaseIdentifiers() | |||||
Determine if the database treats mixed case unquoted SQL identifiers as case sensitive storing them in mixed case. | ||||||
boolean | supportsMixedCaseQuotedIdentifiers() | |||||
Determine whether the database considers mixed case quoted SQL identifiers as case sensitive, storing them in mixed case. | ||||||
boolean | supportsMultipleOpenResults() | |||||
Determine if it is possible for a single CallableStatement to return multiple ResultSets simultaneously. | ||||||
boolean | supportsMultipleResultSets() | |||||
Determine whether retrieving multiple ResultSets from a single call to
the execute method is supported. |
||||||
boolean | supportsMultipleTransactions() | |||||
Determine whether multiple transactions in progress at at time on different connections are supported. | ||||||
boolean | supportsNamedParameters() | |||||
Determine whether call-able statements with named parameters is supported. | ||||||
boolean | supportsNonNullableColumns() | |||||
Determine if columns in the database can be defined as non-nullable. | ||||||
boolean | supportsOpenCursorsAcrossCommit() | |||||
Determine whether keeping Cursors open across Commit operations is supported. | ||||||
boolean | supportsOpenCursorsAcrossRollback() | |||||
Determine if the database can keep Cursors open across Rollback operations. | ||||||
boolean | supportsOpenStatementsAcrossCommit() | |||||
Determine whether keeping Statements open across Commit operations is supported. | ||||||
boolean | supportsOpenStatementsAcrossRollback() | |||||
Determine whether keeping Statements open across Rollback operations is supported. | ||||||
boolean | supportsOrderByUnrelated() | |||||
Determine whether using a column in an ORDER BY clause that is not in the SELECT statement is supported. | ||||||
boolean | supportsOuterJoins() | |||||
Determine whether outer join operations are supported. | ||||||
boolean | supportsPositionedDelete() | |||||
Determine whether positioned DELETE statements are supported. | ||||||
boolean | supportsPositionedUpdate() | |||||
Determine whether positioned UPDATE statements are supported. | ||||||
boolean | supportsResultSetConcurrency(int type, int concurrency) | |||||
Determine whether there is support for a given concurrency style for the given ResultSet. | ||||||
boolean | supportsResultSetHoldability(int holdability) | |||||
Determine whether the supplied ResultSet holdability is supported. | ||||||
boolean | supportsResultSetType(int type) | |||||
Determine whether the supplied ResultSet type is supported. | ||||||
boolean | supportsSavepoints() | |||||
Determine whether Savepoints for transactions are supported. | ||||||
boolean | supportsSchemasInDataManipulation() | |||||
Determine whether a schema name may be used in a data manipulation statement. | ||||||
boolean | supportsSchemasInIndexDefinitions() | |||||
Determine whether a schema name may be used in an index definition statement. | ||||||
boolean | supportsSchemasInPrivilegeDefinitions() | |||||
Determine whether a database schema name can be used in a privilege definition statement. | ||||||
boolean | supportsSchemasInProcedureCalls() | |||||
Determine if a procedure call statement may be contain in a schema name. | ||||||
boolean | supportsSchemasInTableDefinitions() | |||||
Determine if a schema name can be used in a table definition statement. | ||||||
boolean | supportsSelectForUpdate() | |||||
Determine if this SELECT FOR UPDATE statements ar
supported. |
||||||
boolean | supportsStatementPooling() | |||||
Determine whether statement pooling is supported. | ||||||
boolean | supportsStoredProcedures() | |||||
Determine whether stored procedure calls using the stored procedure escape syntax is supported. | ||||||
boolean | supportsSubqueriesInComparisons() | |||||
Determine whether subqueries in comparison expressions are supported. | ||||||
boolean | supportsSubqueriesInExists() | |||||
Determine whether subqueries in EXISTS expressions are supported. | ||||||
boolean | supportsSubqueriesInIns() | |||||
Determine whether subqueries in IN statements are
supported. |
||||||
boolean | supportsSubqueriesInQuantifieds() | |||||
Determine whether subqueries in quantified expressions are supported. | ||||||
boolean | supportsTableCorrelationNames() | |||||
Determine whether the database has table correlation names support. | ||||||
boolean | supportsTransactionIsolationLevel(int level) | |||||
Determine whether a specified transaction isolation level is supported. | ||||||
boolean | supportsTransactions() | |||||
Determine whether transactions are supported. | ||||||
boolean | supportsUnion() | |||||
Determine whether the SQL UNION operation is supported. |
||||||
boolean | supportsUnionAll() | |||||
Determine whether the SQL UNION ALL operation is
supported. |
||||||
boolean | updatesAreDetected(int type) | |||||
Determine if the method ResultSet.rowUpdated can detect a
visible row update. |
||||||
boolean | usesLocalFilePerTable() | |||||
Determine if this database uses a file for each table. | ||||||
boolean | usesLocalFiles() | |||||
Determine whether this database uses a local file to store tables. |
NULL
values.
NULL
values are definitely permitted.
NULL
values are permitted is unknown.
NULL
values.
NULL
values.
NULL
. Applies to the
UPDATE_RULE and DELETE_RULE columns.
NULL
values are not permitted.
NULL
values are permitted.
NULL
values are permitted is unknown.
NULL
value is NOT permitted for
this data type.
NULL
value is permitted for this data type.
NULL
value is permitted for
this data type.
WHERE
is the only WHERE search clause that may
be based on this type.
WHERE
search
clauses.
getProcedures
can be called by the current user.
true
if all procedures can be called by the
current user, false
otherwise.SQLException | if there is a database error |
---|
getTables
can
be used by the current user in a SELECT statement.
true
if all the tables can be used,false
otherwiseSQLException | if there is a database error |
---|
true
if the statement forces a commit,
false
otherwiseSQLException | if there is a database error |
---|
true
if the database ignores a data definition
statement, false
otherwiseSQLException | if there is a database error |
---|
ResultSet.rowDeleted
.
type | the type of the ResultSet involved:
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if the visible row delete can be detected,
false
otherwiseSQLException | if there is a database error |
---|
getMaxRowSize
includes
the SQL data types LONGVARCHAR
and
LONGVARBINARY
.
true
if the return value includes
LONGVARBINARY
and LONGVARCHAR
,
otherwise false
.SQLException | if there is a database error |
---|
TYPE_SCHEM
,
TYPE_NAME
and ORDINAL_POSITION. The descriptions do not
contain inherited attributes.
The returned ResultSet object has rows with the following column names and meanings:
TYPE_CAT
- String - the Type Catalog name (possibly
null
)TYPE_SCHEM
- String - the Type Schema name (possibly
null
)TYPE_NAME
- String - the Type nameATTR_NAME
- String - the Attribute nameDATA_TYPE
- int - the Attribute type as defined in
java.sql.Types
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.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.DECIMAL_DIGITS
- int - how many fractional digits are
supportedNUM_PREC_RADIX
- int - numeric values radixNULLABLE
- int - whether NULL
is
permitted:
NULL
sNULL
s
definitely permittedREMARKS
- String - A comment describing the attribute
(possibly null
)null
)SQL_DATA_TYPE
- int - not usedCHAR
types, the max
number of bytes in the columnNULL
s, "YES" = column allows NULL
s "" =
NULL
status unknownSCOPE_CATALOG
- String - Catalog for table,
SCOPE
of Reference attribute. NULL if
DATA_TYPE
is not REF.SCOPE_SCHEMA
- String - Schema for table,
SCOPE
of Reference attribute. NULL if
DATA_TYPE
is not REF.SCOPE_TABLE
- String - Table name for
SCOPE
of Reference attribute. NULL
if
DATA_TYPE
is not REF.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)catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
typeNamePattern | a Type name. This pattern must match the type name stored in the database. |
attributeNamePattern | an Attribute name. Must match the attribute name as stored in the database. |
SQLException | if there is a database error |
---|
SCOPE
(see
below).
The results are returned as a table, with one entry for each column, as follows:
SCOPE
- short - the SCOPE
of the
result, as follows:
COLUMN_NAME
- String - the column name DATA_TYPE
- int - the Type of the data, as defined in
java.sql.Types
TYPE_NAME
- String - Name of the type - database
dependent. For UDT types the name is fully qualified COLUMN_SIZE
- int - The precision of the data in the
column BUFFER_LENGTH
- int - not used DECIMAL_DIGITS
- short - number of fractional digits
PSEUDO_COLUMN
- short - whether this is a pseudo
column eg. and Oracle ROWID:
catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name Pattern. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
table | the table name. This must match the name of the table as declared in the database. |
scope | the SCOPE of interest, values as defined above |
nullable | true = include columns that are nullable,
false = do not include |
SQLException | if there is a database error |
---|
SQLException | if there is a database error |
---|
SQLException | if there is a database error |
---|
TABLE_CAT
.SQLException | if there is a database error |
---|
The description is returned as a ResultSet with rows of data for each access right, with columns as follows:
TABLE_CAT
- String - Catalog name (possibly
null
)TABLE_SCHEM
- String - Schema name (possibly
null
) TABLE_NAME
- String - The Table name COLUMN_NAME
- String - The Column nameGRANTOR
- String - The grantor of access (possibly
null
)PRIVILEGE
- String - Access right - one of SELECT,
INSERT, UPDATE, REFERENCES,...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.catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name Pattern. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
table | the table name. This must match the name of the table as declared in the database. |
columnNamePattern | the column name. This must match the name of a column in the table in the database. |
SQLException | if there is a database error |
---|
The descriptions are returned as a ResultSet conforming to the following data layout, with one row per table column:
TABLE_CAT
- String - Catalog name (possibly
null
)TABLE_SCHEM
- String - Schema name (possibly
null
) TABLE_NAME
- String - The Table name COLUMN_NAME
- String - The Column nameDATA_TYPE
- int - The SQL type as specified in
java.sql.Types
TYPE_NAME
- String - Name for the data type, depends
on database, UDT names are fully qualifiedCOLUMN_SIZE
- int - Column size - the precision for
numeric types, max characters for char and date typesBUFFER_LENGTH
- int - Not used DECIMAL_DIGITS
- int - maximum number of fractional
digits NUM_PREC_RADIX
- int - the Radix NULLABLE
- int - does the column allow
null
s:
NULL
sNULL
sNULL
statusREMARKS
- String - A description of the column
(possibly null
) COLUMN_DEF
- String - Default value for the column
(possibly null
)SQL_DATA_TYPE
- int - not used SQL_DATETIME_SUB
- int - not used CHAR_OCTET_LENGTH
- int - maximum number of bytes in
the char type columns ORDINAL_POSITION
- int - Column index in the table (1
based) IS_NULLABLE
- String - "NO" = column does not allow
NULLs, "YES" = column allows NULLs "" = NULL
status
unknownSCOPE
_CATALOG - String - Catalog for table,
SCOPE
of Reference attribute. NULL if
DATA_TYPE
is not REF.SCOPE_SCHEMA
- String - Schema for table, scope of
Reference attribute. NULL
if DATA_TYPE
is
not REF.SCOPE_TABLE
- String - Table name for scope of
Reference attribute. NULL
if DATA_TYPE
is
not REF.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)catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
tableNamePattern | the table name. This must match the name of the table as declared in the database. |
columnNamePattern | the column name. This must match the name of a column in the table in the database. |
SQLException | if there is a database error |
---|
SQLException | if there is a database error |
---|
The descriptions are returned as a ResultSet with one row for each Foreign key, with the following layout:
PKTABLE_CAT
- String - from the primary key table :
Catalog (possibly null
)PKTABLE_SCHEM
- String - from the primary key table :
Schema (possibly null
) PKTABLE_NAME
- String - primary key table : name
PKCOLUMN_NAME
- String - primary key column : nameFKTABLE_CAT
- String - from the foreign key table :
the catalog name being exported (possibly null
)FKTABLE_SCHEM
- String - foreign key table : Schema
name being exported (possibly null
) FKTABLE_NAME
- String - foreign key table : the name
being exportedFKCOLUMN_NAME
- String - foreign key column : the
name being exportedKEY_SEQ
- short - sequence number (in the foreign
key)UPDATE_RULE
- short - how to treat foreign key when
primary key is updated:
null
DELETE_RULE
- short - how to treat foreign key when
primary key is deleted:
null
null
)null
)primaryCatalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
primarySchema | a Schema Name. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
primaryTable | the name of the table which exports the key. It must match the name of the table in the database |
foreignCatalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
foreignSchema | a Schema Name. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
foreignTable | the name of the table importing the key. It must match the name of the table in the database |
SQLException | if there is a database error |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
TRANSACTION_NONE
,
TRANSACTION_READ_COMMITTED
,
TRANSACTION_READ_UNCOMMITTED
,
TRANSACTION_REPEATABLE_READ
or
TRANSACTION_SERIALIZABLE
.SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
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:
PKTABLE_CAT
- String - primary key table : Catalog
(possibly null
)PKTABLE_SCHEM
- String - primary key table : Schema
(possibly null
) PKTABLE_NAME
- String - primary key table : name
PKCOLUMN_NAME
- String - primary key column : nameFKTABLE_CAT
- String - foreign key table : Catalog
name being exported (possibly null
)FKTABLE_SCHEM
- String - foreign key table : Schema
name being exported (possibly null
) FKTABLE_NAME
- String - foreign key table : name
being exportedFKCOLUMN_NAME
- String - foreign key column : name
being exportednull
null
null
)null
)catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
table | a table name, which must match the name of a table in the database |
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
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:
PKTABLE_CAT
- String - primary key Catalog name being
imported (possibly null
)PKTABLE_SCHEM
- String - primary key Schema name
being imported (possibly null
) PKTABLE_NAME
- String - primary key Table name being
imported PKCOLUMN_NAME
- String - primary key column name
being importedFKTABLE_CAT
- String - foreign key table catalog name
(possibly null
)FKTABLE_SCHEM
- String - foreign key table Schema
name (possibly null
) FKTABLE_NAME
- String - foreign key table nameFKCOLUMN_NAME
- String - foreign key column namenull
null
null
)null
)catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
table | a table name, which must match the name of a table in the database |
SQLException | a database error occurred |
---|
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:
TABLE_CAT
- String - table catalog name (possibly
null
)TABLE_SCHEM
- String - Table Schema name (possibly
null
) TABLE_NAME
- String - The Table name NON_UNIQUE
- boolean - true
when index
values can be non-unique. Must be false
when TYPE is
tableIndexStatisticINDEX_QUALIFIER
- String : index catalog name.
null
when TYPE is 'tableIndexStatistic'INDEX_NAME
- String : index name. null
when TYPE is 'tableIndexStatistic'COLUMN_NAME
- String - the column name.
null
when TYPE is tableIndexStatisticnull
if
sequencing not supported or TYPE is tableIndexStatistic; otherwise "A"
means sort ascending and "D" means sort descending. catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name. |
table | a table name, which must match the name of a table in the database |
unique | true means only return indices for unique
values, false implies that they can be returned
even if not unique. |
approximate | true implies that the list can contain
approximate or "out of data" values, false
implies that all values must be precisely accurate |
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
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:
TABLE_CAT
- String - table catalog name (possibly
null)TABLE_SCHEM
- String - Table Schema name (possibly
null) TABLE_NAME
- String - The Table name COLUMN_NAME
- String - The Column name KEY_SEQ
- short - the sequence number for this column
in the primary keyPK_NAME
- String - the primary key name (possibly
null)catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with the
empty string used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with the empty
string used to retrieve those without a Schema name. |
table | the name of a table, which must match the name of a table in the database |
SQLException | a database error occurred |
---|
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:
COLUMN_NAME
- String - the name of the columnDATA_TYPE
- int - the SQL type of the data, as in
java.sql.Types
TYPE_NAME
- String - the SQL type name, for a UDT it
is fully qualifiedNULL
s not
permittedNULL
s are
permitted NULL
status unknown REMARKS
- String - an explanatory comment about the
data item catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name. |
procedureNamePattern | a pattern that must match the name of the procedure stored in the database |
columnNamePattern | a column name pattern. The name must match the column name stored in the database. |
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
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:
PROCEDURE_CAT
- String : the procedure catalog namePROCEDURE_SCHEM
- String : the procedure schema name
(possibly null
) PROCEDURE_NAME
- String : the procedure nameReserved
Reserved
Reserved
REMARKS
- String - information about the procedurePROCEDURE_TYPE
- short : one of:
catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name. |
procedureNamePattern | a procedure name pattern, which must match the procedure name stored in the database |
SQLException | a database error occurred |
---|
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
TABLE_SCHEM
- String - the Schema nameTABLE_CAT
ALOG - String - the Catalog name (possibly
null) SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
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:
TABLE_CAT
- String - table catalog name (possibly
null)TABLE_SCHEM
- String - Table Schema name (possibly
null) TABLE_NAME
- String - The Table name TABLE_NAME
- String - The Super Table name
catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name. |
tableNamePattern | a Table Name, which should match the Table name as stored in the database. it may be a fully qualified name. If it is fully qualified the Catalog Name and Schema Name parameters are ignored. |
SQLException | a database error occurred |
---|
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:
TYPE_CAT
- String - the UDT Catalog name (possibly
null)TYPE_SCHEM
- String - the UDT Schema name (possibly
null) TYPE_NAME
- String - the UDT type name TYPE_CAT
- String - direct supertype's Catalog
name (possibly null)TYPE_SCHEM
- String - direct supertype's Schema
name (possibly null) TYPE_NAME
- String - direct supertype's name
catalog | the Catalog name. "" means get the UDTs without a catalog. null means don't use the catalog name to restrict the search. |
---|---|
schemaPattern | the Schema pattern name. "" means get the UDT's without a schema. |
typeNamePattern | the UDT name pattern. This may be a fully qualified name. When a fully qualified name is specified, the Catalog name and Schema name parameters are ignored. |
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
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:
TABLE_CAT
- String - table catalog name (possibly
null)TABLE_SCHEM
- String - Table Schema name (possibly
null) TABLE_NAME
- String - The Table name catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name. |
tableNamePattern | a Table Name, which should match the Table name as stored in the database. |
SQLException | a database error occurred |
---|
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:
TABLE_TYPE
- String - the Table Type. Typical names
include "TABLE", "VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL
TEMPORARY" SQLException | a database error occurred |
---|
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:
TABLE_CAT
- String - table catalog name (possibly
null)TABLE_SCHEM
- String - Table Schema name (possibly
null) TABLE_NAME
- String - The Table name TABLE_TYPE
- String - Typical names include "TABLE",
"VIEW", "SYSTEM TABLE", "ALIAS", "SYNONYM", "GLOBAL TEMPORARY"REMARKS
- String - A comment describing the table
TYPE_CAT
- String - the 'Types' catalog(possibly
null)TYPE_SCHEM
- String - the 'Types' schema(possibly
null) TYPE_NAME
- String - the 'Types' name (possibly null)
SELF_REFERENCING_COL_NAME
- String - the name of a
designated identifier column in a typed table (possibly null) SELF_REFERENCING_COL_NAME
are created (possibly null)
catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no narrowing of the search using Schema Name. Otherwise, the name must match a Schema name in the database, with "" used to retrieve those without a Schema name. |
tableNamePattern | a Table Name, which should match the Table name as stored in the database. |
types | a list of table types to include in the list. null implies list all types. |
SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
DATA_TYPE
value, where the data in each row is structured
into the following columns:
TYPE_NAMR
- String : the Type nameDATA_TYPE
- int : the SQL data type value as defined
in java.sql.Types
PRECISION
- int - the maximum precision of the typeLITERAL_PREFIX
- String : the prefix to be used when
quoting a literal value (possibly null
)LITERAL_SUFFIX
- String : the suffix to be used when
quoting a literal value (possibly null
)CREATE_PARAMS
- String : params used when creating
the type (possibly null
)NULLABLE
- short : shows if the value is null-able:
NULL
s not permittedNULL
s are permitted
NULL
status
unknown TYPE_NAME
- String - a localized version of
the type name (possibly null)DATA_TYPE
- int - not used SQLException | a database error occurred |
---|
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:
TABLE_CAT
- String - Catalog name (possibly null)TABLE_SCHEM
- String - Schema name (possibly null)
TABLE_NAME
- String - The Table name CLASS_NAME
- String - The Java class nameDATA_TYPE
- int - The SQL type as specified in
java.sql.Types
. One of DISTINCT, STRUCT and JAVA_OBJECTREMARKS
- String - A comment which describes the type
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.catalog | a Catalog Name. null is used to imply no narrowing of the search using Catalog Name. Otherwise, the name must match a Catalog Name held in the database, with "" used to retrieve those without a Catalog Name. |
---|---|
schemaPattern | a Schema Name Pattern. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
typeNamePattern | a Type Name, which should match a Type name as stored in the database. It may be fully qualified. |
types | a list of the UDT types to include in the list - one of DISTINCT, STRUCT or JAVA_OBJECT. |
SQLException | a database error occurred |
---|
null
if it cannot be
generated.SQLException | a database error occurred |
---|
SQLException | a database error occurred |
---|
The result is laid-out in the following columns:
SCOPE
- short - not used COLUMN_NAME
- String - Column nameDATA_TYPE
- int - The SQL data type, as defined in
java.sql.Types
TYPE_NAME
- String - The SQL type name, data source
dependent COLUMN_SIZE
- int - Precision for numeric types BUFFER_LENGTH
- int - Length of a column value in
bytes DECIMAL_DIGITS
- short - Number of digits after the
decimal point PSEUDO_COLUMN
- short - If this is a pseudo-column
(for example, an Oracle ROWID):
catalog | a Catalog Name. null is used to imply no
narrowing of the search using Catalog Name. Otherwise, the
name must match a Catalog Name held in the database, with ""
used to retrieve those without a Catalog Name. |
---|---|
schema | a Schema Name Pattern. null is used to imply no
narrowing of the search using Schema Name. Otherwise, the name
must match a Schema name in the database, with "" used to
retrieve those without a Schema name. |
table | a table name. It must match the name of a table in the database. |
SQLException | a database error occurred |
---|
type | the ResultSet type. This may be one of
ResultSet.TYPE_SCROLL_SENSITIVE or
ResultSet.TYPE_SCROLL_INSENSITIVE or
ResultSet.TYPE_FORWARD_ONLY , |
---|
true
if ResultSet.rowInserted detects a visible
row insert otherwise false
.SQLException | a database error occurred |
---|
true
if the catalog appears at the start of a
fully qualified table name, false
otherwise.SQLException | a database error occurred |
---|
true
if the database is in read-only mode,
false
otherwise.SQLException | a database error occurred |
---|
true
if updates are made to a copy of the Large
Object, false
otherwiseSQLException | a database error occurred |
---|
NULL
and non-NULL
values by producing a
NULL
output.
true
if NULL
to non-NULL
concatenations produce a NULL
result,
false
otherwise.SQLException | a database error occurred |
---|
NULL
values are always sorted to the end of
sorted results regardless of requested sort order. This means that they
will appear at the end of sorted lists whatever other non-NULL
values may be present.
true
if NULL
values are sorted at
the end, false
otherwiseSQLException | a database error occurred |
---|
NULL
values are always sorted at the start of
the sorted list, irrespective of the sort order. This means that they
appear at the start of sorted lists, whatever other values may be
present.
true
if NULL
values are sorted at
the start, false
otherwiseSQLException | a database error occurred |
---|
NULL
values are sorted high - i.e. they are
sorted as if they are higher than any other values.
true
if NULL
values are sorted
high, false
otherwise.SQLException | a database error occurred |
---|
NULL
values are sorted low - ie they are
sorted as if they are lower than any other values.
true
if NULL
values are sorted low,
false
otherwise.SQLException | a database error occurred |
---|
type | the type of the ResultSet. It may be either
ResultSet.TYPE_FORWARD_ONLY or
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE ) |
---|
true
if others' deletes are visible,
false
otherwise.SQLException | a database error occurred |
---|
type | the type of the ResultSet. May be
ResultSet.TYPE_FORWARD_ONLY , or
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if others' inserts are visible otherwise
false
.SQLException | a database error occurred |
---|
type | the type of the ResultSet. May be
ResultSet.TYPE_FORWARD_ONLY , or
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if others' inserts are visible otherwise
false
.SQLException | a database error occurred |
---|
type | the type of the ResultSet:
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if the delete's are seen by the own ResultSet
otherwise false
.SQLException | a database error occurred |
---|
type | the type of the ResultSet:
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if inserts are visible for this type
false
otherwise.SQLException | a database error occurred |
---|
type | the type of the ResultSet:
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if updates are visible to in this ResultSet
type otherwise false
.SQLException | a database error occurred |
---|
true
if unquoted SQL identifiers are stored in
lower case, false
otherwise.SQLException | a database error occurred |
---|
true
if quoted SQL identifiers are stored in lower
case, false
otherwise.SQLException | a database error occurred |
---|
true
if unquoted SQL identifiers as stored in
mixed case, false
otherwise.SQLException | a database error occurred |
---|
true
if quoted SQL identifiers are stored in mixed
case, false
otherwise.SQLException | a database error occurred |
---|
true
if unquoted SQL identifiers are stored in
upper case, false
otherwise.SQLException | a database error occurred |
---|
true
if quoted SQL identifiers are stored in upper
case, false
otherwise.SQLException | a database error occurred |
---|
true
if the ANSI92 entry level SQL grammar is
supported, false
otherwise.SQLException | a database error occurred |
---|
true
if the ANSI92 full SQL grammar is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if the ANSI92 intermediate SQL grammar is
supported, false
otherwise.SQLException | a database error occurred |
---|
true
if ALTER TABLE with add column is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if ALTER TABLE with drop column is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if batch updates are supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if catalog names can be used in data
manipulation statements, false
otherwise.SQLException | a database error occurred |
---|
true
if catalog names can be used in Index
Definition statements, false
otherwise.SQLException | a database error occurred |
---|
true
if catalog names can be used in privilege
definition statements, false
otherwise.SQLException | a database error occurred |
---|
true
if catalog names can be used in procedure
call statements.SQLException | a database error occurred |
---|
true
if catalog names can be used in definition
statements, false
otherwise.SQLException | a database error occurred |
---|
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.SQLException | a database error occurred |
---|
fromType | the Type to convert from, as defined by
java.sql.Types |
---|---|
toType | the Type to convert to, as defined by
java.sql.Types |
true
if the CONVERT operation is supported for
these types, false
otherwise.SQLException | a database error occurred |
---|
true
if the CONVERT operation is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if the Core SQL Grammar is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if the database does support correlated
sub-queries and false
otherwise.SQLException | a database error occurred |
---|
true
if both types of statement are permitted,
false
otherwise.SQLException | a database error occurred |
---|
true
if only data manipulation statements are
permitted, false
otherwise.SQLException | a database error occurred |
---|
true
if correlation names must be different to
table names, false
otherwise.SQLException | a database error occurred |
---|
true
if expressions in ORDER BY lists are
supported.SQLException | a database error occurred |
---|
true
if the Extended SQL Grammar is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if full nested outer joins are supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if auto generated keys can be returned,
false
otherwise.SQLException | a database error occurred |
---|
true
if a form of GROUP BY clause is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if GROUP BY clauses can use column names in
this way, false
otherwise.SQLException | a database error occurred |
---|
true
if GROUP BY clause can use a column name not
in the SELECT statement, false
otherwise.SQLException | a database error occurred |
---|
true
if the Integrity Enhancement Facility is
supported, false
otherwise.SQLException | a database error occurred |
---|
true
if LIKE escape clause is supported,
false
otherwiseSQLException | a database error occurred |
---|
true
if there is limited support for outer Join
operations, false
otherwise. This will be
true
if supportsFullOuterJoins
returns true
.SQLException | a database error occurred |
---|
true
if the Minimum SQL Grammar is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if unquoted SQL identifiers are stored in
mixed case, false
otherwise.SQLException | a database error occurred |
---|
true
if quoted SQL identifiers are stored in mixed
case, false
otherwise.SQLException | a database error occurred |
---|
true
if a single CallableStatement can return
multiple ResultSets simultaneously, false
otherwise.SQLException | a database error occurred |
---|
execute
method is supported.
true
if multiple ResultSets can be retrieved,
false
otherwise.SQLException | a database error occurred |
---|
true
if multiple open transactions are supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if named parameters can be used with
call-able statements, false
otherwise.SQLException | a database error occurred |
---|
true
if Columns can be defined non-nullable,
false
otherwise.SQLException | a database error occurred |
---|
true
if Cursors can be kept open across Commit
operations, false
if they might get closed.SQLException | a database error occurred |
---|
true
if Cursors can be kept open across Rollback
operations, false
if they might get closed.SQLException | a database error occurred |
---|
true
if Statements can be kept open,
false
if they might not.SQLException | a database error occurred |
---|
true
if Statements can be kept open,
false
if they might not.SQLException | a database error occurred |
---|
true
if it is possible to ORDER using a column not
in the SELECT, false
otherwise.SQLException | a database error occurred |
---|
true
if outer join operations are supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if the database supports positioned DELETE
statements.SQLException | a database error occurred |
---|
true
if the database supports positioned UPDATE
statements, false
otherwise.SQLException | a database error occurred |
---|
type | the ResultSet type, as defined in
java.sql.ResultSet :
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|---|
concurrency | a concurrency type, which may be one of
ResultSet.CONCUR_READ_ONLY or
ResultSet.CONCUR_UPDATABLE . |
true
if that concurrency and ResultSet type
pairing is supported otherwise false
.SQLException | a database error occurred |
---|
holdability | as specified in java.sql.ResultSet: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT |
---|
true
if the given ResultSet holdability is
supported and if it isn't then false
.SQLException | a database error occurred |
---|
type | the ResultSet type as defined in java.sql.ResultSet:
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
if the ResultSet type is supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if Savepoints are supported,
false
otherwise.SQLException | a database error occurred |
---|
true
if a schema name can be used in a data
manipulation otherwise false
.SQLException | a database error occurred |
---|
true
if a schema name can be used in an index
definition otherwise false
.SQLException | a database error occurred |
---|
true
if a database schema name may be used in a
privilege definition otherwise false
SQLException | a database error occurred |
---|
true
if a schema name can be used in a procedure
call otherwise false
.SQLException | a database error occurred |
---|
true
if a schema name can be used in a table
definition otherwise false
.SQLException | a database error occurred |
---|
SELECT FOR UPDATE
statements ar
supported.
true
if SELECT FOR UPDATE
statements are supported otherwise false
.SQLException | a database error occurred |
---|
true
of the database does support statement
pooling otherwise false
.SQLException | a database error occurred |
---|
true
if stored procedure calls using the stored
procedure escape syntax are supported otherwise
false
.SQLException | a database error occurred |
---|
true
if subqueries are supported in comparison
expressions.SQLException | a database error occurred |
---|
true
if subqueries are supported in EXISTS
expressions otherwise false
.SQLException | a database error occurred |
---|
IN
statements are
supported.
true
if subqueries are supported in IN statements
otherwise false
.SQLException | a database error occurred |
---|
true
if subqueries are supported otherwise
false
.SQLException | a database error occurred |
---|
true
if table correlation names are supported
otherwise false
.SQLException | a database error occurred |
---|
level | the transaction isolation level, as specified in
java.sql.Connection :
TRANSACTION_NONE ,
TRANSACTION_READ_COMMITTED ,
TRANSACTION_READ_UNCOMMITTED ,
TRANSACTION_REPEATABLE_READ ,
TRANSACTION_SERIALIZABLE |
---|
true
if the specific isolation level is supported
otherwise false
.SQLException | a database error occurred |
---|
If transactions are not supported, then the commit
method
does nothing and the transaction isolation level is always
TRANSACTION_NONE
.
true
if transactions are supported otherwise
false
.SQLException | a database error occurred |
---|
SQL UNION
operation is supported.
true
of the database does support
UNION
otherwise false
.SQLException | a database error occurred |
---|
SQL UNION ALL
operation is
supported.
true
if the database does support UNION ALL
otherwise false
.SQLException | a database error occurred |
---|
ResultSet.rowUpdated
can detect a
visible row update.
type | ResultSet type: ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
true
detecting changes is possible otherwise
false
.SQLException | a database error occurred |
---|
true
if the database uses one file for each table
otherwise false
.SQLException | a database error occurred |
---|
true
of the database does store tables in a local
file otherwise false
.SQLException | a database error occurred |
---|
Copyright 2007 Google Inc. | Build 0.9_r1-98467 - 14 Aug 2008 18:48 |