public interface DatabaseMetaData extends Wrapper
This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBC™ 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.
| Modifier and Type | Field and Description |
|---|---|
static short |
attributeNoNulls
Indicates that
NULL values might not be allowed.
|
static short |
attributeNullable
Indicates that
NULL values are definitely allowed.
|
static short |
attributeNullableUnknown
Indicates that whether
NULL values are allowed is not known.
|
static int |
bestRowNotPseudo
Indicates that the best row identifier is NOT a pseudo column.
|
static int |
bestRowPseudo
Indicates that the best row identifier is a pseudo column.
|
static int |
bestRowSession
Indicates that the scope of the best row identifier is the remainder of the current session.
|
static int |
bestRowTemporary
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.
|
static int |
bestRowTransaction
Indicates that the scope of the best row identifier is the remainder of the current transaction.
|
static int |
bestRowUnknown
Indicates that the best row identifier may or may not be a pseudo column.
|
static int |
columnNoNulls
Indicates that the column might not allow
NULL values.
|
static int |
columnNullable
Indicates that the column definitely allows
NULL values.
|
static int |
columnNullableUnknown
Indicates that the nullability of columns is unknown.
|
static int |
functionColumnIn
Indicates that the parameter or column is an IN parameter.
|
static int |
functionColumnInOut
Indicates that the parameter or column is an INOUT parameter.
|
static int |
functionColumnOut
Indicates that the parameter or column is an OUT parameter.
|
static int |
functionColumnResult
Indicates that the parameter or column is a column in a result set.
|
static int |
functionColumnUnknown
Indicates that type of the parameter or column is unknown.
|
static int |
functionNoNulls
Indicates that
NULL values are not allowed.
|
static int |
functionNoTable
Indicates that the function does not return a table.
|
static int |
functionNullable
Indicates that
NULL values are allowed.
|
static int |
functionNullableUnknown
Indicates that whether
NULL values are allowed is unknown.
|
static int |
functionResultUnknown
Indicates that it is not known whether the function returns a result or a table.
|
static int |
functionReturn
Indicates that the parameter or column is a return value.
|
static int |
functionReturnsTable
Indicates that the function returns a table.
|
static 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.
|
static int |
importedKeyInitiallyDeferred
Indicates deferrability.
|
static int |
importedKeyInitiallyImmediate
Indicates deferrability.
|
static 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.
|
static int |
importedKeyNotDeferrable
Indicates deferrability.
|
static 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.
|
static 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.
|
static 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.
|
static int |
procedureColumnIn
Indicates that the column stores IN parameters.
|
static int |
procedureColumnInOut
Indicates that the column stores INOUT parameters.
|
static int |
procedureColumnOut
Indicates that the column stores OUT parameters.
|
static int |
procedureColumnResult
Indicates that the column stores results.
|
static int |
procedureColumnReturn
Indicates that the column stores return values.
|
static int |
procedureColumnUnknown
Indicates that type of the column is unknown.
|
static int |
procedureNoNulls
Indicates that
NULL values are not allowed.
|
static int |
procedureNoResult
Indicates that the procedure does not return a result.
|
static int |
procedureNullable
Indicates that
NULL values are allowed.
|
static int |
procedureNullableUnknown
Indicates that whether
NULL values are allowed is unknown.
|
static int |
procedureResultUnknown
Indicates that it is not known whether the procedure returns a result.
|
static int |
procedureReturnsResult
Indicates that the procedure returns a result.
|
static 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.
|
static 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.
|
static 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.
|
static short |
tableIndexClustered
Indicates that this table index is a clustered index.
|
static short |
tableIndexHashed
Indicates that this table index is a hashed index.
|
static short |
tableIndexOther
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.
|
static short |
tableIndexStatistic
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.
|
static int |
typeNoNulls
Indicates that a
NULL value is NOT allowed for this data type.
|
static int |
typeNullable
Indicates that a
NULL value is allowed for this data type.
|
static int |
typeNullableUnknown
Indicates that it is not known whether a
NULL value is allowed for this data type.
|
static int |
typePredBasic
Indicates that the data type can be only be used in
WHERE search clauses that do not use
LIKE predicates.
|
static int |
typePredChar
Indicates that the data type can be only be used in
WHERE search clauses that use
LIKE predicates.
|
static int |
typePredNone
Indicates that
WHERE search clauses are not supported for this type.
|
static int |
typeSearchable
Indicates that all
WHERE search clauses can be based on this type.
|
static int |
versionColumnNotPseudo
Indicates that this version column is NOT a pseudo column.
|
static int |
versionColumnPseudo
Indicates that this version column is a pseudo column.
|
static int |
versionColumnUnknown
Indicates that this version column may or may not be a pseudo column.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
allProceduresAreCallable()
Retrieves whether the current user can call all the procedures returned by the method
getProcedures.
|
boolean |
allTablesAreSelectable()
Retrieves whether the current user can use all the tables returned by the method
getTables in a
SELECT statement.
|
boolean |
autoCommitFailureClosesAllResultSets()
Retrieves whether a
SQLException while autoCommit is
true indicates that all open ResultSets are closed, even ones that are holdable.
|
boolean |
dataDefinitionCausesTransactionCommit()
Retrieves whether a data definition statement within a transaction forces the transaction to commit.
|
boolean |
dataDefinitionIgnoredInTransactions()
Retrieves whether this database ignores a data definition statement within a transaction.
|
boolean |
deletesAreDetected(int type)
Retrieves whether or not a visible row delete can be detected by calling the method
ResultSet.rowDeleted.
|
boolean |
doesMaxRowSizeIncludeBlobs()
Retrieves whether the return value for the method
getMaxRowSize includes the SQL data types
LONGVARCHAR and
LONGVARBINARY.
|
boolean |
generatedKeyAlwaysReturned()
Retrieves whether a generated key will always be returned if the column name(s) or index(es) specified for the auto generated key column(s) are valid and the statement succeeds.
|
ResultSet |
getAttributes(String
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.
|
ResultSet |
getBestRowIdentifier(String
Retrieves a description of a table's optimal set of columns that uniquely identifies a row.
|
ResultSet |
getCatalogs()
Retrieves the catalog names available in this database.
|
String |
getCatalogSeparator()
Retrieves the
String that this database uses as the separator between a catalog and table name.
|
String |
getCatalogTerm()
Retrieves the database vendor's preferred term for "catalog".
|
ResultSet |
getClientInfoProperties()
Retrieves a list of the client info properties that the driver supports.
|
ResultSet |
getColumnPrivileges(String
Retrieves a description of the access rights for a table's columns.
|
ResultSet |
getColumns(String
Retrieves a description of table columns available in the specified catalog.
|
Connection |
getConnection()
Retrieves the connection that produced this metadata object.
|
ResultSet |
getCrossReference(String
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).
|
int |
getDatabaseMajorVersion()
Retrieves the major version number of the underlying database.
|
int |
getDatabaseMinorVersion()
Retrieves the minor version number of the underlying database.
|
String |
getDatabaseProductName()
Retrieves the name of this database product.
|
String |
getDatabaseProductVersion()
Retrieves the version number of this database product.
|
int |
getDefaultTransactionIsolation()
Retrieves this database's default transaction isolation level.
|
int |
getDriverMajorVersion()
Retrieves this JDBC driver's major version number.
|
int |
getDriverMinorVersion()
Retrieves this JDBC driver's minor version number.
|
String |
getDriverName()
Retrieves the name of this JDBC driver.
|
String |
getDriverVersion()
Retrieves the version number of this JDBC driver as a
String.
|
ResultSet |
getExportedKeys(String
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).
|
String |
getExtraNameCharacters()
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
|
ResultSet |
getFunctionColumns(String
Retrieves a description of the given catalog's system or user function parameters and return type.
|
ResultSet |
getFunctions(String
Retrieves a description of the system and user functions available in the given catalog.
|
String |
getIdentifierQuoteString()
Retrieves the string used to quote SQL identifiers.
|
ResultSet |
getImportedKeys(String
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).
|
ResultSet |
getIndexInfo(String
Retrieves a description of the given table's indices and statistics.
|
int |
getJDBCMajorVersion()
Retrieves the major JDBC version number for this driver.
|
int |
getJDBCMinorVersion()
Retrieves the minor JDBC version number for this driver.
|
int |
getMaxBinaryLiteralLength()
Retrieves the maximum number of hex characters this database allows in an inline binary literal.
|
int |
getMaxCatalogNameLength()
Retrieves the maximum number of characters that this database allows in a catalog name.
|
int |
getMaxCharLiteralLength()
Retrieves the maximum number of characters this database allows for a character literal.
|
int |
getMaxColumnNameLength()
Retrieves the maximum number of characters this database allows for a column name.
|
int |
getMaxColumnsInGroupBy()
Retrieves the maximum number of columns this database allows in a
GROUP BY clause.
|
int |
getMaxColumnsInIndex()
Retrieves the maximum number of columns this database allows in an index.
|
int |
getMaxColumnsInOrderBy()
Retrieves the maximum number of columns this database allows in an
ORDER BY clause.
|
int |
getMaxColumnsInSelect()
Retrieves the maximum number of columns this database allows in a
SELECT list.
|
int |
getMaxColumnsInTable()
Retrieves the maximum number of columns this database allows in a table.
|
int |
getMaxConnections()
Retrieves the maximum number of concurrent connections to this database that are possible.
|
int |
getMaxCursorNameLength()
Retrieves the maximum number of characters that this database allows in a cursor name.
|
int |
getMaxIndexLength()
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.
|
default long |
getMaxLogicalLobSize()
Retrieves the maximum number of bytes this database allows for the logical size for a
LOB.
|
int |
getMaxProcedureNameLength()
Retrieves the maximum number of characters that this database allows in a procedure name.
|
int |
getMaxRowSize()
Retrieves the maximum number of bytes this database allows in a single row.
|
int |
getMaxSchemaNameLength()
Retrieves the maximum number of characters that this database allows in a schema name.
|
int |
getMaxStatementLength()
Retrieves the maximum number of characters this database allows in an SQL statement.
|
int |
getMaxStatements()
Retrieves the maximum number of active statements to this database that can be open at the same time.
|
int |
getMaxTableNameLength()
Retrieves the maximum number of characters this database allows in a table name.
|
int |
getMaxTablesInSelect()
Retrieves the maximum number of tables this database allows in a
SELECT statement.
|
int |
getMaxUserNameLength()
Retrieves the maximum number of characters this database allows in a user name.
|
String |
getNumericFunctions()
Retrieves a comma-separated list of math functions available with this database.
|
ResultSet |
getPrimaryKeys(String
Retrieves a description of the given table's primary key columns.
|
ResultSet |
getProcedureColumns(String
Retrieves a description of the given catalog's stored procedure parameter and result columns.
|
ResultSet |
getProcedures(String
Retrieves a description of the stored procedures available in the given catalog.
|
String |
getProcedureTerm()
Retrieves the database vendor's preferred term for "procedure".
|
ResultSet |
getPseudoColumns(String
Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema.
|
int |
getResultSetHoldability()
Retrieves this database's default holdability for
ResultSet objects.
|
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.
|
ResultSet |
getSchemas()
Retrieves the schema names available in this database.
|
ResultSet |
getSchemas(String
Retrieves the schema names available in this database.
|
String |
getSchemaTerm()
Retrieves the database vendor's preferred term for "schema".
|
String |
getSearchStringEscape()
Retrieves the string that can be used to escape wildcard characters.
|
String |
getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.
|
int |
getSQLStateType()
Indicates whether the SQLSTATE returned by
SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.
|
String |
getStringFunctions()
Retrieves a comma-separated list of string functions available with this database.
|
ResultSet |
getSuperTables(String
Retrieves a description of the table hierarchies defined in a particular schema in this database.
|
ResultSet |
getSuperTypes(String
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
|
String |
getSystemFunctions()
Retrieves a comma-separated list of system functions available with this database.
|
ResultSet |
getTablePrivileges(String
Retrieves a description of the access rights for each table available in a catalog.
|
ResultSet |
getTables(String
Retrieves a description of the tables available in the given catalog.
|
ResultSet |
getTableTypes()
Retrieves the table types available in this database.
|
String |
getTimeDateFunctions()
Retrieves a comma-separated list of the time and date functions available with this database.
|
ResultSet |
getTypeInfo()
Retrieves a description of all the data types supported by this database.
|
ResultSet |
getUDTs(String
Retrieves a description of the user-defined types (UDTs) defined in a particular schema.
|
String |
getURL()
Retrieves the URL for this DBMS.
|
String |
getUserName()
Retrieves the user name as known to this database.
|
ResultSet |
getVersionColumns(String
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated.
|
boolean |
insertsAreDetected(int type)
Retrieves whether or not a visible row insert can be detected by calling the method
ResultSet.rowInserted.
|
boolean |
isCatalogAtStart()
Retrieves whether a catalog appears at the start of a fully qualified table name.
|
boolean |
isReadOnly()
Retrieves whether this database is in read-only mode.
|
boolean |
locatorsUpdateCopy()
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.
|
boolean |
nullPlusNonNullIsNull()
Retrieves whether this database supports concatenations between
NULL and non-
NULL values being
NULL.
|
boolean |
nullsAreSortedAtEnd()
Retrieves whether
NULL values are sorted at the end regardless of sort order.
|
boolean |
nullsAreSortedAtStart()
Retrieves whether
NULL values are sorted at the start regardless of sort order.
|
boolean |
nullsAreSortedHigh()
Retrieves whether
NULL values are sorted high.
|
boolean |
nullsAreSortedLow()
Retrieves whether
NULL values are sorted low.
|
boolean |
othersDeletesAreVisible(int type)
Retrieves whether deletes made by others are visible.
|
boolean |
othersInsertsAreVisible(int type)
Retrieves whether inserts made by others are visible.
|
boolean |
othersUpdatesAreVisible(int type)
Retrieves whether updates made by others are visible.
|
boolean |
ownDeletesAreVisible(int type)
Retrieves whether a result set's own deletes are visible.
|
boolean |
ownInsertsAreVisible(int type)
Retrieves whether a result set's own inserts are visible.
|
boolean |
ownUpdatesAreVisible(int type)
Retrieves whether for the given type of
ResultSet object, the result set's own updates are visible.
|
boolean |
storesLowerCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.
|
boolean |
storesLowerCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.
|
boolean |
storesMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.
|
boolean |
storesMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.
|
boolean |
storesUpperCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
|
boolean |
storesUpperCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.
|
boolean |
supportsAlterTableWithAddColumn()
Retrieves whether this database supports
ALTER TABLE with add column.
|
boolean |
supportsAlterTableWithDropColumn()
Retrieves whether this database supports
ALTER TABLE with drop column.
|
boolean |
supportsANSI92EntryLevelSQL()
Retrieves whether this database supports the ANSI92 entry level SQL grammar.
|
boolean |
supportsANSI92FullSQL()
Retrieves whether this database supports the ANSI92 full SQL grammar supported.
|
boolean |
supportsANSI92IntermediateSQL()
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.
|
boolean |
supportsBatchUpdates()
Retrieves whether this database supports batch updates.
|
boolean |
supportsCatalogsInDataManipulation()
Retrieves whether a catalog name can be used in a data manipulation statement.
|
boolean |
supportsCatalogsInIndexDefinitions()
Retrieves whether a catalog name can be used in an index definition statement.
|
boolean |
supportsCatalogsInPrivilegeDefinitions()
Retrieves whether a catalog name can be used in a privilege definition statement.
|
boolean |
supportsCatalogsInProcedureCalls()
Retrieves whether a catalog name can be used in a procedure call statement.
|
boolean |
supportsCatalogsInTableDefinitions()
Retrieves whether a catalog name can be used in a table definition statement.
|
boolean |
supportsColumnAliasing()
Retrieves whether this database supports column aliasing.
|
boolean |
supportsConvert()
Retrieves whether this database supports the JDBC scalar function
CONVERT for the conversion of one JDBC type to another.
|
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.
|
boolean |
supportsCoreSQLGrammar()
Retrieves whether this database supports the ODBC Core SQL grammar.
|
boolean |
supportsCorrelatedSubqueries()
Retrieves whether this database supports correlated subqueries.
|
boolean |
supportsDataDefinitionAndDataManipulationTransactions()
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.
|
boolean |
supportsDataManipulationTransactionsOnly()
Retrieves whether this database supports only data manipulation statements within a transaction.
|
boolean |
supportsDifferentTableCorrelationNames()
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.
|
boolean |
supportsExpressionsInOrderBy()
Retrieves whether this database supports expressions in
ORDER BY lists.
|
boolean |
supportsExtendedSQLGrammar()
Retrieves whether this database supports the ODBC Extended SQL grammar.
|
boolean |
supportsFullOuterJoins()
Retrieves whether this database supports full nested outer joins.
|
boolean |
supportsGetGeneratedKeys()
Retrieves whether auto-generated keys can be retrieved after a statement has been executed
|
boolean |
supportsGroupBy()
Retrieves whether this database supports some form of
GROUP BY clause.
|
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.
|
boolean |
supportsGroupByUnrelated()
Retrieves whether this database supports using a column that is not in the
SELECT statement in a
GROUP BY clause.
|
boolean |
supportsIntegrityEnhancementFacility()
Retrieves whether this database supports the SQL Integrity Enhancement Facility.
|
boolean |
supportsLikeEscapeClause()
Retrieves whether this database supports specifying a
LIKE escape clause.
|
boolean |
supportsLimitedOuterJoins()
Retrieves whether this database provides limited support for outer joins.
|
boolean |
supportsMinimumSQLGrammar()
Retrieves whether this database supports the ODBC Minimum SQL grammar.
|
boolean |
supportsMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.
|
boolean |
supportsMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.
|
boolean |
supportsMultipleOpenResults()
Retrieves whether it is possible to have multiple
ResultSet objects returned from a
CallableStatement object simultaneously.
|
boolean |
supportsMultipleResultSets()
Retrieves whether this database supports getting multiple
ResultSet objects from a single call to the method
execute.
|
boolean |
supportsMultipleTransactions()
Retrieves whether this database allows having multiple transactions open at once (on different connections).
|
boolean |
supportsNamedParameters()
Retrieves whether this database supports named parameters to callable statements.
|
boolean |
supportsNonNullableColumns()
Retrieves whether columns in this database may be defined as non-nullable.
|
boolean |
supportsOpenCursorsAcrossCommit()
Retrieves whether this database supports keeping cursors open across commits.
|
boolean |
supportsOpenCursorsAcrossRollback()
Retrieves whether this database supports keeping cursors open across rollbacks.
|
boolean |
supportsOpenStatementsAcrossCommit()
Retrieves whether this database supports keeping statements open across commits.
|
boolean |
supportsOpenStatementsAcrossRollback()
Retrieves whether this database supports keeping statements open across rollbacks.
|
boolean |
supportsOrderByUnrelated()
Retrieves whether this database supports using a column that is not in the
SELECT statement in an
ORDER BY clause.
|
boolean |
supportsOuterJoins()
Retrieves whether this database supports some form of outer join.
|
boolean |
supportsPositionedDelete()
Retrieves whether this database supports positioned
DELETE statements.
|
boolean |
supportsPositionedUpdate()
Retrieves whether this database supports positioned
UPDATE statements.
|
default boolean |
supportsRefCursors()
Retrieves whether this database supports REF CURSOR.
|
boolean |
supportsResultSetConcurrency(int type, int concurrency)
Retrieves whether this database supports the given concurrency type in combination with the given result set type.
|
boolean |
supportsResultSetHoldability(int holdability)
Retrieves whether this database supports the given result set holdability.
|
boolean |
supportsResultSetType(int type)
Retrieves whether this database supports the given result set type.
|
boolean |
supportsSavepoints()
Retrieves whether this database supports savepoints.
|
boolean |
supportsSchemasInDataManipulation()
Retrieves whether a schema name can be used in a data manipulation statement.
|
boolean |
supportsSchemasInIndexDefinitions()
Retrieves whether a schema name can be used in an index definition statement.
|
boolean |
supportsSchemasInPrivilegeDefinitions()
Retrieves whether a schema name can be used in a privilege definition statement.
|
boolean |
supportsSchemasInProcedureCalls()
Retrieves whether a schema name can be used in a procedure call statement.
|
boolean |
supportsSchemasInTableDefinitions()
Retrieves whether a schema name can be used in a table definition statement.
|
boolean |
supportsSelectForUpdate()
Retrieves whether this database supports
SELECT FOR UPDATE statements.
|
boolean |
supportsStatementPooling()
Retrieves whether this database supports statement pooling.
|
boolean |
supportsStoredFunctionsUsingCallSyntax()
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.
|
boolean |
supportsStoredProcedures()
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.
|
boolean |
supportsSubqueriesInComparisons()
Retrieves whether this database supports subqueries in comparison expressions.
|
boolean |
supportsSubqueriesInExists()
Retrieves whether this database supports subqueries in
EXISTS expressions.
|
boolean |
supportsSubqueriesInIns()
Retrieves whether this database supports subqueries in
IN expressions.
|
boolean |
supportsSubqueriesInQuantifieds()
Retrieves whether this database supports subqueries in quantified expressions.
|
boolean |
supportsTableCorrelationNames()
Retrieves whether this database supports table correlation names.
|
boolean |
supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction isolation level.
|
boolean |
supportsTransactions()
Retrieves whether this database supports transactions.
|
boolean |
supportsUnion()
Retrieves whether this database supports SQL
UNION.
|
boolean |
supportsUnionAll()
Retrieves whether this database supports SQL
UNION ALL.
|
boolean |
updatesAreDetected(int type)
Retrieves whether or not a visible row update can be detected by calling the method
ResultSet.rowUpdated.
|
boolean |
usesLocalFilePerTable()
Retrieves whether this database uses a file for each table.
|
boolean |
usesLocalFiles()
Retrieves whether this database stores tables in a local file.
|
isWrapperFor, unwrapstatic final int procedureResultUnknown
A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.
static final int procedureNoResult
A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.
static final int procedureReturnsResult
A possible value for column PROCEDURE_TYPE in the ResultSet object returned by the method getProcedures.
static final int procedureColumnUnknown
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
static final int procedureColumnIn
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
static final int procedureColumnInOut
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
static final int procedureColumnOut
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
static final int procedureColumnReturn
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
static final int procedureColumnResult
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getProcedureColumns.
static final int procedureNoNulls
NULL values are not allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.
static final int procedureNullable
NULL values are allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.
static final int procedureNullableUnknown
NULL values are allowed is unknown.
A possible value for the column NULLABLE in the ResultSet object returned by the method getProcedureColumns.
static final int columnNoNulls
NULL values.
A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.
static final int columnNullable
NULL values.
A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.
static final int columnNullableUnknown
A possible value for the column NULLABLE in the ResultSet returned by the method getColumns.
static final int bestRowTemporary
A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.
static final int bestRowTransaction
A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.
static final int bestRowSession
A possible value for the column SCOPE in the ResultSet object returned by the method getBestRowIdentifier.
static final int bestRowUnknown
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.
static final int bestRowNotPseudo
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.
static final int bestRowPseudo
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getBestRowIdentifier.
static final int versionColumnUnknown
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.
static final int versionColumnNotPseudo
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.
static final int versionColumnPseudo
A possible value for the column PSEUDO_COLUMN in the ResultSet object returned by the method getVersionColumns.
static final int importedKeyCascade
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.
static final int importedKeyRestrict
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.
static final int importedKeySetNull
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.
static final int importedKeyNoAction
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.
static final int importedKeySetDefault
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.
static final int importedKeyInitiallyDeferred
A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.
static final int importedKeyInitiallyImmediate
A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.
static final int importedKeyNotDeferrable
A possible value for the column DEFERRABILITY in the ResultSet objects returned by the methods getImportedKeys, getExportedKeys, and getCrossReference.
static final int typeNoNulls
NULL value is NOT allowed for this data type.
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.
static final int typeNullable
NULL value is allowed for this data type.
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.
static final int typeNullableUnknown
NULL value is allowed for this data type.
A possible value for column NULLABLE in the ResultSet object returned by the method getTypeInfo.
static final int typePredNone
WHERE search clauses are not supported for this type.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.
static final int typePredChar
WHERE search clauses that use
LIKE predicates.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.
static final int typePredBasic
WHERE search clauses that do not use
LIKE predicates.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.
static final int typeSearchable
WHERE search clauses can be based on this type.
A possible value for column SEARCHABLE in the ResultSet object returned by the method getTypeInfo.
static final short tableIndexStatistic
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.
static final short tableIndexClustered
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.
static final short tableIndexHashed
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.
static final short tableIndexOther
A possible value for column TYPE in the ResultSet object returned by the method getIndexInfo.
static final short attributeNoNulls
NULL values might not be allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.
static final short attributeNullable
NULL values are definitely allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.
static final short attributeNullableUnknown
NULL values are allowed is not known.
A possible value for the column NULLABLE in the ResultSet object returned by the method getAttributes.
static final int sqlStateXOpen
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.
static final int sqlStateSQL
DatabaseMetaData.getSQLStateType which is used to indicate whether the value returned by the method
SQLException.getSQLState is an SQLSTATE value.
static final int sqlStateSQL99
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.
static final int functionColumnUnknown
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
static final int functionColumnIn
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
static final int functionColumnInOut
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
static final int functionColumnOut
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
static final int functionReturn
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
static final int functionColumnResult
A possible value for the column COLUMN_TYPE in the ResultSet returned by the method getFunctionColumns.
static final int functionNoNulls
NULL values are not allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.
static final int functionNullable
NULL values are allowed.
A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.
static final int functionNullableUnknown
NULL values are allowed is unknown.
A possible value for the column NULLABLE in the ResultSet object returned by the method getFunctionColumns.
static final int functionResultUnknown
A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.
static final int functionNoTable
A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.
static final int functionReturnsTable
A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method getFunctions.
boolean allProceduresAreCallable()
throws SQLException
getProcedures.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean allTablesAreSelectable()
throws SQLException
getTables in a
SELECT statement.
true if so;
false otherwise
SQLException - if a database access error occurs
StringgetURL() throws SQLException
null if it cannot be generated
SQLException - if a database access error occurs
StringgetUserName() throws SQLException
SQLException - if a database access error occurs
boolean isReadOnly()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean nullsAreSortedHigh()
throws SQLException
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.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean nullsAreSortedLow()
throws SQLException
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.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean nullsAreSortedAtStart()
throws SQLException
NULL values are sorted at the start regardless of sort order.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean nullsAreSortedAtEnd()
throws SQLException
NULL values are sorted at the end regardless of sort order.
true if so;
false otherwise
SQLException - if a database access error occurs
StringgetDatabaseProductName() throws SQLException
SQLException - if a database access error occurs
StringgetDatabaseProductVersion() throws SQLException
SQLException - if a database access error occurs
StringgetDriverName() throws SQLException
SQLException - if a database access error occurs
StringgetDriverVersion() throws SQLException
String.
SQLException - if a database access error occurs
int getDriverMajorVersion()
int getDriverMinorVersion()
boolean usesLocalFiles()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean usesLocalFilePerTable()
throws SQLException
true if this database uses a local file for each table;
false otherwise
SQLException - if a database access error occurs
boolean supportsMixedCaseIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean storesUpperCaseIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean storesLowerCaseIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean storesMixedCaseIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsMixedCaseQuotedIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean storesUpperCaseQuotedIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean storesLowerCaseQuotedIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean storesMixedCaseQuotedIdentifiers()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
StringgetIdentifierQuoteString() throws SQLException
SQLException - if a database access error occurs
StringgetSQLKeywords() throws SQLException
SQLException - if a database access error occurs
StringgetNumericFunctions() throws SQLException
SQLException - if a database access error occurs
StringgetStringFunctions() throws SQLException
SQLException - if a database access error occurs
StringgetSystemFunctions() throws SQLException
SQLException - if a database access error occurs
StringgetTimeDateFunctions() throws SQLException
SQLException - if a database access error occurs
StringgetSearchStringEscape() throws SQLException
The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
SQLException - if a database access error occurs
StringgetExtraNameCharacters() throws SQLException
SQLException - if a database access error occurs
boolean supportsAlterTableWithAddColumn()
throws SQLException
ALTER TABLE with add column.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsAlterTableWithDropColumn()
throws SQLException
ALTER TABLE with drop column.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsColumnAliasing()
throws SQLException
If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean nullPlusNonNullIsNull()
throws SQLException
NULL and non-
NULL values being
NULL.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsConvert()
throws SQLException
CONVERT for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined in
java.sql.Types.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsConvert(int fromType,
int toType)
throws SQLException
CONVERT for conversions between the JDBC types
fromType and
toType. The JDBC types are the generic SQL data types defined in
java.sql.Types.
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
true if so;
false otherwise
SQLException - if a database access error occurs
Types
boolean supportsTableCorrelationNames()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsDifferentTableCorrelationNames()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsExpressionsInOrderBy()
throws SQLException
ORDER BY lists.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsOrderByUnrelated()
throws SQLException
SELECT statement in an
ORDER BY clause.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsGroupBy()
throws SQLException
GROUP BY clause.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsGroupByUnrelated()
throws SQLException
SELECT statement in a
GROUP BY clause.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsGroupByBeyondSelect()
throws SQLException
SELECT statement in a
GROUP BY clause provided that all of the columns in the
SELECT statement are included in the
GROUP BY clause.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsLikeEscapeClause()
throws SQLException
LIKE escape clause.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsMultipleResultSets()
throws SQLException
ResultSet objects from a single call to the method
execute.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsMultipleTransactions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsNonNullableColumns()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsMinimumSQLGrammar()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCoreSQLGrammar()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsExtendedSQLGrammar()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsANSI92EntryLevelSQL()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsANSI92IntermediateSQL()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsANSI92FullSQL()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsIntegrityEnhancementFacility()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsOuterJoins()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsFullOuterJoins()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsLimitedOuterJoins()
throws SQLException
true if the method
supportsFullOuterJoins returns
true).
true if so;
false otherwise
SQLException - if a database access error occurs
StringgetSchemaTerm() throws SQLException
SQLException - if a database access error occurs
StringgetProcedureTerm() throws SQLException
SQLException - if a database access error occurs
StringgetCatalogTerm() throws SQLException
SQLException - if a database access error occurs
boolean isCatalogAtStart()
throws SQLException
true if the catalog name appears at the beginning of a fully qualified table name;
false otherwise
SQLException - if a database access error occurs
StringgetCatalogSeparator() throws SQLException
String that this database uses as the separator between a catalog and table name.
SQLException - if a database access error occurs
boolean supportsSchemasInDataManipulation()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSchemasInProcedureCalls()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSchemasInTableDefinitions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSchemasInIndexDefinitions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSchemasInPrivilegeDefinitions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCatalogsInDataManipulation()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCatalogsInProcedureCalls()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCatalogsInTableDefinitions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCatalogsInIndexDefinitions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCatalogsInPrivilegeDefinitions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsPositionedDelete()
throws SQLException
DELETE statements.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsPositionedUpdate()
throws SQLException
UPDATE statements.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSelectForUpdate()
throws SQLException
SELECT FOR UPDATE statements.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsStoredProcedures()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSubqueriesInComparisons()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSubqueriesInExists()
throws SQLException
EXISTS expressions.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSubqueriesInIns()
throws SQLException
IN expressions.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsSubqueriesInQuantifieds()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsCorrelatedSubqueries()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsUnion()
throws SQLException
UNION.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsUnionAll()
throws SQLException
UNION ALL.
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsOpenCursorsAcrossCommit()
throws SQLException
true if cursors always remain open;
false if they might not remain open
SQLException - if a database access error occurs
boolean supportsOpenCursorsAcrossRollback()
throws SQLException
true if cursors always remain open;
false if they might not remain open
SQLException - if a database access error occurs
boolean supportsOpenStatementsAcrossCommit()
throws SQLException
true if statements always remain open;
false if they might not remain open
SQLException - if a database access error occurs
boolean supportsOpenStatementsAcrossRollback()
throws SQLException
true if statements always remain open;
false if they might not remain open
SQLException - if a database access error occurs
int getMaxBinaryLiteralLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxCharLiteralLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxColumnNameLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxColumnsInGroupBy()
throws SQLException
GROUP BY clause.
SQLException - if a database access error occurs
int getMaxColumnsInIndex()
throws SQLException
SQLException - if a database access error occurs
int getMaxColumnsInOrderBy()
throws SQLException
ORDER BY clause.
SQLException - if a database access error occurs
int getMaxColumnsInSelect()
throws SQLException
SELECT list.
SQLException - if a database access error occurs
int getMaxColumnsInTable()
throws SQLException
SQLException - if a database access error occurs
int getMaxConnections()
throws SQLException
SQLException - if a database access error occurs
int getMaxCursorNameLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxIndexLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxSchemaNameLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxProcedureNameLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxCatalogNameLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxRowSize()
throws SQLException
SQLException - if a database access error occurs
boolean doesMaxRowSizeIncludeBlobs()
throws SQLException
getMaxRowSize includes the SQL data types
LONGVARCHAR and
LONGVARBINARY.
true if so;
false otherwise
SQLException - if a database access error occurs
int getMaxStatementLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxStatements()
throws SQLException
SQLException - if a database access error occurs
int getMaxTableNameLength()
throws SQLException
SQLException - if a database access error occurs
int getMaxTablesInSelect()
throws SQLException
SELECT statement.
SELECT statement; a result of zero means that there is no limit or the limit is not known
SQLException - if a database access error occurs
int getMaxUserNameLength()
throws SQLException
SQLException - if a database access error occurs
int getDefaultTransactionIsolation()
throws SQLException
java.sql.Connection.
SQLException - if a database access error occurs
Connection
boolean supportsTransactions()
throws SQLException
commit is a noop, and the isolation level is
TRANSACTION_NONE.
true if transactions are supported;
false otherwise
SQLException - if a database access error occurs
boolean supportsTransactionIsolationLevel(int level)
throws SQLException
level - one of the transaction isolation levels defined in
java.sql.Connection
true if so;
false otherwise
SQLException - if a database access error occurs
Connection
boolean supportsDataDefinitionAndDataManipulationTransactions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean supportsDataManipulationTransactionsOnly()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean dataDefinitionCausesTransactionCommit()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean dataDefinitionIgnoredInTransactions()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
ResultSetgetProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException
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 catalog (may be null) => procedure schema (may be null) => procedure name => explanatory comment on the procedure => kind of procedure:
=> 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
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
ResultSet - each row is a procedure description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException
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 catalog (may be null) => procedure schema (may be null) => procedure name => column/parameter name => kind of column/parameter:
ResultSet => SQL type from java.sql.Types => SQL type name, for a UDT type the type name is fully qualified => precision => length in bytes of data => scale - null is returned for data types where SCALE is not applicable. => radix => can it contain NULL.
=> comment describing parameter/column => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
=> reserved for future use => reserved for future use => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL => 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. => ISO rules are used to determine the nullability for a column.
=> 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.
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
ResultSet - each row describes a stored procedure parameter or column
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetTables(String catalog, String schemaPattern, String tableNamePattern, String [] types) throws SQLException
TABLE_TYPE,
TABLE_CAT,
TABLE_SCHEM and
TABLE_NAME.
Each table description has the following columns:
=> table catalog (may be null) => table schema (may be null) => table name => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". => explanatory comment on the table => the types catalog (may be null) => the types schema (may be null) => type name (may be null) => name of the designated "identifier" column of a typed table (may be null) => 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.
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
ResultSet - each row is a table description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetSchemas() throws SQLException
TABLE_CATALOG and
TABLE_SCHEM.
The schema columns are:
=> schema name => catalog name (may be null) ResultSet object in which each row is a schema description
SQLException - if a database access error occurs
ResultSetgetCatalogs() throws SQLException
The catalog column is:
=> catalog name ResultSet object in which each row has a single
String column that is a catalog name
SQLException - if a database access error occurs
ResultSetgetTableTypes() throws SQLException
The table type is:
=> table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". ResultSet object in which each row has a single
String column that is a table type
SQLException - if a database access error occurs
ResultSetgetColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
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 catalog (may be null) => table schema (may be null) => table name => column name => SQL type from java.sql.Types => Data source dependent type name, for a UDT the type name is fully qualified => column size. => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. => Radix (typically either 10 or 2) => is NULL allowed.
NULL values NULL values => comment describing column (may be null) => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null) => unused => unused => for char types the maximum number of bytes in the column => index of column in table (starting at 1) => ISO rules are used to determine the nullability for a column.
=> catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF) => table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF) => 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) => Indicates whether this column is auto incremented
=> Indicates 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.
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
ResultSet - each row is a column description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilege description has the following columns:
=> table catalog (may be null) => table schema (may be null) => table name => column name => grantor of access (may be null) => grantee of access => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...) => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown 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
ResultSet - each row is a column privilege description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException
Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.
Each privilege description has the following columns:
=> table catalog (may be null) => table schema (may be null) => table name => grantor of access (may be null) => grantee of access => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...) => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown 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
ResultSet - each row is a table privilege description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException
Each column description has the following columns:
=> actual scope of result
=> column name => SQL data type from java.sql.Types => Data source dependent type name, for a UDT the type name is fully qualified => precision => not used => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. => is this a pseudo column like an Oracle ROWID
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.
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.
ResultSet - each row is a column description
SQLException - if a database access error occurs
ResultSetgetVersionColumns(String catalog, String schema, String table) throws SQLException
Each column description has the following columns:
=> is not used => column name => SQL data type from java.sql.Types => Data source-dependent type name => precision => length of column value in bytes => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. => whether this is pseudo column like an Oracle ROWID
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.
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
ResultSet object in which each row is a column description
SQLException - if a database access error occurs
ResultSetgetPrimaryKeys(String catalog, String schema, String table) throws SQLException
Each primary key column description has the following columns:
=> table catalog (may be null) => table schema (may be null) => table name => column name => 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). => primary key name (may be null) 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
ResultSet - each row is a primary key column description
SQLException - if a database access error occurs
ResultSetgetImportedKeys(String catalog, String schema, String table) throws SQLException
Each primary key column description has the following columns:
=> primary key table catalog being imported (may be null) => primary key table schema being imported (may be null) => primary key table name being imported => primary key column name being imported => foreign key table catalog (may be null) => foreign key table schema (may be null) => foreign key table name => foreign key column name => 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). => What happens to a foreign key when the primary key is updated:
NULL if its primary key has been updated => What happens to the foreign key when primary is deleted.
=> foreign key name (may be null) => primary key name (may be null) => can the evaluation of foreign key constraints be deferred until commit
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
ResultSet - each row is a primary key column description
SQLException - if a database access error occurs
getExportedKeys(java.lang.String, java.lang.String, java.lang.String)
ResultSetgetExportedKeys(String catalog, String schema, String table) throws SQLException
Each foreign key column description has the following columns:
=> primary key table catalog (may be null) => primary key table schema (may be null) => primary key table name => primary key column name => foreign key table catalog (may be null) being exported (may be null) => foreign key table schema (may be null) being exported (may be null) => foreign key table name being exported => foreign key column name being exported => 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). => What happens to foreign key when primary is updated:
NULL if its primary key has been updated => What happens to the foreign key when primary is deleted.
NULL if its primary key has been deleted => foreign key name (may be null) => primary key name (may be null) => can the evaluation of foreign key constraints be deferred until commit
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
ResultSet object in which each row is a foreign key column description
SQLException - if a database access error occurs
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)
ResultSetgetCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException
Each foreign key column description has the following columns:
=> parent key table catalog (may be null) => parent key table schema (may be null) => parent key table name => parent key column name => foreign key table catalog (may be null) being exported (may be null) => foreign key table schema (may be null) being exported (may be null) => foreign key table name being exported => foreign key column name being exported => 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). => What happens to foreign key when parent key is updated:
NULL if its parent key has been updated => What happens to the foreign key when parent key is deleted.
NULL if its primary key has been deleted => foreign key name (may be null) => parent key name (may be null) => can the evaluation of foreign key constraints be deferred until commit
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
ResultSet - each row is a foreign key column description
SQLException - if a database access error occurs
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)
ResultSetgetTypeInfo() throws SQLException
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 => SQL data type from java.sql.Types => maximum precision => prefix used to quote a literal (may be null) => suffix used to quote a literal (may be null) => parameters used in creating the type (may be null) => can you use NULL for this type.
=> is it case sensitive. => can you use "WHERE" based on this type:
=> is it unsigned. => can it be a money value. => can it be used for an auto-increment value. => localized version of type name (may be null) => minimum scale supported => maximum scale supported => unused => unused => 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.
ResultSet object in which each row is an SQL type description
SQLException - if a database access error occurs
ResultSetgetIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException
Each index column description has the following columns:
=> table catalog (may be null) => table schema (may be null) => table name => Can index values be non-unique. false when TYPE is tableIndexStatistic => index catalog (may be null); null when TYPE is tableIndexStatistic => index name; null when TYPE is tableIndexStatistic => index type:
=> column sequence number within index; zero when TYPE is tableIndexStatistic => column name; null when TYPE is tableIndexStatistic => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic => 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. => 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, if any. (may be null) 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
ResultSet - each row is an index column description
SQLException - if a database access error occurs
boolean supportsResultSetType(int type)
throws SQLException
type - defined in
java.sql.ResultSet
true if so;
false otherwise
SQLException - if a database access error occurs
Connection
boolean supportsResultSetConcurrency(int type,
int concurrency)
throws SQLException
type - defined in
java.sql.ResultSet
concurrency - type defined in
java.sql.ResultSet
true if so;
false otherwise
SQLException - if a database access error occurs
Connection
boolean ownUpdatesAreVisible(int type)
throws SQLException
ResultSet object, the result set's own updates are visible.
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if updates are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean ownDeletesAreVisible(int type)
throws SQLException
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if deletes are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean ownInsertsAreVisible(int type)
throws SQLException
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if inserts are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean othersUpdatesAreVisible(int type)
throws SQLException
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if updates made by others are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean othersDeletesAreVisible(int type)
throws SQLException
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if deletes made by others are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean othersInsertsAreVisible(int type)
throws SQLException
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if inserts made by others are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean updatesAreDetected(int type)
throws SQLException
ResultSet.rowUpdated.
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if changes are detected by the result set type;
false otherwise
SQLException - if a database access error occurs
boolean deletesAreDetected(int type)
throws SQLException
ResultSet.rowDeleted. If the method
deletesAreDetected returns
false, it means that deleted rows are removed from the result set.
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if deletes are detected by the given result set type;
false otherwise
SQLException - if a database access error occurs
boolean insertsAreDetected(int type)
throws SQLException
ResultSet.rowInserted.
type - the
ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if changes are detected by the specified result set type;
false otherwise
SQLException - if a database access error occurs
boolean supportsBatchUpdates()
throws SQLException
true if this database supports batch updates;
false otherwise
SQLException - if a database access error occurs
ResultSetgetUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException
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:
=> the type's catalog (may be null) => type's schema (may be null) => type name => Java class name => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT => explanatory comment on the type => 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.
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
ResultSet object in which each row describes a UDT
SQLException - if a database access error occurs
getSearchStringEscape()
ConnectiongetConnection() throws SQLException
SQLException - if a database access error occurs
boolean supportsSavepoints()
throws SQLException
true if savepoints are supported;
false otherwise
SQLException - if a database access error occurs
boolean supportsNamedParameters()
throws SQLException
true if named parameters are supported;
false otherwise
SQLException - if a database access error occurs
boolean supportsMultipleOpenResults()
throws SQLException
ResultSet objects returned from a
CallableStatement object simultaneously.
true if a
CallableStatement object can return multiple
ResultSet objects simultaneously;
false otherwise
SQLException - if a datanase access error occurs
boolean supportsGetGeneratedKeys()
throws SQLException
true if auto-generated keys can be retrieved after a statement has executed;
false otherwise
If true is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements
SQLException - if a database access error occurs
ResultSetgetSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException
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:
=> the UDT's catalog (may be null) => UDT's schema (may be null) => type name of the UDT => the direct super type's catalog (may be null) => the direct super type's schema (may be null) => the direct super type's name Note: If the driver does not support type hierarchies, an empty result set is returned.
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
ResultSet object in which a row gives information about the designated UDT
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException
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:
=> the type's catalog (may be null) => type's schema (may be null) => type name => the direct super type's name Note: If the driver does not support type hierarchies, an empty result set is returned.
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
ResultSet object in which each row is a type description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException
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 catalog (may be null) => type schema (may be null) => type name => attribute name => attribute type SQL type from java.sql.Types => 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. => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision. => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. => Radix (typically either 10 or 2) => whether NULL is allowed
=> comment describing column (may be null) => default value (may be null) => unused => unused => for char types the maximum number of bytes in the column => index of the attribute in the UDT (starting at 1) => ISO rules are used to determine the nullability for a attribute.
=> catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF) => 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) 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
ResultSet object in which each row is an attribute description
SQLException - if a database access error occurs
getSearchStringEscape()
boolean supportsResultSetHoldability(int holdability)
throws SQLException
holdability - one of the following constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT
true if so;
false otherwise
SQLException - if a database access error occurs
Connection
int getResultSetHoldability()
throws SQLException
ResultSet objects.
ResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException - if a database access error occurs
int getDatabaseMajorVersion()
throws SQLException
SQLException - if a database access error occurs
int getDatabaseMinorVersion()
throws SQLException
SQLException - if a database access error occurs
int getJDBCMajorVersion()
throws SQLException
SQLException - if a database access error occurs
int getJDBCMinorVersion()
throws SQLException
SQLException - if a database access error occurs
int getSQLStateType()
throws SQLException
SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.
SQLException - if a database access error occurs
boolean locatorsUpdateCopy()
throws SQLException
true if updates are made to a copy of the LOB;
false if updates are made directly to the LOB
SQLException - if a database access error occurs
boolean supportsStatementPooling()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
RowIdLifetimegetRowIdLifetime() throws SQLException
ROWID type, and if so the lifetime for which a
RowId object remains valid.
The returned int values have the following relationship:
ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION < ROWID_VALID_SESSION < ROWID_VALID_FOREVER so 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.
RowId
SQLException - if a database access error occurs
ResultSetgetSchemas(String catalog, String schemaPattern) throws SQLException
TABLE_CATALOG and
TABLE_SCHEM.
The schema columns are:
=> schema name => catalog name (may be null) 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.
ResultSet object in which each row is a schema description
SQLException - if a database access error occurs
getSearchStringEscape()
boolean supportsStoredFunctionsUsingCallSyntax()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
boolean autoCommitFailureClosesAllResultSets()
throws SQLException
SQLException while autoCommit is
true indicates 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.
true if so;
false otherwise
SQLException - if a database access error occurs
ResultSetgetClientInfoProperties() throws SQLException
=> The name of the client info property=> The maximum length of the value for the property=> The default value of the property=> 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
ResultSet object; each row is a supported client info property
SQLException - if a database access error occurs
ResultSetgetFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException
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 catalog (may be null) => function schema (may be null) => function name. This is the name used to invoke the function => explanatory comment on the function => kind of function:
=> 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
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
ResultSet - each row is a function description
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException
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 catalog (may be null) => function schema (may be null) => function name. This is the name used to invoke the function => column/parameter name => kind of column/parameter:
ResultSet => SQL type from java.sql.Types => SQL type name, for a UDT type the type name is fully qualified => precision => length in bytes of data => scale - null is returned for data types where SCALE is not applicable. => radix => can it contain NULL.
=> comment describing column/parameter => the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL => 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. => ISO rules are used to determine the nullability for a parameter or column.
=> 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.
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
ResultSet - each row describes a user function parameter, column or return type
SQLException - if a database access error occurs
getSearchStringEscape()
ResultSetgetPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
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 COLUMN_NAME.
Each column description has the following columns:
=> table catalog (may be null) => table schema (may be null) => table name => column name => SQL type from java.sql.Types => column size. => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. => Radix (typically either 10 or 2) => The allowed usage for the column. The value returned will correspond to the enum name returned by PseudoColumnUsage.name() => comment describing column (may be null) => for char types the maximum number of bytes in the column => ISO rules are used to determine the nullability for a 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.
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
ResultSet - each row is a column description
SQLException - if a database access error occurs
PseudoColumnUsage
boolean generatedKeyAlwaysReturned()
throws SQLException
true if so;
false otherwise
SQLException - if a database access error occurs
default long getMaxLogicalLobSize()
throws SQLException
LOB.
The default implementation will return 0
SQLException - if a database access error occurs
default boolean supportsRefCursors()
throws SQLException
The default implementation will return false
true if this database supports REF CURSOR;
false otherwise
SQLException - if a database access error occurs