Oracle JDBC API Reference
11g Release 2 ("11.2.0.3.0")

oracle.jdbc
Class OracleDatabaseMetaData

java.lang.Object
  extended by oracle.jdbc.OracleDatabaseMetaData
All Implemented Interfaces:
java.sql.DatabaseMetaData, AdditionalDatabaseMetaData

public class OracleDatabaseMetaData
extends java.lang.Object
implements AdditionalDatabaseMetaData

The oracle.jdbc.OracleDatabaseMetaData class along with oracle.jdbc.driver.OracleDatabaseMetaData implement the JDBC 3.0 DatabaseMetaData interface and in ojdbc6.jar and above, the JDBC4.0 DatabaseMetaData interface. Note that the object returned by a call to java.sql.Connection.getMetaData() for a connection from the Oracle driver will be an instance of oracle.jdbc.driver.OracleDatabaseMetaData. There are several proprietary methods which are defined in this class. Only public long getLobMaxLength() will be retained in future versions. The following are superseeded by standard methods public static int getDriverMajorVersionInfo public static int getDriverMinorVersionInfo public static String getDriverVersionInfo and are deprecated. public String getLobPrecision() is no longer meaningful and is deprecated.


Field Summary
static java.lang.String BUILD_DATE
           
static boolean TRACE
           
 
Fields inherited from interface java.sql.DatabaseMetaData
importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeySetDefault
 
Constructor Summary
OracleDatabaseMetaData(OracleConnection conn)
          Deprecated. -- Please use the factory method java.sql.Connection.getMetaData()
 
Method Summary
 boolean allProceduresAreCallable()
          Can all the procedures returned by getProcedures be called by the current user?
 boolean allTablesAreSelectable()
          Can all the tables returned by getTable be SELECTed by the current user?
 boolean 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)
          Implements JDBC 2.0 DatabaseMetaData.deletesAreDetected.
 boolean doesMaxRowSizeIncludeBlobs()
          Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
 java.sql.ResultSet getAttributes(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typeNamePattern, java.lang.String attributeNamePattern)
          JDBC 3.0 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)
          Get a description of a table's optimal set of columns that uniquely identifies a row.
 java.sql.ResultSet getCatalogs()
          Get 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 getColumnPrivileges(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern)
          Get 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)
          Get a description of table columns available in a catalog.
 java.sql.Connection getConnection()
          Implements JDBC 2.0 DatabaseMetaData.getConnection.
 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)
          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.
 int getDatabaseMajorVersion()
          JDBC 3.0 Retrieves the major version number of the underlying database.
 int getDatabaseMinorVersion()
          JDBC 3.0 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()
          What's the database's default transaction isolation level? The values are defined in java.sql.Connection.
 int getDriverMajorVersion()
          What's this JDBC driver's major version number?
static int getDriverMajorVersionInfo()
          Deprecated. -- use standard getDriverMajorVersion()
 int getDriverMinorVersion()
          What's this JDBC driver's minor version number?
static int getDriverMinorVersionInfo()
          Deprecated. -- use JDBC standard method getDriverMinorVersion
 java.lang.String getDriverName()
          What's the name of this JDBC driver?
static java.lang.String getDriverNameInfo()
          What's the name of this JDBC driver?
 java.lang.String getDriverVersion()
          What's the version of this JDBC driver?
static java.lang.String getDriverVersionInfo()
          Deprecated. -- use standard getDriverVersion()
 java.sql.ResultSet getExportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String table)
          Get a description of a foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).
 java.lang.String getExtraNameCharacters()
          Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, 0-9 and _).
 java.lang.String getIdentifierQuoteString()
          What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting isn't supported.
 java.sql.ResultSet getImportedKeys(java.lang.String catalog, java.lang.String schema, java.lang.String table)
          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).
 java.sql.ResultSet getIndexInfo(java.lang.String catalog, java.lang.String schema, java.lang.String table, boolean unique, boolean approximate)
          Get a description of a table's indices and statistics.
 int getJDBCMajorVersion()
          JDBC 3.0 Retrieves the major JDBC version number for this driver.
 int getJDBCMinorVersion()
          JDBC 3.0 Retrieves the minor JDBC version number for this driver.
 long getLobMaxLength()
          The max size of a lob on the server for this connection.
