Class DatabaseMetaDataWrapper
- All Implemented Interfaces:
DatabaseMetaData
,Wrapper
- Version:
- $Revision: 1.4 $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ConnectionWrapper
private final DatabaseMetaData
private boolean
private final List
Fields inherited from interface java.sql.DatabaseMetaData
attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, sqlStateXOpen, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Return true if all the procedures returned by getProcedures can be called by the current user.final boolean
Return true if all the tables returned by getTable can be SELECTed by the current user.boolean
private void
final void
close()
Close this object and any result sets that it createdfinal boolean
Does a data definition statement within a transaction force the transaction to commit?final boolean
Is a data definition statement within a transaction ignored?final boolean
deletesAreDetected
(int type) Indicates whether or not a visible row delete can be detected by calling ResultSet.rowDeleted().final boolean
Return true if getMaxRowSize() included LONGVARCHAR and LONGVARBINARY blobs.boolean
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.final ResultSet
getBestRowIdentifier
(String catalog, String schema, String table, int scope, boolean nullable) Gets a description of a table's optimal set of columns that uniquely identifies a row.final ResultSet
Gets the catalog names available in this database.final String
What's the separator between catalog and table name?final String
What's the database vendor's preferred term for "catalog"?final ResultSet
getColumnPrivileges
(String catalog, String schema, String table, String columnNamePattern) Gets a description of the access rights for a table's columns.final ResultSet
getColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) Gets a description of table columns available in the specified catalog.final Connection
Retrieves the connection that produced this metadata object.final ResultSet
getCrossReference
(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key).int
Retrieves the major version number of the underlying database.int
Retrieves the minor version number of the underlying database.final String
What's the name of this database product?final String
What's the version of this database product?final int
Return the database's default transaction isolation level.final DatabaseMetaData
Return the wrapped objectfinal int
What's this JDBC driver's major version number?final int
What's this JDBC driver's minor version number?final String
What's the name of this JDBC driver?final String
What's the version of this JDBC driver?final ResultSet
getExportedKeys
(String catalog, String schema, String table) Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).final String
Gets 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) getFunctions
(String catalog, String schemaPattern, String functionNamePattern) final String
Return the string used to quote SQL identifiers.final ResultSet
getImportedKeys
(String catalog, String schema, String table) Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).final ResultSet
getIndexInfo
(String catalog, String schema, String table, boolean unique, boolean approximate) Gets a description of a 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.final int
How many hex characters can you have in an inline binary literal?final int
What's the maximum length of a catalog name?final int
What's the max length for a character literal?final int
What's the limit on column name length?final int
What's the maximum number of columns in a "GROUP BY" clause?final int
What's the maximum number of columns allowed in an index?final int
What's the maximum number of columns in an "ORDER BY" clause?final int
What's the maximum number of columns in a "SELECT" list?final int
What's the maximum number of columns in a table?final int
How many active connections can we have at a time to this database?final int
What's the maximum cursor name length?final int
Retrieves the maximum number of bytes for an index, including all of the parts of the index.final int
What's the maximum length of a procedure name?final int
What's the maximum length of a single row?final int
What's the maximum length allowed for a schema name?final int
What's the maximum length of an SQL statement?final int
How many active statements can we have open at one time to this database?final int
What's the maximum length of a table name?final int
What's the maximum number of tables in a SELECT statement?final int
What's the maximum length of a user name?final String
Gets a comma-separated list of math functions.final ResultSet
getPrimaryKeys
(String catalog, String schema, String table) Gets a description of a table's primary key columns.final ResultSet
getProcedureColumns
(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) Gets a description of a catalog's stored procedure parameters and result columns.final ResultSet
getProcedures
(String catalog, String schemaPattern, String procedureNamePattern) Gets a description of the stored procedures available in a catalog.final String
What's the database vendor's preferred term for "procedure"?getPseudoColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) int
Retrieves the default holdability of thisResultSet
object.final ResultSet
Gets the schema names available in this database.getSchemas
(String catalog, String schemaPattern) final String
What's the database vendor's preferred term for "schema"?final String
Gets the string that can be used to escape wildcard characters.final String
Gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords.int
Indicates whether the SQLSTATE returned bySQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL99.final String
Gets a comma-separated list of string functions.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.final String
Gets a comma-separated list of system functions.final ResultSet
getTablePrivileges
(String catalog, String schemaPattern, String tableNamePattern) Gets a description of the access rights for each table available in a catalog.final ResultSet
Gets a description of tables available in a catalog.final ResultSet
Gets the table types available in this database.final String
Gets a comma-separated list of time and date functions.final ResultSet
Gets a description of all the standard SQL types supported by this database.final ResultSet
Gets a description of the user-defined types defined in a particular schema.final String
getURL()
What's the url for this database?final String
What's our user name as known to the database?final ResultSet
getVersionColumns
(String catalog, String schema, String table) Gets a description of a table's columns that are automatically updated when any value in a row is updated.final boolean
insertsAreDetected
(int type) Indicates whether or not a visible row insert can be detected by calling ResultSet.rowInserted().final boolean
Return true if a catalog appears at the start of a qualified table name.final boolean
Is the database in read-only mode?boolean
isWrapperFor
(Class<?> iface) boolean
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.final boolean
Return true if concatenations between NULL and non-NULL values are NULL.final boolean
Return true if NULL values are sorted at the end regardless of sort order.final boolean
Return true if NULL values are sorted at the start regardless of sort order.final boolean
Return true if NULL values are sorted high.final boolean
Return true if NULL values are sorted low.final boolean
othersDeletesAreVisible
(int type) Indicates whether deletes made by others are visible.final boolean
othersInsertsAreVisible
(int type) Indicates whether inserts made by others are visible.final boolean
othersUpdatesAreVisible
(int type) Indicates whether updates made by others are visible.final boolean
ownDeletesAreVisible
(int type) Indicates whether a result set's own deletes are visible.final boolean
ownInsertsAreVisible
(int type) Indicates whether a result set's own inserts are visible.final boolean
ownUpdatesAreVisible
(int type) Indicates whether a result set's own updates are visible.final void
setConnection
(ConnectionWrapper connection) Set the connection that will be returned by getConnection()final boolean
Return true if the database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.final boolean
Return true if the database treats mixed case quoted SQL identifiers as case insensitive and store them in lower case.final boolean
Return true if the database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.final boolean
Return true if the database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.final boolean
Return true if the database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.final boolean
Return true if the database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.final boolean
Return true if "ALTER TABLE" with add column is supported.final boolean
Return true if "ALTER TABLE" with drop column is supported.final boolean
Return true if the ANSI92 entry level SQL grammar is supported.final boolean
Is the ANSI92 full SQL grammar supported?final boolean
Is the ANSI92 intermediate SQL grammar supported?final boolean
Indicates whether the driver supports batch updates.final boolean
Can a catalog name be used in a data manipulation statement?final boolean
Can a catalog name be used in an index definition statement?final boolean
Can a catalog name be used in a privilege definition statement?final boolean
Can a catalog name be used in a procedure call statement?final boolean
Can a catalog name be used in a table definition statement?final boolean
Return true if column aliasing is supported.final boolean
Return true if the CONVERT function between SQL types supported.final boolean
supportsConvert
(int fromType, int toType) Return true if CONVERT between the given SQL types supported.final boolean
Is the ODBC Core SQL grammar supported?final boolean
Return true if correlated subqueries are supported.final boolean
Are both data definition and data manipulation statements within a transaction supported?final boolean
Are only data manipulation statements within a transaction supported?final boolean
If table correlation names are supported, are they restricted to be different from the names of the tables?final boolean
Are expressions in "ORDER BY" lists supported?final boolean
Is the ODBC Extended SQL grammar supported?final boolean
Are full nested outer joins supported?boolean
Retrieves whether auto-generated keys can be retrieved after a statement has been executed.final boolean
Is some form of "GROUP BY" clause supported?final boolean
Return true if a "GROUP BY" clause can add columns not in the SELECT provided it specifies all the columns in the SELECT.final boolean
Can a "GROUP BY" clause use columns not in the SELECT?final boolean
Is the SQL Integrity Enhancement Facility supported?final boolean
Return true if the escape character in "LIKE" clauses is supported.final boolean
Return true if there is limited support for outer joins.final boolean
Return true if the ODBC Minimum SQL grammar is supported.final boolean
Return true if the database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.final boolean
Return true if the 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.final boolean
Are multipleResultSet
from a single execute supported?final boolean
Can we have multiple transactions open at once (on different connections)?boolean
Retrieves whether this database supports named parameters to callable statements.final boolean
Return true if columns can be defined as non-nullable.final boolean
Return true if cursors can remain open across commits.final boolean
Return true if cursors can remain open across rollbacks.final boolean
Return true if statements can remain open across commits.final boolean
Return true if statements can remain open across rollbacks.final boolean
Can an "ORDER BY" clause use columns not in the SELECT statement?final boolean
Is some form of outer join supported?final boolean
Is positioned DELETE supported?final boolean
Is positioned UPDATE supported?final boolean
supportsResultSetConcurrency
(int type, int concurrency) Does the database support the concurrency type in combination with the given result set type?boolean
supportsResultSetHoldability
(int holdability) Retrieves whether this database supports the given result set holdability.final boolean
supportsResultSetType
(int type) Does the database support the given result set type?boolean
Retrieves whether this database supports savepoints.final boolean
Can a schema name be used in a data manipulation statement?final boolean
Can a schema name be used in an index definition statement?final boolean
Can a schema name be used in a privilege definition statement?final boolean
Can a schema name be used in a procedure call statement?final boolean
Can a schema name be used in a table definition statement?final boolean
Is SELECT for UPDATE supported?boolean
Retrieves whether this database supports statement pooling.boolean
final boolean
Return true if stored procedure calls using the stored procedure escape syntax are supported.final boolean
Return true if subqueries in comparison expressions are supported.final boolean
Return true if subqueries in 'exists' expressions are supported.final boolean
Return true if subqueries in 'in' statements are supported.final boolean
Return true if subqueries in quantified expressions are supported.final boolean
Return true if table correlation names supported.final boolean
supportsTransactionIsolationLevel
(int level) Does this database support the given transaction isolation level?final boolean
Return true if transactions are supported.final boolean
Return true if SQL UNION is supported.final boolean
Return true if SQL UNION ALL is supported.<T> T
final boolean
updatesAreDetected
(int type) Indicates whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.final boolean
Return true if the database uses a file for each table.final boolean
Return true if the database stores tables in a local file.private ResultSet
Wrap the specified result setMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.sql.DatabaseMetaData
getMaxLogicalLobSize, supportsRefCursors, supportsSharding
-
Field Details
-
delegate_
-
isOpen_
private boolean isOpen_ -
connection_
-
openResultSets_
-
-
Constructor Details
-
DatabaseMetaDataWrapper
Create a wrapper- Parameters:
metaData
- The object to be wrapped
-
-
Method Details
-
setConnection
Set the connection that will be returned by getConnection()- Parameters:
connection
- the connection
-
getDelegate
Return the wrapped object- Returns:
- The wrapped object
-
getURL
What's the url for this database?- Specified by:
getURL
in interfaceDatabaseMetaData
- Returns:
- the url or null if it cannot be generated
- Throws:
SQLException
- if a database access error occurs
-
getUserName
What's our user name as known to the database?- Specified by:
getUserName
in interfaceDatabaseMetaData
- Returns:
- our database user name
- Throws:
SQLException
- if a database access error occurs
-
isReadOnly
Is the database in read-only mode?- Specified by:
isReadOnly
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getDatabaseProductName
What's the name of this database product?- Specified by:
getDatabaseProductName
in interfaceDatabaseMetaData
- Returns:
- database product name
- Throws:
SQLException
- if a database access error occurs
-
getDatabaseProductVersion
What's the version of this database product?- Specified by:
getDatabaseProductVersion
in interfaceDatabaseMetaData
- Returns:
- database version
- Throws:
SQLException
- if a database access error occurs
-
getDriverName
What's the name of this JDBC driver?- Specified by:
getDriverName
in interfaceDatabaseMetaData
- Returns:
- JDBC driver name
- Throws:
SQLException
- if a database access error occurs
-
getDriverVersion
What's the version of this JDBC driver?- Specified by:
getDriverVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver version
- Throws:
SQLException
- if a database access error occurs
-
getDriverMajorVersion
public final int getDriverMajorVersion()What's this JDBC driver's major version number?- Specified by:
getDriverMajorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver major version
-
getDriverMinorVersion
public final int getDriverMinorVersion()What's this JDBC driver's minor version number?- Specified by:
getDriverMinorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver minor version number
-
getIdentifierQuoteString
Return the string used to quote SQL identifiers. This returns a space " " if identifier quoting isn't supported. A JDBC CompliantTM driver always uses a double quote character.- Specified by:
getIdentifierQuoteString
in interfaceDatabaseMetaData
- Returns:
- the quoting string
- Throws:
SQLException
- if a database access error occurs
-
getSQLKeywords
Gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords.- Specified by:
getSQLKeywords
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database access error occurs
-
getNumericFunctions
Gets a comma-separated list of math functions. These are the X/Open CLI math function names used in the JDBC function escape clause.- Specified by:
getNumericFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database access error occurs
-
getStringFunctions
Gets a comma-separated list of string functions. These are the X/Open CLI string function names used in the JDBC function escape clause.- Specified by:
getStringFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database access error occurs
-
getSystemFunctions
Gets a comma-separated list of system functions. These are the X/Open CLI system function names used in the JDBC function escape clause.- Specified by:
getSystemFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database access error occurs
-
getTimeDateFunctions
Gets a comma-separated list of time and date functions.- Specified by:
getTimeDateFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
- Throws:
SQLException
- if a database access error occurs
-
getSearchStringEscape
Gets the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters.The '_' character represents any single character.
The '%' character represents any sequence of zero or more characters.
- Specified by:
getSearchStringEscape
in interfaceDatabaseMetaData
- Returns:
- the string used to escape wildcard characters
- Throws:
SQLException
- if a database access error occurs
-
getExtraNameCharacters
Gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).- Specified by:
getExtraNameCharacters
in interfaceDatabaseMetaData
- Returns:
- the string containing the extra characters
- Throws:
SQLException
- if a database access error occurs
-
getSchemaTerm
What's the database vendor's preferred term for "schema"?- Specified by:
getSchemaTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
- Throws:
SQLException
- if a database access error occurs
-
getProcedureTerm
What's the database vendor's preferred term for "procedure"?- Specified by:
getProcedureTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
- Throws:
SQLException
- if a database access error occurs
-
getCatalogTerm
What's the database vendor's preferred term for "catalog"?- Specified by:
getCatalogTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
- Throws:
SQLException
- if a database access error occurs
-
isCatalogAtStart
Return true if a catalog appears at the start of a qualified table name. (Otherwise it appears at the end)- Specified by:
isCatalogAtStart
in interfaceDatabaseMetaData
- Returns:
- true if it appears at the start
- Throws:
SQLException
- if a database access error occurs
-
getCatalogSeparator
What's the separator between catalog and table name?- Specified by:
getCatalogSeparator
in interfaceDatabaseMetaData
- Returns:
- the separator string
- Throws:
SQLException
- if a database access error occurs
-
getMaxBinaryLiteralLength
How many hex characters can you have in an inline binary literal?- Specified by:
getMaxBinaryLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max binary literal length in hex characters; 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
What's the max length for a character literal?- Specified by:
getMaxCharLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max literal length; 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
What's the limit on column name length?- Specified by:
getMaxColumnNameLength
in interfaceDatabaseMetaData
- Returns:
- max column name length; 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
What's the maximum number of columns in a "GROUP BY" clause?- Specified by:
getMaxColumnsInGroupBy
in interfaceDatabaseMetaData
- Returns:
- max number of columns; 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
What's the maximum number of columns allowed in an index?- Specified by:
getMaxColumnsInIndex
in interfaceDatabaseMetaData
- Returns:
- max number of columns; 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
What's the maximum number of columns in an "ORDER BY" clause?- Specified by:
getMaxColumnsInOrderBy
in interfaceDatabaseMetaData
- Returns:
- max number of columns; 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
What's the maximum number of columns in a "SELECT" list?- Specified by:
getMaxColumnsInSelect
in interfaceDatabaseMetaData
- Returns:
- max number of columns; 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
What's the maximum number of columns in a table?- Specified by:
getMaxColumnsInTable
in interfaceDatabaseMetaData
- Returns:
- max number of columns; 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
How many active connections can we have at a time to this database?- Specified by:
getMaxConnections
in interfaceDatabaseMetaData
- Returns:
- max number of active connections; 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
What's the maximum cursor name length?- Specified by:
getMaxCursorNameLength
in interfaceDatabaseMetaData
- Returns:
- max cursor name length in bytes; 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 for an index, including all of the parts of the index.- Specified by:
getMaxIndexLength
in interfaceDatabaseMetaData
- Returns:
- max index length in bytes, which 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
What's the maximum length allowed for a schema name?- Specified by:
getMaxSchemaNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes; 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
What's the maximum length of a procedure name?- Specified by:
getMaxProcedureNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes; 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
What's the maximum length of a catalog name?- Specified by:
getMaxCatalogNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes; 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
What's the maximum length of a single row?- Specified by:
getMaxRowSize
in interfaceDatabaseMetaData
- Returns:
- max row size in bytes; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxStatementLength
What's the maximum length of an SQL statement?- Specified by:
getMaxStatementLength
in interfaceDatabaseMetaData
- Returns:
- max length in bytes; 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
How many active statements can we have open at one time to this database?- Specified by:
getMaxStatements
in interfaceDatabaseMetaData
- 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
What's the maximum length of a table name?- Specified by:
getMaxTableNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes; 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
What's the maximum number of tables in a SELECT statement?- Specified by:
getMaxTablesInSelect
in interfaceDatabaseMetaData
- 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
What's the maximum length of a user name?- Specified by:
getMaxUserNameLength
in interfaceDatabaseMetaData
- Returns:
- max user name length in bytes; 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
Return the database's default transaction isolation level. The values are defined injava.sql.Connection
.- Specified by:
getDefaultTransactionIsolation
in interfaceDatabaseMetaData
- Returns:
- the default isolation level
- Throws:
SQLException
- if a database access error occurs
-
getProcedures
public final ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException Gets a description of the stored procedures available in a catalog.Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.
Each procedure description has the the following columns:
- PROCEDURE_CAT String => procedure catalog (may be null)
- PROCEDURE_SCHEM String => procedure schema (may be null)
- PROCEDURE_NAME String => procedure name
- reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String => explanatory comment on the procedure
- PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - May return a result
- procedureNoResult - Does not return a result
- procedureReturnsResult - Returns a result
- Specified by:
getProcedures
in interfaceDatabaseMetaData
- 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 schemaprocedureNamePattern
- a procedure name pattern- Returns:
ResultSet
- each row is a procedure description- Throws:
SQLException
- if a database access error occurs
-
getProcedureColumns
public final ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException Gets a description of a catalog's stored procedure parameters and result columns.Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the
ResultSet
is a parameter description or column description with the following fields:- PROCEDURE_CAT String => procedure catalog (may be null)
- PROCEDURE_SCHEM String => procedure schema (may be null)
- PROCEDURE_NAME String => procedure name
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE short => 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
- 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
Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.
- Specified by:
getProcedureColumns
in interfaceDatabaseMetaData
- 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 schemaprocedureNamePattern
- a procedure name patterncolumnNamePattern
- a column name pattern- Returns:
ResultSet
- each row describes a stored procedure parameter or column- Throws:
SQLException
- if a database access error occurs
-
getTables
public final ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException Gets a description of tables available in a catalog.Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- REMARKS String => explanatory comment on the table
Note: Some databases may not return information for all tables.
- Specified by:
getTables
in interfaceDatabaseMetaData
- 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 patterntypes
- a list of table types to include; null returns all types- Returns:
ResultSet
- each row is a table description- Throws:
SQLException
- if a database access error occurs
-
getSchemas
Gets the schema names available in this database. The results are ordered by schema name.The schema column is:
- TABLE_SCHEM String => schema name
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Returns:
ResultSet
- each row has a single String column that is a schema name- Throws:
SQLException
- if a database access error occurs
-
getCatalogs
Gets the catalog names available in this database. The results are ordered by catalog name.The catalog column is:
- TABLE_CAT String => catalog name
- Specified by:
getCatalogs
in interfaceDatabaseMetaData
- Returns:
ResultSet
- each row has a single String column that is a catalog name- Throws:
SQLException
- if a database access error occurs
-
getTableTypes
Gets 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".
- Specified by:
getTableTypes
in interfaceDatabaseMetaData
- Returns:
ResultSet
- each row has a single String column that is a table type- Throws:
SQLException
- if a database access error occurs
-
getColumns
public final ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Gets 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_SCHEM, TABLE_NAME and ORDINAL_POSITION.
Each column description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE short => 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. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int => the number of fractional digits
- 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
- REMARKS String => comment describing column (may be null)
- COLUMN_DEF String => default value (may be null)
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table (starting at 1)
- IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.
- Specified by:
getColumns
in interfaceDatabaseMetaData
- 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 patterncolumnNamePattern
- a column name pattern- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs
-
getColumnPrivileges
public final ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException Gets a description of the access rights for a table's columns.Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- GRANTOR => grantor of access (may be null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
- Specified by:
getColumnPrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namecolumnNamePattern
- a column name pattern- Returns:
ResultSet
- each row is a column privilege description- Throws:
SQLException
- if a database access error occurs
-
getTablePrivileges
public final ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Gets 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 priviledge 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_SCHEM, TABLE_NAME, and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- GRANTOR => grantor of access (may be null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
- Specified by:
getTablePrivileges
in interfaceDatabaseMetaData
- 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- Returns:
ResultSet
- each row is a table privilege description- Throws:
SQLException
- if a database access error occurs
-
getBestRowIdentifier
public final ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException Gets 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 short => 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
- 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
- Specified by:
getBestRowIdentifier
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namescope
- 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 => actual scope of result
-
getVersionColumns
public final ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException Gets 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 short => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale
- PSEUDO_COLUMN short => is this a 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
- Specified by:
getVersionColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs
-
getPrimaryKeys
public final ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException Gets a description of a table's primary key columns. They are ordered by COLUMN_NAME.Each primary key column description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- KEY_SEQ short => sequence number within primary key
- PK_NAME String => primary key name (may be null)
- Specified by:
getPrimaryKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs
-
getImportedKeys
public final ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.Each primary key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog being imported (may be null)
- PKTABLE_SCHEM String => primary key table schema being imported (may be null)
- PKTABLE_NAME String => primary key table name being imported
- PKCOLUMN_NAME String => primary key column name being imported
- FKTABLE_CAT String => foreign key table catalog (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be null)
- FKTABLE_NAME String => foreign key table name
- FKCOLUMN_NAME String => foreign key column name
- KEY_SEQ short => sequence number within foreign key
- UPDATE_RULE short => What happens to foreign key when
primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to the foreign key when
primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be null)
- PK_NAME String => primary key name (may be null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getImportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs
-
getExportedKeys
public final ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be null)
- PKTABLE_SCHEM String => primary key table schema (may be null)
- PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
- 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
- UPDATE_RULE short => What happens to foreign key when
primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to the foreign key when
primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be null)
- PK_NAME String => primary key name (may be null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getExportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
ResultSet
- each row is a foreign key column description- Throws:
SQLException
- if a database access error occurs
-
getCrossReference
public final ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key). This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.) They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be null)
- PKTABLE_SCHEM String => primary key table schema (may be null)
- PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
- 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
- UPDATE_RULE short => What happens to foreign key when
primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to the foreign key when
primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be null)
- PK_NAME String => primary key name (may be null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getCrossReference
in interfaceDatabaseMetaData
- Parameters:
primaryCatalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaprimarySchema
- a schema name; "" retrieves those without a schemaprimaryTable
- the table name that exports the keyforeignCatalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaforeignSchema
- a schema name; "" retrieves those without a schemaforeignTable
- the table name that imports the key- Returns:
ResultSet
- each row is a foreign key column description- Throws:
SQLException
- if a database access error occurs
-
getTypeInfo
Gets a description of all the standard SQL 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.Each type description has the following columns:
- TYPE_NAME String => Type name
- DATA_TYPE short => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal (may be null)
- LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
- CREATE_PARAMS String => parameters used in creating the type (may be null)
- NULLABLE short => can you use NULL for this type?
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive?
- SEARCHABLE short => can you use "WHERE" based on this
type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned?
- FIXED_PREC_SCALE boolean => can it be a money value?
- AUTO_INCREMENT boolean => can it be used for an auto-increment value?
- LOCAL_TYPE_NAME String => localized version of type name (may be null)
- MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
- Specified by:
getTypeInfo
in interfaceDatabaseMetaData
- Returns:
ResultSet
- each row is an SQL type description- Throws:
SQLException
- if a database access error occurs
-
getIndexInfo
public final ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException Gets a description of a table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.Each index column description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
- INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
- INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
- TYPE short => index type:
- tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
- COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
- ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
- CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
- PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
- FILTER_CONDITION String => Filter condition, if any. (may be null)
- Specified by:
getIndexInfo
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table nameunique
- 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
-
getUDTs
public final ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException Gets a description of the user-defined types defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be null)
- TYPE_SCHEM String => type's schema (may be null)
- TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
Note: If the driver does not support UDTs, an empty result set is returned.
- Specified by:
getUDTs
in interfaceDatabaseMetaData
- 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 type name pattern; may be a fully-qualified nametypes
- a list of user-named types to include (JAVA_OBJECT, STRUCT, or DISTINCT); null returns all types- Returns:
ResultSet
- each row is a type description- Throws:
SQLException
- if a database access error occurs
-
getConnection
Retrieves the connection that produced this metadata object.- Specified by:
getConnection
in interfaceDatabaseMetaData
- Returns:
- the connection that produced this metadata object
- Throws:
SQLException
- If an error occurs
-
close
Close this object and any result sets that it created- Throws:
SQLException
- If an error occurs
-
allProceduresAreCallable
Return true if all the procedures returned by getProcedures can be called by the current user.- Specified by:
allProceduresAreCallable
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
allTablesAreSelectable
Return true if all the tables returned by getTable can be SELECTed by the current user.- Specified by:
allTablesAreSelectable
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedHigh
Return true if NULL values are sorted high.- Specified by:
nullsAreSortedHigh
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedLow
Return true if NULL values are sorted low.- Specified by:
nullsAreSortedLow
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedAtStart
Return true if NULL values are sorted at the start regardless of sort order.- Specified by:
nullsAreSortedAtStart
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedAtEnd
Return true if NULL values are sorted at the end regardless of sort order.- Specified by:
nullsAreSortedAtEnd
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
usesLocalFiles
Return true if the database stores tables in a local file.- Specified by:
usesLocalFiles
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
usesLocalFilePerTable
Return true if the database uses a file for each table.- Specified by:
usesLocalFilePerTable
in interfaceDatabaseMetaData
- Returns:
- true if the database uses a local file for each table
- Throws:
SQLException
- if a database access error occurs
-
supportsMixedCaseIdentifiers
Return true if the database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case. A JDBC Compliant TM driver will always return false.- Specified by:
supportsMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesUpperCaseIdentifiers
Return true if the database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.- Specified by:
storesUpperCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesLowerCaseIdentifiers
Return true if the database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.- Specified by:
storesLowerCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesMixedCaseIdentifiers
Return true if the database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.- Specified by:
storesMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMixedCaseQuotedIdentifiers
Return true if the database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case. A JDBC Compliant TM driver will always return true.- Specified by:
supportsMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesUpperCaseQuotedIdentifiers
Return true if the database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.- Specified by:
storesUpperCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesLowerCaseQuotedIdentifiers
Return true if the database treats mixed case quoted SQL identifiers as case insensitive and store them in lower case.- Specified by:
storesLowerCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesMixedCaseQuotedIdentifiers
Return true if the database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.- Specified by:
storesMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsAlterTableWithAddColumn
Return true if "ALTER TABLE" with add column is supported.- Specified by:
supportsAlterTableWithAddColumn
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsAlterTableWithDropColumn
Return true if "ALTER TABLE" with drop column is supported.- Specified by:
supportsAlterTableWithDropColumn
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsColumnAliasing
Return true if column aliasing is supported.If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. A JDBC CompliantTM driver always returns true.
- Specified by:
supportsColumnAliasing
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullPlusNonNullIsNull
Return true if concatenations between NULL and non-NULL values are NULL. For SQL-92 compliance, a JDBC technology-enabled driver will returntrue
.- Specified by:
nullPlusNonNullIsNull
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsConvert
Return true if the CONVERT function between SQL types supported.- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsConvert
Return true if CONVERT between the given SQL types supported.- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Parameters:
fromType
- the type to convert fromtoType
- the type to convert to- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsTableCorrelationNames
Return true if table correlation names supported. A JDBC CompliantTM driver always returns true.- Specified by:
supportsTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDifferentTableCorrelationNames
If table correlation names are supported, are they restricted to be different from the names of the tables?- Specified by:
supportsDifferentTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsExpressionsInOrderBy
Are expressions in "ORDER BY" lists supported?- Specified by:
supportsExpressionsInOrderBy
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupBy
Is some form of "GROUP BY" clause supported?- Specified by:
supportsGroupBy
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupByBeyondSelect
Return true if a "GROUP BY" clause can add columns not in the SELECT provided it specifies all the columns in the SELECT.- Specified by:
supportsGroupByBeyondSelect
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsLikeEscapeClause
Return true if the escape character in "LIKE" clauses is supported. A JDBC Compliant TM driver always returns true.- Specified by:
supportsLikeEscapeClause
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMultipleResultSets
Are multipleResultSet
from a single execute supported?- Specified by:
supportsMultipleResultSets
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMultipleTransactions
Can we have multiple transactions open at once (on different connections)?- Specified by:
supportsMultipleTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsNonNullableColumns
Return true if columns can be defined as non-nullable. A JDBC CompliantTM driver always returns true.- Specified by:
supportsNonNullableColumns
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMinimumSQLGrammar
Return true if the ODBC Minimum SQL grammar is supported. All JDBC CompliantTM drivers must return true.- Specified by:
supportsMinimumSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCoreSQLGrammar
Is the ODBC Core SQL grammar supported?- Specified by:
supportsCoreSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsExtendedSQLGrammar
Is the ODBC Extended SQL grammar supported?- Specified by:
supportsExtendedSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92EntryLevelSQL
Return true if the ANSI92 entry level SQL grammar is supported. All JDBC Compliant TM drivers must return true.- Specified by:
supportsANSI92EntryLevelSQL
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92IntermediateSQL
Is the ANSI92 intermediate SQL grammar supported?- Specified by:
supportsANSI92IntermediateSQL
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92FullSQL
Is the ANSI92 full SQL grammar supported?- Specified by:
supportsANSI92FullSQL
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsIntegrityEnhancementFacility
Is the SQL Integrity Enhancement Facility supported?- Specified by:
supportsIntegrityEnhancementFacility
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOuterJoins
Is some form of outer join supported?- Specified by:
supportsOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsFullOuterJoins
Are full nested outer joins supported?- Specified by:
supportsFullOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsLimitedOuterJoins
Return true if there is limited support for outer joins. This will be true if supportFullOuterJoins is true.- Specified by:
supportsLimitedOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInDataManipulation
Can a schema name be used in a data manipulation statement?- Specified by:
supportsSchemasInDataManipulation
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInProcedureCalls
Can a schema name be used in a procedure call statement?- Specified by:
supportsSchemasInProcedureCalls
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInTableDefinitions
Can a schema name be used in a table definition statement?- Specified by:
supportsSchemasInTableDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInIndexDefinitions
Can a schema name be used in an index definition statement?- Specified by:
supportsSchemasInIndexDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInPrivilegeDefinitions
Can a schema name be used in a privilege definition statement?- Specified by:
supportsSchemasInPrivilegeDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInDataManipulation
Can a catalog name be used in a data manipulation statement?- Specified by:
supportsCatalogsInDataManipulation
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInProcedureCalls
Can a catalog name be used in a procedure call statement?- Specified by:
supportsCatalogsInProcedureCalls
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInTableDefinitions
Can a catalog name be used in a table definition statement?- Specified by:
supportsCatalogsInTableDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInIndexDefinitions
Can a catalog name be used in an index definition statement?- Specified by:
supportsCatalogsInIndexDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCatalogsInPrivilegeDefinitions
Can a catalog name be used in a privilege definition statement?- Specified by:
supportsCatalogsInPrivilegeDefinitions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsPositionedDelete
Is positioned DELETE supported?- Specified by:
supportsPositionedDelete
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsPositionedUpdate
Is positioned UPDATE supported?- Specified by:
supportsPositionedUpdate
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSelectForUpdate
Is SELECT for UPDATE supported?- Specified by:
supportsSelectForUpdate
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsStoredProcedures
Return true if stored procedure calls using the stored procedure escape syntax are supported.- Specified by:
supportsStoredProcedures
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInComparisons
Return true if subqueries in comparison expressions are supported. A JDBC Compliant TM driver always returns true.- Specified by:
supportsSubqueriesInComparisons
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInExists
Return true if subqueries in 'exists' expressions are supported. A JDBC Compliant TM driver always returns true.- Specified by:
supportsSubqueriesInExists
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInIns
Return true if subqueries in 'in' statements are supported. A JDBC CompliantTM driver always returns true.- Specified by:
supportsSubqueriesInIns
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInQuantifieds
Return true if subqueries in quantified expressions are supported. A JDBC Compliant TM driver always returns true.- Specified by:
supportsSubqueriesInQuantifieds
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsUnion
Return true if SQL UNION is supported.- Specified by:
supportsUnion
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsUnionAll
Return true if SQL UNION ALL is supported.- Specified by:
supportsUnionAll
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOpenCursorsAcrossCommit
Return true if cursors can remain open across commits.- Specified by:
supportsOpenCursorsAcrossCommit
in interfaceDatabaseMetaData
- Returns:
true
if cursors always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
supportsOpenCursorsAcrossRollback
Return true if cursors can remain open across rollbacks.- Specified by:
supportsOpenCursorsAcrossRollback
in interfaceDatabaseMetaData
- Returns:
true
if cursors always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
supportsOpenStatementsAcrossCommit
Return true if statements can remain open across commits.- Specified by:
supportsOpenStatementsAcrossCommit
in interfaceDatabaseMetaData
- Returns:
true
if statements always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
supportsOpenStatementsAcrossRollback
Return true if statements can remain open across rollbacks.- Specified by:
supportsOpenStatementsAcrossRollback
in interfaceDatabaseMetaData
- Returns:
true
if statements always remain open;false
if they might not remain open- Throws:
SQLException
- if a database access error occurs
-
doesMaxRowSizeIncludeBlobs
Return true if getMaxRowSize() included LONGVARCHAR and LONGVARBINARY blobs.- Specified by:
doesMaxRowSizeIncludeBlobs
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsTransactions
Return true if transactions are supported. If not, invoking the methodcommit
is a noop and the isolation level is TRANSACTION_NONE.- Specified by:
supportsTransactions
in interfaceDatabaseMetaData
- Returns:
true
if transactions are supported;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsTransactionIsolationLevel
Does this database support the given transaction isolation level?- Specified by:
supportsTransactionIsolationLevel
in interfaceDatabaseMetaData
- Parameters:
level
- the values are defined injava.sql.Connection
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDataDefinitionAndDataManipulationTransactions
Are both data definition and data manipulation statements within a transaction supported?- Specified by:
supportsDataDefinitionAndDataManipulationTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDataManipulationTransactionsOnly
Are only data manipulation statements within a transaction supported?- Specified by:
supportsDataManipulationTransactionsOnly
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
dataDefinitionCausesTransactionCommit
Does a data definition statement within a transaction force the transaction to commit?- Specified by:
dataDefinitionCausesTransactionCommit
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
dataDefinitionIgnoredInTransactions
Is a data definition statement within a transaction ignored?- Specified by:
dataDefinitionIgnoredInTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsResultSetType
Does the database support the given result set type?- Specified by:
supportsResultSetType
in interfaceDatabaseMetaData
- Parameters:
type
- defined injava.sql.ResultSet
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsResultSetConcurrency
Does the database support the concurrency type in combination with the given result set type?- Specified by:
supportsResultSetConcurrency
in interfaceDatabaseMetaData
- 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
-
ownUpdatesAreVisible
Indicates whether a result set's own updates are visible.- Specified by:
ownUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if updates are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
ownDeletesAreVisible
Indicates whether a result set's own deletes are visible.- Specified by:
ownDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if deletes are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
ownInsertsAreVisible
Indicates whether a result set's own inserts are visible.- Specified by:
ownInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if inserts are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
othersUpdatesAreVisible
Indicates whether updates made by others are visible.- Specified by:
othersUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if updates made by others are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
othersDeletesAreVisible
Indicates whether deletes made by others are visible.- Specified by:
othersDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if deletes made by others are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
othersInsertsAreVisible
Indicates whether inserts made by others are visible.- Specified by:
othersInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if inserts made by others are visible for the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
updatesAreDetected
Indicates whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.- Specified by:
updatesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
true
if changes are detected by the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
deletesAreDetected
Indicates whether or not a visible row delete can be detected by calling ResultSet.rowDeleted(). If deletesAreDetected() returns false, then deleted rows are removed from the result set.- Specified by:
deletesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if changes are detected by the resultset type
- Throws:
SQLException
- if a database access error occurs
-
insertsAreDetected
Indicates whether or not a visible row insert can be detected by calling ResultSet.rowInserted().- Specified by:
insertsAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if changes are detected by the resultset type
- Throws:
SQLException
- if a database access error occurs
-
supportsBatchUpdates
Indicates whether the driver supports batch updates.- Specified by:
supportsBatchUpdates
in interfaceDatabaseMetaData
- Returns:
- true if the driver supports batch updates; false otherwise
- Throws:
SQLException
- If an error occurs
-
checkIsOpen
- Throws:
SQLException
-
wrap
Wrap the specified result set- Parameters:
resultSet
- The result set to wrap- Returns:
- The wrapped result set
-
supportsSavepoints
Retrieves whether this database supports savepoints.- Specified by:
supportsSavepoints
in interfaceDatabaseMetaData
- 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.- Specified by:
supportsNamedParameters
in interfaceDatabaseMetaData
- 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.- Specified by:
supportsMultipleOpenResults
in interfaceDatabaseMetaData
- Returns:
true
if aCallableStatement
object can return multipleResultSet
objects simultaneously;false
otherwise- Throws:
SQLException
- if a datanase access error occurs- Since:
- 1.4
-
supportsGetGeneratedKeys
Retrieves whether auto-generated keys can be retrieved after a statement has been executed.- Specified by:
supportsGetGeneratedKeys
in interfaceDatabaseMetaData
- Returns:
true
if auto-generated keys can be retrieved after a statement has executed;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getSuperTypes
public 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 be
null
) - TYPE_SCHEM String => UDT's schema (may be
null
) - TYPE_NAME String => type name of the UDT
- SUPERTYPE_CAT String => the direct super type's catalog
(may be
null
) - SUPERTYPE_SCHEM String => the direct super type's schema
(may be
null
) - SUPERTYPE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
- Specified by:
getSuperTypes
in interfaceDatabaseMetaData
- 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
- TYPE_CAT String => the UDT's catalog (may be
-
getSuperTables
public 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 be
null
) - TABLE_SCHEM String => type's schema (may be
null
) - TABLE_NAME String => type name
- SUPERTABLE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.
- Specified by:
getSuperTables
in interfaceDatabaseMetaData
- 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
- TABLE_CAT String => the type's catalog (may be
-
getAttributes
public 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_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description does not contain inherited attributes.
The
ResultSet
object that is returned has the following columns:- TYPE_CAT String => type catalog (may be
null
) - TYPE_SCHEM String => type schema (may be
null
) - TYPE_NAME String => type name
- ATTR_NAME String => attribute name
- DATA_TYPE int => attribute type SQL type from java.sql.Types
- ATTR_TYPE_NAME String => Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type.
- ATTR_SIZE int => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision.
- DECIMAL_DIGITS int => the number of fractional digits
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => whether NULL is allowed
- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null
) - ATTR_DEF String => default value (may be
null
) - SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table (starting at 1)
- IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means 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)
- Specified by:
getAttributes
in interfaceDatabaseMetaData
- 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
- TYPE_CAT String => type catalog (may be
-
supportsResultSetHoldability
Retrieves whether this database supports the given result set holdability.- Specified by:
supportsResultSetHoldability
in interfaceDatabaseMetaData
- 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 the default holdability of thisResultSet
object.- Specified by:
getResultSetHoldability
in interfaceDatabaseMetaData
- 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.- Specified by:
getDatabaseMajorVersion
in interfaceDatabaseMetaData
- 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.- Specified by:
getDatabaseMinorVersion
in interfaceDatabaseMetaData
- 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.- Specified by:
getJDBCMajorVersion
in interfaceDatabaseMetaData
- 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.- Specified by:
getJDBCMinorVersion
in interfaceDatabaseMetaData
- 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 SQL99.- Specified by:
getSQLStateType
in interfaceDatabaseMetaData
- Returns:
- the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL99
- 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.- Specified by:
locatorsUpdateCopy
in interfaceDatabaseMetaData
- 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.- Specified by:
supportsStatementPooling
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
generatedKeyAlwaysReturned
- Specified by:
generatedKeyAlwaysReturned
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getPseudoColumns
public ResultSet getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException - Specified by:
getPseudoColumns
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getFunctionColumns
public ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException - Specified by:
getFunctionColumns
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getFunctions
public ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException - Specified by:
getFunctions
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getClientInfoProperties
- Specified by:
getClientInfoProperties
in interfaceDatabaseMetaData
- Throws:
SQLException
-
autoCommitFailureClosesAllResultSets
- Specified by:
autoCommitFailureClosesAllResultSets
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsStoredFunctionsUsingCallSyntax
- Specified by:
supportsStoredFunctionsUsingCallSyntax
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getSchemas
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getRowIdLifetime
- Specified by:
getRowIdLifetime
in interfaceDatabaseMetaData
- Throws:
SQLException
-
isWrapperFor
- Specified by:
isWrapperFor
in interfaceWrapper
- Throws:
SQLException
-
unwrap
- Specified by:
unwrap
in interfaceWrapper
- Throws:
SQLException
-