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