static java.lang.String getLobPrecision()
          Deprecated.  
 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 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()
          What's the maximum length of an index (in bytes)?
 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 a 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?
 int getMaxUserNameLength()
          What's the maximum length of a user name?
 java.lang.String getNumericFunctions()
          Get a comma separated list of math functions.
 OracleTypeMetaData getOracleTypeMetaData(java.lang.String sqlTypeName)
          Return the type metadata for a named type.
 java.sql.ResultSet getPrimaryKeys(java.lang.String catalog, java.lang.String schema, java.lang.String table)
          Get 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)
          Get 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)
          Get a description of stored procedures available in a catalog.
 java.lang.String getProcedureTerm()
          What's the database vendor's preferred term for "procedure"?
 int getResultSetHoldability()
          JDBC 3.0 Retrieves the default holdability of this ResultSet object.
 java.sql.ResultSet getSchemas()
          Get the schema names available in this database.
 java.lang.String getSchemaTerm()
          What's the database vendor's preferred term for "schema"?
 java.lang.String getSearchStringEscape()
          This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters.
 java.lang.String getSQLKeywords()
          Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
 int getSQLStateType()
          JDBC 3.0 Indicates whether the SQLSTATEs returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.
 java.lang.String getStringFunctions()
          Get a comma separated list of string functions.
 java.sql.ResultSet getSuperTables(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern)
          JDBC 3.0 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)
          JDBC 3.0 Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
 java.lang.String getSystemFunctions()
          Get a comma separated list of system functions.
 java.sql.ResultSet getTablePrivileges(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern)
          Get 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)
          Get a description of tables available in a catalog.
 java.sql.ResultSet getTableTypes()
          Get the table types available in this database.
 java.lang.String getTimeDateFunctions()
          Get a comma separated list of time and date functions.
 java.sql.ResultSet getTypeInfo()
          Get 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)
          Implements JDBC 2.0 DatabaseMetaData::getUDTs.
 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)
          Get a description of a table's columns that are automatically updated when any value in a row is updated.
 boolean insertsAreDetected(int type)
          Implements JDBC 2.0 DatabaseMetaData.insertsAreDetected.
 boolean isCatalogAtStart()
          Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end)
 boolean isReadOnly()
          Is the database in read-only mode?
 boolean locatorsUpdateCopy()
          JDBC 3.0
 boolean nullPlusNonNullIsNull()
          Are concatenations between NULL and non-NULL values NULL? A JDBC compliant driver always returns true.
 boolean nullsAreSortedAtEnd()
          Are NULL values sorted at the end regardless of sort order?
 boolean nullsAreSortedAtStart()
          Are NULL values sorted at the start regardless of sort order?
 boolean nullsAreSortedHigh()
          Are NULL values sorted high?
 boolean nullsAreSortedLow()
          Are NULL values sorted low?
 boolean othersDeletesAreVisible(int type)
          Implements JDBC 2.0 DatabaseMetaData..
 boolean othersInsertsAreVisible(int type)
          Implements JDBC 2.0 DatabaseMetaData.othersInsertsAreVisible.
 boolean othersUpdatesAreVisible(int type)
          Implements JDBC 2.0 DatabaseMetaData..
 boolean ownDeletesAreVisible(int type)
          Implements JDBC 2.0 DatabaseMetaData.ownDeletesAreVisible.
 boolean ownInsertsAreVisible(int type)
          Implements JDBC 2.0 DatabaseMetaData.ownInsertsAreVisible.
 boolean ownUpdatesAreVisible(int type)
          Implements JDBC 2.0 DatabaseMetaData.ownUpdatesAreVisible.
 boolean storesLowerCaseIdentifiers()
          Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?
 boolean storesLowerCaseQuotedIdentifiers()
          Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?
 boolean storesMixedCaseIdentifiers()
          Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?
 boolean storesMixedCaseQuotedIdentifiers()
          Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?
 boolean storesUpperCaseIdentifiers()
          Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?
 boolean storesUpperCaseQuotedIdentifiers()
          Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?
 boolean supportsAlterTableWithAddColumn()
          Is "ALTER TABLE" with add column supported?
 boolean supportsAlterTableWithDropColumn()
          Is "ALTER TABLE" with drop column supported?
 boolean supportsANSI92EntryLevelSQL()
          Is the ANSI92 entry level SQL grammar supported? All JDBC compliant drivers must return true.
 boolean supportsANSI92FullSQL()
          Is the ANSI92 full SQL grammar supported?
 boolean supportsANSI92IntermediateSQL()
          Is the ANSI92 intermediate SQL grammar supported?
 boolean supportsBatchUpdates()
          Implements JDBC 2.0 DatabaseMetaData::supportBatchUpdates.
 boolean supportsCatalogsInDataManipulation()
          Can a catalog name be used in a data manipulation statement?
 boolean supportsCatalogsInIndexDefinitions()
          Can a catalog name be used in a 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()
          Is column aliasing supported?
 boolean supportsConvert()
          Is the CONVERT function between SQL types supported?
 boolean supportsConvert(int fromType, int toType)
          Is CONVERT between the given SQL types supported?
 boolean supportsCoreSQLGrammar()
          Is the ODBC Core SQL grammar supported?
 boolean supportsCorrelatedSubqueries()
          Are correlated subqueries supported? A JDBC compliant driver always returns true.
 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()
          JDBC 3.0 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()
          Can a "GROUP BY" clause 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()
          Is the escape character in "LIKE" clauses supported? A JDBC compliant driver always returns true.
 boolean supportsLimitedOuterJoins()
          Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)
 boolean supportsMinimumSQLGrammar()
          Is the ODBC Minimum SQL grammar supported? All JDBC compliant drivers must return true.
 boolean 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.
 boolean 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.
 boolean supportsMultipleOpenResults()
          JDBC 3.0 Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.
 boolean supportsMultipleResultSets()
          Are multiple ResultSets from a single execute supported?
 boolean supportsMultipleTransactions()
          Can we have multiple transactions open at once (on different connections)?
 boolean supportsNamedParameters()
          JDBC 3.0 Retrieves whether this database supports named parameters to callable statements.
 boolean supportsNonNullableColumns()
          Can columns be defined as non-nullable? A JDBC compliant driver always returns true.
 boolean supportsOpenCursorsAcrossCommit()
          Can cursors remain open across commits?
 boolean supportsOpenCursorsAcrossRollback()
          Can cursors remain open across rollbacks?
 boolean supportsOpenStatementsAcrossCommit()
          Can statements remain open across commits?
 boolean supportsOpenStatementsAcrossRollback()
          Can statements remain open across rollbacks?
 boolean supportsOrderByUnrelated()
          Can an "ORDER BY" clause use columns not in the SELECT?
 boolean supportsOuterJoins()
          Is some form of outer join supported?
 boolean supportsPositionedDelete()
          Is positioned DELETE supported? NOTE: Though Oracle supports positional delete through the use of ROWID positional delete as specified by SQLJ92 standard is not supported which is being followed by JDBC 2.1 API Spec.
 boolean supportsPositionedUpdate()
          Is positioned UPDATE supported? NOTE: Though Oracle supports positional updates through the use of ROWID positional updates as specified by SQLJ92 standard is not supported which is being followed by JDBC 2.1 API Spec.
 boolean supportsResultSetConcurrency(int type, int concurrency)
          Implements JDBC 2.0 DatabaseMetaData.supportsResultSetConcurrency.
 boolean supportsResultSetHoldability(int holdability)
          JDBC 3.0 Retrieves whether this database supports the given result set holdability.
 boolean supportsResultSetType(int type)
          Implements JDBC 2.0 DatabaseMetaData.supportsResultSetType.
 boolean supportsSavepoints()
          JDBC 3.0 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()
          JDBC 3.0
 boolean supportsStoredProcedures()
          Are stored procedure calls using the stored procedure escape syntax supported?
 boolean supportsSubqueriesInComparisons()
          Are subqueries in comparison expressions supported? A JDBC compliant driver always returns true.
 boolean supportsSubqueriesInExists()
          Are subqueries in exists expressions supported? A JDBC compliant driver always returns true.
 boolean supportsSubqueriesInIns()
          Are subqueries in "in" statements supported? A JDBC compliant driver always returns true.
 boolean supportsSubqueriesInQuantifieds()
          Are subqueries in quantified expressions supported? A JDBC compliant driver always returns true.
 boolean supportsTableCorrelationNames()
          Are table correlation names supported? A JDBC compliant driver always returns true.
 boolean supportsTransactionIsolationLevel(int level)
          Does the database support the given transaction isolation level?
 boolean supportsTransactions()
          Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.
 boolean supportsUnion()
          Is SQL UNION supported?
 boolean supportsUnionAll()
          Is SQL UNION ALL supported?
 boolean updatesAreDetected(int type)
          Implements JDBC 2.0 DatabaseMetaData.updatesAreDetected.
 boolean usesLocalFilePerTable()
          Does the database use a file for each table?
 boolean usesLocalFiles()
          Does the database store tables in a local file?
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BUILD_DATE

public static final java.lang.String BUILD_DATE
See Also:
Constant Field Values

TRACE

public static final boolean TRACE
See Also:
Constant Field Values
Constructor Detail

OracleDatabaseMetaData

public OracleDatabaseMetaData(OracleConnection conn)
Deprecated. -- Please use the factory method java.sql.Connection.getMetaData()

Method Detail

allProceduresAreCallable

public boolean allProceduresAreCallable()
                                 throws java.sql.SQLException
Can all the procedures returned by getProcedures be called by the current user?

Specified by:
allProceduresAreCallable in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

allTablesAreSelectable

public boolean allTablesAreSelectable()
                               throws java.sql.SQLException
Can all the tables returned by getTable be SELECTed by the current user?

Specified by:
allTablesAreSelectable in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

getURL

public java.lang.String getURL()
                        throws java.sql.SQLException
What's the url for this database?

Specified by:
getURL in interface java.sql.DatabaseMetaData
Returns:
the url or null if it can't be generated
Throws:
java.sql.SQLException

getUserName

public java.lang.String getUserName()
                             throws java.sql.SQLException
What's our user name as known to the database?

Specified by:
getUserName in interface java.sql.DatabaseMetaData
Returns:
our database user name
Throws:
java.sql.SQLException

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
Is the database in read-only mode?

Specified by:
isReadOnly in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

nullsAreSortedHigh

public boolean nullsAreSortedHigh()
                           throws java.sql.SQLException
Are NULL values sorted high?

Specified by:
nullsAreSortedHigh in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

nullsAreSortedLow

public boolean nullsAreSortedLow()
                          throws java.sql.SQLException
Are NULL values sorted low?

Specified by:
nullsAreSortedLow in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

nullsAreSortedAtStart

public boolean nullsAreSortedAtStart()
                              throws java.sql.SQLException
Are NULL values sorted at the start regardless of sort order?

Specified by:
nullsAreSortedAtStart in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

nullsAreSortedAtEnd

public boolean nullsAreSortedAtEnd()
                            throws java.sql.SQLException
Are NULL values sorted at the end regardless of sort order?

Specified by:
nullsAreSortedAtEnd in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

getDatabaseProductName

public java.lang.String getDatabaseProductName()
                                        throws java.sql.SQLException
What's the name of this database product?

Specified by:
getDatabaseProductName in interface java.sql.DatabaseMetaData
Returns:
database product name
Throws:
java.sql.SQLException

getDatabaseProductVersion

public java.lang.String getDatabaseProductVersion()
                                           throws java.sql.SQLException
What's the version of this database product?

Specified by:
getDatabaseProductVersion in interface java.sql.DatabaseMetaData
Returns:
database version
Throws:
java.sql.SQLException

getDriverName

public java.lang.String getDriverName()
                               throws java.sql.SQLException
What's the name of this JDBC driver?

Specified by:
getDriverName in interface java.sql.DatabaseMetaData
Returns:
JDBC driver name
Throws:
java.sql.SQLException

getDriverVersion

public java.lang.String getDriverVersion()
                                  throws java.sql.SQLException
What's the version of this JDBC driver?

