Class DatabaseMetaDataWrapper
- java.lang.Object
-
- com.sun.gjc.spi.base.DatabaseMetaDataWrapper
-
- All Implemented Interfaces:
DatabaseMetaData
,Wrapper
- Direct Known Subclasses:
DatabaseMetaDataWrapper40
public abstract class DatabaseMetaDataWrapper extends Object implements DatabaseMetaData
Abstract class for wrapping DatabaseMetaData
-
-
Field Summary
Fields Modifier and Type Field Description protected static Logger
_logger
protected Connection
connection
protected DatabaseMetaData
databaseMetaData
-
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 Constructor Description DatabaseMetaDataWrapper(Connection con, DatabaseMetaData metaData)
Abstract class for wrapping DatabaseMetaData
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allProceduresAreCallable()
Retrieves whether the current user can call all the procedures returned by the methodgetProcedures
.boolean
allTablesAreSelectable()
Retrieves whether the current user can use all the tables returned by the methodgetTables
in aSELECT
statement.boolean
dataDefinitionCausesTransactionCommit()
Retrieves whether a data definition statement within a transaction forces the transaction to commit.boolean
dataDefinitionIgnoredInTransactions()
Retrieves whether this database ignores a data definition statement within a transaction.boolean
deletesAreDetected(int type)
Retrieves whether or not a visible row delete can be detected by calling the methodResultSet.rowDeleted
.boolean
doesMaxRowSizeIncludeBlobs()
Retrieves whether the return value for the methodgetMaxRowSize
includes the SQL data typesLONGVARCHAR
andLONGVARBINARY
.Connection
getActualConnection()
Returns the actual connection that produced this metadata objectResultSet
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.ResultSet
getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
Retrieves a description of a table's optimal set of columns that uniquely identifies a row.ResultSet
getCatalogs()
Retrieves the catalog names available in this database.String
getCatalogSeparator()
Retrieves theString
that this database uses as the separator between a catalog and table name.String
getCatalogTerm()
Retrieves the database vendor's preferred term for "catalog".ResultSet
getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
Retrieves a description of the access rights for a table's columns.ResultSet
getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
Retrieves a description of table columns available in the specified catalog.Connection
getConnection()
Retrieves the connection that produced this metadata object.ResultSet
getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key columns of the given primary key table (describe how one table imports another's key).int
getDatabaseMajorVersion()
Retrieves the major version number of the underlying database.int
getDatabaseMinorVersion()
Retrieves the minor version number of the underlying database.String
getDatabaseProductName()
Retrieves the name of this database product.String
getDatabaseProductVersion()
Retrieves the version number of this database product.int
getDefaultTransactionIsolation()
Retrieves this database's default transaction isolation level.int
getDriverMajorVersion()
Retrieves this JDBC driver's major version number.int
getDriverMinorVersion()
Retrieves this JDBC driver's minor version number.String
getDriverName()
Retrieves the name of this JDBC driver.String
getDriverVersion()
Retrieves the version number of this JDBC driver as aString
.ResultSet
getExportedKeys(String catalog, String schema, String table)
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).String
getExtraNameCharacters()
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).String
getIdentifierQuoteString()
Retrieves the string used to quote SQL identifiers.ResultSet
getImportedKeys(String catalog, String schema, String table)
Retrieves a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).ResultSet
getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
Retrieves a description of the given table's indices and statistics.int
getJDBCMajorVersion()
Retrieves the major JDBC version number for this driver.int
getJDBCMinorVersion()
Retrieves the minor JDBC version number for this driver.int
getMaxBinaryLiteralLength()
Retrieves the maximum number of hex characters this database allows in an inline binary literal.int
getMaxCatalogNameLength()
Retrieves the maximum number of characters that this database allows in a catalog name.int
getMaxCharLiteralLength()
Retrieves the maximum number of characters this database allows for a character literal.int
getMaxColumnNameLength()
Retrieves the maximum number of characters this database allows for a column name.int
getMaxColumnsInGroupBy()
Retrieves the maximum number of columns this database allows in aGROUP BY
clause.int
getMaxColumnsInIndex()
Retrieves the maximum number of columns this database allows in an index.int
getMaxColumnsInOrderBy()
Retrieves the maximum number of columns this database allows in anORDER BY
clause.int
getMaxColumnsInSelect()
Retrieves the maximum number of columns this database allows in aSELECT
list.int
getMaxColumnsInTable()
Retrieves the maximum number of columns this database allows in a table.int
getMaxConnections()
Retrieves the maximum number of concurrent connections to this database that are possible.int
getMaxCursorNameLength()
Retrieves the maximum number of characters that this database allows in a cursor name.int
getMaxIndexLength()
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.int
getMaxProcedureNameLength()
Retrieves the maximum number of characters that this database allows in a procedure name.int
getMaxRowSize()
Retrieves the maximum number of bytes this database allows in a single row.int
getMaxSchemaNameLength()
Retrieves the maximum number of characters that this database allows in a schema name.int
getMaxStatementLength()
Retrieves the maximum number of characters this database allows in an SQL statement.int
getMaxStatements()
Retrieves the maximum number of active statements to this database that can be open at the same time.int
getMaxTableNameLength()
Retrieves the maximum number of characters this database allows in a table name.int
getMaxTablesInSelect()
Retrieves the maximum number of tables this database allows in aSELECT
statement.int
getMaxUserNameLength()
Retrieves the maximum number of characters this database allows in a user name.protected MethodExecutor
getMethodExecutor()
String
getNumericFunctions()
Retrieves a comma-separated list of math functions available with this database.ResultSet
getPrimaryKeys(String catalog, String schema, String table)
Retrieves a description of the given table's primary key columns.ResultSet
getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter and result columns.ResultSet
getProcedures(String catalog, String schemaPattern, String procedureNamePattern)
Retrieves a description of the stored procedures available in the given catalog.String
getProcedureTerm()
Retrieves the database vendor's preferred term for "procedure".int
getResultSetHoldability()
Retrieves the default holdability of thisResultSet
object.ResultSet
getSchemas()
Retrieves the schema names available in this database.String
getSchemaTerm()
Retrieves the database vendor's preferred term for "schema".String
getSearchStringEscape()
Retrieves the string that can be used to escape wildcard characters.String
getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL92 keywords.int
getSQLStateType()
Indicates whether the SQLSTATE returned bySQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL99.String
getStringFunctions()
Retrieves a comma-separated list of string functions available with this database.ResultSet
getSuperTables(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular schema in this database.ResultSet
getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.String
getSystemFunctions()
Retrieves a comma-separated list of system functions available with this database.ResultSet
getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the access rights for each table available in a catalog.ResultSet
getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)
Retrieves a description of the tables available in the given catalog.ResultSet
getTableTypes()
Retrieves the table types available in this database.String
getTimeDateFunctions()
Retrieves a comma-separated list of the time and date functions available with this database.ResultSet
getTypeInfo()
Retrieves a description of all the standard SQL types supported by this database.ResultSet
getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)
Retrieves a description of the user-defined types (UDTs) defined in a particular schema.String
getURL()
Retrieves the URL for this DBMS.String
getUserName()
Retrieves the user name as known to this database.ResultSet
getVersionColumns(String catalog, String schema, String table)
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated.boolean
insertsAreDetected(int type)
Retrieves whether or not a visible row insert can be detected by calling the methodResultSet.rowInserted
.boolean
isCatalogAtStart()
Retrieves whether a catalog appears at the start of a fully qualified table name.boolean
isReadOnly()
Retrieves whether this database is in read-only mode.boolean
locatorsUpdateCopy()
Indicates whether updates made to a LOB are made on a copy or directly to the LOB.boolean
nullPlusNonNullIsNull()
Retrieves whether this database supports concatenations betweenNULL
and non-NULL
values beingNULL
.boolean
nullsAreSortedAtEnd()
Retrieves whetherNULL
values are sorted at the end regardless of sort order.boolean
nullsAreSortedAtStart()
Retrieves whetherNULL
values are sorted at the start regardless of sort order.boolean
nullsAreSortedHigh()
Retrieves whetherNULL
values are sorted high.boolean
nullsAreSortedLow()
Retrieves whetherNULL
values are sorted low.boolean
othersDeletesAreVisible(int type)
Retrieves whether deletes made by others are visible.boolean
othersInsertsAreVisible(int type)
Retrieves whether inserts made by others are visible.boolean
othersUpdatesAreVisible(int type)
Retrieves whether updates made by others are visible.boolean
ownDeletesAreVisible(int type)
Retrieves whether a result set's own deletes are visible.boolean
ownInsertsAreVisible(int type)
Retrieves whether a result set's own inserts are visible.boolean
ownUpdatesAreVisible(int type)
Retrieves whether for the given type ofResultSet
object, the result set's own updates are visible.boolean
storesLowerCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.boolean
storesLowerCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.boolean
storesMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.boolean
storesMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.boolean
storesUpperCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.boolean
storesUpperCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.boolean
supportsAlterTableWithAddColumn()
Retrieves whether this database supportsALTER TABLE
with add column.boolean
supportsAlterTableWithDropColumn()
Retrieves whether this database supportsALTER TABLE
with drop column.boolean
supportsANSI92EntryLevelSQL()
Retrieves whether this database supports the ANSI92 entry level SQL grammar.boolean
supportsANSI92FullSQL()
Retrieves whether this database supports the ANSI92 full SQL grammar supported.boolean
supportsANSI92IntermediateSQL()
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.boolean
supportsBatchUpdates()
Retrieves whether this database supports batch updates.boolean
supportsCatalogsInDataManipulation()
Retrieves whether a catalog name can be used in a data manipulation statement.boolean
supportsCatalogsInIndexDefinitions()
Retrieves whether a catalog name can be used in an index definition statement.boolean
supportsCatalogsInPrivilegeDefinitions()
Retrieves whether a catalog name can be used in a privilege definition statement.boolean
supportsCatalogsInProcedureCalls()
Retrieves whether a catalog name can be used in a procedure call statement.boolean
supportsCatalogsInTableDefinitions()
Retrieves whether a catalog name can be used in a table definition statement.boolean
supportsColumnAliasing()
Retrieves whether this database supports column aliasing.boolean
supportsConvert()
Retrieves whether this database supports theCONVERT
function between SQL types.boolean
supportsConvert(int fromType, int toType)
Retrieves whether this database supports theCONVERT
for two given SQL types.boolean
supportsCoreSQLGrammar()
Retrieves whether this database supports the ODBC Core SQL grammar.boolean
supportsCorrelatedSubqueries()
Retrieves whether this database supports correlated subqueries.boolean
supportsDataDefinitionAndDataManipulationTransactions()
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.boolean
supportsDataManipulationTransactionsOnly()
Retrieves whether this database supports only data manipulation statements within a transaction.boolean
supportsDifferentTableCorrelationNames()
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.boolean
supportsExpressionsInOrderBy()
Retrieves whether this database supports expressions inORDER BY
lists.boolean
supportsExtendedSQLGrammar()
Retrieves whether this database supports the ODBC Extended SQL grammar.boolean
supportsFullOuterJoins()
Retrieves whether this database supports full nested outer joins.boolean
supportsGetGeneratedKeys()
Retrieves whether auto-generated keys can be retrieved after a statement has been executed.boolean
supportsGroupBy()
Retrieves whether this database supports some form ofGROUP BY
clause.boolean
supportsGroupByBeyondSelect()
Retrieves whether this database supports using columns not included in theSELECT
statement in aGROUP BY
clause provided that all of the columns in theSELECT
statement are included in theGROUP BY
clause.boolean
supportsGroupByUnrelated()
Retrieves whether this database supports using a column that is not in theSELECT
statement in aGROUP BY
clause.boolean
supportsIntegrityEnhancementFacility()
Retrieves whether this database supports the SQL Integrity Enhancement Facility.boolean
supportsLikeEscapeClause()
Retrieves whether this database supports specifying aLIKE
escape clause.boolean
supportsLimitedOuterJoins()
Retrieves whether this database provides limited support for outer joins.boolean
supportsMinimumSQLGrammar()
Retrieves whether this database supports the ODBC Minimum SQL grammar.boolean
supportsMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.boolean
supportsMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.boolean
supportsMultipleOpenResults()
Retrieves whether it is possible to have multipleResultSet
objects returned from aCallableStatement
object simultaneously.boolean
supportsMultipleResultSets()
Retrieves whether this database supports getting multipleResultSet
objects from a single call to the methodexecute
.boolean
supportsMultipleTransactions()
Retrieves whether this database allows having multiple transactions open at once (on different connections).boolean
supportsNamedParameters()
Retrieves whether this database supports named parameters to callable statements.boolean
supportsNonNullableColumns()
Retrieves whether columns in this database may be defined as non-nullable.boolean
supportsOpenCursorsAcrossCommit()
Retrieves whether this database supports keeping cursors open across commits.boolean
supportsOpenCursorsAcrossRollback()
Retrieves whether this database supports keeping cursors open across rollbacks.boolean
supportsOpenStatementsAcrossCommit()
Retrieves whether this database supports keeping statements open across commits.boolean
supportsOpenStatementsAcrossRollback()
Retrieves whether this database supports keeping statements open across rollbacks.boolean
supportsOrderByUnrelated()
Retrieves whether this database supports using a column that is not in theSELECT
statement in anORDER BY
clause.boolean
supportsOuterJoins()
Retrieves whether this database supports some form of outer join.boolean
supportsPositionedDelete()
Retrieves whether this database supports positionedDELETE
statements.boolean
supportsPositionedUpdate()
Retrieves whether this database supports positionedUPDATE
statements.boolean
supportsResultSetConcurrency(int type, int concurrency)
Retrieves whether this database supports the given concurrency type in combination with the given result set type.boolean
supportsResultSetHoldability(int holdability)
Retrieves whether this database supports the given result set holdability.boolean
supportsResultSetType(int type)
Retrieves whether this database supports the given result set type.boolean
supportsSavepoints()
Retrieves whether this database supports savepoints.boolean
supportsSchemasInDataManipulation()
Retrieves whether a schema name can be used in a data manipulation statement.boolean
supportsSchemasInIndexDefinitions()
Retrieves whether a schema name can be used in an index definition statement.boolean
supportsSchemasInPrivilegeDefinitions()
Retrieves whether a schema name can be used in a privilege definition statement.boolean
supportsSchemasInProcedureCalls()
Retrieves whether a schema name can be used in a procedure call statement.boolean
supportsSchemasInTableDefinitions()
Retrieves whether a schema name can be used in a table definition statement.boolean
supportsSelectForUpdate()
Retrieves whether this database supportsSELECT FOR UPDATE
statements.boolean
supportsStatementPooling()
Retrieves whether this database supports statement pooling.boolean
supportsStoredProcedures()
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.boolean
supportsSubqueriesInComparisons()
Retrieves whether this database supports subqueries in comparison expressions.boolean
supportsSubqueriesInExists()
Retrieves whether this database supports subqueries inEXISTS
expressions.boolean
supportsSubqueriesInIns()
Retrieves whether this database supports subqueries inIN
statements.boolean
supportsSubqueriesInQuantifieds()
Retrieves whether this database supports subqueries in quantified expressions.boolean
supportsTableCorrelationNames()
Retrieves whether this database supports table correlation names.boolean
supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction isolation level.boolean
supportsTransactions()
Retrieves whether this database supports transactions.boolean
supportsUnion()
Retrieves whether this database supports SQLUNION
.boolean
supportsUnionAll()
Retrieves whether this database supports SQLUNION ALL
.boolean
updatesAreDetected(int type)
Retrieves whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.boolean
usesLocalFilePerTable()
Retrieves whether this database uses a file for each table.boolean
usesLocalFiles()
Retrieves whether this database stores tables in a local file.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.sql.DatabaseMetaData
autoCommitFailureClosesAllResultSets, generatedKeyAlwaysReturned, getClientInfoProperties, getFunctionColumns, getFunctions, getMaxLogicalLobSize, getPseudoColumns, getRowIdLifetime, getSchemas, supportsRefCursors, supportsSharding, supportsStoredFunctionsUsingCallSyntax
-
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
-
-
-
Field Detail
-
databaseMetaData
protected DatabaseMetaData databaseMetaData
-
connection
protected Connection connection
-
_logger
protected static final Logger _logger
-
-
Constructor Detail
-
DatabaseMetaDataWrapper
public DatabaseMetaDataWrapper(Connection con, DatabaseMetaData metaData)
Abstract class for wrapping DatabaseMetaData- Parameters:
con
- Connection that is wrapped.metaData
- DatabaseMetaData that is wrapped
-
-
Method Detail
-
allProceduresAreCallable
public boolean allProceduresAreCallable() throws SQLException
Retrieves whether the current user can call all the procedures returned by the methodgetProcedures
.- Specified by:
allProceduresAreCallable
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
allTablesAreSelectable
public boolean allTablesAreSelectable() throws SQLException
Retrieves whether the current user can use all the tables returned by the methodgetTables
in aSELECT
statement.- Specified by:
allTablesAreSelectable
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getURL
public String getURL() throws SQLException
Retrieves the URL for this DBMS.- Specified by:
getURL
in interfaceDatabaseMetaData
- Returns:
- the URL for this DBMS or
null
if it cannot be generated - Throws:
SQLException
- if a database access error occurs
-
getUserName
public String getUserName() throws SQLException
Retrieves the user name as known to this database.- Specified by:
getUserName
in interfaceDatabaseMetaData
- Returns:
- the database user name
- Throws:
SQLException
- if a database access error occurs
-
isReadOnly
public boolean isReadOnly() throws SQLException
Retrieves whether this database is in read-only mode.- Specified by:
isReadOnly
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedHigh
public boolean nullsAreSortedHigh() throws SQLException
Retrieves whetherNULL
values are sorted high. Sorted high means thatNULL
values sort higher than any other value in a domain. In an ascending order, if this method returnstrue
,NULL
values will appear at the end. By contrast, the methodnullsAreSortedAtEnd
indicates whetherNULL
values are sorted at the end regardless of sort order.- Specified by:
nullsAreSortedHigh
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedLow
public boolean nullsAreSortedLow() throws SQLException
Retrieves whetherNULL
values are sorted low. Sorted low means thatNULL
values sort lower than any other value in a domain. In an ascending order, if this method returnstrue
,NULL
values will appear at the beginning. By contrast, the methodnullsAreSortedAtStart
indicates whetherNULL
values are sorted at the beginning regardless of sort order.- Specified by:
nullsAreSortedLow
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullsAreSortedAtStart
public boolean nullsAreSortedAtStart() throws SQLException
Retrieves whetherNULL
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
public boolean nullsAreSortedAtEnd() throws SQLException
Retrieves whetherNULL
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
-
getDatabaseProductName
public String getDatabaseProductName() throws SQLException
Retrieves the name of this database product.- Specified by:
getDatabaseProductName
in interfaceDatabaseMetaData
- Returns:
- database product name
- Throws:
SQLException
- if a database access error occurs
-
getDatabaseProductVersion
public String getDatabaseProductVersion() throws SQLException
Retrieves the version number of this database product.- Specified by:
getDatabaseProductVersion
in interfaceDatabaseMetaData
- Returns:
- database version number
- Throws:
SQLException
- if a database access error occurs
-
getDriverName
public String getDriverName() throws SQLException
Retrieves the name of this JDBC driver.- Specified by:
getDriverName
in interfaceDatabaseMetaData
- Returns:
- JDBC driver name
- Throws:
SQLException
- if a database access error occurs
-
getDriverVersion
public String getDriverVersion() throws SQLException
Retrieves the version number of this JDBC driver as aString
.- Specified by:
getDriverVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver version
- Throws:
SQLException
- if a database access error occurs
-
getDriverMajorVersion
public int getDriverMajorVersion()
Retrieves this JDBC driver's major version number.- Specified by:
getDriverMajorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver major version
-
getDriverMinorVersion
public int getDriverMinorVersion()
Retrieves this JDBC driver's minor version number.- Specified by:
getDriverMinorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver minor version number
-
usesLocalFiles
public boolean usesLocalFiles() throws SQLException
Retrieves whether this 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
public boolean usesLocalFilePerTable() throws SQLException
Retrieves whether this database uses a file for each table.- Specified by:
usesLocalFilePerTable
in interfaceDatabaseMetaData
- Returns:
true
if this database uses a local file for each table;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMixedCaseIdentifiers
public boolean supportsMixedCaseIdentifiers() throws SQLException
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.- Specified by:
supportsMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesUpperCaseIdentifiers
public boolean storesUpperCaseIdentifiers() throws SQLException
Retrieves whether this 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
public boolean storesLowerCaseIdentifiers() throws SQLException
Retrieves whether this 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
public boolean storesMixedCaseIdentifiers() throws SQLException
Retrieves whether this 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
public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.- Specified by:
supportsMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesUpperCaseQuotedIdentifiers
public boolean storesUpperCaseQuotedIdentifiers() throws SQLException
Retrieves whether this 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
public boolean storesLowerCaseQuotedIdentifiers() throws SQLException
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.- Specified by:
storesLowerCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
storesMixedCaseQuotedIdentifiers
public boolean storesMixedCaseQuotedIdentifiers() throws SQLException
Retrieves whether this 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
-
getIdentifierQuoteString
public String getIdentifierQuoteString() throws SQLException
Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.- Specified by:
getIdentifierQuoteString
in interfaceDatabaseMetaData
- Returns:
- the quoting string or a space if quoting is not supported
- Throws:
SQLException
- if a database access error occurs
-
getSQLKeywords
public String getSQLKeywords() throws SQLException
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL92 keywords.- Specified by:
getSQLKeywords
in interfaceDatabaseMetaData
- Returns:
- the list of this database's keywords that are not also SQL92 keywords
- Throws:
SQLException
- if a database access error occurs
-
getNumericFunctions
public String getNumericFunctions() throws SQLException
Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.- Specified by:
getNumericFunctions
in interfaceDatabaseMetaData
- Returns:
- the list of math functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getStringFunctions
public String getStringFunctions() throws SQLException
Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.- Specified by:
getStringFunctions
in interfaceDatabaseMetaData
- Returns:
- the list of string functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getSystemFunctions
public String getSystemFunctions() throws SQLException
Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.- Specified by:
getSystemFunctions
in interfaceDatabaseMetaData
- Returns:
- a list of system functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getTimeDateFunctions
public String getTimeDateFunctions() throws SQLException
Retrieves a comma-separated list of the time and date functions available with this database.- Specified by:
getTimeDateFunctions
in interfaceDatabaseMetaData
- Returns:
- the list of time and date functions supported by this database
- Throws:
SQLException
- if a database access error occurs
-
getSearchStringEscape
public String getSearchStringEscape() throws SQLException
Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
- Specified by:
getSearchStringEscape
in interfaceDatabaseMetaData
- Returns:
- the string used to escape wildcard characters
- Throws:
SQLException
- if a database access error occurs
-
getExtraNameCharacters
public String getExtraNameCharacters() throws SQLException
Retrieves 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
-
supportsAlterTableWithAddColumn
public boolean supportsAlterTableWithAddColumn() throws SQLException
Retrieves whether this database supportsALTER TABLE
with add column.- Specified by:
supportsAlterTableWithAddColumn
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsAlterTableWithDropColumn
public boolean supportsAlterTableWithDropColumn() throws SQLException
Retrieves whether this database supportsALTER TABLE
with drop column.- Specified by:
supportsAlterTableWithDropColumn
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsColumnAliasing
public boolean supportsColumnAliasing() throws SQLException
Retrieves whether this database supports column aliasing.If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
- Specified by:
supportsColumnAliasing
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nullPlusNonNullIsNull
public boolean nullPlusNonNullIsNull() throws SQLException
Retrieves whether this database supports concatenations betweenNULL
and non-NULL
values beingNULL
.- Specified by:
nullPlusNonNullIsNull
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsConvert
public boolean supportsConvert() throws SQLException
Retrieves whether this database supports theCONVERT
function between SQL types.- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsConvert
public boolean supportsConvert(int fromType, int toType) throws SQLException
Retrieves whether this database supports theCONVERT
for two given SQL types.- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Parameters:
fromType
- the type to convert from; one of the type codes from the classjava.sql.Types
toType
- the type to convert to; one of the type codes from the classjava.sql.Types
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- See Also:
Types
-
supportsTableCorrelationNames
public boolean supportsTableCorrelationNames() throws SQLException
Retrieves whether this database supports table correlation names.- Specified by:
supportsTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDifferentTableCorrelationNames
public boolean supportsDifferentTableCorrelationNames() throws SQLException
Retrieves whether, when table correlation names are supported, they are restricted to being 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
public boolean supportsExpressionsInOrderBy() throws SQLException
Retrieves whether this database supports expressions inORDER BY
lists.- Specified by:
supportsExpressionsInOrderBy
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOrderByUnrelated
public boolean supportsOrderByUnrelated() throws SQLException
Retrieves whether this database supports using a column that is not in theSELECT
statement in anORDER BY
clause.- Specified by:
supportsOrderByUnrelated
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupBy
public boolean supportsGroupBy() throws SQLException
Retrieves whether this database supports some form ofGROUP BY
clause.- Specified by:
supportsGroupBy
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupByUnrelated
public boolean supportsGroupByUnrelated() throws SQLException
Retrieves whether this database supports using a column that is not in theSELECT
statement in aGROUP BY
clause.- Specified by:
supportsGroupByUnrelated
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsGroupByBeyondSelect
public boolean supportsGroupByBeyondSelect() throws SQLException
Retrieves whether this database supports using columns not included in theSELECT
statement in aGROUP BY
clause provided that all of the columns in theSELECT
statement are included in theGROUP BY
clause.- Specified by:
supportsGroupByBeyondSelect
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsLikeEscapeClause
public boolean supportsLikeEscapeClause() throws SQLException
Retrieves whether this database supports specifying aLIKE
escape clause.- Specified by:
supportsLikeEscapeClause
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMultipleResultSets
public boolean supportsMultipleResultSets() throws SQLException
Retrieves whether this database supports getting multipleResultSet
objects from a single call to the methodexecute
.- Specified by:
supportsMultipleResultSets
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMultipleTransactions
public boolean supportsMultipleTransactions() throws SQLException
Retrieves whether this database allows having 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
public boolean supportsNonNullableColumns() throws SQLException
Retrieves whether columns in this database may be defined as non-nullable.- Specified by:
supportsNonNullableColumns
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsMinimumSQLGrammar
public boolean supportsMinimumSQLGrammar() throws SQLException
Retrieves whether this database supports the ODBC Minimum SQL grammar.- Specified by:
supportsMinimumSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCoreSQLGrammar
public boolean supportsCoreSQLGrammar() throws SQLException
Retrieves whether this database supports the ODBC Core SQL grammar.- Specified by:
supportsCoreSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsExtendedSQLGrammar
public boolean supportsExtendedSQLGrammar() throws SQLException
Retrieves whether this database supports the ODBC Extended SQL grammar.- Specified by:
supportsExtendedSQLGrammar
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92EntryLevelSQL
public boolean supportsANSI92EntryLevelSQL() throws SQLException
Retrieves whether this database supports the ANSI92 entry level SQL grammar.- Specified by:
supportsANSI92EntryLevelSQL
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsANSI92IntermediateSQL
public boolean supportsANSI92IntermediateSQL() throws SQLException
Retrieves whether this database supports 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
public boolean supportsANSI92FullSQL() throws SQLException
Retrieves whether this database supports 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
public boolean supportsIntegrityEnhancementFacility() throws SQLException
Retrieves whether this database supports the SQL Integrity Enhancement Facility.- Specified by:
supportsIntegrityEnhancementFacility
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOuterJoins
public boolean supportsOuterJoins() throws SQLException
Retrieves whether this database supports some form of outer join.- Specified by:
supportsOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsFullOuterJoins
public boolean supportsFullOuterJoins() throws SQLException
Retrieves whether this database supports full nested outer joins.- Specified by:
supportsFullOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsLimitedOuterJoins
public boolean supportsLimitedOuterJoins() throws SQLException
Retrieves whether this database provides limited support for outer joins. (This will betrue
if the methodsupportsFullOuterJoins
returnstrue
).- Specified by:
supportsLimitedOuterJoins
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getSchemaTerm
public String getSchemaTerm() throws SQLException
Retrieves the database vendor's preferred term for "schema".- Specified by:
getSchemaTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term for "schema"
- Throws:
SQLException
- if a database access error occurs
-
getProcedureTerm
public String getProcedureTerm() throws SQLException
Retrieves the database vendor's preferred term for "procedure".- Specified by:
getProcedureTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term for "procedure"
- Throws:
SQLException
- if a database access error occurs
-
getCatalogTerm
public String getCatalogTerm() throws SQLException
Retrieves the database vendor's preferred term for "catalog".- Specified by:
getCatalogTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term for "catalog"
- Throws:
SQLException
- if a database access error occurs
-
isCatalogAtStart
public boolean isCatalogAtStart() throws SQLException
Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.- Specified by:
isCatalogAtStart
in interfaceDatabaseMetaData
- Returns:
true
if the catalog name appears at the beginning of a fully qualified table name;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getCatalogSeparator
public String getCatalogSeparator() throws SQLException
Retrieves theString
that this database uses as the separator between a catalog and table name.- Specified by:
getCatalogSeparator
in interfaceDatabaseMetaData
- Returns:
- the separator string
- Throws:
SQLException
- if a database access error occurs
-
supportsSchemasInDataManipulation
public boolean supportsSchemasInDataManipulation() throws SQLException
Retrieves whether a schema name can 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
public boolean supportsSchemasInProcedureCalls() throws SQLException
Retrieves whether a schema name can 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
public boolean supportsSchemasInTableDefinitions() throws SQLException
Retrieves whether a schema name can 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
public boolean supportsSchemasInIndexDefinitions() throws SQLException
Retrieves whether a schema name can 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
public boolean supportsSchemasInPrivilegeDefinitions() throws SQLException
Retrieves whether a schema name can 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
public boolean supportsCatalogsInDataManipulation() throws SQLException
Retrieves whether a catalog name can 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
public boolean supportsCatalogsInProcedureCalls() throws SQLException
Retrieves whether a catalog name can 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
public boolean supportsCatalogsInTableDefinitions() throws SQLException
Retrieves whether a catalog name can 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
public boolean supportsCatalogsInIndexDefinitions() throws SQLException
Retrieves whether a catalog name can 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
public boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException
Retrieves whether a catalog name can 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
public boolean supportsPositionedDelete() throws SQLException
Retrieves whether this database supports positionedDELETE
statements.- Specified by:
supportsPositionedDelete
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsPositionedUpdate
public boolean supportsPositionedUpdate() throws SQLException
Retrieves whether this database supports positionedUPDATE
statements.- Specified by:
supportsPositionedUpdate
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSelectForUpdate
public boolean supportsSelectForUpdate() throws SQLException
Retrieves whether this database supportsSELECT FOR UPDATE
statements.- Specified by:
supportsSelectForUpdate
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsStoredProcedures
public boolean supportsStoredProcedures() throws SQLException
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.- Specified by:
supportsStoredProcedures
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInComparisons
public boolean supportsSubqueriesInComparisons() throws SQLException
Retrieves whether this database supports subqueries in comparison expressions.- Specified by:
supportsSubqueriesInComparisons
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInExists
public boolean supportsSubqueriesInExists() throws SQLException
Retrieves whether this database supports subqueries inEXISTS
expressions.- Specified by:
supportsSubqueriesInExists
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInIns
public boolean supportsSubqueriesInIns() throws SQLException
Retrieves whether this database supports subqueries inIN
statements.- Specified by:
supportsSubqueriesInIns
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsSubqueriesInQuantifieds
public boolean supportsSubqueriesInQuantifieds() throws SQLException
Retrieves whether this database supports subqueries in quantified expressions.- Specified by:
supportsSubqueriesInQuantifieds
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsCorrelatedSubqueries
public boolean supportsCorrelatedSubqueries() throws SQLException
Retrieves whether this database supports correlated subqueries.- Specified by:
supportsCorrelatedSubqueries
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsUnion
public boolean supportsUnion() throws SQLException
Retrieves whether this database supports SQLUNION
.- Specified by:
supportsUnion
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsUnionAll
public boolean supportsUnionAll() throws SQLException
Retrieves whether this database supports SQLUNION ALL
.- Specified by:
supportsUnionAll
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsOpenCursorsAcrossCommit
public boolean supportsOpenCursorsAcrossCommit() throws SQLException
Retrieves whether this database supports keeping cursors 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
public boolean supportsOpenCursorsAcrossRollback() throws SQLException
Retrieves whether this database supports keeping cursors 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
public boolean supportsOpenStatementsAcrossCommit() throws SQLException
Retrieves whether this database supports keeping statements 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
public boolean supportsOpenStatementsAcrossRollback() throws SQLException
Retrieves whether this database supports keeping statements 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
-
getMaxBinaryLiteralLength
public int getMaxBinaryLiteralLength() throws SQLException
Retrieves the maximum number of hex characters this database allows in an inline binary literal.- Specified by:
getMaxBinaryLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxCharLiteralLength
public int getMaxCharLiteralLength() throws SQLException
Retrieves the maximum number of characters this database allows for a character literal.- Specified by:
getMaxCharLiteralLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnNameLength
public int getMaxColumnNameLength() throws SQLException
Retrieves the maximum number of characters this database allows for a column name.- Specified by:
getMaxColumnNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInGroupBy
public int getMaxColumnsInGroupBy() throws SQLException
Retrieves the maximum number of columns this database allows in aGROUP BY
clause.- Specified by:
getMaxColumnsInGroupBy
in interfaceDatabaseMetaData
- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInIndex
public int getMaxColumnsInIndex() throws SQLException
Retrieves the maximum number of columns this database allows in an index.- Specified by:
getMaxColumnsInIndex
in interfaceDatabaseMetaData
- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInOrderBy
public int getMaxColumnsInOrderBy() throws SQLException
Retrieves the maximum number of columns this database allows in anORDER BY
clause.- Specified by:
getMaxColumnsInOrderBy
in interfaceDatabaseMetaData
- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInSelect
public int getMaxColumnsInSelect() throws SQLException
Retrieves the maximum number of columns this database allows in aSELECT
list.- Specified by:
getMaxColumnsInSelect
in interfaceDatabaseMetaData
- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxColumnsInTable
public int getMaxColumnsInTable() throws SQLException
Retrieves the maximum number of columns this database allows in a table.- Specified by:
getMaxColumnsInTable
in interfaceDatabaseMetaData
- Returns:
- the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxConnections
public int getMaxConnections() throws SQLException
Retrieves the maximum number of concurrent connections to this database that are possible.- Specified by:
getMaxConnections
in interfaceDatabaseMetaData
- Returns:
- the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxCursorNameLength
public int getMaxCursorNameLength() throws SQLException
Retrieves the maximum number of characters that this database allows in a cursor name.- Specified by:
getMaxCursorNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxIndexLength
public int getMaxIndexLength() throws SQLException
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.- Specified by:
getMaxIndexLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxSchemaNameLength
public int getMaxSchemaNameLength() throws SQLException
Retrieves the maximum number of characters that this database allows in a schema name.- Specified by:
getMaxSchemaNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxProcedureNameLength
public int getMaxProcedureNameLength() throws SQLException
Retrieves the maximum number of characters that this database allows in a procedure name.- Specified by:
getMaxProcedureNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxCatalogNameLength
public int getMaxCatalogNameLength() throws SQLException
Retrieves the maximum number of characters that this database allows in a catalog name.- Specified by:
getMaxCatalogNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxRowSize
public int getMaxRowSize() throws SQLException
Retrieves the maximum number of bytes this database allows in a single row.- Specified by:
getMaxRowSize
in interfaceDatabaseMetaData
- Returns:
- the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
doesMaxRowSizeIncludeBlobs
public boolean doesMaxRowSizeIncludeBlobs() throws SQLException
Retrieves whether the return value for the methodgetMaxRowSize
includes the SQL data typesLONGVARCHAR
andLONGVARBINARY
.- Specified by:
doesMaxRowSizeIncludeBlobs
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getMaxStatementLength
public int getMaxStatementLength() throws SQLException
Retrieves the maximum number of characters this database allows in an SQL statement.- Specified by:
getMaxStatementLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxStatements
public int getMaxStatements() throws SQLException
Retrieves the maximum number of active statements to this database that can be open at the same time.- 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
public int getMaxTableNameLength() throws SQLException
Retrieves the maximum number of characters this database allows in a table name.- Specified by:
getMaxTableNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getMaxTablesInSelect
public int getMaxTablesInSelect() throws SQLException
Retrieves the maximum number of tables this database allows in aSELECT
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
public int getMaxUserNameLength() throws SQLException
Retrieves the maximum number of characters this database allows in a user name.- Specified by:
getMaxUserNameLength
in interfaceDatabaseMetaData
- Returns:
- the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known
- Throws:
SQLException
- if a database access error occurs
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation() throws SQLException
Retrieves this database's default transaction isolation level. The possible values are defined injava.sql.Connection
.- Specified by:
getDefaultTransactionIsolation
in interfaceDatabaseMetaData
- Returns:
- the default isolation level
- Throws:
SQLException
- if a database access error occurs- See Also:
Connection
-
supportsTransactions
public boolean supportsTransactions() throws SQLException
Retrieves whether this database supports transactions. If not, invoking the methodcommit
is a noop, and the isolation level isTRANSACTION_NONE
.- Specified by:
supportsTransactions
in interfaceDatabaseMetaData
- Returns:
true
if transactions are supported;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsTransactionIsolationLevel
public boolean supportsTransactionIsolationLevel(int level) throws SQLException
Retrieves whether this database supports the given transaction isolation level.- Specified by:
supportsTransactionIsolationLevel
in interfaceDatabaseMetaData
- Parameters:
level
- one of the transaction isolation levels defined injava.sql.Connection
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs- See Also:
Connection
-
supportsDataDefinitionAndDataManipulationTransactions
public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException
Retrieves whether this database supports both data definition and data manipulation statements within a transaction.- Specified by:
supportsDataDefinitionAndDataManipulationTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
supportsDataManipulationTransactionsOnly
public boolean supportsDataManipulationTransactionsOnly() throws SQLException
Retrieves whether this database supports only data manipulation statements within a transaction.- Specified by:
supportsDataManipulationTransactionsOnly
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
dataDefinitionCausesTransactionCommit
public boolean dataDefinitionCausesTransactionCommit() throws SQLException
Retrieves whether a data definition statement within a transaction forces the transaction to commit.- Specified by:
dataDefinitionCausesTransactionCommit
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
dataDefinitionIgnoredInTransactions
public boolean dataDefinitionIgnoredInTransactions() throws SQLException
Retrieves whether this database ignores a data definition statement within a transaction.- Specified by:
dataDefinitionIgnoredInTransactions
in interfaceDatabaseMetaData
- Returns:
true
if so;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
getProcedures
public ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException
Retrieves a description of the stored procedures available in the given catalog. Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered byPROCEDURE_SCHEM
andPROCEDURE_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; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchprocedureNamePattern
- a procedure name pattern; must match the procedure name as it is stored in the database- Returns:
ResultSet
- each row is a procedure description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- PROCEDURE_CAT String => procedure catalog (may be
-
getProcedureColumns
public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException
Retrieves a description of the given catalog's stored procedure parameter and result columns.Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_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 int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale
- 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; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchprocedureNamePattern
- a procedure name pattern; must match the procedure name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row describes a stored procedure parameter or column- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- PROCEDURE_CAT String => procedure catalog (may be
-
getTables
public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException
Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered 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
- TYPE_CAT String => the types catalog (may be
null
) - TYPE_SCHEM String => the types schema (may be
null
) - TYPE_NAME String => type name (may be
null
) - SELF_REFERENCING_COL_NAME String => name of the designated
"identifier" column of a typed table (may be
null
) - REF_GENERATION String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are
"SYSTEM", "USER", "DERIVED". (may be
null
)
Note: Some databases may not return information for all tables.
- Specified by:
getTables
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 searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasetypes
- 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- See Also:
getSearchStringEscape()
- TABLE_CAT String => table catalog (may be
-
getSchemas
public ResultSet getSchemas() throws SQLException
Retrieves the schema names available in this database. The results are ordered by schema name.The schema column is:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null
)
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Returns:
- a
ResultSet
object in which each row is a schema decription - Throws:
SQLException
- if a database access error occurs
-
getCatalogs
public ResultSet getCatalogs() throws SQLException
Retrieves 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:
- a
ResultSet
object in which each row has a singleString
column that is a catalog name - Throws:
SQLException
- if a database access error occurs
-
getTableTypes
public ResultSet getTableTypes() throws SQLException
Retrieves the table types available in this database. The results are ordered by table type.The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- Specified by:
getTableTypes
in interfaceDatabaseMetaData
- Returns:
- a
ResultSet
object in which each row has a singleString
column that is a table type - Throws:
SQLException
- if a database access error occurs
-
getColumns
public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException
Retrieves a description of table columns available in the specified catalog.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by
Each column description has the following columns:TABLE_SCHEM
,TABLE_NAME
, andORDINAL_POSITION
.- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
- COLUMN_SIZE int => column size. 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
- columnNoNulls - might not allow
- 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.
- SCOPE_CATLOG String => catalog of table that is the scope
of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String => schema of table that is the scope
of a reference attribute (
null
if the DATA_TYPE isn't REF) - SCOPE_TABLE String => table name that this the scope
of a reference attribure (
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:
getColumns
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 searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String => table catalog (may be
-
getColumnPrivileges
public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException
Retrieves a description of the access rights for a table's columns.Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each 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; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the databasecolumnNamePattern
- a column name pattern; must match the column name as it is stored in the database- Returns:
ResultSet
- each row is a column privilege description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String => table catalog (may be
-
getTablePrivileges
public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException
Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_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; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschemaPattern
- a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtableNamePattern
- a table name pattern; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a table privilege description- Throws:
SQLException
- if a database access error occurs- See Also:
getSearchStringEscape()
- TABLE_CAT String => table catalog (may be
-
getBestRowIdentifier
public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.Each column description has the following columns:
- SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => not used
- DECIMAL_DIGITS short => scale
- 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; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the databasescope
- the scope of interest; use same values as SCOPEnullable
- include columns that are nullable.- Returns:
ResultSet
- each row is a column description- Throws:
SQLException
- if a database access error occurs
- SCOPE short => actual scope of result
-
getVersionColumns
public ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.Each column description has the following columns:
- SCOPE short => is not used
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from
java.sql.Types
- TYPE_NAME String => Data source-dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale
- PSEUDO_COLUMN short => whether this is pseudo column
like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
- Specified by:
getVersionColumns
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 searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the database- Returns:
- a
ResultSet
object in which each row is a column description - Throws:
SQLException
- if a database access error occurs
-
getPrimaryKeys
public ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException
Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.Each primary key column description has the following columns:
- TABLE_CAT String => table catalog (may be
null
) - TABLE_SCHEM String => table schema (may be
null
) - TABLE_NAME String => table name
- COLUMN_NAME String => column name
- KEY_SEQ short => sequence number within primary key
- PK_NAME String => primary key name (may be
null
)
- Specified by:
getPrimaryKeys
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 searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs
- TABLE_CAT String => table catalog (may be
-
getImportedKeys
public ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException
Retrieves 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 a foreign key
- UPDATE_RULE short => What happens to a
foreign key when the primary key is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated - importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be
null
) - PK_NAME String => primary key name (may be
null
) - DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getImportedKeys
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 searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a primary key column description- Throws:
SQLException
- if a database access error occurs- See Also:
getExportedKeys(java.lang.String, java.lang.String, java.lang.String)
- PKTABLE_CAT String => primary key table catalog
being imported (may be
-
getExportedKeys
public ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be
null
) - PKTABLE_SCHEM String => primary key table schema (may be
null
) - PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null
) being exported (may benull
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) being exported (may benull
) - FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key
- 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; must match the catalog name as it is stored in this database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in this database- Returns:
- a
ResultSet
object in which each row is a foreign key column description - Throws:
SQLException
- if a database access error occurs- See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)
- PKTABLE_CAT String => primary key table catalog (may be
-
getCrossReference
public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException
Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key columns of the given primary key table (describe how one table imports another's key). This should normally return a single foreign key/primary key pair because most tables import a foreign key from a table only 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 benull
) - FKTABLE_SCHEM String => foreign key table schema (may be
null
) being exported (may benull
) - FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key
- 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; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaprimarySchema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means drop schema name from the selection criteriaprimaryTable
- the name of the table that exports the key; must match the table name as it is stored in the databaseforeignCatalog
- a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;null
means drop catalog name from the selection criteriaforeignSchema
- a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means drop schema name from the selection criteriaforeignTable
- the name of the table that imports the key; must match the table name as it is stored in the database- Returns:
ResultSet
- each row is a foreign key column description- Throws:
SQLException
- if a database access error occurs- See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)
- PKTABLE_CAT String => primary key table catalog (may be
-
getTypeInfo
public ResultSet getTypeInfo() throws SQLException
Retrieves 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 int => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal
(may be
null
) - LITERAL_SUFFIX String => suffix used to quote a literal
(may be
null
) - CREATE_PARAMS String => parameters used in creating
the type (may be
null
) - NULLABLE short => can you use NULL for this type.
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive.
- SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned.
- FIXED_PREC_SCALE boolean => can it be a money value.
- AUTO_INCREMENT boolean => can it be used for an auto-increment value.
- LOCAL_TYPE_NAME String => localized version of type name
(may be
null
) - MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
- Specified by:
getTypeInfo
in interfaceDatabaseMetaData
- Returns:
- a
ResultSet
object in which each row is an SQL type description - Throws:
SQLException
- if a database access error occurs
-
getIndexInfo
public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException
Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.Each index column description has the following columns:
- TABLE_CAT String => table catalog (may 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; must match the catalog name as it is stored in this database; "" retrieves those without a catalog;null
means that the catalog name should not be used to narrow the searchschema
- a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtable
- a table name; must match the table name as it is stored in this databaseunique
- when true, return only indices for unique values; when false, return indices regardless of whether unique or notapproximate
- when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate- Returns:
ResultSet
- each row is an index column description- Throws:
SQLException
- if a database access error occurs
- TABLE_CAT String => table catalog (may be
-
supportsResultSetType
public boolean supportsResultSetType(int type) throws SQLException
Retrieves whether this database supports 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- Since:
- 1.2
- See Also:
Connection
-
supportsResultSetConcurrency
public boolean supportsResultSetConcurrency(int type, int concurrency) throws SQLException
Retrieves whether this database supports the given 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- Since:
- 1.2
- See Also:
Connection
-
ownUpdatesAreVisible
public boolean ownUpdatesAreVisible(int type) throws SQLException
Retrieves whether for the given type ofResultSet
object, the result set's own updates are visible.- Specified by:
ownUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if updates are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
ownDeletesAreVisible
public boolean ownDeletesAreVisible(int type) throws SQLException
Retrieves whether a result set's own deletes are visible.- Specified by:
ownDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if deletes are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
ownInsertsAreVisible
public boolean ownInsertsAreVisible(int type) throws SQLException
Retrieves whether a result set's own inserts are visible.- Specified by:
ownInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if inserts are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
othersUpdatesAreVisible
public boolean othersUpdatesAreVisible(int type) throws SQLException
Retrieves whether updates made by others are visible.- Specified by:
othersUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if updates made by others are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
othersDeletesAreVisible
public boolean othersDeletesAreVisible(int type) throws SQLException
Retrieves whether deletes made by others are visible.- Specified by:
othersDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if deletes made by others are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
othersInsertsAreVisible
public boolean othersInsertsAreVisible(int type) throws SQLException
Retrieves whether inserts made by others are visible.- Specified by:
othersInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if inserts made by others are visible for the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
updatesAreDetected
public boolean updatesAreDetected(int type) throws SQLException
Retrieves whether or not a visible row update can be detected by calling the methodResultSet.rowUpdated
.- Specified by:
updatesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if changes are detected by the result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
deletesAreDetected
public boolean deletesAreDetected(int type) throws SQLException
Retrieves whether or not a visible row delete can be detected by calling the methodResultSet.rowDeleted
. If the methoddeletesAreDetected
returnsfalse
, it means that deleted rows are removed from the result set.- Specified by:
deletesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if deletes are detected by the given result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
insertsAreDetected
public boolean insertsAreDetected(int type) throws SQLException
Retrieves whether or not a visible row insert can be detected by calling the methodResultSet.rowInserted
.- Specified by:
insertsAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- theResultSet
type; one ofResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Returns:
true
if changes are detected by the specified result set type;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
supportsBatchUpdates
public boolean supportsBatchUpdates() throws SQLException
Retrieves whether this database supports batch updates.- Specified by:
supportsBatchUpdates
in interfaceDatabaseMetaData
- Returns:
true
if this database supports batch upcates;false
otherwise- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getUDTs
public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException
Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have typeJAVA_OBJECT
,STRUCT
, orDISTINCT
.Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be
null
) - TYPE_SCHEM String => type's schema (may be
null
) - TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
- BASE_TYPE short => type code of the source type of a
DISTINCT type or the type that implements the user-generated
reference type of the SELF_REFERENCING_COLUMN of a structured
type as defined in java.sql.Types (
null
if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty result set is returned.
- Specified by:
getUDTs
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 pattern name; must match the schema name as it is stored in the database; "" retrieves those without a schema;null
means that the schema name should not be used to narrow the searchtypeNamePattern
- a type name pattern; must match the type name as it is stored in the database; may be a fully qualified nametypes
- a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include;null
returns all types- Returns:
ResultSet
object in which each row describes a UDT- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- TYPE_CAT String => the type's catalog (may be
-
getConnection
public Connection getConnection() throws SQLException
Retrieves the connection that produced this metadata object.- Specified by:
getConnection
in interfaceDatabaseMetaData
- Returns:
- the connection that produced this metadata object
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getActualConnection
public Connection getActualConnection() throws SQLException
Returns the actual connection that produced this metadata object- Returns:
- Connection
- Throws:
SQLException
-
supportsSavepoints
public boolean supportsSavepoints() throws SQLException
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
public boolean supportsNamedParameters() throws SQLException
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
public boolean supportsMultipleOpenResults() throws SQLException
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
public boolean supportsGetGeneratedKeys() throws SQLException
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 theResultSet
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. TheResultSet
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
public boolean supportsResultSetHoldability(int holdability) throws SQLException
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:
Connection
-
getResultSetHoldability
public int getResultSetHoldability() throws SQLException
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
public int getDatabaseMajorVersion() throws SQLException
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
public int getDatabaseMinorVersion() throws SQLException
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
public int getJDBCMajorVersion() throws SQLException
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
public int getJDBCMinorVersion() throws SQLException
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
public int getSQLStateType() throws SQLException
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
public boolean locatorsUpdateCopy() throws SQLException
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
public boolean supportsStatementPooling() throws SQLException
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
-
getMethodExecutor
protected MethodExecutor getMethodExecutor()
-
-