Comprehensive information about the database as a whole.
This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBCTM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.
A user for this interface is commonly a tool that needs to discover how to
deal with the underlying DBMS. This is especially true for applications
that are intended to be used with more than one DBMS. For example, a tool might use the method
getTypeInfo
to find out what data types can be used in a
CREATE TABLE
statement. Or a user might call the method
supportsCorrelatedSubqueries
to see if it is possible to use
a correlated subquery or supportsBatchUpdates
to see if it is
possible to use batch updates.
Some DatabaseMetaData
methods return lists of information
in the form of ResultSet
objects.
Regular ResultSet
methods, such as
getString
and getInt
, can be used
to retrieve the data from these ResultSet
objects. If
a given form of metadata is not available, an empty ResultSet
will be returned. Additional columns beyond the columns defined to be
returned by the ResultSet
object for a given method
can be defined by the JDBC driver vendor and must be accessed
by their column label.
Some DatabaseMetaData
methods take arguments that are
String patterns. These arguments all have names such as fooPattern.
Within a pattern String, "%" means match any substring of 0 or more
characters, and "_" means match any one character. Only metadata
entries matching the search pattern are returned. If a search pattern
argument is set to null
, that argument's criterion will
be dropped from the search.
Constant Summary
short | attributeNoNulls | Indicates that NULL values might not be allowed. |
short | attributeNullable | Indicates that NULL values are definitely allowed. |
short | attributeNullableUnknown | Indicates that whether NULL values are allowed is not
known. |
int | bestRowNotPseudo | Indicates that the best row identifier is NOT a pseudo column. |
int | bestRowPseudo | Indicates that the best row identifier is a pseudo column. |
int | bestRowSession | Indicates that the scope of the best row identifier is the remainder of the current session. |
int | bestRowTemporary | Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used. |
int | bestRowTransaction | Indicates that the scope of the best row identifier is the remainder of the current transaction. |
int | bestRowUnknown | Indicates that the best row identifier may or may not be a pseudo column. |
int | columnNoNulls | Indicates that the column might not allow NULL values. |
int | columnNullable | Indicates that the column definitely allows NULL values. |
int | columnNullableUnknown | Indicates that the nullability of columns is unknown. |
int | functionColumnIn | Indicates that the parameter or column is an IN parameter. |
int | functionColumnInOut | Indicates that the parameter or column is an INOUT parameter. |
int | functionColumnOut | Indicates that the parameter or column is an OUT parameter. |
int | functionColumnResult | Indicates that the parameter or column is a column in a result set. |
int | functionColumnUnknown | Indicates that type of the parameter or column is unknown. |
int | functionNoNulls | Indicates that NULL values are not allowed. |
int | functionNoTable | Indicates that the function does not return a table. |
int | functionNullable | Indicates that NULL values are allowed. |
int | functionNullableUnknown | Indicates that whether NULL values are allowed
is unknown. |
int | functionResultUnknown | Indicates that it is not known whether the function returns a result or a table. |
int | functionReturn | Indicates that the parameter or column is a return value. |
int | functionReturnsTable | Indicates that the function returns a table. |
int | importedKeyCascade | For the column UPDATE_RULE ,
indicates that
when the primary key is updated, the foreign key (imported key)
is changed to agree with it. |
int | importedKeyInitiallyDeferred | Indicates deferrability. |
int | importedKeyInitiallyImmediate | Indicates deferrability. |
int | importedKeyNoAction | For the columns UPDATE_RULE
and DELETE_RULE , indicates that
if the primary key has been imported, it cannot be updated or deleted. |
int | importedKeyNotDeferrable | Indicates deferrability. |
int | importedKeyRestrict | For the column UPDATE_RULE , indicates that
a primary key may not be updated if it has been imported by
another table as a foreign key. |
int | importedKeySetDefault | For the columns UPDATE_RULE
and DELETE_RULE , indicates that
if the primary key is updated or deleted, the foreign key (imported key)
is set to the default value. |
int | importedKeySetNull | For the columns UPDATE_RULE
and DELETE_RULE , indicates that
when the primary key is updated or deleted, the foreign key (imported key)
is changed to NULL . |
int | procedureColumnIn | Indicates that the column stores IN parameters. |
int | procedureColumnInOut | Indicates that the column stores INOUT parameters. |
int | procedureColumnOut | Indicates that the column stores OUT parameters. |
int | procedureColumnResult | Indicates that the column stores results. |
int | procedureColumnReturn | Indicates that the column stores return values. |
int | procedureColumnUnknown | Indicates that type of the column is unknown. |
int | procedureNoNulls | Indicates that NULL values are not allowed. |
int | procedureNoResult | Indicates that the procedure does not return a result. |
int | procedureNullable | Indicates that NULL values are allowed. |
int | procedureNullableUnknown | Indicates that whether NULL values are allowed
is unknown. |
int | procedureResultUnknown | Indicates that it is not known whether the procedure returns a result. |
int | procedureReturnsResult | Indicates that the procedure returns a result. |
int | sqlStateSQL | A possible return value for the method
DatabaseMetaData.getSQLStateType which is used to indicate
whether the value returned by the method
SQLException.getSQLState is an SQLSTATE value. |
int | sqlStateSQL99 | A possible return value for the method
DatabaseMetaData.getSQLStateType which is used to indicate
whether the value returned by the method
SQLException.getSQLState is an SQL99 SQLSTATE value. |
int | sqlStateXOpen | A possible return value for the method
DatabaseMetaData.getSQLStateType which is used to indicate
whether the value returned by the method
SQLException.getSQLState is an
X/Open (now know as Open Group) SQL CLI SQLSTATE value. |
short | tableIndexClustered | Indicates that this table index is a clustered index. |
short | tableIndexHashed | Indicates that this table index is a hashed index. |
short | tableIndexOther | Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these. |
short | tableIndexStatistic | Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions. |
int | typeNoNulls | Indicates that a NULL value is NOT allowed for this
data type. |
int | typeNullable | Indicates that a NULL value is allowed for this
data type. |
int | typeNullableUnknown | Indicates that it is not known whether a NULL value
is allowed for this data type. |
int | typePredBasic | Indicates that the data type can be only be used in WHERE
search clauses
that do not use LIKE predicates. |
int | typePredChar | Indicates that the data type
can be only be used in WHERE search clauses
that use LIKE predicates. |
int | typePredNone | Indicates that WHERE search clauses are not supported
for this type. |
int | typeSearchable | Indicates that all WHERE search clauses can be
based on this type. |
int | versionColumnNotPseudo | Indicates that this version column is NOT a pseudo column. |
int | versionColumnPseudo | Indicates that this version column is a pseudo column. |
int | versionColumnUnknown | Indicates that this version column may or may not be a pseudo column. |
Public Method Summary
abstract boolean |
allProceduresAreCallable()
Retrieves whether the current user can call all the procedures
returned by the method
getProcedures . |
abstract boolean |
allTablesAreSelectable()
Retrieves whether the current user can use all the tables returned
by the method
getTables in a SELECT
statement. |
abstract boolean |
autoCommitFailureClosesAllResultSets()
Retrieves whether a
SQLException while autoCommit is true inidcates
that all open ResultSets are closed, even ones that are holdable. |
abstract boolean |
dataDefinitionCausesTransactionCommit()
Retrieves whether a data definition statement within a transaction forces
the transaction to commit.
|
abstract boolean |
dataDefinitionIgnoredInTransactions()
Retrieves whether this database ignores a data definition statement
within a transaction.
|
abstract boolean |
deletesAreDetected(int type)
Retrieves whether or not a visible row delete can be detected by
calling the method
ResultSet.rowDeleted . |
abstract boolean |
doesMaxRowSizeIncludeBlobs()
Retrieves whether the return value for the method
getMaxRowSize includes the SQL data types
LONGVARCHAR and LONGVARBINARY . |
abstract ResultSet |
getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)
Retrieves a description of the given attribute of the given type
for a user-defined type (UDT) that is available in the given schema
and catalog.
|
abstract ResultSet |
getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
Retrieves a description of a table's optimal set of columns that
uniquely identifies a row.
|
abstract String |
getCatalogSeparator()
Retrieves the
String that this database uses as the
separator between a catalog and table name. |
abstract String |
getCatalogTerm()
Retrieves the database vendor's preferred term for "catalog".
|
abstract ResultSet |
getCatalogs()
Retrieves the catalog names available in this database.
|
abstract ResultSet |
getClientInfoProperties()
Retrieves a list of the client info properties
that the driver supports.
|
abstract ResultSet |
getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
Retrieves a description of the access rights for a table's columns.
|
abstract ResultSet |
getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
Retrieves a description of table columns available in
the specified catalog.
|
abstract Connection |
getConnection()
Retrieves the connection that produced this metadata object.
|
abstract ResultSet |
getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)
Retrieves a description of the foreign key columns in the given foreign key
table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table).
|
abstract int |
getDatabaseMajorVersion()
Retrieves the major version number of the underlying database.
|
abstract int |
getDatabaseMinorVersion()
Retrieves the minor version number of the underlying database.
|
abstract String |
getDatabaseProductName()
Retrieves the name of this database product.
|
abstract String |
getDatabaseProductVersion()
Retrieves the version number of this database product.
|
abstract int |
getDefaultTransactionIsolation()
Retrieves this database's default transaction isolation level.
|
abstract int |
getDriverMajorVersion()
Retrieves this JDBC driver's major version number.
|
abstract int |
getDriverMinorVersion()
Retrieves this JDBC driver's minor version number.
|
abstract String |
getDriverName()
Retrieves the name of this JDBC driver.
|
abstract String |
getDriverVersion()
Retrieves the version number of this JDBC driver as a
String . |
abstract ResultSet |
getExportedKeys(String catalog, String schema, String table)
Retrieves a description of the foreign key columns that reference the
given table's primary key columns (the foreign keys exported by a
table).
|
abstract String |
getExtraNameCharacters()
Retrieves all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, A-Z, 0-9 and _).
|
abstract ResultSet |
getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's system or user
function parameters and return type.
|
abstract ResultSet |
getFunctions(String catalog, String schemaPattern, String functionNamePattern)
Retrieves a description of the system and user functions available
in the given catalog.
|
abstract String |
getIdentifierQuoteString()
Retrieves the string used to quote SQL identifiers.
|
abstract ResultSet |
getImportedKeys(String catalog, String schema, String table)
Retrieves a description of the primary key columns that are
referenced by the given table's foreign key columns (the primary keys
imported by a table).
|
abstract ResultSet |
getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
Retrieves a description of the given table's indices and statistics.
|
abstract int |
getJDBCMajorVersion()
Retrieves the major JDBC version number for this
driver.
|
abstract int |
getJDBCMinorVersion()
Retrieves the minor JDBC version number for this
driver.
|
abstract int |
getMaxBinaryLiteralLength()
Retrieves the maximum number of hex characters this database allows in an
inline binary literal.
|
abstract int |
getMaxCatalogNameLength()
Retrieves the maximum number of characters that this database allows in a
catalog name.
|
abstract int |
getMaxCharLiteralLength()
Retrieves the maximum number of characters this database allows
for a character literal.
|
abstract int |
getMaxColumnNameLength()
Retrieves the maximum number of characters this database allows
for a column name.
|
abstract int |
getMaxColumnsInGroupBy()
Retrieves the maximum number of columns this database allows in a
GROUP BY clause. |
abstract int |
getMaxColumnsInIndex()
Retrieves the maximum number of columns this database allows in an index.
|
abstract int |
getMaxColumnsInOrderBy()
Retrieves the maximum number of columns this database allows in an
ORDER BY clause. |
abstract int |
getMaxColumnsInSelect()
Retrieves the maximum number of columns this database allows in a
SELECT list. |
abstract int |
getMaxColumnsInTable()
Retrieves the maximum number of columns this database allows in a table.
|
abstract int |
getMaxConnections()
Retrieves the maximum number of concurrent connections to this
database that are possible.
|
abstract int |
getMaxCursorNameLength()
Retrieves the maximum number of characters that this database allows in a
cursor name.
|
abstract int |
getMaxIndexLength()
Retrieves the maximum number of bytes this database allows for an
index, including all of the parts of the index.
|
abstract int |
getMaxProcedureNameLength()
Retrieves the maximum number of characters that this database allows in a
procedure name.
|
abstract int |
getMaxRowSize()
Retrieves the maximum number of bytes this database allows in
a single row.
|
abstract int |
getMaxSchemaNameLength()
Retrieves the maximum number of characters that this database allows in a
schema name.
|
abstract int |
getMaxStatementLength()
Retrieves the maximum number of characters this database allows in
an SQL statement.
|
abstract int |
getMaxStatements()
Retrieves the maximum number of active statements to this database
that can be open at the same time.
|
abstract int |
getMaxTableNameLength()
Retrieves the maximum number of characters this database allows in
a table name.
|
abstract int |
getMaxTablesInSelect()
Retrieves the maximum number of tables this database allows in a
SELECT statement. |
abstract int |
getMaxUserNameLength()
Retrieves the maximum number of characters this database allows in
a user name.
|
abstract String |
getNumericFunctions()
Retrieves a comma-separated list of math functions available with
this database.
|
abstract ResultSet |
getPrimaryKeys(String catalog, String schema, String table)
Retrieves a description of the given table's primary key columns.
|
abstract ResultSet |
getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter
and result columns.
|
abstract String |
getProcedureTerm()
Retrieves the database vendor's preferred term for "procedure".
|
abstract ResultSet |
getProcedures(String catalog, String schemaPattern, String procedureNamePattern)
Retrieves a description of the stored procedures available in the given
catalog.
|
abstract int |
getResultSetHoldability()
Retrieves this database's default holdability for
ResultSet
objects. |
abstract RowIdLifetime |
getRowIdLifetime()
Indicates whether or not this data source supports the SQL
ROWID type,
and if so the lifetime for which a RowId object remains valid. |
abstract String |
getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords
that are NOT also SQL:2003 keywords.
|
abstract int |
getSQLStateType()
Indicates whether the SQLSTATE returned by
SQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003. |
abstract String |
getSchemaTerm()
Retrieves the database vendor's preferred term for "schema".
|
abstract ResultSet |
getSchemas(String catalog, String schemaPattern)
Retrieves the schema names available in this database.
|
abstract ResultSet |
getSchemas()
Retrieves the schema names available in this database.
|
abstract String |
getSearchStringEscape()
Retrieves the string that can be used to escape wildcard characters.
|
abstract String |
getStringFunctions()
Retrieves a comma-separated list of string functions available with
this database.
|
abstract ResultSet |
getSuperTables(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular
schema in this database.
|
abstract ResultSet |
getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a
particular schema in this database.
|
abstract String |
getSystemFunctions()
Retrieves a comma-separated list of system functions available with
this database.
|
abstract ResultSet |
getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the access rights for each table available
in a catalog.
|
abstract ResultSet |
getTableTypes()
Retrieves the table types available in this database.
|
abstract ResultSet | |
abstract String |
getTimeDateFunctions()
Retrieves a comma-separated list of the time and date functions available
with this database.
|
abstract ResultSet |
getTypeInfo()
Retrieves a description of all the data types supported by
this database.
|
abstract ResultSet | |
abstract String |
getURL()
Retrieves the URL for this DBMS.
|
abstract String |
getUserName()
Retrieves the user name as known to this database.
|
abstract ResultSet |
getVersionColumns(String catalog, String schema, String table)
Retrieves a description of a table's columns that are automatically
updated when any value in a row is updated.
|
abstract boolean |
insertsAreDetected(int type)
Retrieves whether or not a visible row insert can be detected
by calling the method
ResultSet.rowInserted . |
abstract boolean |
isCatalogAtStart()
Retrieves whether a catalog appears at the start of a fully qualified
table name.
|
abstract boolean |
isReadOnly()
Retrieves whether this database is in read-only mode.
|
abstract boolean |
locatorsUpdateCopy()
Indicates whether updates made to a LOB are made on a copy or directly
to the LOB.
|
abstract boolean |
nullPlusNonNullIsNull()
Retrieves whether this database supports concatenations between
NULL and non-NULL values being
NULL . |
abstract boolean |
nullsAreSortedAtEnd()
Retrieves whether
NULL values are sorted at the end regardless of
sort order. |
abstract boolean |
nullsAreSortedAtStart()
Retrieves whether
NULL values are sorted at the start regardless
of sort order. |
abstract boolean |
nullsAreSortedHigh()
Retrieves whether
NULL values are sorted high. |
abstract boolean |
nullsAreSortedLow()
Retrieves whether
NULL values are sorted low. |
abstract boolean |
othersDeletesAreVisible(int type)
Retrieves whether deletes made by others are visible.
|
abstract boolean |
othersInsertsAreVisible(int type)
Retrieves whether inserts made by others are visible.
|
abstract boolean |
othersUpdatesAreVisible(int type)
Retrieves whether updates made by others are visible.
|
abstract boolean |
ownDeletesAreVisible(int type)
Retrieves whether a result set's own deletes are visible.
|
abstract boolean |
ownInsertsAreVisible(int type)
Retrieves whether a result set's own inserts are visible.
|
abstract boolean |
ownUpdatesAreVisible(int type)
Retrieves whether for the given type of
ResultSet object,
the result set's own updates are visible. |
abstract boolean |
storesLowerCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in lower case.
|
abstract boolean |
storesLowerCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in lower case.
|
abstract boolean |
storesMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in mixed case.
|
abstract boolean |
storesMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in mixed case.
|
abstract boolean |
storesUpperCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in upper case.
|
abstract boolean |
storesUpperCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in upper case.
|
abstract boolean |
supportsANSI92EntryLevelSQL()
Retrieves whether this database supports the ANSI92 entry level SQL
grammar.
|
abstract boolean |
supportsANSI92FullSQL()
Retrieves whether this database supports the ANSI92 full SQL grammar supported.
|
abstract boolean |
supportsANSI92IntermediateSQL()
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.
|
abstract boolean |
supportsAlterTableWithAddColumn()
Retrieves whether this database supports
ALTER TABLE
with add column. |
abstract boolean |
supportsAlterTableWithDropColumn()
Retrieves whether this database supports
ALTER TABLE
with drop column. |
abstract boolean |
supportsBatchUpdates()
Retrieves whether this database supports batch updates.
|
abstract boolean |
supportsCatalogsInDataManipulation()
Retrieves whether a catalog name can be used in a data manipulation statement.
|
abstract boolean |
supportsCatalogsInIndexDefinitions()
Retrieves whether a catalog name can be used in an index definition statement.
|
abstract boolean |
supportsCatalogsInPrivilegeDefinitions()
Retrieves whether a catalog name can be used in a privilege definition statement.
|
abstract boolean |
supportsCatalogsInProcedureCalls()
Retrieves whether a catalog name can be used in a procedure call statement.
|
abstract boolean |
supportsCatalogsInTableDefinitions()
Retrieves whether a catalog name can be used in a table definition statement.
|
abstract boolean |
supportsColumnAliasing()
Retrieves whether this database supports column aliasing.
|
abstract boolean |
supportsConvert(int fromType, int toType)
Retrieves whether this database supports the JDBC scalar function
CONVERT for conversions between the JDBC types fromType
and toType. |
abstract boolean |
supportsConvert()
Retrieves whether this database supports the JDBC scalar function
CONVERT for the conversion of one JDBC type to another. |
abstract boolean |
supportsCoreSQLGrammar()
Retrieves whether this database supports the ODBC Core SQL grammar.
|
abstract boolean |
supportsCorrelatedSubqueries()
Retrieves whether this database supports correlated subqueries.
|
abstract boolean |
supportsDataDefinitionAndDataManipulationTransactions()
Retrieves whether this database supports both data definition and
data manipulation statements within a transaction.
|
abstract boolean |
supportsDataManipulationTransactionsOnly()
Retrieves whether this database supports only data manipulation
statements within a transaction.
|
abstract boolean |
supportsDifferentTableCorrelationNames()
Retrieves whether, when table correlation names are supported, they
are restricted to being different from the names of the tables.
|
abstract boolean |
supportsExpressionsInOrderBy()
Retrieves whether this database supports expressions in
ORDER BY lists. |
abstract boolean |
supportsExtendedSQLGrammar()
Retrieves whether this database supports the ODBC Extended SQL grammar.
|
abstract boolean |
supportsFullOuterJoins()
Retrieves whether this database supports full nested outer joins.
|
abstract boolean |
supportsGetGeneratedKeys()
Retrieves whether auto-generated keys can be retrieved after
a statement has been executed
|
abstract boolean |
supportsGroupBy()
Retrieves whether this database supports some form of
GROUP BY clause. |
abstract boolean |
supportsGroupByBeyondSelect()
Retrieves whether this database supports using columns not included in
the
SELECT statement in a GROUP BY clause
provided that all of the columns in the SELECT statement
are included in the GROUP BY clause. |
abstract boolean |
supportsGroupByUnrelated()
Retrieves whether this database supports using a column that is
not in the
SELECT statement in a
GROUP BY clause. |
abstract boolean |
supportsIntegrityEnhancementFacility()
Retrieves whether this database supports the SQL Integrity
Enhancement Facility.
|
abstract boolean |
supportsLikeEscapeClause()
Retrieves whether this database supports specifying a
LIKE escape clause. |
abstract boolean |
supportsLimitedOuterJoins()
Retrieves whether this database provides limited support for outer
joins.
|
abstract boolean |
supportsMinimumSQLGrammar()
Retrieves whether this database supports the ODBC Minimum SQL grammar.
|
abstract boolean |
supportsMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case sensitive and as a result stores them in mixed case.
|
abstract boolean |
supportsMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case sensitive and as a result stores them in mixed case.
|
abstract boolean |
supportsMultipleOpenResults()
Retrieves whether it is possible to have multiple
ResultSet objects
returned from a CallableStatement object
simultaneously. |
abstract boolean |
supportsMultipleResultSets()
Retrieves whether this database supports getting multiple
ResultSet objects from a single call to the
method execute . |
abstract boolean |
supportsMultipleTransactions()
Retrieves whether this database allows having multiple
transactions open at once (on different connections).
|
abstract boolean |
supportsNamedParameters()
Retrieves whether this database supports named parameters to callable
statements.
|
abstract boolean |
supportsNonNullableColumns()
Retrieves whether columns in this database may be defined as non-nullable.
|
abstract boolean |
supportsOpenCursorsAcrossCommit()
Retrieves whether this database supports keeping cursors open
across commits.
|
abstract boolean |
supportsOpenCursorsAcrossRollback()
Retrieves whether this database supports keeping cursors open
across rollbacks.
|
abstract boolean |
supportsOpenStatementsAcrossCommit()
Retrieves whether this database supports keeping statements open
across commits.
|
abstract boolean |
supportsOpenStatementsAcrossRollback()
Retrieves whether this database supports keeping statements open
across rollbacks.
|
abstract boolean |
supportsOrderByUnrelated()
Retrieves whether this database supports using a column that is
not in the
SELECT statement in an
ORDER BY clause. |
abstract boolean |
supportsOuterJoins()
Retrieves whether this database supports some form of outer join.
|
abstract boolean |
supportsPositionedDelete()
Retrieves whether this database supports positioned
DELETE
statements. |
abstract boolean |
supportsPositionedUpdate()
Retrieves whether this database supports positioned
UPDATE
statements. |
abstract boolean |
supportsResultSetConcurrency(int type, int concurrency)
Retrieves whether this database supports the given concurrency type
in combination with the given result set type.
|
abstract boolean |
supportsResultSetHoldability(int holdability)
Retrieves whether this database supports the given result set holdability.
|
abstract boolean |
supportsResultSetType(int type)
Retrieves whether this database supports the given result set type.
|
abstract boolean |
supportsSavepoints()
Retrieves whether this database supports savepoints.
|
abstract boolean |
supportsSchemasInDataManipulation()
Retrieves whether a schema name can be used in a data manipulation statement.
|
abstract boolean |
supportsSchemasInIndexDefinitions()
Retrieves whether a schema name can be used in an index definition statement.
|
abstract boolean |
supportsSchemasInPrivilegeDefinitions()
Retrieves whether a schema name can be used in a privilege definition statement.
|
abstract boolean |
supportsSchemasInProcedureCalls()
Retrieves whether a schema name can be used in a procedure call statement.
|
abstract boolean |
supportsSchemasInTableDefinitions()
Retrieves whether a schema name can be used in a table definition statement.
|
abstract boolean |
supportsSelectForUpdate()
Retrieves whether this database supports
SELECT FOR UPDATE
statements. |
abstract boolean |
supportsStatementPooling()
Retrieves whether this database supports statement pooling.
|
abstract boolean |
supportsStoredFunctionsUsingCallSyntax()
Retrieves whether this database supports invoking user-defined or vendor functions
using the stored procedure escape syntax.
|
abstract boolean |
supportsStoredProcedures()
Retrieves whether this database supports stored procedure calls
that use the stored procedure escape syntax.
|
abstract boolean |
supportsSubqueriesInComparisons()
Retrieves whether this database supports subqueries in comparison
expressions.
|
abstract boolean |
supportsSubqueriesInExists()
Retrieves whether this database supports subqueries in
EXISTS expressions. |
abstract boolean |
supportsSubqueriesInIns()
Retrieves whether this database supports subqueries in
IN expressions. |
abstract boolean |
supportsSubqueriesInQuantifieds()
Retrieves whether this database supports subqueries in quantified
expressions.
|
abstract boolean |
supportsTableCorrelationNames()
Retrieves whether this database supports table correlation names.
|
abstract boolean |
supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction isolation level.
|
abstract boolean |
supportsTransactions()
Retrieves whether this database supports transactions.
|
abstract boolean |
supportsUnion()
Retrieves whether this database supports SQL
UNION . |
abstract boolean |
supportsUnionAll()
Retrieves whether this database supports SQL
UNION ALL . |
abstract boolean |
updatesAreDetected(int type)
Retrieves whether or not a visible row update can be detected by
calling the method
ResultSet.rowUpdated . |
abstract boolean |
usesLocalFilePerTable()
Retrieves whether this database uses a file for each table.
|
abstract boolean |
usesLocalFiles()
Retrieves whether this database stores tables in a local file.
|
Inherited Method Summary
Constants
public static final short attributeNoNulls
Indicates that NULL
values might not be allowed.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getAttributes
.
public static final short attributeNullable
Indicates that NULL
values are definitely allowed.
A possible value for the column NULLABLE
in the ResultSet
object
returned by the method getAttributes
.
public static final short attributeNullableUnknown
Indicates that whether NULL
values are allowed is not
known.
A possible value for the column NULLABLE
in the ResultSet
object
returned by the method getAttributes
.
public static final int bestRowNotPseudo
Indicates that the best row identifier is NOT a pseudo column.
A possible value for the column
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getBestRowIdentifier
.
public static final int bestRowPseudo
Indicates that the best row identifier is a pseudo column.
A possible value for the column
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getBestRowIdentifier
.
public static final int bestRowSession
Indicates that the scope of the best row identifier is the remainder of the current session.
A possible value for the column
SCOPE
in the ResultSet
object
returned by the method getBestRowIdentifier
.
public static final int bestRowTemporary
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.
A possible value for the column
SCOPE
in the ResultSet
object
returned by the method getBestRowIdentifier
.
public static final int bestRowTransaction
Indicates that the scope of the best row identifier is the remainder of the current transaction.
A possible value for the column
SCOPE
in the ResultSet
object
returned by the method getBestRowIdentifier
.
public static final int bestRowUnknown
Indicates that the best row identifier may or may not be a pseudo column.
A possible value for the column
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getBestRowIdentifier
.
public static final int columnNoNulls
Indicates that the column might not allow NULL
values.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method
getColumns
.
public static final int columnNullable
Indicates that the column definitely allows NULL
values.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method
getColumns
.
public static final int columnNullableUnknown
Indicates that the nullability of columns is unknown.
A possible value for the column
NULLABLE
in the ResultSet
returned by the method
getColumns
.
public static final int functionColumnIn
Indicates that the parameter or column is an IN parameter.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
public static final int functionColumnInOut
Indicates that the parameter or column is an INOUT parameter.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
public static final int functionColumnOut
Indicates that the parameter or column is an OUT parameter.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
public static final int functionColumnResult
Indicates that the parameter or column is a column in a result set.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
public static final int functionColumnUnknown
Indicates that type of the parameter or column is unknown.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
public static final int functionNoNulls
Indicates that NULL
values are not allowed.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getFunctionColumns
.
public static final int functionNoTable
Indicates that the function does not return a table.
A possible value for column FUNCTION_TYPE
in the
ResultSet
object returned by the method
getFunctions
.
public static final int functionNullable
Indicates that NULL
values are allowed.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getFunctionColumns
.
public static final int functionNullableUnknown
Indicates that whether NULL
values are allowed
is unknown.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getFunctionColumns
.
public static final int functionResultUnknown
Indicates that it is not known whether the function returns a result or a table.
A possible value for column FUNCTION_TYPE
in the
ResultSet
object returned by the method
getFunctions
.
public static final int functionReturn
Indicates that the parameter or column is a return value.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getFunctionColumns
.
public static final int functionReturnsTable
Indicates that the function returns a table.
A possible value for column FUNCTION_TYPE
in the
ResultSet
object returned by the method
getFunctions
.
public static final int importedKeyCascade
For the column UPDATE_RULE
,
indicates that
when the primary key is updated, the foreign key (imported key)
is changed to agree with it.
For the column DELETE_RULE
,
it indicates that
when the primary key is deleted, rows that imported that key
are deleted.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeyInitiallyDeferred
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY
in the ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeyInitiallyImmediate
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY
in the ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeyNoAction
For the columns UPDATE_RULE
and DELETE_RULE
, indicates that
if the primary key has been imported, it cannot be updated or deleted.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeyNotDeferrable
Indicates deferrability. See SQL-92 for a definition.
A possible value for the column DEFERRABILITY
in the ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeyRestrict
For the column UPDATE_RULE
, indicates that
a primary key may not be updated if it has been imported by
another table as a foreign key.
For the column DELETE_RULE
, indicates that
a primary key may not be deleted if it has been imported by
another table as a foreign key.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeySetDefault
For the columns UPDATE_RULE
and DELETE_RULE
, indicates that
if the primary key is updated or deleted, the foreign key (imported key)
is set to the default value.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int importedKeySetNull
For the columns UPDATE_RULE
and DELETE_RULE
, indicates that
when the primary key is updated or deleted, the foreign key (imported key)
is changed to NULL
.
A possible value for the columns UPDATE_RULE
and DELETE_RULE
in the
ResultSet
objects returned by the methods
getImportedKeys
, getExportedKeys
,
and getCrossReference
.
public static final int procedureColumnIn
Indicates that the column stores IN parameters.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
public static final int procedureColumnInOut
Indicates that the column stores INOUT parameters.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
public static final int procedureColumnOut
Indicates that the column stores OUT parameters.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
public static final int procedureColumnResult
Indicates that the column stores results.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
public static final int procedureColumnReturn
Indicates that the column stores return values.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
public static final int procedureColumnUnknown
Indicates that type of the column is unknown.
A possible value for the column
COLUMN_TYPE
in the ResultSet
returned by the method getProcedureColumns
.
public static final int procedureNoNulls
Indicates that NULL
values are not allowed.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getProcedureColumns
.
public static final int procedureNoResult
Indicates that the procedure does not return a result.
A possible value for column PROCEDURE_TYPE
in the
ResultSet
object returned by the method
getProcedures
.
public static final int procedureNullable
Indicates that NULL
values are allowed.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getProcedureColumns
.
public static final int procedureNullableUnknown
Indicates that whether NULL
values are allowed
is unknown.
A possible value for the column
NULLABLE
in the ResultSet
object
returned by the method getProcedureColumns
.
public static final int procedureResultUnknown
Indicates that it is not known whether the procedure returns a result.
A possible value for column PROCEDURE_TYPE
in the
ResultSet
object returned by the method
getProcedures
.
public static final int procedureReturnsResult
Indicates that the procedure returns a result.
A possible value for column PROCEDURE_TYPE
in the
ResultSet
object returned by the method
getProcedures
.
public static final int sqlStateSQL
A possible return value for the method
DatabaseMetaData.getSQLStateType
which is used to indicate
whether the value returned by the method
SQLException.getSQLState
is an SQLSTATE value.
public static final int sqlStateSQL99
A possible return value for the method
DatabaseMetaData.getSQLStateType
which is used to indicate
whether the value returned by the method
SQLException.getSQLState
is an SQL99 SQLSTATE value.
Note:This constant remains only for compatibility reasons. Developers
should use the constant sqlStateSQL
instead.
public static final int sqlStateXOpen
A possible return value for the method
DatabaseMetaData.getSQLStateType
which is used to indicate
whether the value returned by the method
SQLException.getSQLState
is an
X/Open (now know as Open Group) SQL CLI SQLSTATE value.
public static final short tableIndexClustered
Indicates that this table index is a clustered index.
A possible value for column TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
public static final short tableIndexHashed
Indicates that this table index is a hashed index.
A possible value for column TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
public static final short tableIndexOther
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
A possible value for column TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
public static final short tableIndexStatistic
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
A possible value for column TYPE
in the
ResultSet
object returned by the method
getIndexInfo
.
public static final int typeNoNulls
Indicates that a NULL
value is NOT allowed for this
data type.
A possible value for column NULLABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int typeNullable
Indicates that a NULL
value is allowed for this
data type.
A possible value for column NULLABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int typeNullableUnknown
Indicates that it is not known whether a NULL
value
is allowed for this data type.
A possible value for column NULLABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int typePredBasic
Indicates that the data type can be only be used in WHERE
search clauses
that do not use LIKE
predicates.
A possible value for column SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int typePredChar
Indicates that the data type
can be only be used in WHERE
search clauses
that use LIKE
predicates.
A possible value for column SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int typePredNone
Indicates that WHERE
search clauses are not supported
for this type.
A possible value for column SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int typeSearchable
Indicates that all WHERE
search clauses can be
based on this type.
A possible value for column SEARCHABLE
in the
ResultSet
object returned by the method
getTypeInfo
.
public static final int versionColumnNotPseudo
Indicates that this version column is NOT a pseudo column.
A possible value for the column
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getVersionColumns
.
public static final int versionColumnPseudo
Indicates that this version column is a pseudo column.
A possible value for the column
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getVersionColumns
.
public static final int versionColumnUnknown
Indicates that this version column may or may not be a pseudo column.
A possible value for the column
PSEUDO_COLUMN
in the ResultSet
object
returned by the method getVersionColumns
.
Public Methods
public abstract boolean allProceduresAreCallable ()
Retrieves whether the current user can call all the procedures
returned by the method getProcedures
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean allTablesAreSelectable ()
Retrieves whether the current user can use all the tables returned
by the method getTables
in a SELECT
statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean autoCommitFailureClosesAllResultSets ()
Retrieves whether a SQLException
while autoCommit is true
inidcates
that all open ResultSets are closed, even ones that are holdable. When a SQLException
occurs while
autocommit is true
, it is vendor specific whether the JDBC driver responds with a commit operation, a
rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference
is in whether or not holdable ResultSets are closed.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean dataDefinitionCausesTransactionCommit ()
Retrieves whether a data definition statement within a transaction forces the transaction to commit.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean dataDefinitionIgnoredInTransactions ()
Retrieves whether this database ignores a data definition statement within a transaction.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean deletesAreDetected (int type)
Retrieves whether or not a visible row delete can be detected by
calling the method ResultSet.rowDeleted
. If the method
deletesAreDetected
returns false
, it means that
deleted rows are removed from the result set.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if deletes are detected by the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean doesMaxRowSizeIncludeBlobs ()
Retrieves whether the return value for the method
getMaxRowSize
includes the SQL data types
LONGVARCHAR
and LONGVARBINARY
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getAttributes (String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)
Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.
Descriptions are returned only for attributes of UDTs matching the
catalog, schema, type, and attribute name criteria. They are ordered by
TYPE_CAT
, TYPE_SCHEM
,
TYPE_NAME
and ORDINAL_POSITION
. This description
does not contain inherited attributes.
The ResultSet
object that is returned has the following
columns:
- TYPE_CAT String => type catalog (may be
null
) - TYPE_SCHEM String => type schema (may be
null
) - TYPE_NAME String => type name
- ATTR_NAME String => attribute name
- DATA_TYPE int => attribute type SQL type from java.sql.Types
- ATTR_TYPE_NAME String => Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type.
- ATTR_SIZE int => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => whether NULL is allowed
- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null
) - ATTR_DEF String => default value (may be
null
) - SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1)
- IS_NULLABLE String => ISO rules are used to determine
the nullability for a attribute.
- YES --- if the attribute can include NULLs
- NO --- if the attribute cannot include NULLs
- empty string --- if the nullability for the attribute is unknown
- SCOPE_CATALOG String => catalog of table that is the
scope of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String => schema of table that is the
scope of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_TABLE String => table name that is the scope of a
reference attribute (
null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
Ref type,SQL type from java.sql.Types (
null
if DATA_TYPE isn't DISTINCT or user-generated REF)
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
typeNamePattern | a type name pattern; must match the type name as it is stored in the database |
attributeNamePattern | an attribute name pattern; must match the attribute name as it is declared in the database |
Returns
- a
ResultSet
object in which each row is an attribute description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract ResultSet getBestRowIdentifier (String catalog, String schema, String table, int scope, boolean nullable)
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.
Each column description has the following columns:
- SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => not used
- DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
- PSEUDO_COLUMN short => is this a pseudo column
like an Oracle ROWID
- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in the database |
scope | the scope of interest; use same values as SCOPE |
nullable | include columns that are nullable. |
Returns
ResultSet
- each row is a column description
Throws
SQLException | if a database access error occurs |
---|
public abstract String getCatalogSeparator ()
Retrieves the String
that this database uses as the
separator between a catalog and table name.
Returns
- the separator string
Throws
SQLException | if a database access error occurs |
---|
public abstract String getCatalogTerm ()
Retrieves the database vendor's preferred term for "catalog".
Returns
- the vendor term for "catalog"
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getCatalogs ()
Retrieves the catalog names available in this database. The results are ordered by catalog name.
The catalog column is:
- TABLE_CAT String => catalog name
Returns
- a
ResultSet
object in which each row has a singleString
column that is a catalog name
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getClientInfoProperties ()
Retrieves a list of the client info properties that the driver supports. The result set contains the following columns
- NAME String=> The name of the client info property
- MAX_LEN int=> The maximum length of the value for the property
- DEFAULT_VALUE String=> The default value of the property
- DESCRIPTION String=> A description of the property. This will typically contain information as to where this property is stored in the database.
The ResultSet
is sorted by the NAME column
Returns
- A
ResultSet
object; each row is a supported client info property
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getColumnPrivileges (String catalog, String schema, String table, String columnNamePattern)
Retrieves a description of the access rights for a table's columns.
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- GRANTOR String => grantor of access (may be
null
) - GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted
to grant to others; "NO" if not;
null
if unknown
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name as it is
stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in the database |
columnNamePattern | a column name pattern; must match the column name as it is stored in the database |
Returns
ResultSet
- each row is a column privilege description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract ResultSet getColumns (String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
Retrieves a description of table columns available in the specified catalog.
Only column descriptions matching the catalog, schema, table
and column name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,
TABLE_NAME
, and ORDINAL_POSITION
.
Each column description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
- COLUMN_SIZE int => column size.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => is NULL allowed.
- columnNoNulls - might not allow
NULL
values - columnNullable - definitely allows
NULL
values - columnNullableUnknown - nullability unknown
- columnNoNulls - might not allow
- REMARKS String => comment describing column (may be
null
) - COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be
null
) - SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table (starting at 1)
- IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
- SCOPE_CATALOG String => catalog of table that is the scope
of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String => schema of table that is the scope
of a reference attribute (
null
if the DATA_TYPE isn't REF) - SCOPE_TABLE String => table name that this the scope
of a reference attribute (
null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
Ref type, SQL type from java.sql.Types (
null
if DATA_TYPE isn't DISTINCT or user-generated REF) - IS_AUTOINCREMENT String => Indicates whether this column is auto incremented
- YES --- if the column is auto incremented
- NO --- if the column is not auto incremented
- empty string --- if it cannot be determined whether the column is auto incremented
- IS_GENERATEDCOLUMN String => Indicates whether this is a generated column
- YES --- if this a generated column
- NO --- if this not a generated column
- empty string --- if it cannot be determined whether this is a generated column
The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
tableNamePattern | a table name pattern; must match the table name as it is stored in the database |
columnNamePattern | a column name pattern; must match the column name as it is stored in the database |
Returns
ResultSet
- each row is a column description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract Connection getConnection ()
Retrieves the connection that produced this metadata object.
Returns
- the connection that produced this metadata object
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getCrossReference (String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table). The number of columns returned from the parent table must match the number of columns that make up the foreign key. They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:
- PKTABLE_CAT String => parent key table catalog (may be
null
) - PKTABLE_SCHEM String => parent key table schema (may be
null
) - PKTABLE_NAME String => parent key table name
- PKCOLUMN_NAME String => parent key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null
) being exported (may benull
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) being exported (may benull
) - FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
- UPDATE_RULE short => What happens to
foreign key when parent key is updated:
- importedNoAction - do not allow update of parent key if it has been imported
- importedKeyCascade - change imported key to agree with parent key update
- importedKeySetNull - change imported key to
NULL
if its parent key has been updated - importedKeySetDefault - change imported key to default values if its parent key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when parent key is deleted.
- importedKeyNoAction - do not allow delete of parent key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its parent key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => parent key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
Parameters
parentCatalog | a catalog name; must match the catalog name
as it is stored in the database; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria |
---|---|
parentSchema | a schema name; must match the schema name as
it is stored in the database; "" retrieves those without a schema;
null means drop schema name from the selection criteria |
parentTable | the name of the table that exports the key; must match the table name as it is stored in the database |
foreignCatalog | a catalog name; must match the catalog name as
it is stored in the database; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria |
foreignSchema | a schema name; must match the schema name as it
is stored in the database; "" retrieves those without a schema;
null means drop schema name from the selection criteria |
foreignTable | the name of the table that imports the key; must match the table name as it is stored in the database |
Returns
ResultSet
- each row is a foreign key column description
Throws
SQLException | if a database access error occurs |
---|
public abstract int getDatabaseMajorVersion ()
Retrieves the major version number of the underlying database.
Returns
- the underlying database's major version
Throws
SQLException | if a database access error occurs |
---|
public abstract int getDatabaseMinorVersion ()
Retrieves the minor version number of the underlying database.
Returns
- underlying database's minor version
Throws
SQLException | if a database access error occurs |
---|
public abstract String getDatabaseProductName ()
Retrieves the name of this database product.
Returns
- database product name
Throws
SQLException | if a database access error occurs |
---|
public abstract String getDatabaseProductVersion ()
Retrieves the version number of this database product.
Returns
- database version number
Throws
SQLException | if a database access error occurs |
---|
public abstract int getDefaultTransactionIsolation ()
Retrieves this database's default transaction isolation level. The
possible values are defined in java.sql.Connection
.
Returns
- the default isolation level
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract int getDriverMajorVersion ()
Retrieves this JDBC driver's major version number.
Returns
- JDBC driver major version
public abstract int getDriverMinorVersion ()
Retrieves this JDBC driver's minor version number.
Returns
- JDBC driver minor version number
public abstract String getDriverName ()
Retrieves the name of this JDBC driver.
Returns
- JDBC driver name
Throws
SQLException | if a database access error occurs |
---|
public abstract String getDriverVersion ()
Retrieves the version number of this JDBC driver as a String
.
Returns
- JDBC driver version
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getExportedKeys (String catalog, String schema, String table)
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be
null
) - PKTABLE_SCHEM String => primary key table schema (may be
null
) - PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null
) being exported (may benull
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) being exported (may benull
) - FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
- UPDATE_RULE short => What happens to
foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => primary key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in this database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in this database |
Returns
- a
ResultSet
object in which each row is a foreign key column description
Throws
SQLException | if a database access error occurs |
---|
public abstract String getExtraNameCharacters ()
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
Returns
- the string containing the extra characters
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getFunctionColumns (String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's system or user function parameters and return type.
Only descriptions matching the schema, function and
parameter name criteria are returned. They are ordered by
FUNCTION_CAT
, FUNCTION_SCHEM
,
FUNCTION_NAME
and
SPECIFIC_ NAME
. Within this, the return value,
if any, is first. Next are the parameter descriptions in call
order. The column descriptions follow in column number order.
Each row in the ResultSet
is a parameter description, column description or
return type description with the following fields:
- FUNCTION_CAT String => function catalog (may be
null
) - FUNCTION_SCHEM String => function schema (may be
null
) - FUNCTION_NAME String => function name. This is the name used to invoke the function
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- functionColumnUnknown - nobody knows
- functionColumnIn - IN parameter
- functionColumnInOut - INOUT parameter
- functionColumnOut - OUT parameter
- functionColumnReturn - function return value
- functionColumnResult - Indicates that the parameter or column
is a column in the
ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale - null is returned for data types where SCALE is not applicable.
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- functionNoNulls - does not allow NULL values
- functionNullable - allows NULL values
- functionNullableUnknown - nullability unknown
- REMARKS String => comment describing column/parameter
- CHAR_OCTET_LENGTH int => the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL
- ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1.
- IS_NULLABLE String => ISO rules are used to determine
the nullability for a parameter or column.
- YES --- if the parameter or column can include NULLs
- NO --- if the parameter or column cannot include NULLs
- empty string --- if the nullability for the parameter or column is unknown
- SPECIFIC_NAME String => the name which uniquely identifies
this function within its schema. This is a user specified, or DBMS
generated, name that may be different then the
FUNCTION_NAME
for example with overload functions
The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
functionNamePattern | a procedure name pattern; must match the function name as it is stored in the database |
columnNamePattern | a parameter name pattern; must match the parameter or column name as it is stored in the database |
Returns
ResultSet
- each row describes a user function parameter, column or return type
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract ResultSet getFunctions (String catalog, String schemaPattern, String functionNamePattern)
Retrieves a description of the system and user functions available in the given catalog.
Only system and user function descriptions matching the schema and
function name criteria are returned. They are ordered by
FUNCTION_CAT
, FUNCTION_SCHEM
,
FUNCTION_NAME
and
SPECIFIC_ NAME
.
Each function description has the the following columns:
- FUNCTION_CAT String => function catalog (may be
null
) - FUNCTION_SCHEM String => function schema (may be
null
) - FUNCTION_NAME String => function name. This is the name used to invoke the function
- REMARKS String => explanatory comment on the function
- FUNCTION_TYPE short => kind of function:
- functionResultUnknown - Cannot determine if a return value or table will be returned
- functionNoTable- Does not return a table
- functionReturnsTable - Returns a table
- SPECIFIC_NAME String => the name which uniquely identifies
this function within its schema. This is a user specified, or DBMS
generated, name that may be different then the
FUNCTION_NAME
for example with overload functions
A user may not have permission to execute any of the functions that are
returned by getFunctions
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
functionNamePattern | a function name pattern; must match the function name as it is stored in the database |
Returns
ResultSet
- each row is a function description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract String getIdentifierQuoteString ()
Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.
Returns
- the quoting string or a space if quoting is not supported
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getImportedKeys (String catalog, String schema, String table)
Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.
Each primary key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog
being imported (may be
null
) - PKTABLE_SCHEM String => primary key table schema
being imported (may be
null
) - PKTABLE_NAME String => primary key table name being imported
- PKCOLUMN_NAME String => primary key column name being imported
- FKTABLE_CAT String => foreign key table catalog (may be
null
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) - FKTABLE_NAME String => foreign key table name
- FKCOLUMN_NAME String => foreign key column name
- KEY_SEQ short => sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
- UPDATE_RULE short => What happens to a
foreign key when the primary key is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => primary key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in the database |
Returns
ResultSet
- each row is a primary key column description
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getIndexInfo (String catalog, String schema, String table, boolean unique, boolean approximate)
Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.
Each index column description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- NON_UNIQUE boolean => Can index values be non-unique. false when TYPE is tableIndexStatistic
- INDEX_QUALIFIER String => index catalog (may be
null
);null
when TYPE is tableIndexStatistic - INDEX_NAME String => index name;
null
when TYPE is tableIndexStatistic - TYPE short => index type:
- tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
- COLUMN_NAME String => column name;
null
when TYPE is tableIndexStatistic - ASC_OR_DESC String => column sort sequence, "A" => ascending,
"D" => descending, may be
null
if sort sequence is not supported;null
when TYPE is tableIndexStatistic - CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
- PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
- FILTER_CONDITION String => Filter condition, if any.
(may be
null
)
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in this database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name
as it is stored in this database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in this database |
unique | when true, return only indices for unique values; when false, return indices regardless of whether unique or not |
approximate | when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate |
Returns
ResultSet
- each row is an index column description
Throws
SQLException | if a database access error occurs |
---|
public abstract int getJDBCMajorVersion ()
Retrieves the major JDBC version number for this driver.
Returns
- JDBC version major number
Throws
SQLException | if a database access error occurs |
---|
public abstract int getJDBCMinorVersion ()
Retrieves the minor JDBC version number for this driver.
Returns
- JDBC version minor number
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxBinaryLiteralLength ()
Retrieves the maximum number of hex characters this database allows in an inline binary literal.
Returns
- max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxCatalogNameLength ()
Retrieves the maximum number of characters that this database allows in a catalog name.
Returns
- the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxCharLiteralLength ()
Retrieves the maximum number of characters this database allows for a character literal.
Returns
- the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxColumnNameLength ()
Retrieves the maximum number of characters this database allows for a column name.
Returns
- the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxColumnsInGroupBy ()
Retrieves the maximum number of columns this database allows in a
GROUP BY
clause.
Returns
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxColumnsInIndex ()
Retrieves the maximum number of columns this database allows in an index.
Returns
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxColumnsInOrderBy ()
Retrieves the maximum number of columns this database allows in an
ORDER BY
clause.
Returns
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxColumnsInSelect ()
Retrieves the maximum number of columns this database allows in a
SELECT
list.
Returns
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxColumnsInTable ()
Retrieves the maximum number of columns this database allows in a table.
Returns
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxConnections ()
Retrieves the maximum number of concurrent connections to this database that are possible.
Returns
- the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxCursorNameLength ()
Retrieves the maximum number of characters that this database allows in a cursor name.
Returns
- the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxIndexLength ()
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.
Returns
- the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxProcedureNameLength ()
Retrieves the maximum number of characters that this database allows in a procedure name.
Returns
- the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxRowSize ()
Retrieves the maximum number of bytes this database allows in a single row.
Returns
- the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxSchemaNameLength ()
Retrieves the maximum number of characters that this database allows in a schema name.
Returns
- the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxStatementLength ()
Retrieves the maximum number of characters this database allows in an SQL statement.
Returns
- the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxStatements ()
Retrieves the maximum number of active statements to this database that can be open at the same time.
Returns
- the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxTableNameLength ()
Retrieves the maximum number of characters this database allows in a table name.
Returns
- the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxTablesInSelect ()
Retrieves the maximum number of tables this database allows in a
SELECT
statement.
Returns
- the maximum number of tables allowed in a
SELECT
statement; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract int getMaxUserNameLength ()
Retrieves the maximum number of characters this database allows in a user name.
Returns
- the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known
Throws
SQLException | if a database access error occurs |
---|
public abstract String getNumericFunctions ()
Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.
Returns
- the list of math functions supported by this database
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getPrimaryKeys (String catalog, String schema, String table)
Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.
Each primary key column description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- KEY_SEQ short => sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key).
- PK_NAME String => primary key name (may be
null
)
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in the database |
Returns
ResultSet
- each row is a primary key column description
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getProcedureColumns (String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter and result columns.
Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the ResultSet
is a parameter description or
column description with the following fields:
- PROCEDURE_CAT String => procedure catalog (may be
null
) - PROCEDURE_SCHEM String => procedure schema (may be
null
) - PROCEDURE_NAME String => procedure name
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale - null is returned for data types where SCALE is not applicable.
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String => comment describing parameter/column
- COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be
null
)- The string NULL (not enclosed in quotes) - if NULL was specified as the default value
- TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
- NULL - if a default value was not specified
- SQL_DATA_TYPE int => reserved for future use
- SQL_DATETIME_SUB int => reserved for future use
- CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL
- ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 is returned if this row describes the procedure's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. If there are multiple result sets, the column ordinal positions are implementation defined.
- IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
- SPECIFIC_NAME String => the name which uniquely identifies this procedure within its schema.
Note: Some databases may not return the column descriptions for a procedure.
The PRECISION column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
procedureNamePattern | a procedure name pattern; must match the procedure name as it is stored in the database |
columnNamePattern | a column name pattern; must match the column name as it is stored in the database |
Returns
ResultSet
- each row describes a stored procedure parameter or column
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract String getProcedureTerm ()
Retrieves the database vendor's preferred term for "procedure".
Returns
- the vendor term for "procedure"
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getProcedures (String catalog, String schemaPattern, String procedureNamePattern)
Retrieves a description of the stored procedures available in the given catalog.
Only procedure descriptions matching the schema and
procedure name criteria are returned. They are ordered by
PROCEDURE_CAT
, PROCEDURE_SCHEM
,
PROCEDURE_NAME
and SPECIFIC_ NAME
.
Each procedure description has the the following columns:
- PROCEDURE_CAT String => procedure catalog (may be
null
) - PROCEDURE_SCHEM String => procedure schema (may be
null
) - PROCEDURE_NAME String => procedure name
- reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String => explanatory comment on the procedure
- PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - Cannot determine if a return value will be returned
- procedureNoResult - Does not return a return value
- procedureReturnsResult - Returns a return value
- SPECIFIC_NAME String => The name which uniquely identifies this procedure within its schema.
A user may not have permissions to execute any of the procedures that are
returned by getProcedures
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
procedureNamePattern | a procedure name pattern; must match the procedure name as it is stored in the database |
Returns
ResultSet
- each row is a procedure description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract int getResultSetHoldability ()
Retrieves this database's default holdability for ResultSet
objects.
Returns
- the default holdability; either
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
Throws
SQLException | if a database access error occurs |
---|
public abstract RowIdLifetime getRowIdLifetime ()
Indicates whether or not this data source supports the SQL ROWID
type,
and if so the lifetime for which a RowId
object remains valid.
The returned int values have the following relationship:
ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION < ROWID_VALID_SESSION < ROWID_VALID_FOREVERso conditional logic such as
if (metadata.getRowIdLifetime() > DatabaseMetaData.ROWID_VALID_TRANSACTION)can be used. Valid Forever means valid across all Sessions, and valid for a Session means valid across all its contained Transactions.
Returns
- the status indicating the lifetime of a
RowId
Throws
SQLException | if a database access error occurs |
---|
public abstract String getSQLKeywords ()
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.
Returns
- the list of this database's keywords that are not also SQL:2003 keywords
Throws
SQLException | if a database access error occurs |
---|
public abstract int getSQLStateType ()
Indicates whether the SQLSTATE returned by SQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003.
Returns
- the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL
Throws
SQLException | if a database access error occurs |
---|
public abstract String getSchemaTerm ()
Retrieves the database vendor's preferred term for "schema".
Returns
- the vendor term for "schema"
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getSchemas (String catalog, String schemaPattern)
Retrieves the schema names available in this database. The results
are ordered by TABLE_CATALOG
and
TABLE_SCHEM
.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null
)
Parameters
catalog | a catalog name; must match the catalog name as it is stored in the database;"" retrieves those without a catalog; null means catalog name should not be used to narrow down the search. |
---|---|
schemaPattern | a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search. |
Returns
- a
ResultSet
object in which each row is a schema description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract ResultSet getSchemas ()
Retrieves the schema names available in this database. The results
are ordered by TABLE_CATALOG
and
TABLE_SCHEM
.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null
)
Returns
- a
ResultSet
object in which each row is a schema description
Throws
SQLException | if a database access error occurs |
---|
public abstract String getSearchStringEscape ()
Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).
The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
Returns
- the string used to escape wildcard characters
Throws
SQLException | if a database access error occurs |
---|
public abstract String getStringFunctions ()
Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.
Returns
- the list of string functions supported by this database
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getSuperTables (String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular schema in this database.
Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.
Each type description has the following columns:
- TABLE_CAT String => the type's catalog (may be
null
) - TABLE_SCHEM String => type's schema (may be
null
) - TABLE_NAME String => type name
- SUPERTABLE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
Parameters
catalog | a catalog name; "" retrieves those without a catalog;
null means drop catalog name from the selection criteria |
---|---|
schemaPattern | a schema name pattern; "" retrieves those without a schema |
tableNamePattern | a table name pattern; may be a fully-qualified name |
Returns
- a
ResultSet
object in which each row is a type description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract ResultSet getSuperTypes (String catalog, String schemaPattern, String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.
Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.
If a UDT does not have a direct super type, it is not listed here.
A row of the ResultSet
object returned by this method
describes the designated UDT and a direct supertype. A row has the following
columns:
- TYPE_CAT String => the UDT's catalog (may be
null
) - TYPE_SCHEM String => UDT's schema (may be
null
) - TYPE_NAME String => type name of the UDT
- SUPERTYPE_CAT String => the direct super type's catalog
(may be
null
) - SUPERTYPE_SCHEM String => the direct super type's schema
(may be
null
) - SUPERTYPE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
Parameters
catalog | a catalog name; "" retrieves those without a catalog;
null means drop catalog name from the selection criteria |
---|---|
schemaPattern | a schema name pattern; "" retrieves those without a schema |
typeNamePattern | a UDT name pattern; may be a fully-qualified name |
Returns
- a
ResultSet
object in which a row gives information about the designated UDT
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract String getSystemFunctions ()
Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.
Returns
- a list of system functions supported by this database
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getTablePrivileges (String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)
Only privileges matching the schema and table name
criteria are returned. They are ordered by
TABLE_CAT
,
TABLE_SCHEM
, TABLE_NAME
,
and PRIVILEGE
.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- GRANTOR String => grantor of access (may be
null
) - GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted
to grant to others; "NO" if not;
null
if unknown
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
tableNamePattern | a table name pattern; must match the table name as it is stored in the database |
Returns
ResultSet
- each row is a table privilege description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract ResultSet getTableTypes ()
Retrieves the table types available in this database. The results are ordered by table type.
The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
Returns
- a
ResultSet
object in which each row has a singleString
column that is a table type
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getTables (String catalog, String schemaPattern, String tableNamePattern, String[] types)
Retrieves a description of the tables available in the given catalog.
Only table descriptions matching the catalog, schema, table
name and type criteria are returned. They are ordered by
TABLE_TYPE
, TABLE_CAT
,
TABLE_SCHEM
and TABLE_NAME
.
Each table description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- REMARKS String => explanatory comment on the table
- TYPE_CAT String => the types catalog (may be
null
) - TYPE_SCHEM String => the types schema (may be
null
) - TYPE_NAME String => type name (may be
null
) - SELF_REFERENCING_COL_NAME String => name of the designated
"identifier" column of a typed table (may be
null
) - REF_GENERATION String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are
"SYSTEM", "USER", "DERIVED". (may be
null
)
Note: Some databases may not return information for all tables.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
tableNamePattern | a table name pattern; must match the table name as it is stored in the database |
types | a list of table types, which must be from the list of table types
returned from getTableTypes() ,to include; null returns
all types |
Returns
ResultSet
- each row is a table description
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract String getTimeDateFunctions ()
Retrieves a comma-separated list of the time and date functions available with this database.
Returns
- the list of time and date functions supported by this database
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getTypeInfo ()
Retrieves a description of all the data types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.
If the database supports SQL distinct types, then getTypeInfo() will return a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT. If the database supports SQL structured types, then getTypeInfo() will return a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.
If SQL distinct or structured types are supported, then information on the individual types may be obtained from the getUDTs() method.
Each type description has the following columns:
- TYPE_NAME String => Type name
- DATA_TYPE int => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal
(may be
null
) - LITERAL_SUFFIX String => suffix used to quote a literal
(may be
null
) - CREATE_PARAMS String => parameters used in creating
the type (may be
null
) - NULLABLE short => can you use NULL for this type.
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive.
- SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned.
- FIXED_PREC_SCALE boolean => can it be a money value.
- AUTO_INCREMENT boolean => can it be used for an auto-increment value.
- LOCAL_TYPE_NAME String => localized version of type name
(may be
null
) - MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
The PRECISION column represents the maximum column size that the server supports for the given datatype. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Returns
- a
ResultSet
object in which each row is an SQL type description
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getUDTs (String catalog, String schemaPattern, String typeNamePattern, int[] types)
Retrieves a description of the user-defined types (UDTs) defined
in a particular schema. Schema-specific UDTs may have type
JAVA_OBJECT
, STRUCT
,
or DISTINCT
.
Only types matching the catalog, schema, type name and type
criteria are returned. They are ordered by DATA_TYPE
,
TYPE_CAT
, TYPE_SCHEM
and
TYPE_NAME
. The type name parameter may be a fully-qualified
name. In this case, the catalog and schemaPattern parameters are
ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be
null
) - TYPE_SCHEM String => type's schema (may be
null
) - TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
- BASE_TYPE short => type code of the source type of a
DISTINCT type or the type that implements the user-generated
reference type of the SELF_REFERENCING_COLUMN of a structured
type as defined in java.sql.Types (
null
if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty result set is returned.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schemaPattern | a schema pattern name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
typeNamePattern | a type name pattern; must match the type name as it is stored in the database; may be a fully qualified name |
types | a list of user-defined types (JAVA_OBJECT,
STRUCT, or DISTINCT) to include; null returns all types |
Returns
ResultSet
object in which each row describes a UDT
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract String getURL ()
Retrieves the URL for this DBMS.
Returns
- the URL for this DBMS or
null
if it cannot be generated
Throws
SQLException | if a database access error occurs |
---|
public abstract String getUserName ()
Retrieves the user name as known to this database.
Returns
- the database user name
Throws
SQLException | if a database access error occurs |
---|
public abstract ResultSet getVersionColumns (String catalog, String schema, String table)
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.
Each column description has the following columns:
- SCOPE short => is not used
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from
java.sql.Types
- TYPE_NAME String => Data source-dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
- PSEUDO_COLUMN short => whether this is pseudo column
like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Parameters
catalog | a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search |
---|---|
schema | a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search |
table | a table name; must match the table name as it is stored in the database |
Returns
- a
ResultSet
object in which each row is a column description
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean insertsAreDetected (int type)
Retrieves whether or not a visible row insert can be detected
by calling the method ResultSet.rowInserted
.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if changes are detected by the specified result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean isCatalogAtStart ()
Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.
Returns
true
if the catalog name appears at the beginning of a fully qualified table name;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean isReadOnly ()
Retrieves whether this database is in read-only mode.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean locatorsUpdateCopy ()
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.
Returns
true
if updates are made to a copy of the LOB;false
if updates are made directly to the LOB
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean nullPlusNonNullIsNull ()
Retrieves whether this database supports concatenations between
NULL
and non-NULL
values being
NULL
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean nullsAreSortedAtEnd ()
Retrieves whether NULL
values are sorted at the end regardless of
sort order.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean nullsAreSortedAtStart ()
Retrieves whether NULL
values are sorted at the start regardless
of sort order.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean nullsAreSortedHigh ()
Retrieves whether NULL
values are sorted high.
Sorted high means that NULL
values
sort higher than any other value in a domain. In an ascending order,
if this method returns true
, NULL
values
will appear at the end. By contrast, the method
nullsAreSortedAtEnd
indicates whether NULL
values
are sorted at the end regardless of sort order.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean nullsAreSortedLow ()
Retrieves whether NULL
values are sorted low.
Sorted low means that NULL
values
sort lower than any other value in a domain. In an ascending order,
if this method returns true
, NULL
values
will appear at the beginning. By contrast, the method
nullsAreSortedAtStart
indicates whether NULL
values
are sorted at the beginning regardless of sort order.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean othersDeletesAreVisible (int type)
Retrieves whether deletes made by others are visible.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if deletes made by others are visible for the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean othersInsertsAreVisible (int type)
Retrieves whether inserts made by others are visible.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if inserts made by others are visible for the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean othersUpdatesAreVisible (int type)
Retrieves whether updates made by others are visible.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if updates made by others are visible for the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean ownDeletesAreVisible (int type)
Retrieves whether a result set's own deletes are visible.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if deletes are visible for the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean ownInsertsAreVisible (int type)
Retrieves whether a result set's own inserts are visible.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if inserts are visible for the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean ownUpdatesAreVisible (int type)
Retrieves whether for the given type of ResultSet
object,
the result set's own updates are visible.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if updates are visible for the given result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean storesLowerCaseIdentifiers ()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean storesLowerCaseQuotedIdentifiers ()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean storesMixedCaseIdentifiers ()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean storesMixedCaseQuotedIdentifiers ()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean storesUpperCaseIdentifiers ()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean storesUpperCaseQuotedIdentifiers ()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsANSI92EntryLevelSQL ()
Retrieves whether this database supports the ANSI92 entry level SQL grammar.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsANSI92FullSQL ()
Retrieves whether this database supports the ANSI92 full SQL grammar supported.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsANSI92IntermediateSQL ()
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsAlterTableWithAddColumn ()
Retrieves whether this database supports ALTER TABLE
with add column.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsAlterTableWithDropColumn ()
Retrieves whether this database supports ALTER TABLE
with drop column.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsBatchUpdates ()
Retrieves whether this database supports batch updates.
Returns
true
if this database supports batch upcates;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCatalogsInDataManipulation ()
Retrieves whether a catalog name can be used in a data manipulation statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCatalogsInIndexDefinitions ()
Retrieves whether a catalog name can be used in an index definition statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCatalogsInPrivilegeDefinitions ()
Retrieves whether a catalog name can be used in a privilege definition statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCatalogsInProcedureCalls ()
Retrieves whether a catalog name can be used in a procedure call statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCatalogsInTableDefinitions ()
Retrieves whether a catalog name can be used in a table definition statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsColumnAliasing ()
Retrieves whether this database supports column aliasing.
If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsConvert (int fromType, int toType)
Retrieves whether this database supports the JDBC scalar function
CONVERT
for conversions between the JDBC types fromType
and toType. The JDBC types are the generic SQL data types defined
in java.sql.Types
.
Parameters
fromType | the type to convert from; one of the type codes from
the class java.sql.Types |
---|---|
toType | the type to convert to; one of the type codes from
the class java.sql.Types |
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract boolean supportsConvert ()
Retrieves whether this database supports the JDBC scalar function
CONVERT
for the conversion of one JDBC type to another.
The JDBC types are the generic SQL data types defined
in java.sql.Types
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCoreSQLGrammar ()
Retrieves whether this database supports the ODBC Core SQL grammar.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsCorrelatedSubqueries ()
Retrieves whether this database supports correlated subqueries.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsDataDefinitionAndDataManipulationTransactions ()
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsDataManipulationTransactionsOnly ()
Retrieves whether this database supports only data manipulation statements within a transaction.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsDifferentTableCorrelationNames ()
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsExpressionsInOrderBy ()
Retrieves whether this database supports expressions in
ORDER BY
lists.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsExtendedSQLGrammar ()
Retrieves whether this database supports the ODBC Extended SQL grammar.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsFullOuterJoins ()
Retrieves whether this database supports full nested outer joins.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsGetGeneratedKeys ()
Retrieves whether auto-generated keys can be retrieved after a statement has been executed
Returns
true
if auto-generated keys can be retrieved after a statement has executed;false
otherwiseIf
true
is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsGroupBy ()
Retrieves whether this database supports some form of
GROUP BY
clause.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsGroupByBeyondSelect ()
Retrieves whether this database supports using columns not included in
the SELECT
statement in a GROUP BY
clause
provided that all of the columns in the SELECT
statement
are included in the GROUP BY
clause.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsGroupByUnrelated ()
Retrieves whether this database supports using a column that is
not in the SELECT
statement in a
GROUP BY
clause.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsIntegrityEnhancementFacility ()
Retrieves whether this database supports the SQL Integrity Enhancement Facility.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsLikeEscapeClause ()
Retrieves whether this database supports specifying a
LIKE
escape clause.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsLimitedOuterJoins ()
Retrieves whether this database provides limited support for outer
joins. (This will be true
if the method
supportsFullOuterJoins
returns true
).
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsMinimumSQLGrammar ()
Retrieves whether this database supports the ODBC Minimum SQL grammar.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsMixedCaseIdentifiers ()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsMixedCaseQuotedIdentifiers ()
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsMultipleOpenResults ()
Retrieves whether it is possible to have multiple ResultSet
objects
returned from a CallableStatement
object
simultaneously.
Returns
true
if aCallableStatement
object can return multipleResultSet
objects simultaneously;false
otherwise
Throws
SQLException | if a datanase access error occurs |
---|
public abstract boolean supportsMultipleResultSets ()
Retrieves whether this database supports getting multiple
ResultSet
objects from a single call to the
method execute
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsMultipleTransactions ()
Retrieves whether this database allows having multiple transactions open at once (on different connections).
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsNamedParameters ()
Retrieves whether this database supports named parameters to callable statements.
Returns
true
if named parameters are supported;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsNonNullableColumns ()
Retrieves whether columns in this database may be defined as non-nullable.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsOpenCursorsAcrossCommit ()
Retrieves whether this database supports keeping cursors open across commits.
Returns
true
if cursors always remain open;false
if they might not remain open
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsOpenCursorsAcrossRollback ()
Retrieves whether this database supports keeping cursors open across rollbacks.
Returns
true
if cursors always remain open;false
if they might not remain open
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsOpenStatementsAcrossCommit ()
Retrieves whether this database supports keeping statements open across commits.
Returns
true
if statements always remain open;false
if they might not remain open
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsOpenStatementsAcrossRollback ()
Retrieves whether this database supports keeping statements open across rollbacks.
Returns
true
if statements always remain open;false
if they might not remain open
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsOrderByUnrelated ()
Retrieves whether this database supports using a column that is
not in the SELECT
statement in an
ORDER BY
clause.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsOuterJoins ()
Retrieves whether this database supports some form of outer join.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsPositionedDelete ()
Retrieves whether this database supports positioned DELETE
statements.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsPositionedUpdate ()
Retrieves whether this database supports positioned UPDATE
statements.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsResultSetConcurrency (int type, int concurrency)
Retrieves whether this database supports the given concurrency type in combination with the given result set type.
Parameters
type | defined in java.sql.ResultSet |
---|---|
concurrency | type defined in java.sql.ResultSet |
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract boolean supportsResultSetHoldability (int holdability)
Retrieves whether this database supports the given result set holdability.
Parameters
holdability | one of the following constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT |
---|
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract boolean supportsResultSetType (int type)
Retrieves whether this database supports the given result set type.
Parameters
type | defined in java.sql.ResultSet |
---|
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract boolean supportsSavepoints ()
Retrieves whether this database supports savepoints.
Returns
true
if savepoints are supported;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSchemasInDataManipulation ()
Retrieves whether a schema name can be used in a data manipulation statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSchemasInIndexDefinitions ()
Retrieves whether a schema name can be used in an index definition statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSchemasInPrivilegeDefinitions ()
Retrieves whether a schema name can be used in a privilege definition statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSchemasInProcedureCalls ()
Retrieves whether a schema name can be used in a procedure call statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSchemasInTableDefinitions ()
Retrieves whether a schema name can be used in a table definition statement.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSelectForUpdate ()
Retrieves whether this database supports SELECT FOR UPDATE
statements.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsStatementPooling ()
Retrieves whether this database supports statement pooling.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsStoredFunctionsUsingCallSyntax ()
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsStoredProcedures ()
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSubqueriesInComparisons ()
Retrieves whether this database supports subqueries in comparison expressions.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSubqueriesInExists ()
Retrieves whether this database supports subqueries in
EXISTS
expressions.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSubqueriesInIns ()
Retrieves whether this database supports subqueries in
IN
expressions.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsSubqueriesInQuantifieds ()
Retrieves whether this database supports subqueries in quantified expressions.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsTableCorrelationNames ()
Retrieves whether this database supports table correlation names.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsTransactionIsolationLevel (int level)
Retrieves whether this database supports the given transaction isolation level.
Parameters
level | one of the transaction isolation levels defined in
java.sql.Connection |
---|
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
See Also
public abstract boolean supportsTransactions ()
Retrieves whether this database supports transactions. If not, invoking the
method commit
is a noop, and the isolation level is
TRANSACTION_NONE
.
Returns
true
if transactions are supported;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsUnion ()
Retrieves whether this database supports SQL UNION
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean supportsUnionAll ()
Retrieves whether this database supports SQL UNION ALL
.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean updatesAreDetected (int type)
Retrieves whether or not a visible row update can be detected by
calling the method ResultSet.rowUpdated
.
Parameters
type | the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
---|
Returns
true
if changes are detected by the result set type;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean usesLocalFilePerTable ()
Retrieves whether this database uses a file for each table.
Returns
true
if this database uses a local file for each table;false
otherwise
Throws
SQLException | if a database access error occurs |
---|
public abstract boolean usesLocalFiles ()
Retrieves whether this database stores tables in a local file.
Returns
true
if so;false
otherwise
Throws
SQLException | if a database access error occurs |
---|