Specified by:
getDriverVersion in interface java.sql.DatabaseMetaData
Returns:
JDBC driver version
Throws:
java.sql.SQLException

getDriverMajorVersion

public int getDriverMajorVersion()
What's this JDBC driver's major version number?

Specified by:
getDriverMajorVersion in interface java.sql.DatabaseMetaData
Returns:
JDBC driver major version

getDriverMinorVersion

public int getDriverMinorVersion()
What's this JDBC driver's minor version number?

Specified by:
getDriverMinorVersion in interface java.sql.DatabaseMetaData
Returns:
JDBC driver minor version number

usesLocalFiles

public boolean usesLocalFiles()
                       throws java.sql.SQLException
Does the database store tables in a local file?

Specified by:
usesLocalFiles in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

usesLocalFilePerTable

public boolean usesLocalFilePerTable()
                              throws java.sql.SQLException
Does the database use a file for each table?

Specified by:
usesLocalFilePerTable in interface java.sql.DatabaseMetaData
Returns:
true if the database uses a local file for each table
Throws:
java.sql.SQLException

supportsMixedCaseIdentifiers

public boolean supportsMixedCaseIdentifiers()
                                     throws java.sql.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.

Specified by:
supportsMixedCaseIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

storesUpperCaseIdentifiers

public boolean storesUpperCaseIdentifiers()
                                   throws java.sql.SQLException
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?

Specified by:
storesUpperCaseIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

storesLowerCaseIdentifiers

public boolean storesLowerCaseIdentifiers()
                                   throws java.sql.SQLException
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?

Specified by:
storesLowerCaseIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

storesMixedCaseIdentifiers

public boolean storesMixedCaseIdentifiers()
                                   throws java.sql.SQLException
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?

Specified by:
storesMixedCaseIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsMixedCaseQuotedIdentifiers

public boolean supportsMixedCaseQuotedIdentifiers()
                                           throws java.sql.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.

Specified by:
supportsMixedCaseQuotedIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

storesUpperCaseQuotedIdentifiers

public boolean storesUpperCaseQuotedIdentifiers()
                                         throws java.sql.SQLException
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?

Specified by:
storesUpperCaseQuotedIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

storesLowerCaseQuotedIdentifiers

public boolean storesLowerCaseQuotedIdentifiers()
                                         throws java.sql.SQLException
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?

Specified by:
storesLowerCaseQuotedIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

storesMixedCaseQuotedIdentifiers

public boolean storesMixedCaseQuotedIdentifiers()
                                         throws java.sql.SQLException
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?

Specified by:
storesMixedCaseQuotedIdentifiers in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

getIdentifierQuoteString

public java.lang.String getIdentifierQuoteString()
                                          throws java.sql.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.

Specified by:
getIdentifierQuoteString in interface java.sql.DatabaseMetaData
Returns:
the quoting string
Throws:
java.sql.SQLException

getSQLKeywords

public java.lang.String getSQLKeywords()
                                throws java.sql.SQLException
Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.

Specified by:
getSQLKeywords in interface java.sql.DatabaseMetaData
Returns:
the list
Throws:
java.sql.SQLException

getNumericFunctions

public java.lang.String getNumericFunctions()
                                     throws java.sql.SQLException
Get a comma separated list of math functions. The following are supported

Specified by:
getNumericFunctions in interface java.sql.DatabaseMetaData
Returns:
the list
Throws:
java.sql.SQLException

getStringFunctions

public java.lang.String getStringFunctions()
                                    throws java.sql.SQLException
Get a comma separated list of string functions. The following are supported In addition, the following are supported in a JDBC 4.0 environment

Specified by:
getStringFunctions in interface java.sql.DatabaseMetaData
Returns:
the list
Throws:
java.sql.SQLException

getSystemFunctions

public java.lang.String getSystemFunctions()
                                    throws java.sql.SQLException
Get a comma separated list of system functions. The following are supported

Specified by:
getSystemFunctions in interface java.sql.DatabaseMetaData
Returns:
the list
Throws:
java.sql.SQLException

getTimeDateFunctions

public java.lang.String getTimeDateFunctions()
                                      throws java.sql.SQLException
Get a comma separated list of time and date functions. The following are supported In addition, the following are supported in a JDBC 4.0 environment.

Specified by:
getTimeDateFunctions in interface java.sql.DatabaseMetaData
Returns:
the list
Throws:
java.sql.SQLException

getSearchStringEscape

public java.lang.String getSearchStringEscape()
                                       throws java.sql.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.

Specified by:
getSearchStringEscape in interface java.sql.DatabaseMetaData
Returns:
the string used to escape wildcard characters
Throws:
java.sql.SQLException

getExtraNameCharacters

public java.lang.String getExtraNameCharacters()
                                        throws java.sql.SQLException
Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, 0-9 and _).

Specified by:
getExtraNameCharacters in interface java.sql.DatabaseMetaData
Returns:
the string containing the extra characters
Throws:
java.sql.SQLException

supportsAlterTableWithAddColumn

public boolean supportsAlterTableWithAddColumn()
                                        throws java.sql.SQLException
Is "ALTER TABLE" with add column supported?

Specified by:
supportsAlterTableWithAddColumn in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsAlterTableWithDropColumn

public boolean supportsAlterTableWithDropColumn()
                                         throws java.sql.SQLException
Is "ALTER TABLE" with drop column supported?

Specified by:
supportsAlterTableWithDropColumn in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsColumnAliasing

public boolean supportsColumnAliasing()
                               throws java.sql.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.

Specified by:
supportsColumnAliasing in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

nullPlusNonNullIsNull

public boolean nullPlusNonNullIsNull()
                              throws java.sql.SQLException
Are concatenations between NULL and non-NULL values NULL? A JDBC compliant driver always returns true.

Specified by:
nullPlusNonNullIsNull in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsConvert

public boolean supportsConvert()
                        throws java.sql.SQLException
Is the CONVERT function between SQL types supported?

Specified by:
supportsConvert in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsConvert

public boolean supportsConvert(int fromType,
                               int toType)
                        throws java.sql.SQLException
Is CONVERT between the given SQL types supported?

Specified by:
supportsConvert in interface java.sql.DatabaseMetaData
Parameters:
fromType - the type to convert from
toType - the type to convert to
Returns:
true if so
Throws:
java.sql.SQLException
See Also:
Types

supportsTableCorrelationNames

public boolean supportsTableCorrelationNames()
                                      throws java.sql.SQLException
Are table correlation names supported? A JDBC compliant driver always returns true.

Specified by:
supportsTableCorrelationNames in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsDifferentTableCorrelationNames

public 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 interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsExpressionsInOrderBy

public boolean supportsExpressionsInOrderBy()
                                     throws java.sql.SQLException
Are expressions in "ORDER BY" lists supported?

Specified by:
supportsExpressionsInOrderBy in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsOrderByUnrelated

public boolean supportsOrderByUnrelated()
                                 throws java.sql.SQLException
Can an "ORDER BY" clause use columns not in the SELECT?

Specified by:
supportsOrderByUnrelated in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsGroupBy

public boolean supportsGroupBy()
                        throws java.sql.SQLException
Is some form of "GROUP BY" clause supported?

Specified by:
supportsGroupBy in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsGroupByUnrelated

public boolean supportsGroupByUnrelated()
                                 throws java.sql.SQLException
Can a "GROUP BY" clause use columns not in the SELECT?

Specified by:
supportsGroupByUnrelated in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsGroupByBeyondSelect

public boolean supportsGroupByBeyondSelect()
                                    throws java.sql.SQLException
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?

Specified by:
supportsGroupByBeyondSelect in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsLikeEscapeClause

public boolean supportsLikeEscapeClause()
                                 throws java.sql.SQLException
Is the escape character in "LIKE" clauses supported? A JDBC compliant driver always returns true.

Specified by:
supportsLikeEscapeClause in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsMultipleResultSets

public boolean supportsMultipleResultSets()
                                   throws java.sql.SQLException
Are multiple ResultSets from a single execute supported?

Specified by:
supportsMultipleResultSets in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsMultipleTransactions

public boolean supportsMultipleTransactions()
                                     throws java.sql.SQLException
Can we have multiple transactions open at once (on different connections)?

