All Packages Class Hierarchy This Package Previous Next Index
Class oracle.jdbc.driver.OracleDatabaseMetaData
java.lang.Object
|
+----oracle.jdbc.driver.OracleDatabaseMetaData
- public class OracleDatabaseMetaData
- extends Object
- implements DatabaseMetaData
The OracleDatabaseMetaData class implements the JDBC 1.0 DatabaseMetaData
interface.
-
OracleDatabaseMetaData(OracleConnection)
-
-
allProceduresAreCallable()
- Can all the procedures returned by getProcedures be called by the
current user?
-
allTablesAreSelectable()
- Can all the tables returned by getTable be SELECTed by the
current user?
-
dataDefinitionCausesTransactionCommit()
- Does a data definition statement within a transaction force the
transaction to commit?
-
dataDefinitionIgnoredInTransactions()
- Is a data definition statement within a transaction ignored?
-
deletesAreDetected(int)
- Implements JDBC 2.0 DatabaseMetaData.deletesAreDetected.
-
doesMaxRowSizeIncludeBlobs()
- Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY
blobs?
-
getBestRowIdentifier(String, String, String, int, boolean)
- Get a description of a table's optimal set of columns that
uniquely identifies a row.
-
getCatalogs()
- Get the catalog names available in this database.
-
getCatalogSeparator()
- What's the separator between catalog and table name?
-
getCatalogTerm()
- What's the database vendor's preferred term for "catalog"?
-
getColumnPrivileges(String, String, String, String)
- Get a description of the access rights for a table's columns.
-
getColumns(String, String, String, String)
- Get a description of table columns available in a catalog.
-
getConnection()
- Implements JDBC 2.0 DatabaseMetaData.getConnection.
-
getCrossReference(String, String, String, String, String, String)
- Get 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.
-
getDatabaseProductName()
- What's the name of this database product?
-
getDatabaseProductVersion()
- What's the version of this database product?
-
getDefaultTransactionIsolation()
- What's the database's default transaction isolation level? The
values are defined in java.sql.Connection.
-
getDriverMajorVersion()
- What's this JDBC driver's major version number?
-
getDriverMajorVersionInfo()
- What's this JDBC driver's major version number?
-
getDriverMinorVersion()
- What's this JDBC driver's minor version number?
-
getDriverMinorVersionInfo()
- What's this JDBC driver's minor version number?
-
getDriverName()
- What's the name of this JDBC driver?
-
getDriverNameInfo()
- What's the name of this JDBC driver?
-
getDriverVersion()
- What's the version of this JDBC driver?
-
getDriverVersionInfo()
- What's the version of this JDBC driver?
-
getExportedKeys(String, String, String)
- Get a description of a foreign key columns that reference a
table's primary key columns (the foreign keys exported by a
table).
-
getExtraNameCharacters()
- Get all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, 0-9 and _).
-
getIdentifierQuoteString()
- What's the string used to quote SQL identifiers?
This returns a space " " if identifier quoting isn't supported.
-
getImportedKeys(String, String, String)
- Get a description of the primary key columns that are
referenced by a table's foreign key columns (the primary keys
imported by a table).
-
getIndexInfo(String, String, String, boolean, boolean)
- Get a description of a table's indices and statistics.
-
getMaxBinaryLiteralLength()
- How many hex characters can you have in an inline binary literal?
-
getMaxCatalogNameLength()
- What's the maximum length of a catalog name?
-
getMaxCharLiteralLength()
- What's the max length for a character literal?
-
getMaxColumnNameLength()
- What's the limit on column name length?
-
getMaxColumnsInGroupBy()
- What's the maximum number of columns in a "GROUP BY" clause?
-
getMaxColumnsInIndex()
- What's the maximum number of columns allowed in an index?
-
getMaxColumnsInOrderBy()
- What's the maximum number of columns in an "ORDER BY" clause?
-
getMaxColumnsInSelect()
- What's the maximum number of columns in a "SELECT" list?
-
getMaxColumnsInTable()
- What's maximum number of columns in a table?
-
getMaxConnections()
- How many active connections can we have at a time to this database?
-
getMaxCursorNameLength()
- What's the maximum cursor name length?
-
getMaxIndexLength()
- What's the maximum length of an index (in bytes)?
-
getMaxProcedureNameLength()
- What's the maximum length of a procedure name?
-
getMaxRowSize()
- What's the maximum length of a single row?
-
getMaxSchemaNameLength()
- What's the maximum length allowed for a schema name?
-
getMaxStatementLength()
- What's the maximum length of a SQL statement?
-
getMaxStatements()
- How many active statements can we have open at one time to this
database?
-
getMaxTableNameLength()
- What's the maximum length of a table name?
-
getMaxTablesInSelect()
- What's the maximum number of tables in a SELECT?
-
getMaxUserNameLength()
- What's the maximum length of a user name?
-
getNumericFunctions()
- Get a comma separated list of math functions.
-
getPrimaryKeys(String, String, String)
- Get a description of a table's primary key columns.
-
getProcedureColumns(String, String, String, String)
- Get a description of a catalog's stored procedure parameters
and result columns.
-
getProcedures(String, String, String)
- Get a description of stored procedures available in a
catalog.
-
getProcedureTerm()
- What's the database vendor's preferred term for "procedure"?
-
getSchemas()
- Get the schema names available in this database.
-
getSchemaTerm()
- What's the database vendor's preferred term for "schema"?
-
getSearchStringEscape()
- This is the string that can be used to escape '_' or '%' in
the string pattern style catalog search parameters.
-
getSQLKeywords()
- Get a comma separated list of all a database's SQL keywords
that are NOT also SQL92 keywords.
-
getStringFunctions()
- Get a comma separated list of string functions.
-
getSystemFunctions()
- Get a comma separated list of system functions.
-
getTablePrivileges(String, String, String)
- Get a description of the access rights for each table available
in a catalog.
-
getTables(String, String, String, String[])
- Get a description of tables available in a catalog.
-
getTableTypes()
- Get the table types available in this database.
-
getTimeDateFunctions()
- Get a comma separated list of time and date functions.
-
getTypeInfo()
- Get a description of all the standard SQL types supported by
this database.
-
getUDTs(String, String, String, int[])
- Implements JDBC 2.0 DatabaseMetaData::getUDTs.
-
getURL()
- What's the url for this database?
-
getUserName()
- What's our user name as known to the database?
-
getVersionColumns(String, String, String)
- Get a description of a table's columns that are automatically
updated when any value in a row is updated.
-
insertsAreDetected(int)
- Implements JDBC 2.0 DatabaseMetaData.insertsAreDetected.
-
isCatalogAtStart()
- Does a catalog appear at the start of a qualified table name?
(Otherwise it appears at the end)
-
isReadOnly()
- Is the database in read-only mode?
-
nullPlusNonNullIsNull()
- Are concatenations between NULL and non-NULL values NULL?
A JDBC compliant driver always returns true.
-
nullsAreSortedAtEnd()
- Are NULL values sorted at the end regardless of sort order?
-
nullsAreSortedAtStart()
- Are NULL values sorted at the start regardless of sort order?
-
nullsAreSortedHigh()
- Are NULL values sorted high?
-
nullsAreSortedLow()
- Are NULL values sorted low?
-
othersDeletesAreVisible(int)
- Implements JDBC 2.0 DatabaseMetaData..
-
othersInsertsAreVisible(int)
- Implements JDBC 2.0 DatabaseMetaData.othersInsertsAreVisible.
-
othersUpdatesAreVisible(int)
- Implements JDBC 2.0 DatabaseMetaData..
-
ownDeletesAreVisible(int)
- Implements JDBC 2.0 DatabaseMetaData.ownDeletesAreVisible.
-
ownInsertsAreVisible(int)
- Implements JDBC 2.0 DatabaseMetaData.ownInsertsAreVisible.
-
ownUpdatesAreVisible(int)
- Implements JDBC 2.0 DatabaseMetaData.ownUpdatesAreVisible.
-
storesLowerCaseIdentifiers()
- Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in lower case?
-
storesLowerCaseQuotedIdentifiers()
- Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in lower case?
-
storesMixedCaseIdentifiers()
- Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in mixed case?
-
storesMixedCaseQuotedIdentifiers()
- Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in mixed case?
-
storesUpperCaseIdentifiers()
- Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in upper case?
-
storesUpperCaseQuotedIdentifiers()
- Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in upper case?
-
supportsAlterTableWithAddColumn()
- Is "ALTER TABLE" with add column supported?
-
supportsAlterTableWithDropColumn()
- Is "ALTER TABLE" with drop column supported?
-
supportsANSI92EntryLevelSQL()
- Is the ANSI92 entry level SQL grammar supported?
All JDBC compliant drivers must return true.
-
supportsANSI92FullSQL()
- Is the ANSI92 full SQL grammar supported?
-
supportsANSI92IntermediateSQL()
- Is the ANSI92 intermediate SQL grammar supported?
-
supportsBatchUpdates()
- Implements JDBC 2.0 DatabaseMetaData::supportBatchUpdates.
-
supportsCatalogsInDataManipulation()
- Can a catalog name be used in a data manipulation statement?
-
supportsCatalogsInIndexDefinitions()
- Can a catalog name be used in a index definition statement?
-
supportsCatalogsInPrivilegeDefinitions()
- Can a catalog name be used in a privilege definition statement?
-
supportsCatalogsInProcedureCalls()
- Can a catalog name be used in a procedure call statement?
-
supportsCatalogsInTableDefinitions()
- Can a catalog name be used in a table definition statement?
-
supportsColumnAliasing()
- Is column aliasing 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.
-
supportsConvert()
- Is the CONVERT function between SQL types supported?
-
supportsConvert(int, int)
- Is CONVERT between the given SQL types supported?
-
supportsCoreSQLGrammar()
- Is the ODBC Core SQL grammar supported?
-
supportsCorrelatedSubqueries()
- Are correlated subqueries supported?
A JDBC compliant driver always returns true.
-
supportsDataDefinitionAndDataManipulationTransactions()
- Are both data definition and data manipulation statements
within a transaction supported?
-
supportsDataManipulationTransactionsOnly()
- Are only data manipulation statements within a transaction
supported?
-
supportsDifferentTableCorrelationNames()
- If table correlation names are supported, are they restricted
to be different from the names of the tables?
-
supportsExpressionsInOrderBy()
- Are expressions in "ORDER BY" lists supported?
-
supportsExtendedSQLGrammar()
- Is the ODBC Extended SQL grammar supported?
-
supportsFullOuterJoins()
- Are full nested outer joins supported?
-
supportsGroupBy()
- Is some form of "GROUP BY" clause supported?
-
supportsGroupByBeyondSelect()
- Can a "GROUP BY" clause add columns not in the SELECT
provided it specifies all the columns in the SELECT?
-
supportsGroupByUnrelated()
- Can a "GROUP BY" clause use columns not in the SELECT?
-
supportsIntegrityEnhancementFacility()
- Is the SQL Integrity Enhancement Facility supported?
-
supportsLikeEscapeClause()
- Is the escape character in "LIKE" clauses supported?
A JDBC compliant driver always returns true.
-
supportsLimitedOuterJoins()
- Is there limited support for outer joins? (This will be true
if supportFullOuterJoins is true.)
-
supportsMinimumSQLGrammar()
- Is the ODBC Minimum SQL grammar supported?
All JDBC compliant drivers must return true.
-
supportsMixedCaseIdentifiers()
- Does the database treat mixed case unquoted SQL identifiers as
case sensitive and as a result store them in mixed case?
A JDBC compliant driver will always return false.
-
supportsMixedCaseQuotedIdentifiers()
- Does the database treat mixed case quoted SQL identifiers as
case sensitive and as a result store them in mixed case?
A JDBC compliant driver will always return false.
-
supportsMultipleResultSets()
- Are multiple ResultSets from a single execute supported?
-
supportsMultipleTransactions()
- Can we have multiple transactions open at once (on different
connections)?
-
supportsNonNullableColumns()
- Can columns be defined as non-nullable?
A JDBC compliant driver always returns true.
-
supportsOpenCursorsAcrossCommit()
- Can cursors remain open across commits?
-
supportsOpenCursorsAcrossRollback()
- Can cursors remain open across rollbacks?
-
supportsOpenStatementsAcrossCommit()
- Can statements remain open across commits?
-
supportsOpenStatementsAcrossRollback()
- Can statements remain open across rollbacks?
-
supportsOrderByUnrelated()
- Can an "ORDER BY" clause use columns not in the SELECT?
-
supportsOuterJoins()
- Is some form of outer join supported?
-
supportsPositionedDelete()
- Is positioned DELETE supported?
-
supportsPositionedUpdate()
- Is positioned UPDATE supported?
-
supportsResultSetConcurrency(int, int)
- Implements JDBC 2.0 DatabaseMetaData.supportsResultSetConcurrency.
-
supportsResultSetType(int)
- Implements JDBC 2.0 DatabaseMetaData.supportsResultSetType.
-
supportsSchemasInDataManipulation()
- Can a schema name be used in a data manipulation statement?
-
supportsSchemasInIndexDefinitions()
- Can a schema name be used in an index definition statement?
-
supportsSchemasInPrivilegeDefinitions()
- Can a schema name be used in a privilege definition statement?
-
supportsSchemasInProcedureCalls()
- Can a schema name be used in a procedure call statement?
-
supportsSchemasInTableDefinitions()
- Can a schema name be used in a table definition statement?
-
supportsSelectForUpdate()
- Is SELECT for UPDATE supported?
-
supportsStoredProcedures()
- Are stored procedure calls using the stored procedure escape
syntax supported?
-
supportsSubqueriesInComparisons()
- Are subqueries in comparison expressions supported?
A JDBC compliant driver always returns true.
-
supportsSubqueriesInExists()
- Are subqueries in exists expressions supported?
A JDBC compliant driver always returns true.
-
supportsSubqueriesInIns()
- Are subqueries in "in" statements supported?
A JDBC compliant driver always returns true.
-
supportsSubqueriesInQuantifieds()
- Are subqueries in quantified expressions supported?
A JDBC compliant driver always returns true.
-
supportsTableCorrelationNames()
- Are table correlation names supported?
A JDBC compliant driver always returns true.
-
supportsTransactionIsolationLevel(int)
- Does the database support the given transaction isolation level?
-
supportsTransactions()
- Are transactions supported? If not, commit is a noop and the
isolation level is TRANSACTION_NONE.
-
supportsUnion()
- Is SQL UNION supported?
-
supportsUnionAll()
- Is SQL UNION ALL supported?
-
updatesAreDetected(int)
- Implements JDBC 2.0 DatabaseMetaData.updatesAreDetected.
-
usesLocalFilePerTable()
- Does the database use a file for each table?
-
usesLocalFiles()
- Does the database store tables in a local file?
OracleDatabaseMetaData
public OracleDatabaseMetaData(OracleConnection conn)
allProceduresAreCallable
public boolean allProceduresAreCallable() throws SQLException
- Can all the procedures returned by getProcedures be called by the
current user?
- Returns:
- true if so
allTablesAreSelectable
public boolean allTablesAreSelectable() throws SQLException
- Can all the tables returned by getTable be SELECTed by the
current user?
- Returns:
- true if so
getURL
public String getURL() throws SQLException
- What's the url for this database?
- Returns:
- the url or null if it can't be generated
getUserName
public String getUserName() throws SQLException
- What's our user name as known to the database?
- Returns:
- our database user name
isReadOnly
public boolean isReadOnly() throws SQLException
- Is the database in read-only mode?
- Returns:
- true if so
nullsAreSortedHigh
public boolean nullsAreSortedHigh() throws SQLException
- Are NULL values sorted high?
- Returns:
- true if so
nullsAreSortedLow
public boolean nullsAreSortedLow() throws SQLException
- Are NULL values sorted low?
- Returns:
- true if so
nullsAreSortedAtStart
public boolean nullsAreSortedAtStart() throws SQLException
- Are NULL values sorted at the start regardless of sort order?
- Returns:
- true if so
nullsAreSortedAtEnd
public boolean nullsAreSortedAtEnd() throws SQLException
- Are NULL values sorted at the end regardless of sort order?
- Returns:
- true if so
getDatabaseProductName
public String getDatabaseProductName() throws SQLException
- What's the name of this database product?
- Returns:
- database product name
getDatabaseProductVersion
public String getDatabaseProductVersion() throws SQLException
- What's the version of this database product?
- Returns:
- database version
getDriverName
public String getDriverName() throws SQLException
- What's the name of this JDBC driver?
- Returns:
- JDBC driver name
getDriverVersion
public String getDriverVersion() throws SQLException
- What's the version of this JDBC driver?
- Returns:
- JDBC driver version
getDriverMajorVersion
public int getDriverMajorVersion()
- What's this JDBC driver's major version number?
- Returns:
- JDBC driver major version
getDriverMinorVersion
public int getDriverMinorVersion()
- What's this JDBC driver's minor version number?
- Returns:
- JDBC driver minor version number
usesLocalFiles
public boolean usesLocalFiles() throws SQLException
- Does the database store tables in a local file?
- Returns:
- true if so
usesLocalFilePerTable
public boolean usesLocalFilePerTable() throws SQLException
- Does the database use a file for each table?
- Returns:
- true if the database uses a local file for each table
supportsMixedCaseIdentifiers
public boolean supportsMixedCaseIdentifiers() throws SQLException
- Does the database treat mixed case unquoted SQL identifiers as
case sensitive and as a result store them in mixed case?
A JDBC compliant driver will always return false.
- Returns:
- true if so
storesUpperCaseIdentifiers
public boolean storesUpperCaseIdentifiers() throws SQLException
- Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in upper case?
- Returns:
- true if so
storesLowerCaseIdentifiers
public boolean storesLowerCaseIdentifiers() throws SQLException
- Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in lower case?
- Returns:
- true if so
storesMixedCaseIdentifiers
public boolean storesMixedCaseIdentifiers() throws SQLException
- Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in mixed case?
- Returns:
- true if so
supportsMixedCaseQuotedIdentifiers
public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException
- Does the database treat mixed case quoted SQL identifiers as
case sensitive and as a result store them in mixed case?
A JDBC compliant driver will always return false.
- Returns:
- true if so
storesUpperCaseQuotedIdentifiers
public boolean storesUpperCaseQuotedIdentifiers() throws SQLException
- Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in upper case?
- Returns:
- true if so
storesLowerCaseQuotedIdentifiers
public boolean storesLowerCaseQuotedIdentifiers() throws SQLException
- Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in lower case?
- Returns:
- true if so
storesMixedCaseQuotedIdentifiers
public boolean storesMixedCaseQuotedIdentifiers() throws SQLException
- Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in mixed case?
- Returns:
- true if so
getIdentifierQuoteString
public String getIdentifierQuoteString() throws SQLException
- What's the string used to quote SQL identifiers?
This returns a space " " if identifier quoting isn't supported.
A JDBC compliant driver always uses a double quote character.
- Returns:
- the quoting string
getSQLKeywords
public String getSQLKeywords() throws SQLException
- Get a comma separated list of all a database's SQL keywords
that are NOT also SQL92 keywords.
- Returns:
- the list
getNumericFunctions
public String getNumericFunctions() throws SQLException
- Get a comma separated list of math functions.
- Returns:
- the list
getStringFunctions
public String getStringFunctions() throws SQLException
- Get a comma separated list of string functions.
- Returns:
- the list
getSystemFunctions
public String getSystemFunctions() throws SQLException
- Get a comma separated list of system functions.
- Returns:
- the list
getTimeDateFunctions
public String getTimeDateFunctions() throws SQLException
- Get a comma separated list of time and date functions.
- Returns:
- the list
getSearchStringEscape
public String getSearchStringEscape() throws SQLException
- 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.
- Returns:
- the string used to escape wildcard characters
getExtraNameCharacters
public String getExtraNameCharacters() throws SQLException
- Get all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, 0-9 and _).
- Returns:
- the string containing the extra characters
supportsAlterTableWithAddColumn
public boolean supportsAlterTableWithAddColumn() throws SQLException
- Is "ALTER TABLE" with add column supported?
- Returns:
- true if so
supportsAlterTableWithDropColumn
public boolean supportsAlterTableWithDropColumn() throws SQLException
- Is "ALTER TABLE" with drop column supported?
- Returns:
- true if so
supportsColumnAliasing
public boolean supportsColumnAliasing() throws SQLException
- Is column aliasing 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 compliant driver always returns true.
- Returns:
- true if so
nullPlusNonNullIsNull
public boolean nullPlusNonNullIsNull() throws SQLException
- Are concatenations between NULL and non-NULL values NULL?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsConvert
public boolean supportsConvert() throws SQLException
- Is the CONVERT function between SQL types supported?
- Returns:
- true if so
supportsConvert
public boolean supportsConvert(int fromType,
int toType) throws SQLException
- Is CONVERT between the given SQL types supported?
- Parameters:
- fromType - the type to convert from
- toType - the type to convert to
- Returns:
- true if so
- See Also:
- Types
supportsTableCorrelationNames
public boolean supportsTableCorrelationNames() throws SQLException
- Are table correlation names supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsDifferentTableCorrelationNames
public boolean supportsDifferentTableCorrelationNames() throws SQLException
- If table correlation names are supported, are they restricted
to be different from the names of the tables?
- Returns:
- true if so
supportsExpressionsInOrderBy
public boolean supportsExpressionsInOrderBy() throws SQLException
- Are expressions in "ORDER BY" lists supported?
- Returns:
- true if so
supportsOrderByUnrelated
public boolean supportsOrderByUnrelated() throws SQLException
- Can an "ORDER BY" clause use columns not in the SELECT?
- Returns:
- true if so
supportsGroupBy
public boolean supportsGroupBy() throws SQLException
- Is some form of "GROUP BY" clause supported?
- Returns:
- true if so
supportsGroupByUnrelated
public boolean supportsGroupByUnrelated() throws SQLException
- Can a "GROUP BY" clause use columns not in the SELECT?
- Returns:
- true if so
supportsGroupByBeyondSelect
public boolean supportsGroupByBeyondSelect() throws SQLException
- Can a "GROUP BY" clause add columns not in the SELECT
provided it specifies all the columns in the SELECT?
- Returns:
- true if so
supportsLikeEscapeClause
public boolean supportsLikeEscapeClause() throws SQLException
- Is the escape character in "LIKE" clauses supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsMultipleResultSets
public boolean supportsMultipleResultSets() throws SQLException
- Are multiple ResultSets from a single execute supported?
- Returns:
- true if so
supportsMultipleTransactions
public boolean supportsMultipleTransactions() throws SQLException
- Can we have multiple transactions open at once (on different
connections)?
- Returns:
- true if so
supportsNonNullableColumns
public boolean supportsNonNullableColumns() throws SQLException
- Can columns be defined as non-nullable?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsMinimumSQLGrammar
public boolean supportsMinimumSQLGrammar() throws SQLException
- Is the ODBC Minimum SQL grammar supported?
All JDBC compliant drivers must return true.
- Returns:
- true if so
supportsCoreSQLGrammar
public boolean supportsCoreSQLGrammar() throws SQLException
- Is the ODBC Core SQL grammar supported?
- Returns:
- true if so
supportsExtendedSQLGrammar
public boolean supportsExtendedSQLGrammar() throws SQLException
- Is the ODBC Extended SQL grammar supported?
- Returns:
- true if so
supportsANSI92EntryLevelSQL
public boolean supportsANSI92EntryLevelSQL() throws SQLException
- Is the ANSI92 entry level SQL grammar supported?
All JDBC compliant drivers must return true.
- Returns:
- true if so
supportsANSI92IntermediateSQL
public boolean supportsANSI92IntermediateSQL() throws SQLException
- Is the ANSI92 intermediate SQL grammar supported?
- Returns:
- true if so
supportsANSI92FullSQL
public boolean supportsANSI92FullSQL() throws SQLException
- Is the ANSI92 full SQL grammar supported?
- Returns:
- true if so
supportsIntegrityEnhancementFacility
public boolean supportsIntegrityEnhancementFacility() throws SQLException
- Is the SQL Integrity Enhancement Facility supported?
- Returns:
- true if so
supportsOuterJoins
public boolean supportsOuterJoins() throws SQLException
- Is some form of outer join supported?
- Returns:
- true if so
supportsFullOuterJoins
public boolean supportsFullOuterJoins() throws SQLException
- Are full nested outer joins supported?
- Returns:
- true if so
supportsLimitedOuterJoins
public boolean supportsLimitedOuterJoins() throws SQLException
- Is there limited support for outer joins? (This will be true
if supportFullOuterJoins is true.)
- Returns:
- true if so
getSchemaTerm
public String getSchemaTerm() throws SQLException
- What's the database vendor's preferred term for "schema"?
- Returns:
- the vendor term
getProcedureTerm
public String getProcedureTerm() throws SQLException
- What's the database vendor's preferred term for "procedure"?
- Returns:
- the vendor term
getCatalogTerm
public String getCatalogTerm() throws SQLException
- What's the database vendor's preferred term for "catalog"?
- Returns:
- the vendor term
isCatalogAtStart
public boolean isCatalogAtStart() throws SQLException
- Does a catalog appear at the start of a qualified table name?
(Otherwise it appears at the end)
- Returns:
- true if it appears at the start
getCatalogSeparator
public String getCatalogSeparator() throws SQLException
- What's the separator between catalog and table name?
- Returns:
- the separator string
supportsSchemasInDataManipulation
public boolean supportsSchemasInDataManipulation() throws SQLException
- Can a schema name be used in a data manipulation statement?
- Returns:
- true if so
supportsSchemasInProcedureCalls
public boolean supportsSchemasInProcedureCalls() throws SQLException
- Can a schema name be used in a procedure call statement?
- Returns:
- true if so
supportsSchemasInTableDefinitions
public boolean supportsSchemasInTableDefinitions() throws SQLException
- Can a schema name be used in a table definition statement?
- Returns:
- true if so
supportsSchemasInIndexDefinitions
public boolean supportsSchemasInIndexDefinitions() throws SQLException
- Can a schema name be used in an index definition statement?
- Returns:
- true if so
supportsSchemasInPrivilegeDefinitions
public boolean supportsSchemasInPrivilegeDefinitions() throws SQLException
- Can a schema name be used in a privilege definition statement?
- Returns:
- true if so
supportsCatalogsInDataManipulation
public boolean supportsCatalogsInDataManipulation() throws SQLException
- Can a catalog name be used in a data manipulation statement?
- Returns:
- true if so
supportsCatalogsInProcedureCalls
public boolean supportsCatalogsInProcedureCalls() throws SQLException
- Can a catalog name be used in a procedure call statement?
- Returns:
- true if so
supportsCatalogsInTableDefinitions
public boolean supportsCatalogsInTableDefinitions() throws SQLException
- Can a catalog name be used in a table definition statement?
- Returns:
- true if so
supportsCatalogsInIndexDefinitions
public boolean supportsCatalogsInIndexDefinitions() throws SQLException
- Can a catalog name be used in a index definition statement?
- Returns:
- true if so
supportsCatalogsInPrivilegeDefinitions
public boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException
- Can a catalog name be used in a privilege definition statement?
- Returns:
- true if so
supportsPositionedDelete
public boolean supportsPositionedDelete() throws SQLException
- Is positioned DELETE supported?
- Returns:
- true if so
supportsPositionedUpdate
public boolean supportsPositionedUpdate() throws SQLException
- Is positioned UPDATE supported?
- Returns:
- true if so
supportsSelectForUpdate
public boolean supportsSelectForUpdate() throws SQLException
- Is SELECT for UPDATE supported?
- Returns:
- true if so
supportsStoredProcedures
public boolean supportsStoredProcedures() throws SQLException
- Are stored procedure calls using the stored procedure escape
syntax supported?
- Returns:
- true if so
supportsSubqueriesInComparisons
public boolean supportsSubqueriesInComparisons() throws SQLException
- Are subqueries in comparison expressions supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsSubqueriesInExists
public boolean supportsSubqueriesInExists() throws SQLException
- Are subqueries in exists expressions supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsSubqueriesInIns
public boolean supportsSubqueriesInIns() throws SQLException
- Are subqueries in "in" statements supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsSubqueriesInQuantifieds
public boolean supportsSubqueriesInQuantifieds() throws SQLException
- Are subqueries in quantified expressions supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsCorrelatedSubqueries
public boolean supportsCorrelatedSubqueries() throws SQLException
- Are correlated subqueries supported?
A JDBC compliant driver always returns true.
- Returns:
- true if so
supportsUnion
public boolean supportsUnion() throws SQLException
- Is SQL UNION supported?
- Returns:
- true if so
supportsUnionAll
public boolean supportsUnionAll() throws SQLException
- Is SQL UNION ALL supported?
- Returns:
- true if so
supportsOpenCursorsAcrossCommit
public boolean supportsOpenCursorsAcrossCommit() throws SQLException
- Can cursors remain open across commits?
- Returns:
- true if so
- See Also:
- disableAutoClose
supportsOpenCursorsAcrossRollback
public boolean supportsOpenCursorsAcrossRollback() throws SQLException
- Can cursors remain open across rollbacks?
- Returns:
- true if so
- See Also:
- disableAutoClose
supportsOpenStatementsAcrossCommit
public boolean supportsOpenStatementsAcrossCommit() throws SQLException
- Can statements remain open across commits?
- Returns:
- true if so
- See Also:
- disableAutoClose
supportsOpenStatementsAcrossRollback
public boolean supportsOpenStatementsAcrossRollback() throws SQLException
- Can statements remain open across rollbacks?
- Returns:
- true if so
- See Also:
- disableAutoClose
getMaxBinaryLiteralLength
public int getMaxBinaryLiteralLength() throws SQLException
- How many hex characters can you have in an inline binary literal?
- Returns:
- max literal length
getMaxCharLiteralLength
public int getMaxCharLiteralLength() throws SQLException
- What's the max length for a character literal?
- Returns:
- max literal length
getMaxColumnNameLength
public int getMaxColumnNameLength() throws SQLException
- What's the limit on column name length?
- Returns:
- max literal length
getMaxColumnsInGroupBy
public int getMaxColumnsInGroupBy() throws SQLException
- What's the maximum number of columns in a "GROUP BY" clause?
- Returns:
- max number of columns
getMaxColumnsInIndex
public int getMaxColumnsInIndex() throws SQLException
- What's the maximum number of columns allowed in an index?
- Returns:
- max columns
getMaxColumnsInOrderBy
public int getMaxColumnsInOrderBy() throws SQLException
- What's the maximum number of columns in an "ORDER BY" clause?
- Returns:
- max columns
getMaxColumnsInSelect
public int getMaxColumnsInSelect() throws SQLException
- What's the maximum number of columns in a "SELECT" list?
- Returns:
- max columns
getMaxColumnsInTable
public int getMaxColumnsInTable() throws SQLException
- What's maximum number of columns in a table?
- Returns:
- max columns
getMaxConnections
public int getMaxConnections() throws SQLException
- How many active connections can we have at a time to this database?
- Returns:
- max connections
getMaxCursorNameLength
public int getMaxCursorNameLength() throws SQLException
- What's the maximum cursor name length?
- Returns:
- max cursor name length in bytes
getMaxIndexLength
public int getMaxIndexLength() throws SQLException
- What's the maximum length of an index (in bytes)?
- Returns:
- max index length in bytes
getMaxSchemaNameLength
public int getMaxSchemaNameLength() throws SQLException
- What's the maximum length allowed for a schema name?
- Returns:
- max name length in bytes
getMaxProcedureNameLength
public int getMaxProcedureNameLength() throws SQLException
- What's the maximum length of a procedure name?
- Returns:
- max name length in bytes
getMaxCatalogNameLength
public int getMaxCatalogNameLength() throws SQLException
- What's the maximum length of a catalog name?
- Returns:
- max name length in bytes
getMaxRowSize
public int getMaxRowSize() throws SQLException
- What's the maximum length of a single row?
- Returns:
- max row size in bytes
doesMaxRowSizeIncludeBlobs
public boolean doesMaxRowSizeIncludeBlobs() throws SQLException
- Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY
blobs?
- Returns:
- true if so
getMaxStatementLength
public int getMaxStatementLength() throws SQLException
- What's the maximum length of a SQL statement?
- Returns:
- max length in bytes
getMaxStatements
public int getMaxStatements() throws SQLException
- How many active statements can we have open at one time to this
database?
- Returns:
- the maximum
getMaxTableNameLength
public int getMaxTableNameLength() throws SQLException
- What's the maximum length of a table name?
- Returns:
- max name length in bytes
getMaxTablesInSelect
public int getMaxTablesInSelect() throws SQLException
- What's the maximum number of tables in a SELECT?
- Returns:
- the maximum
getMaxUserNameLength
public int getMaxUserNameLength() throws SQLException
- What's the maximum length of a user name?
- Returns:
- max name length in bytes
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation() throws SQLException
- What's the database's default transaction isolation level? The
values are defined in java.sql.Connection.
- Returns:
- the default isolation level
- See Also:
- Connection
supportsTransactions
public boolean supportsTransactions() throws SQLException
- Are transactions supported? If not, commit is a noop and the
isolation level is TRANSACTION_NONE.
- Returns:
- true if transactions are supported
supportsTransactionIsolationLevel
public boolean supportsTransactionIsolationLevel(int level) throws SQLException
- Does the database support the given transaction isolation level?
- Parameters:
- level - the values are defined in java.sql.Connection
- Returns:
- true if so
- See Also:
- Connection
supportsDataDefinitionAndDataManipulationTransactions
public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException
- Are both data definition and data manipulation statements
within a transaction supported?
- Returns:
- true if so
supportsDataManipulationTransactionsOnly
public boolean supportsDataManipulationTransactionsOnly() throws SQLException
- Are only data manipulation statements within a transaction
supported?
- Returns:
- true if so
dataDefinitionCausesTransactionCommit
public boolean dataDefinitionCausesTransactionCommit() throws SQLException
- Does a data definition statement within a transaction force the
transaction to commit?
- Returns:
- true if so
dataDefinitionIgnoredInTransactions
public boolean dataDefinitionIgnoredInTransactions() throws SQLException
- Is a data definition statement within a transaction ignored?
- Returns:
- true if so
getProcedures
public synchronized ResultSet getProcedures(String catalog,
String schemaPattern,
String procedureNamePattern) throws SQLException
- Get a description of 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
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schemaPattern - a schema name pattern; "" retrieves those
without a schema
- procedureNamePattern - a procedure name pattern
- Returns:
- ResultSet each row is a procedure description
- See Also:
- getSearchStringEscape
getProcedureColumns
public synchronized ResultSet getProcedureColumns(String catalog,
String schemaPattern,
String procedureNamePattern,
String columnNamePattern) throws SQLException
- Get 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 desription 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
- 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.
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schemaPattern - a schema name pattern; "" retrieves those
without a schema
- procedureNamePattern - a procedure name pattern
- columnNamePattern - a column name pattern
- Returns:
- ResultSet each row is a stored procedure parameter or
column description
- See Also:
- getSearchStringEscape
getTables
public synchronized ResultSet getTables(String catalog,
String schemaPattern,
String tableNamePattern,
String types[]) throws SQLException
- Get 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".
- TABLE_REMARKS String => explanatory comment on the table
Note: Some databases may not return information for
all tables.
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schemaPattern - a schema name pattern; "" retrieves those
without a schema
- tableNamePattern - a table name pattern
- types - a list of table types to include; null returns all types
- Returns:
- ResultSet each row is a table description
- See Also:
- getSearchStringEscape
getSchemas
public ResultSet getSchemas() throws SQLException
- Get the schema names available in this database. The results
are ordered by schema name.
The schema column is:
- TABLE_SCHEM String => schema name
- Returns:
- ResultSet each row has a single String column that is a
schema name
getCatalogs
public ResultSet getCatalogs() throws SQLException
- Get the catalog names available in this database. The results
are ordered by catalog name.
The catalog column is:
- TABLE_CAT String => catalog name
- Returns:
- ResultSet each row has a single String column that is a
catalog name
getTableTypes
public ResultSet getTableTypes() throws SQLException
- Get the table types available in this database. The results
are ordered by table type.
The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- Returns:
- ResultSet each row has a single String column that is a
table type
getColumns
public synchronized ResultSet getColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern) throws SQLException
- Get a description of table columns available in a 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
- 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.
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schemaPattern - a schema name pattern; "" retrieves those
without a schema
- tableNamePattern - a table name pattern
- columnNamePattern - a column name pattern
- Returns:
- ResultSet each row is a column description
- See Also:
- getSearchStringEscape
getColumnPrivileges
public synchronized ResultSet getColumnPrivileges(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern) throws SQLException
- Get 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
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name; "" retrieves those without a schema
- table - a table name
- columnNamePattern - a column name pattern
- Returns:
- ResultSet each row is a column privilege description
- See Also:
- getSearchStringEscape
getTablePrivileges
public synchronized ResultSet getTablePrivileges(String catalog,
String schemaPattern,
String tableNamePattern) throws SQLException
- Get a description of the access rights for each table available
in a catalog.
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
- 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
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schemaPattern - a schema name pattern; "" retrieves those
without a schema
- tableNamePattern - a table name pattern
- Returns:
- ResultSet each row is a table privilege description
- See Also:
- getSearchStringEscape
getBestRowIdentifier
public synchronized ResultSet getBestRowIdentifier(String catalog,
String schema,
String table,
int scope,
boolean nullable) throws SQLException
- Get 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
- 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
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name; "" retrieves those without a schema
- table - a table name
- scope - the scope of interest; use same values as SCOPE
- nullable - include columns that are nullable?
- Returns:
- ResultSet each row is a column description
getVersionColumns
public synchronized ResultSet getVersionColumns(String catalog,
String schema,
String table) throws SQLException
- Get 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
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name; "" retrieves those without a schema
- table - a table name
- Returns:
- ResultSet each row is a column description
getPrimaryKeys
public ResultSet getPrimaryKeys(String catalog,
String schema,
String table) throws SQLException
- Get a description of a table's primary key columns. They
are ordered by COLUMN_NAME.
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
- KEY_SEQ short => sequence number within primary key
- PK_NAME String => primary key name (may be null)
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name pattern; "" retrieves those
without a schema
- table - a table name
- Returns:
- ResultSet each row is a primary key column description
getImportedKeys
public synchronized ResultSet getImportedKeys(String catalog,
String schema,
String table) throws SQLException
- Get 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:
- importedKeyCascade - change imported key to agree
with primary key update
- importedKeyRestrict - do not allow update of primary
key if it has been imported
- importedKeySetNull - change imported key to NULL if
its primary key has been updated
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyCascade - delete rows that import a deleted key
- importedKeyRestrict - do not allow delete of primary
key if it has been imported
- importedKeySetNull - change imported key to NULL 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)
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name pattern; "" retrieves those
without a schema
- table - a table name
- Returns:
- ResultSet each row is a primary key column description
- See Also:
- getExportedKeys
getExportedKeys
public ResultSet getExportedKeys(String catalog,
String schema,
String table) throws SQLException
- Get a description of a 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:
- importedKeyCascade - change imported key to agree
with primary key update
- importedKeyRestrict - do not allow update of primary
key if it has been imported
- importedKeySetNull - change imported key to NULL if
its primary key has been updated
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyCascade - delete rows that import a deleted key
- importedKeyRestrict - do not allow delete of primary
key if it has been imported
- importedKeySetNull - change imported key to NULL if
its primary key has been deleted
- FK_NAME String => foreign key identifier (may be null)
- PK_NAME String => primary key identifier (may be null)
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name pattern; "" retrieves those
without a schema
- table - a table name
- Returns:
- ResultSet each row is a foreign key column description
- See Also:
- getImportedKeys
getCrossReference
public ResultSet getCrossReference(String primaryCatalog,
String primarySchema,
String primaryTable,
String foreignCatalog,
String foreignSchema,
String foreignTable) throws SQLException
- Get 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:
- importedKeyCascade - change imported key to agree
with primary key update
- importedKeyRestrict - do not allow update of primary
key if it has been imported
- importedKeySetNull - change imported key to NULL if
its primary key has been updated
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyCascade - delete rows that import a deleted key
- importedKeyRestrict - do not allow delete of primary
key if it has been imported
- importedKeySetNull - change imported key to NULL if
its primary key has been deleted
- FK_NAME String => foreign key identifier (may be null)
- PK_NAME String => primary key identifier (may be null)
- Parameters:
- primaryCatalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- primarySchema - a schema name pattern; "" retrieves those
without a schema
- primaryTable - the table name that exports the key
- foreignCatalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- foreignSchema - a schema name pattern; "" retrieves those
without a schema
- foreignTable - the table name that imports the key
- Returns:
- ResultSet each row is a foreign key column description
- See Also:
- getImportedKeys
getTypeInfo
public ResultSet getTypeInfo() throws SQLException
- Get 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
- Returns:
- ResultSet each row is a SQL type description
getIndexInfo
public synchronized ResultSet getIndexInfo(String catalog,
String schema,
String table,
boolean unique,
boolean approximate) throws SQLException
- Get 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 tableIndexStatisic 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)
- Parameters:
- catalog - a catalog name; "" retrieves those without a
catalog; null means drop catalog name from the selection criteria
- schema - a schema name pattern; "" retrieves those without a schema
- table - a table name
- unique - when true, return only indices for unique values;
when false, return indices regardless of whether unique or not
- approximate - when true, result is allowed to reflect approximate
or out of data values; when false, results are requested to be
accurate
- Returns:
- ResultSet each row is an index column description
supportsResultSetType
public boolean supportsResultSetType(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.supportsResultSetType.
Does the database support the given result set type?
This method always return true.
- Parameters:
- type - defined in
java.sql.ResultSet
- Returns:
- true always
- Throws: SQLException
- if a database access error occurs
- See Also:
- Connection
supportsResultSetConcurrency
public boolean supportsResultSetConcurrency(int type,
int concurrency) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.supportsResultSetConcurrency.
Does the database support the concurrency type in combination
with the given result set type?
This method always return true.
- Parameters:
- type - defined in
java.sql.ResultSet
- concurrency - type defined in
java.sql.ResultSet
- Returns:
- true always
- Throws: SQLException
- if a database access error occurs
- See Also:
- Connection
ownUpdatesAreVisible
public boolean ownUpdatesAreVisible(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.ownUpdatesAreVisible.
Indicates whether a result set's own updates are visible.
Return true for scroll-insensitive and scroll-sensitive resultsets.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
-
true
if updates are visible for the result set type;
false
otherwise
- Throws: SQLException
- if a database access error occurs
ownDeletesAreVisible
public boolean ownDeletesAreVisible(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.ownDeletesAreVisible.
Indicates whether a result set's own deletes are visible.
Return true for scroll-insensitive and scroll-sensitive resultsets.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
-
true
if deletes are visible for the result set type;
false
otherwise
- Throws: SQLException
- if a database access error occurs
ownInsertsAreVisible
public boolean ownInsertsAreVisible(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.ownInsertsAreVisible.
Indicates whether a result set's own inserts are visible.
This method always return false in Oracle JDBC driver.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
-
true
if inserts are visible for the result set type;
false
otherwise
- Throws: SQLException
- if a database access error occurs
othersUpdatesAreVisible
public boolean othersUpdatesAreVisible(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData..
Indicates whether updates made by others are visible.
Return true for scroll-sensitive result sets; reutrn false otherwise.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
-
true
if updates made by others
are visible for the result set type; false
otherwise
- Throws: SQLException
- if a database access error occurs
othersDeletesAreVisible
public boolean othersDeletesAreVisible(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData..
Indicates whether deletes made by others are visible.
This method always return false since Oracle JDBC driver
doesn't make others changes visible.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
-
true
if deletes made by others
are visible for the result set type;
false
otherwise
- Throws: SQLException
- if a database access error occurs
othersInsertsAreVisible
public boolean othersInsertsAreVisible(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.othersInsertsAreVisible.
Indicates whether inserts made by others are visible.
This method always return false since Oracle JDBC driver
doesn't make others changes visible.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
- true if updates are visible for the result set type
- Throws: SQLException
- if a database access error occurs
updatesAreDetected
public boolean updatesAreDetected(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.updatesAreDetected.
Indicates whether or not a visible row update can be detected by
calling the method
ResultSet.rowUpdated
.
This method always return false since Oracle JDBC driver
doesn't detect row changes.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
-
true
if changes are detected by the result set type;
false
otherwise
- Throws: SQLException
- if a database access error occurs
deletesAreDetected
public boolean deletesAreDetected(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.deletesAreDetected.
Indicates whether or not a visible row delete can be detected by
calling ResultSet.rowDeleted().
This method always return false since Oracle JDBC driver
doesn't detect row changes.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
- true if changes are detected by the resultset type
- Throws: SQLException
- if a database access error occurs
insertsAreDetected
public boolean insertsAreDetected(int type) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.insertsAreDetected.
Indicates whether or not a visible row insert can be detected
by calling ResultSet.rowInserted().
This method always return false since Oracle JDBC driver
doesn't detect row changes.
- Parameters:
- result - set type, i.e. ResultSet.TYPE_XXX
- Returns:
- false always
- Throws: SQLException
- if a database access error occurs
supportsBatchUpdates
public boolean supportsBatchUpdates() throws SQLException
- Implements JDBC 2.0 DatabaseMetaData::supportBatchUpdates.
Indicates whether the driver supports batch updates.
- Returns:
- true if the driver supports batch updates; false otherwise
getUDTs
public ResultSet getUDTs(String catalog,
String schemaPattern,
String typeNamePattern,
int types[]) throws SQLException
- Implements JDBC 2.0 DatabaseMetaData::getUDTs.
Gets a description of the STRUCT types defined in a particular
schema.
Only types matching the 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 which is always null
- TYPE_SCHEM String => type's schema
- TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE String => type value defined in java.sql.Types.
Only STRUCT is supported.
- REMARKS String => explanatory comment on the type
- Parameters:
- catalog - is ignored since Oracle database doesn't support
catalog for structured types
- schemaPattern - a schema name pattern; "" retrieves those
without a schema
- typeNamePattern - a type name pattern; may be a fully-qualified
name
- types - a list of user-named types to include (Oracle only
STRUCT) supports; null returns all types
- Returns:
- ResultSet - each row is a type description
- Throws: SQLException
- if a database access error occurs
getConnection
public Connection getConnection() throws SQLException
- Implements JDBC 2.0 DatabaseMetaData.getConnection.
Retrieves the connection that produced this metadata object.
- Returns:
- the connection that produced this metadata object
getDriverNameInfo
public static String getDriverNameInfo() throws SQLException
- What's the name of this JDBC driver?
- Returns:
- JDBC driver name
getDriverVersionInfo
public static String getDriverVersionInfo() throws SQLException
- What's the version of this JDBC driver?
- Returns:
- JDBC driver version
getDriverMajorVersionInfo
public static int getDriverMajorVersionInfo()
- What's this JDBC driver's major version number?
- Returns:
- JDBC driver major version
getDriverMinorVersionInfo
public static int getDriverMinorVersionInfo()
- What's this JDBC driver's minor version number?
- Returns:
- JDBC driver minor version number
All Packages Class Hierarchy This Package Previous Next Index