Interface DatabaseMetaData
- All Superinterfaces:
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.
- Since:
- 1.1
-
Field Summary
Modifier and TypeFieldDescriptionstatic final short
Indicates thatNULL
values might not be allowed.static final short
Indicates thatNULL
values are definitely allowed.static final short
Indicates that whetherNULL
values are allowed is not known.static final int
Indicates that the best row identifier is NOT a pseudo column.static final int
Indicates that the best row identifier is a pseudo column.static final int
Indicates that the scope of the best row identifier is the remainder of the current session.static final int
Indicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.static final int
Indicates that the scope of the best row identifier is the remainder of the current transaction.static final int
Indicates that the best row identifier may or may not be a pseudo column.static final int
Indicates that the column might not allowNULL
values.static final int
Indicates that the column definitely allowsNULL
values.static final int
Indicates that the nullability of columns is unknown.static final int
Indicates that the parameter or column is an IN parameter.static final int
Indicates that the parameter or column is an INOUT parameter.static final int
Indicates that the parameter or column is an OUT parameter.static final int
Indicates that the parameter or column is a column in a result set.static final int
Indicates that type of the parameter or column is unknown.static final int
Indicates thatNULL
values are not allowed.static final int
Indicates that the function does not return a table.static final int
Indicates thatNULL
values are allowed.static final int
Indicates that whetherNULL
values are allowed is unknown.static final int
Indicates that it is not known whether the function returns a result or a table.static final int
Indicates that the parameter or column is a return value.static final int
Indicates that the function returns a table.static final int
For the columnUPDATE_RULE
, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it.static final int
Indicates deferrability.static final int
Indicates deferrability.static final int
For the columnsUPDATE_RULE
andDELETE_RULE
, indicates that if the primary key has been imported, it cannot be updated or deleted.static final int
Indicates deferrability.static final int
For the columnUPDATE_RULE
, indicates that a primary key may not be updated if it has been imported by another table as a foreign key.static final int
For the columnsUPDATE_RULE
andDELETE_RULE
, indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value.static final int
For the columnsUPDATE_RULE
andDELETE_RULE
, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed toNULL
.static final int
Indicates that the column stores IN parameters.static final int
Indicates that the column stores INOUT parameters.static final int
Indicates that the column stores OUT parameters.static final int
Indicates that the column stores results.static final int
Indicates that the column stores return values.static final int
Indicates that type of the column is unknown.static final int
Indicates thatNULL
values are not allowed.static final int
Indicates that the procedure does not return a result.static final int
Indicates thatNULL
values are allowed.static final int
Indicates that whetherNULL
values are allowed is unknown.static final int
Indicates that it is not known whether the procedure returns a result.static final int
Indicates that the procedure returns a result.static final int
A possible return value for the methodDatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the methodSQLException.getSQLState
is an SQLSTATE value.static final int
A possible return value for the methodDatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the methodSQLException.getSQLState
is an SQL99 SQLSTATE value.static final int
A possible return value for the methodDatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the methodSQLException.getSQLState
is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.static final short
Indicates that this table index is a clustered index.static final short
Indicates that this table index is a hashed index.static final short
Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.static final short
Indicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.static final int
Indicates that aNULL
value is NOT allowed for this data type.static final int
Indicates that aNULL
value is allowed for this data type.static final int
Indicates that it is not known whether aNULL
value is allowed for this data type.static final int
Indicates that the data type can be only be used inWHERE
search clauses that do not useLIKE
predicates.static final int
Indicates that the data type can be only be used inWHERE
search clauses that useLIKE
predicates.static final int
Indicates thatWHERE
search clauses are not supported for this type.static final int
Indicates that allWHERE
search clauses can be based on this type.static final int
Indicates that this version column is NOT a pseudo column.static final int
Indicates that this version column is a pseudo column.static final int
Indicates that this version column may or may not be a pseudo column. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Retrieves whether the current user can call all the procedures returned by the methodgetProcedures
.boolean
Retrieves whether the current user can use all the tables returned by the methodgetTables
in aSELECT
statement.boolean
Retrieves whether aSQLException
while autoCommit istrue
indicates that all open ResultSets are closed, even ones that are holdable.boolean
Retrieves whether a data definition statement within a transaction forces the transaction to commit.boolean
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 methodResultSet.rowDeleted
.boolean
Retrieves whether the return value for the methodgetMaxRowSize
includes the SQL data typesLONGVARCHAR
andLONGVARBINARY
.boolean
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.getAttributes
(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.getBestRowIdentifier
(String catalog, String schema, String table, int scope, boolean nullable) Retrieves a description of a table's optimal set of columns that uniquely identifies a row.Retrieves the catalog names available in this database.Retrieves theString
that this database uses as the separator between a catalog and table name.Retrieves the database vendor's preferred term for "catalog".Retrieves a list of the client info properties that the driver supports.getColumnPrivileges
(String catalog, String schema, String table, String columnNamePattern) Retrieves a description of the access rights for a table's columns.getColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) Retrieves a description of table columns available in the specified catalog.Retrieves the connection that produced this metadata object.getCrossReference
(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table).int
Retrieves the major version number of the underlying database.int
Retrieves the minor version number of the underlying database.Retrieves the name of this database product.Retrieves the version number of this database product.int
Retrieves this database's default transaction isolation level.int
Retrieves this JDBC driver's major version number.int
Retrieves this JDBC driver's minor version number.Retrieves the name of this JDBC driver.Retrieves the version number of this JDBC driver as aString
.getExportedKeys
(String catalog, String schema, String table) Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).getFunctionColumns
(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) Retrieves a description of the given catalog's system or user function parameters and return type.getFunctions
(String catalog, String schemaPattern, String functionNamePattern) Retrieves a description of the system and user functions available in the given catalog.Retrieves the string used to quote SQL identifiers.getImportedKeys
(String catalog, String schema, String table) Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table).getIndexInfo
(String catalog, String schema, String table, boolean unique, boolean approximate) Retrieves a description of the given table's indices and statistics.int
Retrieves the major JDBC version number for this driver.int
Retrieves the minor JDBC version number for this driver.int
Retrieves the maximum number of hex characters this database allows in an inline binary literal.int
Retrieves the maximum number of characters that this database allows in a catalog name.int
Retrieves the maximum number of characters this database allows for a character literal.int
Retrieves the maximum number of characters this database allows for a column name.int
Retrieves the maximum number of columns this database allows in aGROUP BY
clause.int
Retrieves the maximum number of columns this database allows in an index.int
Retrieves the maximum number of columns this database allows in anORDER BY
clause.int
Retrieves the maximum number of columns this database allows in aSELECT
list.int
Retrieves the maximum number of columns this database allows in a table.int
Retrieves the maximum number of concurrent connections to this database that are possible.int
Retrieves the maximum number of characters that this database allows in a cursor name.int
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.default long
Retrieves the maximum number of bytes this database allows for the logical size for aLOB
.int
Retrieves the maximum number of characters that this database allows in a procedure name.int
Retrieves the maximum number of bytes this database allows in a single row.int
Retrieves the maximum number of characters that this database allows in a schema name.int
Retrieves the maximum number of characters this database allows in an SQL statement.int
Retrieves the maximum number of active statements to this database that can be open at the same time.int
Retrieves the maximum number of characters this database allows in a table name.int
Retrieves the maximum number of tables this database allows in aSELECT
statement.int
Retrieves the maximum number of characters this database allows in a user name.Retrieves a comma-separated list of math functions available with this database.getPrimaryKeys
(String catalog, String schema, String table) Retrieves a description of the given table's primary key columns.getProcedureColumns
(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) Retrieves a description of the given catalog's stored procedure parameter and result columns.getProcedures
(String catalog, String schemaPattern, String procedureNamePattern) Retrieves a description of the stored procedures available in the given catalog.Retrieves the database vendor's preferred term for "procedure".getPseudoColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema.int
Retrieves this database's default holdability forResultSet
objects.Indicates whether this data source supports the SQLROWID
type, and the lifetime for which aRowId
object remains valid.Retrieves the schema names available in this database.getSchemas
(String catalog, String schemaPattern) Retrieves the schema names available in this database.Retrieves the database vendor's preferred term for "schema".Retrieves the string that can be used to escape wildcard characters.Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.int
Indicates whether the SQLSTATE returned bySQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003.Retrieves a comma-separated list of string functions available with this database.getSuperTables
(String catalog, String schemaPattern, String tableNamePattern) Retrieves a description of the table hierarchies defined in a particular schema in this database.getSuperTypes
(String catalog, String schemaPattern, String typeNamePattern) Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.Retrieves a comma-separated list of system functions available with this database.getTablePrivileges
(String catalog, String schemaPattern, String tableNamePattern) Retrieves a description of the access rights for each table available in a catalog.Retrieves a description of the tables available in the given catalog.Retrieves the table types available in this database.Retrieves a comma-separated list of the time and date functions available with this database.Retrieves a description of all the data types supported by this database.Retrieves a description of the user-defined types (UDTs) defined in a particular schema.getURL()
Retrieves the URL for this DBMS.Retrieves the user name as known to this database.getVersionColumns
(String catalog, String schema, String table) Retrieves a description of a table's columns that are automatically updated when any value in a row is updated.boolean
insertsAreDetected
(int type) Retrieves whether or not a visible row insert can be detected by calling the methodResultSet.rowInserted
.boolean
Retrieves whether a catalog appears at the start of a fully qualified table name.boolean
Retrieves whether this database is in read-only mode.boolean
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.boolean
Retrieves whether this database supports concatenations betweenNULL
and non-NULL
values beingNULL
.boolean
Retrieves whetherNULL
values are sorted at the end regardless of sort order.boolean
Retrieves whetherNULL
values are sorted at the start regardless of sort order.boolean
Retrieves whetherNULL
values are sorted high.boolean
Retrieves whetherNULL
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 ofResultSet
object, the result set's own updates are visible.boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.boolean
Retrieves whether this database supportsALTER TABLE
with add column.boolean
Retrieves whether this database supportsALTER TABLE
with drop column.boolean
Retrieves whether this database supports the ANSI92 entry level SQL grammar.boolean
Retrieves whether this database supports the ANSI92 full SQL grammar supported.boolean
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.boolean
Retrieves whether this database supports batch updates.boolean
Retrieves whether a catalog name can be used in a data manipulation statement.boolean
Retrieves whether a catalog name can be used in an index definition statement.boolean
Retrieves whether a catalog name can be used in a privilege definition statement.boolean
Retrieves whether a catalog name can be used in a procedure call statement.boolean
Retrieves whether a catalog name can be used in a table definition statement.boolean
Retrieves whether this database supports column aliasing.boolean
Retrieves whether this database supports the JDBC scalar functionCONVERT
for the conversion of one JDBC type to another.boolean
supportsConvert
(int fromType, int toType) Retrieves whether this database supports the JDBC scalar functionCONVERT
for conversions between the JDBC types fromType and toType.boolean
Retrieves whether this database supports the ODBC Core SQL grammar.boolean
Retrieves whether this database supports correlated subqueries.boolean
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.boolean
Retrieves whether this database supports only data manipulation statements within a transaction.boolean
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.boolean
Retrieves whether this database supports expressions inORDER BY
lists.boolean
Retrieves whether this database supports the ODBC Extended SQL grammar.boolean
Retrieves whether this database supports full nested outer joins.boolean
Retrieves whether auto-generated keys can be retrieved after a statement has been executedboolean
Retrieves whether this database supports some form ofGROUP BY
clause.boolean
Retrieves whether this database supports using columns not included in theSELECT
statement in aGROUP BY
clause provided that all of the columns in theSELECT
statement are included in theGROUP BY
clause.boolean
Retrieves whether this database supports using a column that is not in theSELECT
statement in aGROUP BY
clause.boolean
Retrieves whether this database supports the SQL Integrity Enhancement Facility.boolean
Retrieves whether this database supports specifying aLIKE
escape clause.boolean
Retrieves whether this database provides limited support for outer joins.boolean
Retrieves whether this database supports the ODBC Minimum SQL grammar.boolean
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.boolean
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.boolean
Retrieves whether it is possible to have multipleResultSet
objects returned from aCallableStatement
object simultaneously.boolean
Retrieves whether this database supports getting multipleResultSet
objects from a single call to the methodexecute
.boolean
Retrieves whether this database allows having multiple transactions open at once (on different connections).boolean
Retrieves whether this database supports named parameters to callable statements.boolean
Retrieves whether columns in this database may be defined as non-nullable.boolean
Retrieves whether this database supports keeping cursors open across commits.boolean
Retrieves whether this database supports keeping cursors open across rollbacks.boolean
Retrieves whether this database supports keeping statements open across commits.boolean
Retrieves whether this database supports keeping statements open across rollbacks.boolean
Retrieves whether this database supports using a column that is not in theSELECT
statement in anORDER BY
clause.boolean
Retrieves whether this database supports some form of outer join.boolean
Retrieves whether this database supports positionedDELETE
statements.boolean
Retrieves whether this database supports positionedUPDATE
statements.default boolean
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
Retrieves whether this database supports savepoints.boolean
Retrieves whether a schema name can be used in a data manipulation statement.boolean
Retrieves whether a schema name can be used in an index definition statement.boolean
Retrieves whether a schema name can be used in a privilege definition statement.boolean
Retrieves whether a schema name can be used in a procedure call statement.boolean
Retrieves whether a schema name can be used in a table definition statement.boolean
Retrieves whether this database supportsSELECT FOR UPDATE
statements.default boolean
Retrieves whether this database supports sharding.boolean
Retrieves whether this database supports statement pooling.boolean
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.boolean
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.boolean
Retrieves whether this database supports subqueries in comparison expressions.boolean
Retrieves whether this database supports subqueries inEXISTS
expressions.boolean
Retrieves whether this database supports subqueries inIN
expressions.boolean
Retrieves whether this database supports subqueries in quantified expressions.boolean
Retrieves whether this database supports table correlation names.boolean
supportsTransactionIsolationLevel
(int level) Retrieves whether this database supports the given transaction isolation level.boolean
Retrieves whether this database supports transactions.boolean
Retrieves whether this database supports SQLUNION
.boolean
Retrieves whether this database supports SQLUNION ALL
.boolean
updatesAreDetected
(int type) Retrieves whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.boolean
Retrieves whether this database uses a file for each table.boolean
Retrieves whether this database stores tables in a local file.Methods declared in interface java.sql.Wrapper
isWrapperFor, unwrap
-
Field Details
-
procedureResultUnknown
static final int procedureResultUnknownIndicates that it is not known whether the procedure returns a result.A possible value for column
PROCEDURE_TYPE
in theResultSet
object returned by the methodgetProcedures
.- See Also:
-
procedureNoResult
static final int procedureNoResultIndicates that the procedure does not return a result.A possible value for column
PROCEDURE_TYPE
in theResultSet
object returned by the methodgetProcedures
.- See Also:
-
procedureReturnsResult
static final int procedureReturnsResultIndicates that the procedure returns a result.A possible value for column
PROCEDURE_TYPE
in theResultSet
object returned by the methodgetProcedures
.- See Also:
-
procedureColumnUnknown
static final int procedureColumnUnknownIndicates that type of the column is unknown.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetProcedureColumns
.- See Also:
-
procedureColumnIn
static final int procedureColumnInIndicates that the column stores IN parameters.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetProcedureColumns
.- See Also:
-
procedureColumnInOut
static final int procedureColumnInOutIndicates that the column stores INOUT parameters.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetProcedureColumns
.- See Also:
-
procedureColumnOut
static final int procedureColumnOutIndicates that the column stores OUT parameters.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetProcedureColumns
.- See Also:
-
procedureColumnReturn
static final int procedureColumnReturnIndicates that the column stores return values.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetProcedureColumns
.- See Also:
-
procedureColumnResult
static final int procedureColumnResultIndicates that the column stores results.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetProcedureColumns
.- See Also:
-
procedureNoNulls
static final int procedureNoNullsIndicates thatNULL
values are not allowed.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetProcedureColumns
.- See Also:
-
procedureNullable
static final int procedureNullableIndicates thatNULL
values are allowed.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetProcedureColumns
.- See Also:
-
procedureNullableUnknown
static final int procedureNullableUnknownIndicates that whetherNULL
values are allowed is unknown.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetProcedureColumns
.- See Also:
-
columnNoNulls
static final int columnNoNullsIndicates that the column might not allowNULL
values.A possible value for the column
NULLABLE
in theResultSet
returned by the methodgetColumns
.- See Also:
-
columnNullable
static final int columnNullableIndicates that the column definitely allowsNULL
values.A possible value for the column
NULLABLE
in theResultSet
returned by the methodgetColumns
.- See Also:
-
columnNullableUnknown
static final int columnNullableUnknownIndicates that the nullability of columns is unknown.A possible value for the column
NULLABLE
in theResultSet
returned by the methodgetColumns
.- See Also:
-
bestRowTemporary
static final int bestRowTemporaryIndicates that the scope of the best row identifier is very temporary, lasting only while the row is being used.A possible value for the column
SCOPE
in theResultSet
object returned by the methodgetBestRowIdentifier
.- See Also:
-
bestRowTransaction
static final int bestRowTransactionIndicates that the scope of the best row identifier is the remainder of the current transaction.A possible value for the column
SCOPE
in theResultSet
object returned by the methodgetBestRowIdentifier
.- See Also:
-
bestRowSession
static final int bestRowSessionIndicates that the scope of the best row identifier is the remainder of the current session.A possible value for the column
SCOPE
in theResultSet
object returned by the methodgetBestRowIdentifier
.- See Also:
-
bestRowUnknown
static final int bestRowUnknownIndicates that the best row identifier may or may not be a pseudo column.A possible value for the column
PSEUDO_COLUMN
in theResultSet
object returned by the methodgetBestRowIdentifier
.- See Also:
-
bestRowNotPseudo
static final int bestRowNotPseudoIndicates that the best row identifier is NOT a pseudo column.A possible value for the column
PSEUDO_COLUMN
in theResultSet
object returned by the methodgetBestRowIdentifier
.- See Also:
-
bestRowPseudo
static final int bestRowPseudoIndicates that the best row identifier is a pseudo column.A possible value for the column
PSEUDO_COLUMN
in theResultSet
object returned by the methodgetBestRowIdentifier
.- See Also:
-
versionColumnUnknown
static final int versionColumnUnknownIndicates that this version column may or may not be a pseudo column.A possible value for the column
PSEUDO_COLUMN
in theResultSet
object returned by the methodgetVersionColumns
.- See Also:
-
versionColumnNotPseudo
static final int versionColumnNotPseudoIndicates that this version column is NOT a pseudo column.A possible value for the column
PSEUDO_COLUMN
in theResultSet
object returned by the methodgetVersionColumns
.- See Also:
-
versionColumnPseudo
static final int versionColumnPseudoIndicates that this version column is a pseudo column.A possible value for the column
PSEUDO_COLUMN
in theResultSet
object returned by the methodgetVersionColumns
.- See Also:
-
importedKeyCascade
static final int importedKeyCascadeFor the columnUPDATE_RULE
, indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it. For the columnDELETE_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
andDELETE_RULE
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeyRestrict
static final int importedKeyRestrictFor the columnUPDATE_RULE
, indicates that a primary key may not be updated if it has been imported by another table as a foreign key. For the columnDELETE_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
andDELETE_RULE
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeySetNull
static final int importedKeySetNullFor the columnsUPDATE_RULE
andDELETE_RULE
, indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed toNULL
.A possible value for the columns
UPDATE_RULE
andDELETE_RULE
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeyNoAction
static final int importedKeyNoActionFor the columnsUPDATE_RULE
andDELETE_RULE
, indicates that if the primary key has been imported, it cannot be updated or deleted.A possible value for the columns
UPDATE_RULE
andDELETE_RULE
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeySetDefault
static final int importedKeySetDefaultFor the columnsUPDATE_RULE
andDELETE_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
andDELETE_RULE
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeyInitiallyDeferred
static final int importedKeyInitiallyDeferredIndicates deferrability. See SQL-92 for a definition.A possible value for the column
DEFERRABILITY
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeyInitiallyImmediate
static final int importedKeyInitiallyImmediateIndicates deferrability. See SQL-92 for a definition.A possible value for the column
DEFERRABILITY
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
importedKeyNotDeferrable
static final int importedKeyNotDeferrableIndicates deferrability. See SQL-92 for a definition.A possible value for the column
DEFERRABILITY
in theResultSet
objects returned by the methodsgetImportedKeys
,getExportedKeys
, andgetCrossReference
.- See Also:
-
typeNoNulls
static final int typeNoNullsIndicates that aNULL
value is NOT allowed for this data type.A possible value for column
NULLABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
typeNullable
static final int typeNullableIndicates that aNULL
value is allowed for this data type.A possible value for column
NULLABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
typeNullableUnknown
static final int typeNullableUnknownIndicates that it is not known whether aNULL
value is allowed for this data type.A possible value for column
NULLABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
typePredNone
static final int typePredNoneIndicates thatWHERE
search clauses are not supported for this type.A possible value for column
SEARCHABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
typePredChar
static final int typePredCharIndicates that the data type can be only be used inWHERE
search clauses that useLIKE
predicates.A possible value for column
SEARCHABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
typePredBasic
static final int typePredBasicIndicates that the data type can be only be used inWHERE
search clauses that do not useLIKE
predicates.A possible value for column
SEARCHABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
typeSearchable
static final int typeSearchableIndicates that allWHERE
search clauses can be based on this type.A possible value for column
SEARCHABLE
in theResultSet
object returned by the methodgetTypeInfo
.- See Also:
-
tableIndexStatistic
static final short tableIndexStatisticIndicates that this column contains table statistics that are returned in conjunction with a table's index descriptions.A possible value for column
TYPE
in theResultSet
object returned by the methodgetIndexInfo
.- See Also:
-
tableIndexClustered
static final short tableIndexClusteredIndicates that this table index is a clustered index.A possible value for column
TYPE
in theResultSet
object returned by the methodgetIndexInfo
.- See Also:
-
tableIndexHashed
static final short tableIndexHashedIndicates that this table index is a hashed index.A possible value for column
TYPE
in theResultSet
object returned by the methodgetIndexInfo
.- See Also:
-
tableIndexOther
static final short tableIndexOtherIndicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these.A possible value for column
TYPE
in theResultSet
object returned by the methodgetIndexInfo
.- See Also:
-
attributeNoNulls
static final short attributeNoNullsIndicates thatNULL
values might not be allowed.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetAttributes
.- See Also:
-
attributeNullable
static final short attributeNullableIndicates thatNULL
values are definitely allowed.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetAttributes
.- See Also:
-
attributeNullableUnknown
static final short attributeNullableUnknownIndicates that whetherNULL
values are allowed is not known.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetAttributes
.- See Also:
-
sqlStateXOpen
static final int sqlStateXOpenA possible return value for the methodDatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the methodSQLException.getSQLState
is an X/Open (now know as Open Group) SQL CLI SQLSTATE value.- Since:
- 1.4
- See Also:
-
sqlStateSQL
static final int sqlStateSQLA possible return value for the methodDatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the methodSQLException.getSQLState
is an SQLSTATE value.- Since:
- 1.6
- See Also:
-
sqlStateSQL99
static final int sqlStateSQL99A possible return value for the methodDatabaseMetaData.getSQLStateType
which is used to indicate whether the value returned by the methodSQLException.getSQLState
is an SQL99 SQLSTATE value.Note:This constant remains only for compatibility reasons. Developers should use the constant
sqlStateSQL
instead.- Since:
- 1.4
- See Also:
-
functionColumnUnknown
static final int functionColumnUnknownIndicates that type of the parameter or column is unknown.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetFunctionColumns
.- See Also:
-
functionColumnIn
static final int functionColumnInIndicates that the parameter or column is an IN parameter.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionColumnInOut
static final int functionColumnInOutIndicates that the parameter or column is an INOUT parameter.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionColumnOut
static final int functionColumnOutIndicates that the parameter or column is an OUT parameter.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionReturn
static final int functionReturnIndicates that the parameter or column is a return value.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionColumnResult
static final int functionColumnResultIndicates that the parameter or column is a column in a result set.A possible value for the column
COLUMN_TYPE
in theResultSet
returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionNoNulls
static final int functionNoNullsIndicates thatNULL
values are not allowed.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionNullable
static final int functionNullableIndicates thatNULL
values are allowed.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionNullableUnknown
static final int functionNullableUnknownIndicates that whetherNULL
values are allowed is unknown.A possible value for the column
NULLABLE
in theResultSet
object returned by the methodgetFunctionColumns
.- Since:
- 1.6
- See Also:
-
functionResultUnknown
static final int functionResultUnknownIndicates that it is not known whether the function returns a result or a table.A possible value for column
FUNCTION_TYPE
in theResultSet
object returned by the methodgetFunctions
.- Since:
- 1.6
- See Also:
-
functionNoTable
static final int functionNoTableIndicates that the function does not return a table.A possible value for column
FUNCTION_TYPE
in theResultSet
object returned by the methodgetFunctions
.- Since:
- 1.6
- See Also:
-
functionReturnsTable
static final int functionReturnsTableIndicates that the function returns a table.A possible value for column
FUNCTION_TYPE
in theResultSet
object returned by the methodgetFunctions
.- Since:
- 1.6
- See Also:
-
-
Method Details
-
allProceduresAreCallable
Retrieves whether the current user can call all the procedures returned by the methodgetProcedures
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
allTablesAreSelectable
Retrieves whether the current user can use all the tables returned by the methodgetTables
in aSELECT
statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getURL
Retrieves the URL for this DBMS.- Returns:
- the URL for this DBMS or
null
if it cannot be generated - Throws:
SQLException
- if a database access error occurs
-
getUserName
Retrieves the user name as known to this database.- Returns:
- the database user name
- Throws:
SQLException
- if a database access error occurs
-
isReadOnly
Retrieves whether this database is in read-only mode.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedHigh
Retrieves whetherNULL
values are sorted high. Sorted high means thatNULL
values sort higher than any other value in a domain. In an ascending order, if this method returnstrue
,NULL
values will appear at the end. By contrast, the methodnullsAreSortedAtEnd
indicates whetherNULL
values are sorted at the end regardless of sort order.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedLow
Retrieves whetherNULL
values are sorted low. Sorted low means thatNULL
values sort lower than any other value in a domain. In an ascending order, if this method returnstrue
,NULL
values will appear at the beginning. By contrast, the methodnullsAreSortedAtStart
indicates whetherNULL
values are sorted at the beginning regardless of sort order.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedAtStart
Retrieves whetherNULL
values are sorted at the start regardless of sort order.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedAtEnd
Retrieves whetherNULL
values are sorted at the end regardless of sort order.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getDatabaseProductName
Retrieves the name of this database product.- Returns:
- database product name
- Throws:
SQLException
- if a database access error occurs
-
getDatabaseProductVersion
Retrieves the version number of this database product.- Returns:
- database version number
- Throws:
SQLException
- if a database access error occurs
-
getDriverName
Retrieves the name of this JDBC driver.- Returns:
- JDBC driver name
- Throws:
SQLException
- if a database access error occurs
-
getDriverVersion
Retrieves the version number of this JDBC driver as aString
.- Returns:
- JDBC driver version
- Throws:
SQLException
- if a database access error occurs
-
getDriverMajorVersion
int getDriverMajorVersion()Retrieves this JDBC driver's major version number.- Returns:
- JDBC driver major version
-
getDriverMinorVersion
int getDriverMinorVersion()Retrieves this JDBC driver's minor version number.- Returns:
- JDBC driver minor version number
-
usesLocalFiles
Retrieves whether this database stores tables in a local file.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
usesLocalFilePerTable
Retrieves whether this database uses a file for each table.- Returns:
true
if this database uses a local file for each table;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMixedCaseIdentifiers
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesUpperCaseIdentifiers
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesLowerCaseIdentifiers
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesMixedCaseIdentifiers
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMixedCaseQuotedIdentifiers
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesUpperCaseQuotedIdentifiers
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesLowerCaseQuotedIdentifiers
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesMixedCaseQuotedIdentifiers
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getIdentifierQuoteString
Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.- Returns:
- the quoting string or a space if quoting is not supported
- Throws:
SQLException
- if a database access error occurs
-
getSQLKeywords
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.- Returns:
- the list of this database's keywords that are not also SQL:2003 keywords
- Throws:
SQLException
- if a database access error occurs
-
getNumericFunctions
Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.- Returns:
- the list of math functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getStringFunctions
Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.- Returns:
- the list of string functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getSystemFunctions
Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.- Returns:
- a list of system functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getTimeDateFunctions
Retrieves a comma-separated list of the time and date functions available with this database.- Returns:
- the list of time and date functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getSearchStringEscape
Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
- Returns:
- the string used to escape wildcard characters
- Throws:
SQLException
- if a database access error occurs
-
getExtraNameCharacters
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).- Returns:
- the string containing the extra characters
- Throws:
SQLException
- if a database access error occurs
-
supportsAlterTableWithAddColumn
Retrieves whether this database supportsALTER TABLE
with add column.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsAlterTableWithDropColumn
Retrieves whether this database supportsALTER TABLE
with drop column.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsColumnAliasing
Retrieves whether this database supports column aliasing.If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullPlusNonNullIsNull
Retrieves whether this database supports concatenations betweenNULL
and non-NULL
values beingNULL
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsConvert
Retrieves whether this database supports the JDBC scalar functionCONVERT
for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined injava.sql.Types
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsConvert
Retrieves whether this database supports the JDBC scalar functionCONVERT
for conversions between the JDBC types fromType and toType. The JDBC types are the generic SQL data types defined injava.sql.Types
.- Parameters:
fromType
- the type to convert from; one of the type codes from the classjava.sql.Types
toType
- the type to convert to; one of the type codes from the classjava.sql.Types
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- See Also:
-
supportsTableCorrelationNames
Retrieves whether this database supports table correlation names.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDifferentTableCorrelationNames
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsExpressionsInOrderBy
Retrieves whether this database supports expressions inORDER BY
lists.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupBy
Retrieves whether this database supports some form ofGROUP BY
clause.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupByBeyondSelect
Retrieves whether this database supports using columns not included in theSELECT
statement in aGROUP BY
clause provided that all of the columns in theSELECT
statement are included in theGROUP BY
clause.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsLikeEscapeClause
Retrieves whether this database supports specifying aLIKE
escape clause.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMultipleResultSets
Retrieves whether this database supports getting multipleResultSet
objects from a single call to the methodexecute
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMultipleTransactions
Retrieves whether this database allows having multiple transactions open at once (on different connections).- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsNonNullableColumns
Retrieves whether columns in this database may be defined as non-nullable.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMinimumSQLGrammar
Retrieves whether this database supports the ODBC Minimum SQL grammar.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCoreSQLGrammar
Retrieves whether this database supports the ODBC Core SQL grammar.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsExtendedSQLGrammar
Retrieves whether this database supports the ODBC Extended SQL grammar.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92EntryLevelSQL
Retrieves whether this database supports the ANSI92 entry level SQL grammar.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92IntermediateSQL
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92FullSQL
Retrieves whether this database supports the ANSI92 full SQL grammar supported.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsIntegrityEnhancementFacility
Retrieves whether this database supports the SQL Integrity Enhancement Facility.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOuterJoins
Retrieves whether this database supports some form of outer join.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsFullOuterJoins
Retrieves whether this database supports full nested outer joins.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsLimitedOuterJoins
Retrieves whether this database provides limited support for outer joins. (This will betrue
if the methodsupportsFullOuterJoins
returnstrue
).- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getSchemaTerm
Retrieves the database vendor's preferred term for "schema".- Returns:
- the vendor term for "schema"
- Throws:
SQLException
- if a database access error occurs
-
getProcedureTerm
Retrieves the database vendor's preferred term for "procedure".- Returns:
- the vendor term for "procedure"
- Throws:
SQLException
- if a database access error occurs
-
getCatalogTerm
Retrieves the database vendor's preferred term for "catalog".- Returns:
- the vendor term for "catalog"
- Throws:
SQLException
- if a database access error occurs
-
isCatalogAtStart
Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.- Returns:
true
if the catalog name appears at the beginning of a fully qualified table name;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getCatalogSeparator
Retrieves theString
that this database uses as the separator between a catalog and table name.- Returns:
- the separator string
- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInDataManipulation
Retrieves whether a schema name can be used in a data manipulation statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInProcedureCalls
Retrieves whether a schema name can be used in a procedure call statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInTableDefinitions
Retrieves whether a schema name can be used in a table definition statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInIndexDefinitions
Retrieves whether a schema name can be used in an index definition statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInPrivilegeDefinitions
Retrieves whether a schema name can be used in a privilege definition statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInDataManipulation
Retrieves whether a catalog name can be used in a data manipulation statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInProcedureCalls
Retrieves whether a catalog name can be used in a procedure call statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInTableDefinitions
Retrieves whether a catalog name can be used in a table definition statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInIndexDefinitions
Retrieves whether a catalog name can be used in an index definition statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInPrivilegeDefinitions
Retrieves whether a catalog name can be used in a privilege definition statement.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsPositionedDelete
Retrieves whether this database supports positionedDELETE
statements.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsPositionedUpdate
Retrieves whether this database supports positionedUPDATE
statements.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSelectForUpdate
Retrieves whether this database supportsSELECT FOR UPDATE
statements.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsStoredProcedures
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInComparisons
Retrieves whether this database supports subqueries in comparison expressions.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInExists
Retrieves whether this database supports subqueries inEXISTS
expressions.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInIns
Retrieves whether this database supports subqueries inIN
expressions.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInQuantifieds
Retrieves whether this database supports subqueries in quantified expressions.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsUnion
Retrieves whether this database supports SQLUNION
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsUnionAll
Retrieves whether this database supports SQLUNION ALL
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOpenCursorsAcrossCommit
Retrieves whether this database supports keeping cursors open across commits.- Returns:
true
if cursors always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
supportsOpenCursorsAcrossRollback
Retrieves whether this database supports keeping cursors open across rollbacks.- Returns:
true
if cursors always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
supportsOpenStatementsAcrossCommit
Retrieves whether this database supports keeping statements open across commits.- Returns:
true
if statements always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
supportsOpenStatementsAcrossRollback
Retrieves whether this database supports keeping statements open across rollbacks.- Returns:
true
if statements always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
getMaxBinaryLiteralLength
Retrieves the maximum number of hex characters this database allows in an inline binary literal.- Returns:
- max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxCharLiteralLength
Retrieves the maximum number of characters this database allows for a character literal.- Returns:
- the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnNameLength
Retrieves the maximum number of characters this database allows for a column name.- Returns:
- the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInGroupBy
Retrieves the maximum number of columns this database allows in aGROUP BY
clause.- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInIndex
Retrieves the maximum number of columns this database allows in an index.- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInOrderBy
Retrieves the maximum number of columns this database allows in anORDER BY
clause.- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInSelect
Retrieves the maximum number of columns this database allows in aSELECT
list.- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInTable
Retrieves the maximum number of columns this database allows in a table.- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxConnections
Retrieves the maximum number of concurrent connections to this database that are possible.- Returns:
- the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxCursorNameLength
Retrieves the maximum number of characters that this database allows in a cursor name.- Returns:
- the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxIndexLength
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.- Returns:
- the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxSchemaNameLength
Retrieves the maximum number of characters that this database allows in a schema name.- Returns:
- the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxProcedureNameLength
Retrieves the maximum number of characters that this database allows in a procedure name.- Returns:
- the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxCatalogNameLength
Retrieves the maximum number of characters that this database allows in a catalog name.- Returns:
- the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxRowSize
Retrieves the maximum number of bytes this database allows in a single row.- Returns:
- the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
doesMaxRowSizeIncludeBlobs
Retrieves whether the return value for the methodgetMaxRowSize
includes the SQL data typesLONGVARCHAR
andLONGVARBINARY
.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getMaxStatementLength
Retrieves the maximum number of characters this database allows in an SQL statement.- Returns:
- the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxStatements
Retrieves the maximum number of active statements to this database that can be open at the same time.- Returns:
- the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxTableNameLength
Retrieves the maximum number of characters this database allows in a table name.- Returns:
- the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxTablesInSelect
Retrieves the maximum number of tables this database allows in aSELECT
statement.- Returns:
- the maximum number of tables allowed in a
SELECT
statement; a result of zero means that there is no limit or the limit is not known - Throws:
SQLException
- if a database access error occurs
-
getMaxUserNameLength
Retrieves the maximum number of characters this database allows in a user name.- Returns:
- the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getDefaultTransactionIsolation
Retrieves this database's default transaction isolation level. The possible values are defined injava.sql.Connection
.- Returns:
- the default isolation level
- Throws:
SQLException
- if a database access error occurs- See Also:
-
supportsTransactions
Retrieves whether this database supports transactions. If not, invoking the methodcommit
is a noop, and the isolation level isTRANSACTION_NONE
.- Returns:
true
if transactions are supported;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsTransactionIsolationLevel
Retrieves whether this database supports the given transaction isolation level.- Parameters:
level
- one of the transaction isolation levels defined injava.sql.Connection
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- See Also:
-
supportsDataDefinitionAndDataManipulationTransactions
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDataManipulationTransactionsOnly
Retrieves whether this database supports only data manipulation statements within a transaction.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
dataDefinitionCausesTransactionCommit
Retrieves whether a data definition statement within a transaction forces the transaction to commit.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
dataDefinitionIgnoredInTransactions
Retrieves whether this database ignores a data definition statement within a transaction.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getProcedures
ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException Retrieves a description of the stored procedures available in the given catalog.Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by
PROCEDURE_CAT
,PROCEDURE_SCHEM
,PROCEDURE_NAME
andSPECIFIC_NAME
.Each procedure description has the following columns:
- PROCEDURE_CAT String
=>
procedure catalog (may benull
) - PROCEDURE_SCHEM String
=>
procedure schema (may benull
) - PROCEDURE_NAME String
=>
procedure name - reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String
=>
explanatory comment on the procedure - PROCEDURE_TYPE short
=>
kind of procedure:- procedureResultUnknown - Cannot determine if a return value will be returned
- procedureNoResult - Does not return a return value
- procedureReturnsResult - Returns a return value
- SPECIFIC_NAME String
=>
The name which uniquely identifies this procedure within its schema.
A user may not have permissions to execute any of the procedures that are returned by
getProcedures
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchprocedureNamePattern
- a procedure name pattern; must match the procedure name as it is stored in the database- Returns:
ResultSet
- each row is a procedure description- Throws:
SQLException
- if a database access error occurs- See Also:
- PROCEDURE_CAT String
-
getProcedureColumns
ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException Retrieves a description of the given catalog's stored procedure parameter and result columns.Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the
ResultSet
is a parameter description or column description with the following fields:- PROCEDURE_CAT String
=>
procedure catalog (may benull
) - PROCEDURE_SCHEM String
=>
procedure schema (may benull
) - PROCEDURE_NAME String
=>
procedure name - COLUMN_NAME String
=>
column/parameter name - COLUMN_TYPE Short
=>
kind of column/parameter:- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE int
=>
SQL type from java.sql.Types - TYPE_NAME String
=>
SQL type name, for a UDT type the type name is fully qualified - PRECISION int
=>
precision - LENGTH int
=>
length in bytes of data - SCALE short
=>
scale - null is returned for data types where SCALE is not applicable. - RADIX short
=>
radix - NULLABLE short
=>
can it contain NULL.- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String
=>
comment describing parameter/column - COLUMN_DEF String
=>
default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may benull
)- The string NULL (not enclosed in quotes) - if NULL was specified as the default value
- TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
- NULL - if a default value was not specified
- SQL_DATA_TYPE int
=>
reserved for future use - SQL_DATETIME_SUB int
=>
reserved for future use - CHAR_OCTET_LENGTH int
=>
the maximum length of binary and character based columns. For any other datatype the returned value is a NULL - ORDINAL_POSITION int
=>
the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 is returned if this row describes the procedure's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. If there are multiple result sets, the column ordinal positions are implementation defined. - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a column.- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
- SPECIFIC_NAME String
=>
the name which uniquely identifies this procedure within its schema.
Note: Some databases may not return the column descriptions for a procedure.
The PRECISION column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchprocedureNamePattern
- a procedure name pattern; must match the procedure name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row describes a stored procedure parameter or column- Throws:
SQLException
- if a database access error occurs- See Also:
- PROCEDURE_CAT String
-
getTables
ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered byTABLE_TYPE
,TABLE_CAT
,TABLE_SCHEM
andTABLE_NAME
.Each table description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - TABLE_TYPE String
=>
table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". - REMARKS String
=>
explanatory comment on the table (may benull
) - TYPE_CAT String
=>
the types catalog (may benull
) - TYPE_SCHEM String
=>
the types schema (may benull
) - TYPE_NAME String
=>
type name (may benull
) - SELF_REFERENCING_COL_NAME String
=>
name of the designated "identifier" column of a typed table (may benull
) - REF_GENERATION String
=>
specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may benull
)
Note: Some databases may not return information for all tables.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasetypes
- a list of table types, which must be from the list of table types returned fromgetTableTypes()
, to include;null
returns all types- Returns:
ResultSet
- each row is a table description- Throws:
SQLException
- if a database access error occurs- See Also:
- TABLE_CAT String
-
getSchemas
Retrieves the schema names available in this database. The results are ordered byTABLE_CATALOG
andTABLE_SCHEM
.The schema columns are:
- TABLE_SCHEM String
=>
schema name - TABLE_CATALOG String
=>
catalog name (may benull
)
- Returns:
- a
ResultSet
object in which each row is a schema description - Throws:
SQLException
- if a database access error occurs
- TABLE_SCHEM String
-
getCatalogs
Retrieves the catalog names available in this database. The results are ordered by catalog name.The catalog column is:
- TABLE_CAT String
=>
catalog name
- Returns:
- a
ResultSet
object in which each row has a singleString
column that is a catalog name - Throws:
SQLException
- if a database access error occurs
- TABLE_CAT String
-
getTableTypes
Retrieves the table types available in this database. The results are ordered by table type.The table type is:
- TABLE_TYPE String
=>
table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- Returns:
- a
ResultSet
object in which each row has a singleString
column that is a table type - Throws:
SQLException
- if a database access error occurs
- TABLE_TYPE String
-
getColumns
ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Retrieves a description of table columns available in the specified catalog.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,TABLE_NAME
, andORDINAL_POSITION
.Each column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL type from java.sql.Types - TYPE_NAME String
=>
Data source dependent type name, for a UDT the type name is fully qualified - COLUMN_SIZE int
=>
column size. - BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int
=>
the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. - NUM_PREC_RADIX int
=>
Radix (typically either 10 or 2) - NULLABLE int
=>
is NULL allowed.- columnNoNulls - might not allow
NULL
values - columnNullable - definitely allows
NULL
values - columnNullableUnknown - nullability unknown
- columnNoNulls - might not allow
- REMARKS String
=>
comment describing column (may benull
) - COLUMN_DEF String
=>
default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may benull
) - SQL_DATA_TYPE int
=>
unused - SQL_DATETIME_SUB int
=>
unused - CHAR_OCTET_LENGTH int
=>
for char types the maximum number of bytes in the column - ORDINAL_POSITION int
=>
index of column in table (starting at 1) - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a column.- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
- SCOPE_CATALOG String
=>
catalog of table that is the scope of a reference attribute (null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String
=>
schema of table that is the scope of a reference attribute (null
if the DATA_TYPE isn't REF) - SCOPE_TABLE String
=>
table name that this the scope of a reference attribute (null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short
=>
source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null
if DATA_TYPE isn't DISTINCT or user-generated REF) - IS_AUTOINCREMENT String
=>
Indicates whether this column is auto incremented- YES --- if the column is auto incremented
- NO --- if the column is not auto incremented
- empty string --- if it cannot be determined whether the column is auto incremented
- IS_GENERATEDCOLUMN String
=>
Indicates whether this is a generated column- YES --- if this a generated column
- NO --- if this not a generated column
- empty string --- if it cannot be determined whether this is a generated column
The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs- See Also:
- TABLE_CAT String
-
getColumnPrivileges
ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException Retrieves a description of the access rights for a table's columns.Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilege description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - GRANTOR String
=>
grantor of access (may benull
) - GRANTEE String
=>
grantee of access - PRIVILEGE String
=>
name of access (SELECT, INSERT, UPDATE, REFERENCES, ...) - IS_GRANTABLE String
=>
"YES" if grantee is permitted to grant to others; "NO" if not;null
if unknown
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column privilege description- Throws:
SQLException
- if a database access error occurs- See Also:
- TABLE_CAT String
-
getTablePrivileges
ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)Only privileges matching the schema and table name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,TABLE_NAME
, andPRIVILEGE
.Each privilege description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - GRANTOR String
=>
grantor of access (may benull
) - GRANTEE String
=>
grantee of access - PRIVILEGE String
=>
name of access (SELECT, INSERT, UPDATE, REFERENCES, ...) - IS_GRANTABLE String
=>
"YES" if grantee is permitted to grant to others; "NO" if not;null
if unknown
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a table privilege description- Throws:
SQLException
- if a database access error occurs- See Also:
- TABLE_CAT String
-
getBestRowIdentifier
ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.Each column description has the following columns:
- SCOPE short
=>
actual scope of result- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL data type from java.sql.Types - TYPE_NAME String
=>
Data source dependent type name, for a UDT the type name is fully qualified - COLUMN_SIZE int
=>
precision - BUFFER_LENGTH int
=>
not used - DECIMAL_DIGITS short
=>
scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. - PSEUDO_COLUMN short
=>
is this a pseudo column like an Oracle ROWID- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in the databasescope
- the scope of interest; use same values as SCOPEnullable
- include columns that are nullable.- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs
- SCOPE short
-
getVersionColumns
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.Each column description has the following columns:
- SCOPE short
=>
is not used - COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL data type fromjava.sql.Types
- TYPE_NAME String
=>
Data source-dependent type name - COLUMN_SIZE int
=>
precision - BUFFER_LENGTH int
=>
length of column value in bytes - DECIMAL_DIGITS short
=>
scale - Null is returned for data types where DECIMAL_DIGITS is not applicable. - PSEUDO_COLUMN short
=>
whether this is pseudo column like an Oracle ROWID- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in the database- Returns:
- a
ResultSet
object in which each row is a column description - Throws:
SQLException
- if a database access error occurs
- SCOPE short
-
getPrimaryKeys
Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.Each primary key column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - KEY_SEQ short
=>
sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key). - PK_NAME String
=>
primary key name (may benull
)
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs
- TABLE_CAT String
-
getImportedKeys
Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.Each primary key column description has the following columns:
- PKTABLE_CAT String
=>
primary key table catalog being imported (may benull
) - PKTABLE_SCHEM String
=>
primary key table schema being imported (may benull
) - PKTABLE_NAME String
=>
primary key table name being imported - PKCOLUMN_NAME String
=>
primary key column name being imported - FKTABLE_CAT String
=>
foreign key table catalog (may benull
) - FKTABLE_SCHEM String
=>
foreign key table schema (may benull
) - FKTABLE_NAME String
=>
foreign key table name - FKCOLUMN_NAME String
=>
foreign key column name - KEY_SEQ short
=>
sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key). - UPDATE_RULE short
=>
What happens to a foreign key when the primary key is updated:- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short
=>
What happens to the foreign key when primary is deleted.- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String
=>
foreign key name (may benull
) - PK_NAME String
=>
primary key name (may benull
) - DEFERRABILITY short
=>
can the evaluation of foreign key constraints be deferred until commit- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs- See Also:
- PKTABLE_CAT String
-
getExportedKeys
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String
=>
primary key table catalog (may benull
) - PKTABLE_SCHEM String
=>
primary key table schema (may benull
) - PKTABLE_NAME String
=>
primary key table name - PKCOLUMN_NAME String
=>
primary key column name - FKTABLE_CAT String
=>
foreign key table catalog (may benull
) being exported (may benull
) - FKTABLE_SCHEM String
=>
foreign key table schema (may benull
) being exported (may benull
) - FKTABLE_NAME String
=>
foreign key table name being exported - FKCOLUMN_NAME String
=>
foreign key column name being exported - KEY_SEQ short
=>
sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key). - UPDATE_RULE short
=>
What happens to foreign key when primary is updated:- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short
=>
What happens to the foreign key when primary is deleted.- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String
=>
foreign key name (may benull
) - PK_NAME String
=>
primary key name (may benull
) - DEFERRABILITY short
=>
can the evaluation of foreign key constraints be deferred until commit- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in this database- Returns:
- a
ResultSet
object in which each row is a foreign key column description - Throws:
SQLException
- if a database access error occurs- See Also:
- PKTABLE_CAT String
-
getCrossReference
ResultSet getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table). The number of columns returned from the parent table must match the number of columns that make up the foreign key. They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String
=>
parent key table catalog (may benull
) - PKTABLE_SCHEM String
=>
parent key table schema (may benull
) - PKTABLE_NAME String
=>
parent key table name - PKCOLUMN_NAME String
=>
parent key column name - FKTABLE_CAT String
=>
foreign key table catalog (may benull
) being exported (may benull
) - FKTABLE_SCHEM String
=>
foreign key table schema (may benull
) being exported (may benull
) - FKTABLE_NAME String
=>
foreign key table name being exported - FKCOLUMN_NAME String
=>
foreign key column name being exported - KEY_SEQ short
=>
sequence number within foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key). - UPDATE_RULE short
=>
What happens to foreign key when parent key is updated:- importedNoAction - do not allow update of parent key if it has been imported
- importedKeyCascade - change imported key to agree with parent key update
- importedKeySetNull - change imported key to
NULL
if its parent key has been updated - importedKeySetDefault - change imported key to default values if its parent key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short
=>
What happens to the foreign key when parent key is deleted.- importedKeyNoAction - do not allow delete of parent key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL
if its primary key has been deleted - importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its parent key has been deleted
- FK_NAME String
=>
foreign key name (may benull
) - PK_NAME String
=>
parent key name (may benull
) - DEFERRABILITY short
=>
can the evaluation of foreign key constraints be deferred until commit- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Parameters:
parentCatalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaparentSchema
- 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 criteriaparentTable
- the name of the table that exports the key; must match the table name as it is stored in the databaseforeignCatalog
- 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 criteriaforeignSchema
- 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 criteriaforeignTable
- the name of the table that imports the key; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a foreign key column description- Throws:
SQLException
- if a database access error occurs- See Also:
- PKTABLE_CAT String
-
getTypeInfo
Retrieves a description of all the data types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.If the database supports SQL distinct types, then getTypeInfo() will return a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT. If the database supports SQL structured types, then getTypeInfo() will return a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.
If SQL distinct or structured types are supported, then information on the individual types may be obtained from the getUDTs() method.
Each type description has the following columns:
- TYPE_NAME String
=>
Type name - DATA_TYPE int
=>
SQL data type from java.sql.Types - PRECISION int
=>
maximum precision - LITERAL_PREFIX String
=>
prefix used to quote a literal (may benull
) - LITERAL_SUFFIX String
=>
suffix used to quote a literal (may benull
) - CREATE_PARAMS String
=>
parameters used in creating the type (may benull
) - NULLABLE short
=>
can you use NULL for this type.- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean
=>
is it case sensitive. - SEARCHABLE short
=>
can you use "WHERE" based on this type:- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean
=>
is it unsigned. - FIXED_PREC_SCALE boolean
=>
can it be a money value. - AUTO_INCREMENT boolean
=>
can it be used for an auto-increment value. - LOCAL_TYPE_NAME String
=>
localized version of type name (may benull
) - MINIMUM_SCALE short
=>
minimum scale supported - MAXIMUM_SCALE short
=>
maximum scale supported - SQL_DATA_TYPE int
=>
unused - SQL_DATETIME_SUB int
=>
unused - NUM_PREC_RADIX int
=>
usually 2 or 10
The PRECISION column represents the maximum column size that the server supports for the given datatype. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Returns:
- a
ResultSet
object in which each row is an SQL type description - Throws:
SQLException
- if a database access error occurs
- TYPE_NAME String
-
getIndexInfo
ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.Each index column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - NON_UNIQUE boolean
=>
Can index values be non-unique. false when TYPE is tableIndexStatistic - INDEX_QUALIFIER String
=>
index catalog (may benull
);null
when TYPE is tableIndexStatistic - INDEX_NAME String
=>
index name;null
when TYPE is tableIndexStatistic - TYPE short
=>
index type:- tableIndexStatistic - this identifies table statistics that are returned in conjunction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short
=>
column sequence number within index; zero when TYPE is tableIndexStatistic - COLUMN_NAME String
=>
column name;null
when TYPE is tableIndexStatistic - ASC_OR_DESC String
=>
column sort sequence, "A"=>
ascending, "D"=>
descending, may benull
if sort sequence is not supported;null
when TYPE is tableIndexStatistic - CARDINALITY long
=>
When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index. - PAGES long
=>
When TYPE is tableIndexStatistic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index. - FILTER_CONDITION String
=>
Filter condition, if any. (may benull
)
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- 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 searchtable
- a table name; must match the table name as it is stored in this databaseunique
- when true, return only indices for unique values; when false, return indices regardless of whether unique or notapproximate
- when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate- Returns:
ResultSet
- each row is an index column description- Throws:
SQLException
- if a database access error occurs
- TABLE_CAT String
-
supportsResultSetType
Retrieves whether this database supports the given result set type.- Parameters:
type
- defined injava.sql.ResultSet
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
-
supportsResultSetConcurrency
Retrieves whether this database supports the given concurrency type in combination with the given result set type.- Parameters:
type
- defined injava.sql.ResultSet
concurrency
- type defined injava.sql.ResultSet
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
-
ownUpdatesAreVisible
Retrieves whether for the given type ofResultSet
object, the result set's own updates are visible.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if updates are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
ownDeletesAreVisible
Retrieves whether a result set's own deletes are visible.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if deletes are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
ownInsertsAreVisible
Retrieves whether a result set's own inserts are visible.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if inserts are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
othersUpdatesAreVisible
Retrieves whether updates made by others are visible.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if updates made by others are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
othersDeletesAreVisible
Retrieves whether deletes made by others are visible.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if deletes made by others are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
othersInsertsAreVisible
Retrieves whether inserts made by others are visible.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if inserts made by others are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
updatesAreDetected
Retrieves whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if changes are detected by the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
deletesAreDetected
Retrieves whether or not a visible row delete can be detected by calling the methodResultSet.rowDeleted
. If the methoddeletesAreDetected
returnsfalse
, it means that deleted rows are removed from the result set.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if deletes are detected by the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
insertsAreDetected
Retrieves whether or not a visible row insert can be detected by calling the methodResultSet.rowInserted
.- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if changes are detected by the specified result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
supportsBatchUpdates
Retrieves whether this database supports batch updates.- Returns:
true
if this database supports batch updates;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getUDTs
ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have typeJAVA_OBJECT
,STRUCT
, orDISTINCT
.Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by
DATA_TYPE
,TYPE_CAT
,TYPE_SCHEM
andTYPE_NAME
. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.Each type description has the following columns:
- TYPE_CAT String
=>
the type's catalog (may benull
) - TYPE_SCHEM String
=>
type's schema (may benull
) - TYPE_NAME String
=>
type name - CLASS_NAME String
=>
Java class name - DATA_TYPE int
=>
type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT - REMARKS String
=>
explanatory comment on the type - BASE_TYPE short
=>
type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (null
if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty result set is returned.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchtypeNamePattern
- a type name pattern; must match the type name as it is stored in the database; may be a fully qualified nametypes
- a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include;null
returns all types- Returns:
ResultSet
object in which each row describes a UDT- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
- TYPE_CAT String
-
getConnection
Retrieves the connection that produced this metadata object.- Returns:
- the connection that produced this metadata object
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
supportsSavepoints
Retrieves whether this database supports savepoints.- Returns:
true
if savepoints are supported;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
supportsNamedParameters
Retrieves whether this database supports named parameters to callable statements.- Returns:
true
if named parameters are supported;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
supportsMultipleOpenResults
Retrieves whether it is possible to have multipleResultSet
objects returned from aCallableStatement
object simultaneously.- Returns:
true
if aCallableStatement
object can return multipleResultSet
objects simultaneously;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
supportsGetGeneratedKeys
Retrieves whether auto-generated keys can be retrieved after a statement has been executed- Returns:
true
if auto-generated keys can be retrieved after a statement has executed;false
otherwiseIf
true
is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getSuperTypes
ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.
If a UDT does not have a direct super type, it is not listed here. A row of the
ResultSet
object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:- TYPE_CAT String
=>
the UDT's catalog (may benull
) - TYPE_SCHEM String
=>
UDT's schema (may benull
) - TYPE_NAME String
=>
type name of the UDT - SUPERTYPE_CAT String
=>
the direct super type's catalog (may benull
) - SUPERTYPE_SCHEM String
=>
the direct super type's schema (may benull
) - SUPERTYPE_NAME String
=>
the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematypeNamePattern
- a UDT name pattern; may be a fully-qualified name- Returns:
- a
ResultSet
object in which a row gives information about the designated UDT - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
- TYPE_CAT String
-
getSuperTables
ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Retrieves a description of the table hierarchies defined in a particular schema in this database.Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.
Each type description has the following columns:
- TABLE_CAT String
=>
the type's catalog (may benull
) - TABLE_SCHEM String
=>
type's schema (may benull
) - TABLE_NAME String
=>
type name - SUPERTABLE_NAME String
=>
the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name pattern; may be a fully-qualified name- Returns:
- a
ResultSet
object in which each row is a type description - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
- TABLE_CAT String
-
getAttributes
ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by
TYPE_CAT
,TYPE_SCHEM
,TYPE_NAME
andORDINAL_POSITION
. This description does not contain inherited attributes.The
ResultSet
object that is returned has the following columns:- TYPE_CAT String
=>
type catalog (may benull
) - TYPE_SCHEM String
=>
type schema (may benull
) - TYPE_NAME String
=>
type name - ATTR_NAME String
=>
attribute name - DATA_TYPE int
=>
attribute type SQL type from java.sql.Types - ATTR_TYPE_NAME String
=>
Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type. - ATTR_SIZE int
=>
column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision. - DECIMAL_DIGITS int
=>
the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. - NUM_PREC_RADIX int
=>
Radix (typically either 10 or 2) - NULLABLE int
=>
whether NULL is allowed- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String
=>
comment describing column (may benull
) - ATTR_DEF String
=>
default value (may benull
) - SQL_DATA_TYPE int
=>
unused - SQL_DATETIME_SUB int
=>
unused - CHAR_OCTET_LENGTH int
=>
for char types the maximum number of bytes in the column - ORDINAL_POSITION int
=>
index of the attribute in the UDT (starting at 1) - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a attribute.- YES --- if the attribute can include NULLs
- NO --- if the attribute cannot include NULLs
- empty string --- if the nullability for the attribute is unknown
- SCOPE_CATALOG String
=>
catalog of table that is the scope of a reference attribute (null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String
=>
schema of table that is the scope of a reference attribute (null
if DATA_TYPE isn't REF) - SCOPE_TABLE String
=>
table name that is the scope of a reference attribute (null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short
=>
source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null
if DATA_TYPE isn't DISTINCT or user-generated REF)
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchtypeNamePattern
- a type name pattern; must match the type name as it is stored in the databaseattributeNamePattern
- an attribute name pattern; must match the attribute name as it is declared in the database- Returns:
- a
ResultSet
object in which each row is an attribute description - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
- TYPE_CAT String
-
supportsResultSetHoldability
Retrieves whether this database supports the given result set holdability.- Parameters:
holdability
- one of the following constants:ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getResultSetHoldability
Retrieves this database's default holdability forResultSet
objects.- Returns:
- the default holdability; either
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getDatabaseMajorVersion
Retrieves the major version number of the underlying database.- Returns:
- the underlying database's major version
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getDatabaseMinorVersion
Retrieves the minor version number of the underlying database.- Returns:
- underlying database's minor version
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getJDBCMajorVersion
Retrieves the major JDBC version number for this driver.- Returns:
- JDBC version major number
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getJDBCMinorVersion
Retrieves the minor JDBC version number for this driver.- Returns:
- JDBC version minor number
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getSQLStateType
Indicates whether the SQLSTATE returned bySQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003.- Returns:
- the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
locatorsUpdateCopy
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.- Returns:
true
if updates are made to a copy of the LOB;false
if updates are made directly to the LOB- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
supportsStatementPooling
Retrieves whether this database supports statement pooling.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getRowIdLifetime
Indicates whether this data source supports the SQLROWID
type, and the lifetime for which aRowId
object remains valid.- Returns:
- the status indicating the lifetime of a
RowId
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
getSchemas
Retrieves the schema names available in this database. The results are ordered byTABLE_CATALOG
andTABLE_SCHEM
.The schema columns are:
- TABLE_SCHEM String
=>
schema name - TABLE_CATALOG String
=>
catalog name (may benull
)
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database;"" retrieves those without a catalog; null means catalog name should not be used to narrow down the search.schemaPattern
- a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search.- Returns:
- a
ResultSet
object in which each row is a schema description - Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
- See Also:
- TABLE_SCHEM String
-
supportsStoredFunctionsUsingCallSyntax
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
autoCommitFailureClosesAllResultSets
Retrieves whether aSQLException
while autoCommit istrue
indicates that all open ResultSets are closed, even ones that are holdable. When aSQLException
occurs while autocommit istrue
, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
getClientInfoProperties
Retrieves a list of the client info properties that the driver supports. The result set contains the following columns- NAME String
=>
The name of the client info property
- MAX_LEN int
=>
The maximum length of the value for the property
- DEFAULT_VALUE String
=>
The default value of the property
- DESCRIPTION String
=>
A description of the property. This will typically contain information as to where this property is stored in the database.
The
ResultSet
is sorted by the NAME column- Returns:
- A
ResultSet
object; each row is a supported client info property - Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
- NAME String
-
getFunctions
ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException Retrieves a description of the system and user functions available in the given catalog.Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered by
FUNCTION_CAT
,FUNCTION_SCHEM
,FUNCTION_NAME
andSPECIFIC_NAME
.Each function description has the following columns:
- FUNCTION_CAT String
=>
function catalog (may benull
) - FUNCTION_SCHEM String
=>
function schema (may benull
) - FUNCTION_NAME String
=>
function name. This is the name used to invoke the function - REMARKS String
=>
explanatory comment on the function - FUNCTION_TYPE short
=>
kind of function:- functionResultUnknown - Cannot determine if a return value or table will be returned
- functionNoTable- Does not return a table
- functionReturnsTable - Returns a table
- SPECIFIC_NAME String
=>
the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then theFUNCTION_NAME
for example with overload functions
A user may not have permission to execute any of the functions that are returned by
getFunctions
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchfunctionNamePattern
- a function name pattern; must match the function name as it is stored in the database- Returns:
ResultSet
- each row is a function description- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
- See Also:
- FUNCTION_CAT String
-
getFunctionColumns
ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException Retrieves a description of the given catalog's system or user function parameters and return type.Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by
FUNCTION_CAT
,FUNCTION_SCHEM
,FUNCTION_NAME
andSPECIFIC_NAME
. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.Each row in the
ResultSet
is a parameter description, column description or return type description with the following fields:- FUNCTION_CAT String
=>
function catalog (may benull
) - FUNCTION_SCHEM String
=>
function schema (may benull
) - FUNCTION_NAME String
=>
function name. This is the name used to invoke the function - COLUMN_NAME String
=>
column/parameter name - COLUMN_TYPE Short
=>
kind of column/parameter:- functionColumnUnknown - nobody knows
- functionColumnIn - IN parameter
- functionColumnInOut - INOUT parameter
- functionColumnOut - OUT parameter
- functionReturn - function return value
- functionColumnResult - Indicates that the parameter or column
is a column in the
ResultSet
- DATA_TYPE int
=>
SQL type from java.sql.Types - TYPE_NAME String
=>
SQL type name, for a UDT type the type name is fully qualified - PRECISION int
=>
precision - LENGTH int
=>
length in bytes of data - SCALE short
=>
scale - null is returned for data types where SCALE is not applicable. - RADIX short
=>
radix - NULLABLE short
=>
can it contain NULL.- functionNoNulls - does not allow NULL values
- functionNullable - allows NULL values
- functionNullableUnknown - nullability unknown
- REMARKS String
=>
comment describing column/parameter - CHAR_OCTET_LENGTH int
=>
the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL - ORDINAL_POSITION int
=>
the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a parameter or column.- YES --- if the parameter or column can include NULLs
- NO --- if the parameter or column cannot include NULLs
- empty string --- if the nullability for the parameter or column is unknown
- SPECIFIC_NAME String
=>
the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then theFUNCTION_NAME
for example with overload functions
The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchfunctionNamePattern
- a procedure name pattern; must match the function name as it is stored in the databasecolumnNamePattern
- a parameter name pattern; must match the parameter or column name as it is stored in the database- Returns:
ResultSet
- each row describes a user function parameter, column or return type- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
- See Also:
- FUNCTION_CAT String
-
getPseudoColumns
ResultSet getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema. Pseudo or hidden columns may not always be stored within a table and are not visible in a ResultSet unless they are specified in the query's outermost SELECT list. Pseudo or hidden columns may not necessarily be able to be modified. If there are no pseudo or hidden columns, an empty ResultSet is returned.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by
TABLE_CAT
,TABLE_SCHEM
,TABLE_NAME
andCOLUMN_NAME
.Each column description has the following columns:
- TABLE_CAT String
=>
table catalog (may benull
) - TABLE_SCHEM String
=>
table schema (may benull
) - TABLE_NAME String
=>
table name - COLUMN_NAME String
=>
column name - DATA_TYPE int
=>
SQL type from java.sql.Types - COLUMN_SIZE int
=>
column size. - DECIMAL_DIGITS int
=>
the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. - NUM_PREC_RADIX int
=>
Radix (typically either 10 or 2) - COLUMN_USAGE String
=>
The allowed usage for the column. The value returned will correspond to the enum name returned byPseudoColumnUsage.name()
- REMARKS String
=>
comment describing column (may benull
) - CHAR_OCTET_LENGTH int
=>
for char types the maximum number of bytes in the column - IS_NULLABLE String
=>
ISO rules are used to determine the nullability for a column.- YES --- if the column can include NULLs
- NO --- if the column cannot include NULLs
- empty string --- if the nullability for the column is unknown
The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
- Parameters:
catalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- 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 searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs- Since:
- 1.7
- See Also:
- TABLE_CAT String
-
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. The key that is returned may or may not be based on the column(s) for the auto generated key. Consult your JDBC driver documentation for additional details.- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.7
-
getMaxLogicalLobSize
Retrieves the maximum number of bytes this database allows for the logical size for aLOB
.The default implementation will return
0
- Returns:
- the maximum number of bytes allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.8
-
supportsRefCursors
Retrieves whether this database supports REF CURSOR.The default implementation will return
false
- Returns:
true
if this database supports REF CURSOR;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.8
-
supportsSharding
Retrieves whether this database supports sharding.- Implementation Requirements:
- The default implementation will return
false
- Returns:
true
if this database supports sharding;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 9
-