Specified by:
supportsMultipleTransactions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsNonNullableColumns

public boolean supportsNonNullableColumns()
                                   throws java.sql.SQLException
Can columns be defined as non-nullable? A JDBC compliant driver always returns true.

Specified by:
supportsNonNullableColumns in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsMinimumSQLGrammar

public boolean supportsMinimumSQLGrammar()
                                  throws java.sql.SQLException
Is the ODBC Minimum SQL grammar supported? All JDBC compliant drivers must return true.

Specified by:
supportsMinimumSQLGrammar in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCoreSQLGrammar

public boolean supportsCoreSQLGrammar()
                               throws java.sql.SQLException
Is the ODBC Core SQL grammar supported?

Specified by:
supportsCoreSQLGrammar in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsExtendedSQLGrammar

public boolean supportsExtendedSQLGrammar()
                                   throws java.sql.SQLException
Is the ODBC Extended SQL grammar supported?

Specified by:
supportsExtendedSQLGrammar in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsANSI92EntryLevelSQL

public boolean supportsANSI92EntryLevelSQL()
                                    throws java.sql.SQLException
Is the ANSI92 entry level SQL grammar supported? All JDBC compliant drivers must return true.

Specified by:
supportsANSI92EntryLevelSQL in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsANSI92IntermediateSQL

public boolean supportsANSI92IntermediateSQL()
                                      throws java.sql.SQLException
Is the ANSI92 intermediate SQL grammar supported?

Specified by:
supportsANSI92IntermediateSQL in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsANSI92FullSQL

public boolean supportsANSI92FullSQL()
                              throws java.sql.SQLException
Is the ANSI92 full SQL grammar supported?

Specified by:
supportsANSI92FullSQL in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsIntegrityEnhancementFacility

public boolean supportsIntegrityEnhancementFacility()
                                             throws java.sql.SQLException
Is the SQL Integrity Enhancement Facility supported?

Specified by:
supportsIntegrityEnhancementFacility in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsOuterJoins

public boolean supportsOuterJoins()
                           throws java.sql.SQLException
Is some form of outer join supported?

Specified by:
supportsOuterJoins in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsFullOuterJoins

public boolean supportsFullOuterJoins()
                               throws java.sql.SQLException
Are full nested outer joins supported?

Specified by:
supportsFullOuterJoins in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsLimitedOuterJoins

public boolean supportsLimitedOuterJoins()
                                  throws java.sql.SQLException
Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)

Specified by:
supportsLimitedOuterJoins in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

getSchemaTerm

public java.lang.String getSchemaTerm()
                               throws java.sql.SQLException
What's the database vendor's preferred term for "schema"?

Specified by:
getSchemaTerm in interface java.sql.DatabaseMetaData
Returns:
the vendor term
Throws:
java.sql.SQLException

getProcedureTerm

public java.lang.String getProcedureTerm()
                                  throws java.sql.SQLException
What's the database vendor's preferred term for "procedure"?

Specified by:
getProcedureTerm in interface java.sql.DatabaseMetaData
Returns:
the vendor term
Throws:
java.sql.SQLException

getCatalogTerm

public java.lang.String getCatalogTerm()
                                throws java.sql.SQLException
What's the database vendor's preferred term for "catalog"?

Specified by:
getCatalogTerm in interface java.sql.DatabaseMetaData
Returns:
the vendor term
Throws:
java.sql.SQLException

isCatalogAtStart

public boolean isCatalogAtStart()
                         throws java.sql.SQLException
Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end)

Specified by:
isCatalogAtStart in interface java.sql.DatabaseMetaData
Returns:
true if it appears at the start
Throws:
java.sql.SQLException

getCatalogSeparator

public java.lang.String getCatalogSeparator()
                                     throws java.sql.SQLException
What's the separator between catalog and table name?

Specified by:
getCatalogSeparator in interface java.sql.DatabaseMetaData
Returns:
the separator string
Throws:
java.sql.SQLException

supportsSchemasInDataManipulation

public boolean supportsSchemasInDataManipulation()
                                          throws java.sql.SQLException
Can a schema name be used in a data manipulation statement?

Specified by:
supportsSchemasInDataManipulation in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSchemasInProcedureCalls

public boolean supportsSchemasInProcedureCalls()
                                        throws java.sql.SQLException
Can a schema name be used in a procedure call statement?

Specified by:
supportsSchemasInProcedureCalls in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSchemasInTableDefinitions

public boolean supportsSchemasInTableDefinitions()
                                          throws java.sql.SQLException
Can a schema name be used in a table definition statement?

Specified by:
supportsSchemasInTableDefinitions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSchemasInIndexDefinitions

public boolean supportsSchemasInIndexDefinitions()
                                          throws java.sql.SQLException
Can a schema name be used in an index definition statement?

Specified by:
supportsSchemasInIndexDefinitions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSchemasInPrivilegeDefinitions

public boolean supportsSchemasInPrivilegeDefinitions()
                                              throws java.sql.SQLException
Can a schema name be used in a privilege definition statement?

Specified by:
supportsSchemasInPrivilegeDefinitions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCatalogsInDataManipulation

public boolean supportsCatalogsInDataManipulation()
                                           throws java.sql.SQLException
Can a catalog name be used in a data manipulation statement?

Specified by:
supportsCatalogsInDataManipulation in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCatalogsInProcedureCalls

public boolean supportsCatalogsInProcedureCalls()
                                         throws java.sql.SQLException
Can a catalog name be used in a procedure call statement?

Specified by:
supportsCatalogsInProcedureCalls in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCatalogsInTableDefinitions

public boolean supportsCatalogsInTableDefinitions()
                                           throws java.sql.SQLException
Can a catalog name be used in a table definition statement?

Specified by:
supportsCatalogsInTableDefinitions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCatalogsInIndexDefinitions

public boolean supportsCatalogsInIndexDefinitions()
                                           throws java.sql.SQLException
Can a catalog name be used in a index definition statement?

Specified by:
supportsCatalogsInIndexDefinitions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCatalogsInPrivilegeDefinitions

public boolean supportsCatalogsInPrivilegeDefinitions()
                                               throws java.sql.SQLException
Can a catalog name be used in a privilege definition statement?

Specified by:
supportsCatalogsInPrivilegeDefinitions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsPositionedDelete

public boolean supportsPositionedDelete()
                                 throws java.sql.SQLException
Is positioned DELETE supported? NOTE: Though Oracle supports positional delete through the use of ROWID positional delete as specified by SQLJ92 standard is not supported which is being followed by JDBC 2.1 API Spec.

Specified by:
supportsPositionedDelete in interface java.sql.DatabaseMetaData
Returns:
false
Throws:
java.sql.SQLException

supportsPositionedUpdate

public boolean supportsPositionedUpdate()
                                 throws java.sql.SQLException
Is positioned UPDATE supported? NOTE: Though Oracle supports positional updates through the use of ROWID positional updates as specified by SQLJ92 standard is not supported which is being followed by JDBC 2.1 API Spec.

Specified by:
supportsPositionedUpdate in interface java.sql.DatabaseMetaData
Returns:
false
Throws:
java.sql.SQLException

supportsSelectForUpdate

public boolean supportsSelectForUpdate()
                                throws java.sql.SQLException
Is SELECT for UPDATE supported?

Specified by:
supportsSelectForUpdate in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsStoredProcedures

public boolean supportsStoredProcedures()
                                 throws java.sql.SQLException
Are stored procedure calls using the stored procedure escape syntax supported?

Specified by:
supportsStoredProcedures in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSubqueriesInComparisons

public boolean supportsSubqueriesInComparisons()
                                        throws java.sql.SQLException
Are subqueries in comparison expressions supported? A JDBC compliant driver always returns true.

Specified by:
supportsSubqueriesInComparisons in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSubqueriesInExists

public boolean supportsSubqueriesInExists()
                                   throws java.sql.SQLException
Are subqueries in exists expressions supported? A JDBC compliant driver always returns true.

Specified by:
supportsSubqueriesInExists in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSubqueriesInIns

public boolean supportsSubqueriesInIns()
                                throws java.sql.SQLException
Are subqueries in "in" statements supported? A JDBC compliant driver always returns true.

Specified by:
supportsSubqueriesInIns in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsSubqueriesInQuantifieds

public boolean supportsSubqueriesInQuantifieds()
                                        throws java.sql.SQLException
Are subqueries in quantified expressions supported? A JDBC compliant driver always returns true.

Specified by:
supportsSubqueriesInQuantifieds in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsCorrelatedSubqueries

public boolean supportsCorrelatedSubqueries()
                                     throws java.sql.SQLException
Are correlated subqueries supported? A JDBC compliant driver always returns true.

Specified by:
supportsCorrelatedSubqueries in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsUnion

public boolean supportsUnion()
                      throws java.sql.SQLException
Is SQL UNION supported?

Specified by:
supportsUnion in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsUnionAll

public boolean supportsUnionAll()
                         throws java.sql.SQLException
Is SQL UNION ALL supported?

Specified by:
supportsUnionAll in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsOpenCursorsAcrossCommit

public boolean supportsOpenCursorsAcrossCommit()
                                        throws java.sql.SQLException
Can cursors remain open across commits?

Specified by:
supportsOpenCursorsAcrossCommit in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException
See Also:
Connection#disableAutoClose

supportsOpenCursorsAcrossRollback

public boolean supportsOpenCursorsAcrossRollback()
                                          throws java.sql.SQLException
Can cursors remain open across rollbacks?

Specified by:
supportsOpenCursorsAcrossRollback in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException
See Also:
Connection#disableAutoClose

supportsOpenStatementsAcrossCommit

public boolean supportsOpenStatementsAcrossCommit()
                                           throws java.sql.SQLException
Can statements remain open across commits?

Specified by:
supportsOpenStatementsAcrossCommit in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException
See Also:
Connection#disableAutoClose

supportsOpenStatementsAcrossRollback

public boolean supportsOpenStatementsAcrossRollback()
                                             throws java.sql.SQLException
Can statements remain open across rollbacks?

Specified by:
supportsOpenStatementsAcrossRollback in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException
See Also:
Connection#disableAutoClose

getMaxBinaryLiteralLength

public int getMaxBinaryLiteralLength()
                              throws java.sql.SQLException
How many hex characters can you have in an inline binary literal?

Specified by:
getMaxBinaryLiteralLength in interface java.sql.DatabaseMetaData
Returns:
max literal length
Throws:
java.sql.SQLException

getMaxCharLiteralLength

public int getMaxCharLiteralLength()
                            throws java.sql.SQLException
What's the max length for a character literal?

Specified by:
getMaxCharLiteralLength in interface java.sql.DatabaseMetaData
Returns:
max literal length
Throws:
java.sql.SQLException

getMaxColumnNameLength

public int getMaxColumnNameLength()
                           throws java.sql.SQLException
What's the limit on column name length?

Specified by:
getMaxColumnNameLength in interface java.sql.DatabaseMetaData
Returns:
max literal length
Throws:
java.sql.SQLException

getMaxColumnsInGroupBy

public int getMaxColumnsInGroupBy()
                           throws java.sql.SQLException
What's the maximum number of columns in a "GROUP BY" clause?

Specified by:
getMaxColumnsInGroupBy in interface java.sql.DatabaseMetaData
Returns:
max number of columns
Throws:
java.sql.SQLException

getMaxColumnsInIndex

public int getMaxColumnsInIndex()
                         throws java.sql.SQLException
What's the maximum number of columns allowed in an index?

Specified by:
getMaxColumnsInIndex in interface java.sql.DatabaseMetaData
Returns:
max columns
Throws:
java.sql.SQLException

getMaxColumnsInOrderBy

public int getMaxColumnsInOrderBy()
                           throws java.sql.SQLException
What's the maximum number of columns in an "ORDER BY" clause?

Specified by:
getMaxColumnsInOrderBy in interface java.sql.DatabaseMetaData
Returns:
max columns
Throws:
java.sql.SQLException

getMaxColumnsInSelect

public int getMaxColumnsInSelect()
                          throws java.sql.SQLException
What's the maximum number of columns in a "SELECT" list?

Specified by:
getMaxColumnsInSelect in interface java.sql.DatabaseMetaData
Returns:
max columns
Throws:
java.sql.SQLException

getMaxColumnsInTable

public int getMaxColumnsInTable()
                         throws java.sql.SQLException
What's maximum number of columns in a table?

Specified by:
getMaxColumnsInTable in interface java.sql.DatabaseMetaData
Returns:
max columns
Throws:
java.sql.SQLException

getMaxConnections

public int getMaxConnections()
                      throws java.sql.SQLException
How many active connections can we have at a time to this database?

Specified by:
getMaxConnections in interface java.sql.DatabaseMetaData
Returns:
max connections
Throws:
java.sql.SQLException

getMaxCursorNameLength

public int getMaxCursorNameLength()
                           throws java.sql.SQLException
What's the maximum cursor name length?

Specified by:
getMaxCursorNameLength in interface java.sql.DatabaseMetaData
Returns:
max cursor name length in bytes
Throws:
java.sql.SQLException

getMaxIndexLength

public int getMaxIndexLength()
                      throws java.sql.SQLException
What's the maximum length of an index (in bytes)?

Specified by:
getMaxIndexLength in interface java.sql.DatabaseMetaData
Returns:
max index length in bytes
Throws:
java.sql.SQLException

getMaxSchemaNameLength

public int getMaxSchemaNameLength()
                           throws java.sql.SQLException
What's the maximum length allowed for a schema name?

Specified by:
getMaxSchemaNameLength in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes
Throws:
java.sql.SQLException

getMaxProcedureNameLength

public int getMaxProcedureNameLength()
                              throws java.sql.SQLException
What's the maximum length of a procedure name?

Specified by:
getMaxProcedureNameLength in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes
Throws:
java.sql.SQLException

getMaxCatalogNameLength

public int getMaxCatalogNameLength()
                            throws java.sql.SQLException
What's the maximum length of a catalog name?

Specified by:
getMaxCatalogNameLength in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes
Throws:
java.sql.SQLException

getMaxRowSize

public int getMaxRowSize()
                  throws java.sql.SQLException
What's the maximum length of a single row?

Specified by:
getMaxRowSize in interface java.sql.DatabaseMetaData
Returns:
max row size in bytes
Throws:
java.sql.SQLException

doesMaxRowSizeIncludeBlobs

public boolean doesMaxRowSizeIncludeBlobs()
                                   throws java.sql.SQLException
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?

Specified by:
doesMaxRowSizeIncludeBlobs in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

getMaxStatementLength

public int getMaxStatementLength()
                          throws java.sql.SQLException
What's the maximum length of a SQL statement?

Specified by:
getMaxStatementLength in interface java.sql.DatabaseMetaData
Returns:
max length in bytes
Throws:
java.sql.SQLException

getMaxStatements

public int getMaxStatements()
                     throws java.sql.SQLException
How many active statements can we have open at one time to this database?

Specified by:
getMaxStatements in interface java.sql.DatabaseMetaData
Returns:
the maximum
Throws:
java.sql.SQLException

getMaxTableNameLength

public int getMaxTableNameLength()
                          throws java.sql.SQLException
What's the maximum length of a table name?

Specified by:
getMaxTableNameLength in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes
Throws:
java.sql.SQLException

getMaxTablesInSelect

public int getMaxTablesInSelect()
                         throws java.sql.SQLException
What's the maximum number of tables in a SELECT?

Specified by:
getMaxTablesInSelect in interface java.sql.DatabaseMetaData
Returns:
the maximum
Throws:
java.sql.SQLException

getMaxUserNameLength

public int getMaxUserNameLength()
                         throws java.sql.SQLException
What's the maximum length of a user name?

Specified by:
getMaxUserNameLength in interface java.sql.DatabaseMetaData
Returns:
max name length in bytes
Throws:
java.sql.SQLException

getDefaultTransactionIsolation

public int getDefaultTransactionIsolation()
                                   throws java.sql.SQLException
What's the database's default transaction isolation level? The values are defined in java.sql.Connection.

Specified by:
getDefaultTransactionIsolation in interface java.sql.DatabaseMetaData
Returns:
the default isolation level
Throws:
java.sql.SQLException
See Also:
Connection

supportsTransactions

public boolean supportsTransactions()
                             throws java.sql.SQLException
Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.

Specified by:
supportsTransactions in interface java.sql.DatabaseMetaData
Returns:
true if transactions are supported
Throws:
java.sql.SQLException

supportsTransactionIsolationLevel

public boolean supportsTransactionIsolationLevel(int level)
                                          throws java.sql.SQLException
Does the database support the given transaction isolation level?

Specified by:
supportsTransactionIsolationLevel in interface java.sql.DatabaseMetaData
Parameters:
level - the values are defined in java.sql.Connection
Returns:
true if so
Throws:
java.sql.SQLException
See Also:
Connection

supportsDataDefinitionAndDataManipulationTransactions

public boolean supportsDataDefinitionAndDataManipulationTransactions()
                                                              throws java.sql.SQLException
Are both data definition and data manipulation statements within a transaction supported?

Specified by:
supportsDataDefinitionAndDataManipulationTransactions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

supportsDataManipulationTransactionsOnly

public boolean supportsDataManipulationTransactionsOnly()
                                                 throws java.sql.SQLException
Are only data manipulation statements within a transaction supported?

Specified by:
supportsDataManipulationTransactionsOnly in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

dataDefinitionCausesTransactionCommit

public boolean dataDefinitionCausesTransactionCommit()
                                              throws java.sql.SQLException
Does a data definition statement within a transaction force the transaction to commit?

Specified by:
dataDefinitionCausesTransactionCommit in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

dataDefinitionIgnoredInTransactions

public boolean dataDefinitionIgnoredInTransactions()
                                            throws java.sql.SQLException
Is a data definition statement within a transaction ignored?

Specified by:
dataDefinitionIgnoredInTransactions in interface java.sql.DatabaseMetaData
Returns:
true if so
Throws:
java.sql.SQLException

getProcedures

public java.sql.ResultSet getProcedures(java.lang.String catalog,
                                        java.lang.String schemaPattern,
                                        java.lang.String procedureNamePattern)
                                 throws java.sql.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:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. reserved for future use
  5. reserved for future use
  6. reserved for future use
  7. REMARKS String => explanatory comment on the procedure
  8. 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 interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getSearchStringEscape()

getProcedureColumns

public java.sql.ResultSet getProcedureColumns(java.lang.String catalog,
                                              java.lang.String schemaPattern,
                                              java.lang.String procedureNamePattern,
                                              java.lang.String columnNamePattern)
                                       throws java.sql.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:

  1. PROCEDURE_CAT String => procedure catalog (may be null) Interpreted as the Oracle Package name.
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. COLUMN_NAME String => column/parameter name
  5. 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
  6. DATA_TYPE short => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL?
    • procedureNoNulls - does not allow NULL values
    • procedureNullable - allows NULL values
    • procedureNullableUnknown - nullability unknown
  13. 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. These additional columns MUST be accessed by name, not by index.

Oracle Specific:

The catalog argument is taken to mean a package name. Note that this is not a pattern and wildcards are not supported.

Database synonyms may be defined (amoung other things) for a package, for an unpackaged procedure or for a synonym. The combination of synonyms and wildcards in the schemaPattern and procedureNamePattern is supported in a limited way due to complexity and performace issues.

If the schemaPattern does not contain wildcards and the catalog argument is not null and not empty, the values are taken as either a schema + package name or a schema + synonym for a package. If it is a synonym, it will be resolved perhaps through multiple levels of synonyms and the search for the procedureNamePattern and columnNamePatten will be conducted in the resulting package.

If the catalog is null and both the schemaNamePattern and procedureNamePattern do not contain wildcards, the values are taken as either a schema + procedureName or a schema + synonym. If it is a synonym it will be resolved perhaps through multiple levels of synonyms and the search for the columnNamePatten will be conducted in the resulting procedure

Specified by:
getProcedureColumns in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getSearchStringEscape()

getTables

public java.sql.ResultSet getTables(java.lang.String catalog,
                                    java.lang.String schemaPattern,
                                    java.lang.String tableNamePattern,
                                    java.lang.String[] types)
                             throws java.sql.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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
  5. TABLE_REMARKS String => explanatory comment on the table

Note: Some databases may not return information for all tables.

Specified by:
getTables in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getSearchStringEscape()

getSchemas

public java.sql.ResultSet getSchemas()
                              throws java.sql.SQLException
Get the schema names available in this database. The results are ordered by schema name.

The schema column is:

  1. TABLE_SCHEM String => schema name

Specified by:
getSchemas in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row has a single String column that is a schema name
Throws:
java.sql.SQLException

getCatalogs

public java.sql.ResultSet getCatalogs()
                               throws java.sql.SQLException
Get the catalog names available in this database. The results are ordered by catalog name.

The catalog column is:

  1. TABLE_CAT String => catalog name

Specified by:
getCatalogs in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row has a single String column that is a catalog name
Throws:
java.sql.SQLException

getTableTypes

public java.sql.ResultSet getTableTypes()
                                 throws java.sql.SQLException
Get the table types available in this database. The results are ordered by table type.

The table type is:

  1. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Specified by:
getTableTypes in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row has a single String column that is a table type
Throws:
java.sql.SQLException

getColumns

public java.sql.ResultSet getColumns(java.lang.String catalog,
                                     java.lang.String schemaPattern,
                                     java.lang.String tableNamePattern,
                                     java.lang.String columnNamePattern)
                              throws java.sql.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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE short => SQL type from java.sql.Types
  6. TYPE_NAME String => Data source dependent type name
  7. 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.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS int => the number of fractional digits
  10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  11. NULLABLE int => is NULL allowed?
    • columnNoNulls - might not allow NULL values
    • columnNullable - definitely allows NULL values
    • columnNullableUnknown - nullability unknown
  12. REMARKS String => comment describing column (may be null)
  13. COLUMN_DEF String => default value (may be null)
  14. SQL_DATA_TYPE int => unused
  15. SQL_DATETIME_SUB int => unused
  16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  17. ORDINAL_POSITION int => index of column in table (starting at 1)
  18. 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 interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getSearchStringEscape()

getColumnPrivileges

public java.sql.ResultSet getColumnPrivileges(java.lang.String catalog,
                                              java.lang.String schemaPattern,
                                              java.lang.String tableNamePattern,
                                              java.lang.String columnNamePattern)
                                       throws java.sql.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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. GRANTOR => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Specified by:
getColumnPrivileges in interface java.sql.DatabaseMetaData
Parameters:
catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern - a schema name; "" retrieves those without a schema
tableNamePattern - a table name
columnNamePattern - a column name pattern
Returns:
ResultSet each row is a column privilege description
Throws:
java.sql.SQLException
See Also:
getSearchStringEscape()

getTablePrivileges

public java.sql.ResultSet getTablePrivileges(java.lang.String catalog,
                                             java.lang.String schemaPattern,
                                             java.lang.String tableNamePattern)
                                      throws java.sql.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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. GRANTOR => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Specified by:
getTablePrivileges in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getSearchStringEscape()

getBestRowIdentifier

public java.sql.ResultSet getBestRowIdentifier(java.lang.String catalog,
                                               java.lang.String schema,
                                               java.lang.String table,
                                               int scope,
                                               boolean nullable)
                                        throws java.sql.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:

  1. 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
  2. COLUMN_NAME String => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => not used
  7. DECIMAL_DIGITS short => scale
  8. 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 interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException

getVersionColumns

public java.sql.ResultSet getVersionColumns(java.lang.String catalog,
                                            java.lang.String schema,
                                            java.lang.String table)
                                     throws java.sql.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:

  1. SCOPE short => is not used
  2. COLUMN_NAME String => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => length of column value in bytes
  7. DECIMAL_DIGITS short => scale
  8. 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 interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException

getPrimaryKeys

public java.sql.ResultSet getPrimaryKeys(java.lang.String catalog,
                                         java.lang.String schema,
                                         java.lang.String table)
                                  throws java.sql.SQLException
Get a description of a table's primary key columns. They are ordered by COLUMN_NAME.

Each column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. KEY_SEQ short => sequence number within primary key
  6. PK_NAME String => primary key name (may be null)

Specified by:
getPrimaryKeys in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException

getImportedKeys

public java.sql.ResultSet getImportedKeys(java.lang.String catalog,
                                          java.lang.String schema,
                                          java.lang.String table)
                                   throws java.sql.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:

  1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
  2. PKTABLE_SCHEM String => primary key table schema being imported (may be null)
  3. PKTABLE_NAME String => primary key table name being imported
  4. PKCOLUMN_NAME String => primary key column name being imported
  5. FKTABLE_CAT String => foreign key table catalog (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null)
  7. FKTABLE_NAME String => foreign key table name
  8. FKCOLUMN_NAME String => foreign key column name
  9. KEY_SEQ short => sequence number within foreign key
  10. 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
  11. 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
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)

Specified by:
getImportedKeys in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getExportedKeys(java.lang.String, java.lang.String, java.lang.String)

getExportedKeys

public java.sql.ResultSet getExportedKeys(java.lang.String catalog,
                                          java.lang.String schema,
                                          java.lang.String table)
                                   throws java.sql.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:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. 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
  11. 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
  12. FK_NAME String => foreign key identifier (may be null)
  13. PK_NAME String => primary key identifier (may be null)

Specified by:
getExportedKeys in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

getCrossReference

public 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
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:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. 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
  11. 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
  12. FK_NAME String => foreign key identifier (may be null)
  13. PK_NAME String => primary key identifier (may be null)

Specified by:
getCrossReference in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException
See Also:
getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

getTypeInfo

public java.sql.ResultSet getTypeInfo()
                               throws java.sql.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:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE short => SQL data type from java.sql.Types
  3. PRECISION int => maximum precision
  4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
  5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
  6. CREATE_PARAMS String => parameters used in creating the type (may be null)
  7. NULLABLE short => can you use NULL for this type?
    • typeNoNulls - does not allow NULL values
    • typeNullable - allows NULL values
    • typeNullableUnknown - nullability unknown
  8. CASE_SENSITIVE boolean=> is it case sensitive?
  9. 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 ..
  10. UNSIGNED_ATTRIBUTE boolean => is it unsigned?
  11. FIXED_PREC_SCALE boolean => can it be a money value?
  12. AUTO_INCREMENT boolean => can it be used for an auto-increment value?
  13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
  14. MINIMUM_SCALE short => minimum scale supported
  15. MAXIMUM_SCALE short => maximum scale supported
  16. SQL_DATA_TYPE int => unused
  17. SQL_DATETIME_SUB int => unused
  18. NUM_PREC_RADIX int => usually 2 or 10

Specified by:
getTypeInfo in interface java.sql.DatabaseMetaData
Returns:
ResultSet each row is a SQL type description
Throws:
java.sql.SQLException

getIndexInfo

public java.sql.ResultSet getIndexInfo(java.lang.String catalog,
                                       java.lang.String schema,
                                       java.lang.String table,
                                       boolean unique,
                                       boolean approximate)
                                throws java.sql.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:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
  6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
  7. 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
  8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
  9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
  10. 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
  11. 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.
  12. 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.
  13. FILTER_CONDITION String => Filter condition, if any. (may be null)

Specified by:
getIndexInfo in interface java.sql.DatabaseMetaData
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
Throws:
java.sql.SQLException

supportsResultSetType

public boolean supportsResultSetType(int type)
                              throws java.sql.SQLException
Implements JDBC 2.0 DatabaseMetaData.supportsResultSetType. Does the database support the given result set type? This method always return true.

Specified by:
supportsResultSetType in interface java.sql.DatabaseMetaData
Parameters:
type - defined in java.sql.ResultSet
Returns:
true always
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
Connection

supportsResultSetConcurrency

public boolean supportsResultSetConcurrency(int type,
                                            int concurrency)
                                     throws java.sql.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.

Specified by:
supportsResultSetConcurrency in interface java.sql.DatabaseMetaData
Parameters:
type - defined in java.sql.ResultSet
concurrency - type defined in java.sql.ResultSet
Returns:
true always
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
Connection

ownUpdatesAreVisible

public boolean ownUpdatesAreVisible(int type)
                             throws java.sql.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.

Specified by:
ownUpdatesAreVisible in interface java.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 boolean ownDeletesAreVisible(int type)
                             throws java.sql.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.

Specified by:
ownDeletesAreVisible in interface java.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 boolean ownInsertsAreVisible(int type)
                             throws java.sql.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.

Specified by:
ownInsertsAreVisible in interface java.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 boolean othersUpdatesAreVisible(int type)
                                throws java.sql.SQLException
Implements JDBC 2.0 DatabaseMetaData.. Indicates whether updates made by others are visible. return true for scroll-sensitive result sets; reutrn false otherwise.

Specified by:
othersUpdatesAreVisible in interface java.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 boolean othersDeletesAreVisible(int type)
                                throws java.sql.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.

Specified by:
othersDeletesAreVisible in interface java.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 boolean othersInsertsAreVisible(int type)
                                throws java.sql.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.

Specified by:
othersInsertsAreVisible in interface java.sql.DatabaseMetaData
Parameters:
type - result set type, i.e. ResultSet.TYPE_XXX
Returns:
true if updates are visible for the result set type 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 boolean updatesAreDetected(int type)
                           throws java.sql.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.

Specified by:
updatesAreDetected in interface java.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 boolean deletesAreDetected(int type)
                           throws java.sql.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.

Specified by:
deletesAreDetected in interface java.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 boolean insertsAreDetected(int type)
                           throws java.sql.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.

Specified by:
insertsAreDetected in interface java.sql.DatabaseMetaData
Parameters:
type -
type - result set type, i.e. ResultSet.TYPE_XXX
Returns:
false always
Throws:
java.sql.SQLException - if a database access error occurs

supportsBatchUpdates

public boolean supportsBatchUpdates()
                             throws java.sql.SQLException
Implements JDBC 2.0 DatabaseMetaData::supportBatchUpdates. Indicates whether the driver supports batch updates.

Specified by:
supportsBatchUpdates in interface java.sql.DatabaseMetaData
Returns:
true if the driver supports batch updates false otherwise
Throws:
java.sql.SQLException

getUDTs

public java.sql.ResultSet getUDTs(java.lang.String catalog,
                                  java.lang.String schemaPattern,
                                  java.lang.String typeNamePattern,
                                  int[] types)
                           throws java.sql.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:

  1. TYPE_CAT String => the type's catalog which is always null
  2. TYPE_SCHEM String => type's schema
  3. TYPE_NAME String => type name
  4. CLASS_NAME String => Java class name
  5. DATA_TYPE String => type value defined in java.sql.Types. Only STRUCT is supported.
  6. REMARKS String => explanatory comment on the type

Specified by:
getUDTs in interface java.sql.DatabaseMetaData
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:
java.sql.SQLException - if a database access error occurs

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
Implements JDBC 2.0 DatabaseMetaData.getConnection. Retrieves the connection that produced this metadata object.

Specified by:
getConnection in interface java.sql.DatabaseMetaData
Returns:
the connection that produced this metadata object
Throws:
java.sql.SQLException

supportsSavepoints

public boolean supportsSavepoints()
                           throws java.sql.SQLException
JDBC 3.0 Retrieves whether this database supports savepoints.

Specified by:
supportsSavepoints in interface java.sql.DatabaseMetaData
Returns:
true if savepoints are supported false otherwise
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

supportsNamedParameters

public boolean supportsNamedParameters()
                                throws java.sql.SQLException
JDBC 3.0 Retrieves whether this database supports named parameters to callable statements.

Specified by:
supportsNamedParameters in interface java.sql.DatabaseMetaData
Returns:
true if named parameters are supported false otherwise
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

supportsMultipleOpenResults

public boolean supportsMultipleOpenResults()
                                    throws java.sql.SQLException
JDBC 3.0 Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

Specified by:
supportsMultipleOpenResults in interface java.sql.DatabaseMetaData
Returns:
true if a CallableStatement object can return multiple ResultSet objects simultaneously; false otherwise
Throws:
java.sql.SQLException - if a datanase access error occurs
Since:
9.0.2

supportsGetGeneratedKeys

public boolean supportsGetGeneratedKeys()
                                 throws java.sql.SQLException
JDBC 3.0 Retrieves whether auto-generated keys can be retrieved after a statement has been executed.

Specified by:
supportsGetGeneratedKeys in interface java.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:
9.0.2

getSuperTypes

public java.sql.ResultSet getSuperTypes(java.lang.String catalog,
                                        java.lang.String schemaPattern,
                                        java.lang.String typeNamePattern)
                                 throws java.sql.SQLException
JDBC 3.0 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:

  1. TYPE_CAT String => the UDT's catalog (may be null)
  2. TYPE_SCHEM String => UDT's schema (may be null)
  3. TYPE_NAME String => type name of the UDT
  4. SUPERTYPE_CAT String => the direct super type's catalog (may be null)
  5. SUPERTYPE_SCHEM String => the direct super type's schema (may be null)
  6. 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 interface java.sql.DatabaseMetaData
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
typeNamePattern - 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:
9.0.2

getSuperTables

public java.sql.ResultSet getSuperTables(java.lang.String catalog,
                                         java.lang.String schemaPattern,
                                         java.lang.String tableNamePattern)
                                  throws java.sql.SQLException
JDBC 3.0 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:

  1. TABLE_CAT String => the type's catalog (may be null)
  2. TABLE_SCHEM String => type's schema (may be null)
  3. TABLE_NAME String => type name
  4. 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 interface java.sql.DatabaseMetaData
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; 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:
9.0.2

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
JDBC 3.0 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:

  1. TYPE_CAT String => type catalog (may be null)
  2. TYPE_SCHEM String => type schema (may be null)
  3. TYPE_NAME String => type name
  4. ATTR_NAME String => attribute name
  5. DATA_TYPE short => attribute type SQL type from java.sql.Types
  6. 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.
  7. 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.
  8. DECIMAL_DIGITS int => the number of fractional digits
  9. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  10. NULLABLE int => whether NULL is allowed
    • attributeNoNulls - might not allow NULL values
    • attributeNullable - definitely allows NULL values
    • attributeNullableUnknown - nullability unknown
  11. REMARKS String => comment describing column (may be null)
  12. ATTR_DEF String => default value (may be null)
  13. SQL_DATA_TYPE int => unused
  14. SQL_DATETIME_SUB int => unused
  15. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  16. ORDINAL_POSITION int => index of column in table (starting at 1)
  17. 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.
  18. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  19. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  20. SCOPE_TABLE String => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  21. 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 interface java.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 search
schemaPattern - 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 search
typeNamePattern - a type name pattern; must match the type name as it is stored in the database
attributeNamePattern - 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:
9.0.2

supportsResultSetHoldability

public boolean supportsResultSetHoldability(int holdability)
                                     throws java.sql.SQLException
JDBC 3.0 Retrieves whether this database supports the given result set holdability.

Specified by:
supportsResultSetHoldability in interface java.sql.DatabaseMetaData
Parameters:
holdability - one of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT or OracleResultSet.HOLD_CURSORS_OVER_COMMIT for jdk1.2 and jdk1.3 or OracleResultSet.CLOSE_CURSORS_AT_COMMIT for jdk1.2 and jdk1.3
Returns:
true if so false otherwise
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2
See Also:
Connection

getResultSetHoldability

public int getResultSetHoldability()
                            throws java.sql.SQLException
JDBC 3.0 Retrieves the default holdability of this ResultSet object.

Specified by:
getResultSetHoldability in interface java.sql.DatabaseMetaData
Returns:
the default holdability either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT or OracleResultSet.HOLD_CURSORS_OVER_COMMIT for jdk1.2 and jdk1.3 or OracleResultSet.CLOSE_CURSORS_AT_COMMIT for jdk1.2 and jdk1.3
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

getDatabaseMajorVersion

public int getDatabaseMajorVersion()
                            throws java.sql.SQLException
JDBC 3.0 Retrieves the major version number of the underlying database.

Specified by:
getDatabaseMajorVersion in interface java.sql.DatabaseMetaData
Returns:
the underlying database's major version
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

getDatabaseMinorVersion

public int getDatabaseMinorVersion()
                            throws java.sql.SQLException
JDBC 3.0 Retrieves the minor version number of the underlying database.

Specified by:
getDatabaseMinorVersion in interface java.sql.DatabaseMetaData
Returns:
underlying database's minor version
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

getJDBCMajorVersion

public int getJDBCMajorVersion()
                        throws java.sql.SQLException
JDBC 3.0 Retrieves the major JDBC version number for this driver.

Specified by:
getJDBCMajorVersion in interface java.sql.DatabaseMetaData
Returns:
JDBC version major number
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

getJDBCMinorVersion

public int getJDBCMinorVersion()
                        throws java.sql.SQLException
JDBC 3.0 Retrieves the minor JDBC version number for this driver.

Specified by:
getJDBCMinorVersion in interface java.sql.DatabaseMetaData
Returns:
JDBC version minor number
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

getSQLStateType

public int getSQLStateType()
                    throws java.sql.SQLException
JDBC 3.0 Indicates whether the SQLSTATEs returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.

Specified by:
getSQLStateType in interface java.sql.DatabaseMetaData
Returns:
the type of SQLSTATEs, one of: sqlStateXOpen or sqlStateSQL99
Throws:
java.sql.SQLException - if a database access error occurs
Since:
9.0.2

locatorsUpdateCopy

public boolean locatorsUpdateCopy()
                           throws java.sql.SQLException
JDBC 3.0

Specified by:
locatorsUpdateCopy in interface java.sql.DatabaseMetaData
Returns:
Throws:
java.sql.SQLException

supportsStatementPooling

public boolean supportsStatementPooling()
                                 throws java.sql.SQLException
JDBC 3.0

Specified by:
supportsStatementPooling in interface java.sql.DatabaseMetaData
Returns:
Throws:
java.sql.SQLException

getDriverNameInfo

public static java.lang.String getDriverNameInfo()
                                          throws java.sql.SQLException
What's the name of this JDBC driver?

Returns:
JDBC driver name
Throws:
java.sql.SQLException

getDriverVersionInfo

public static java.lang.String getDriverVersionInfo()
                                             throws java.sql.SQLException
Deprecated. -- use standard getDriverVersion()

What's the version of this JDBC driver?

Returns:
JDBC driver version
Throws:
java.sql.SQLException

getDriverMajorVersionInfo

public static int getDriverMajorVersionInfo()
Deprecated. -- use standard getDriverMajorVersion()

What's this JDBC driver's major version number?

Returns:
JDBC driver major version

getDriverMinorVersionInfo

public static int getDriverMinorVersionInfo()
Deprecated. -- use JDBC standard method getDriverMinorVersion

What's this JDBC driver's minor version number?

Returns:
JDBC driver minor version number

getLobPrecision

public static java.lang.String getLobPrecision()
                                        throws java.sql.SQLException
Deprecated. 

This is an internal method that should not be used by customers.

Throws:
java.sql.SQLException

getLobMaxLength

public long getLobMaxLength()
                     throws java.sql.SQLException
The max size of a lob on the server for this connection. Note that the actual size available for a particular lob will depend on the specific storage allocation.

Specified by:
getLobMaxLength in interface AdditionalDatabaseMetaData
Returns:
Max size of lob.
Throws:
java.sql.SQLException

getOracleTypeMetaData

public OracleTypeMetaData getOracleTypeMetaData(java.lang.String sqlTypeName)
                                         throws java.sql.SQLException
Description copied from interface: AdditionalDatabaseMetaData
Return the type metadata for a named type. Use this instead of the various Descriptor classes and methods. Use of the Descriptor classes and methods such as oracle.sql.TypeDescriptor, is not recommended and will cause ClassCastException if used with some new Oracle JDBC features.

Specified by:
getOracleTypeMetaData in interface AdditionalDatabaseMetaData
Parameters:
sqlTypeName - the name of the type
Returns:
the metadata for the type
Throws:
java.sql.SQLException - if the type does not exist or some other error occurs

Oracle JDBC API Reference
11g Release 2 ("11.2.0.3.0")

Copyright © 1998, 2007, Oracle. All rights reserved.