Interface DatabaseMetaData

Method Details

• allProceduresAreCallable

  boolean allProceduresAreCallable() throws SQLException

  Retrieves whether the current user can call all the procedures returned by the method getProcedures.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• allTablesAreSelectable

  boolean allTablesAreSelectable() throws SQLException

  Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getURL

  String getURL() throws SQLException

  Retrieves the URL for this DBMS.

  Returns:

  the URL for this DBMS or null if it cannot be generated

  Throws:

  SQLException - if a database access error occurs

• getUserName

  String getUserName() throws SQLException

  Retrieves the user name as known to this database.

  Returns:

  the database user name

  Throws:

  SQLException - if a database access error occurs

• isReadOnly

  boolean isReadOnly() throws SQLException

  Retrieves whether this database is in read-only mode.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• nullsAreSortedHigh

  boolean nullsAreSortedHigh() throws SQLException

  Retrieves whether NULL values are sorted high. Sorted high means that NULL values sort higher than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the end. By contrast, the method nullsAreSortedAtEnd indicates whether NULL values are sorted at the end regardless of sort order.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• nullsAreSortedLow

  boolean nullsAreSortedLow() throws SQLException

  Retrieves whether NULL values are sorted low. Sorted low means that NULL values sort lower than any other value in a domain. In an ascending order, if this method returns true, NULL values will appear at the beginning. By contrast, the method nullsAreSortedAtStart indicates whether NULL values are sorted at the beginning regardless of sort order.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• nullsAreSortedAtStart

  boolean nullsAreSortedAtStart() throws SQLException

  Retrieves whether NULL values are sorted at the start regardless of sort order.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• nullsAreSortedAtEnd

  boolean nullsAreSortedAtEnd() throws SQLException

  Retrieves whether NULL values are sorted at the end regardless of sort order.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getDatabaseProductName

  String getDatabaseProductName() throws SQLException

  Retrieves the name of this database product.

  Returns:

  database product name

  Throws:

  SQLException - if a database access error occurs

• getDatabaseProductVersion

  String getDatabaseProductVersion() throws SQLException

  Retrieves the version number of this database product.

  Returns:

  database version number

  Throws:

  SQLException - if a database access error occurs

• getDriverName

  String getDriverName() throws SQLException

  Retrieves the name of this JDBC driver.

  Returns:

  JDBC driver name

  Throws:

  SQLException - if a database access error occurs

• getDriverVersion

  String getDriverVersion() throws SQLException

  Retrieves the version number of this JDBC driver as a String.

  Returns:

  JDBC driver version

  Throws:

  SQLException - if a database access error occurs

• getDriverMajorVersion

  int getDriverMajorVersion()

  Retrieves this JDBC driver's major version number.

  Returns:

  JDBC driver major version

• getDriverMinorVersion

  int getDriverMinorVersion()

  Retrieves this JDBC driver's minor version number.

  Returns:

  JDBC driver minor version number

• usesLocalFiles

  boolean usesLocalFiles() throws SQLException

  Retrieves whether this database stores tables in a local file.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• usesLocalFilePerTable

  boolean usesLocalFilePerTable() throws SQLException

  Retrieves whether this database uses a file for each table.

  Returns:

  true if this database uses a local file for each table; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsMixedCaseIdentifiers

  boolean supportsMixedCaseIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• storesUpperCaseIdentifiers

  boolean storesUpperCaseIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• storesLowerCaseIdentifiers

  boolean storesLowerCaseIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• storesMixedCaseIdentifiers

  boolean storesMixedCaseIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsMixedCaseQuotedIdentifiers

  boolean supportsMixedCaseQuotedIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• storesUpperCaseQuotedIdentifiers

  boolean storesUpperCaseQuotedIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• storesLowerCaseQuotedIdentifiers

  boolean storesLowerCaseQuotedIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• storesMixedCaseQuotedIdentifiers

  boolean storesMixedCaseQuotedIdentifiers() throws SQLException

  Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getIdentifierQuoteString

  String getIdentifierQuoteString() throws SQLException

  Retrieves the string used to quote SQL identifiers. This method returns a space " " if identifier quoting is not supported.

  Returns:

  the quoting string or a space if quoting is not supported

  Throws:

  SQLException - if a database access error occurs

• getSQLKeywords

  String getSQLKeywords() throws SQLException

  Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords.

  Returns:

  the list of this database's keywords that are not also SQL:2003 keywords

  Throws:

  SQLException - if a database access error occurs

• getNumericFunctions

  String getNumericFunctions() throws SQLException

  Retrieves a comma-separated list of math functions available with this database. These are the Open /Open CLI math function names used in the JDBC function escape clause.

  Returns:

  the list of math functions supported by this database

  Throws:

  SQLException - if a database access error occurs

• getStringFunctions

  String getStringFunctions() throws SQLException

  Retrieves a comma-separated list of string functions available with this database. These are the Open Group CLI string function names used in the JDBC function escape clause.

  Returns:

  the list of string functions supported by this database

  Throws:

  SQLException - if a database access error occurs

• getSystemFunctions

  String getSystemFunctions() throws SQLException

  Retrieves a comma-separated list of system functions available with this database. These are the Open Group CLI system function names used in the JDBC function escape clause.

  Returns:

  a list of system functions supported by this database

  Throws:

  SQLException - if a database access error occurs

• getTimeDateFunctions

  String getTimeDateFunctions() throws SQLException

  Retrieves a comma-separated list of the time and date functions available with this database.

  Returns:

  the list of time and date functions supported by this database

  Throws:

  SQLException - if a database access error occurs

• getSearchStringEscape

  String getSearchStringEscape() throws SQLException

  Retrieves the string that can be used to escape wildcard characters. This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).

  The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.

  Returns:

  the string used to escape wildcard characters

  Throws:

  SQLException - if a database access error occurs

• getExtraNameCharacters

  String getExtraNameCharacters() throws SQLException

  Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

  Returns:

  the string containing the extra characters

  Throws:

  SQLException - if a database access error occurs

• supportsAlterTableWithAddColumn

  boolean supportsAlterTableWithAddColumn() throws SQLException

  Retrieves whether this database supports ALTER TABLE with add column.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsAlterTableWithDropColumn

  boolean supportsAlterTableWithDropColumn() throws SQLException

  Retrieves whether this database supports ALTER TABLE with drop column.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsColumnAliasing

  boolean supportsColumnAliasing() throws SQLException

  Retrieves whether this database supports column aliasing.

  If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• nullPlusNonNullIsNull

  boolean nullPlusNonNullIsNull() throws SQLException

  Retrieves whether this database supports concatenations between NULL and non-NULL values being NULL.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsConvert

  boolean supportsConvert() throws SQLException

  Retrieves whether this database supports the JDBC scalar function CONVERT for the conversion of one JDBC type to another. The JDBC types are the generic SQL data types defined in java.sql.Types.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsConvert

  boolean supportsConvert(int fromType, int toType) throws SQLException

  Retrieves whether this database supports the JDBC scalar function CONVERT for conversions between the JDBC types fromType and toType. The JDBC types are the generic SQL data types defined in java.sql.Types.

  Parameters:

  fromType - the type to convert from; one of the type codes from the class java.sql.Types

  toType - the type to convert to; one of the type codes from the class java.sql.Types

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • Types

• supportsTableCorrelationNames

  boolean supportsTableCorrelationNames() throws SQLException

  Retrieves whether this database supports table correlation names.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsDifferentTableCorrelationNames

  boolean supportsDifferentTableCorrelationNames() throws SQLException

  Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsExpressionsInOrderBy

  boolean supportsExpressionsInOrderBy() throws SQLException

  Retrieves whether this database supports expressions in ORDER BY lists.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsOrderByUnrelated

  boolean supportsOrderByUnrelated() throws SQLException

  Retrieves whether this database supports using a column that is not in the SELECT statement in an ORDER BY clause.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsGroupBy

  boolean supportsGroupBy() throws SQLException

  Retrieves whether this database supports some form of GROUP BY clause.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsGroupByUnrelated

  boolean supportsGroupByUnrelated() throws SQLException

  Retrieves whether this database supports using a column that is not in the SELECT statement in a GROUP BY clause.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsGroupByBeyondSelect

  boolean supportsGroupByBeyondSelect() throws SQLException

  Retrieves whether this database supports using columns not included in the SELECT statement in a GROUP BY clause provided that all of the columns in the SELECT statement are included in the GROUP BY clause.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsLikeEscapeClause

  boolean supportsLikeEscapeClause() throws SQLException

  Retrieves whether this database supports specifying a LIKE escape clause.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsMultipleResultSets

  boolean supportsMultipleResultSets() throws SQLException

  Retrieves whether this database supports getting multiple ResultSet objects from a single call to the method execute.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsMultipleTransactions

  boolean supportsMultipleTransactions() throws SQLException

  Retrieves whether this database allows having multiple transactions open at once (on different connections).

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsNonNullableColumns

  boolean supportsNonNullableColumns() throws SQLException

  Retrieves whether columns in this database may be defined as non-nullable.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsMinimumSQLGrammar

  boolean supportsMinimumSQLGrammar() throws SQLException

  Retrieves whether this database supports the ODBC Minimum SQL grammar.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCoreSQLGrammar

  boolean supportsCoreSQLGrammar() throws SQLException

  Retrieves whether this database supports the ODBC Core SQL grammar.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsExtendedSQLGrammar

  boolean supportsExtendedSQLGrammar() throws SQLException

  Retrieves whether this database supports the ODBC Extended SQL grammar.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsANSI92EntryLevelSQL

  boolean supportsANSI92EntryLevelSQL() throws SQLException

  Retrieves whether this database supports the ANSI92 entry level SQL grammar.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsANSI92IntermediateSQL

  boolean supportsANSI92IntermediateSQL() throws SQLException

  Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsANSI92FullSQL

  boolean supportsANSI92FullSQL() throws SQLException

  Retrieves whether this database supports the ANSI92 full SQL grammar supported.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsIntegrityEnhancementFacility

  boolean supportsIntegrityEnhancementFacility() throws SQLException

  Retrieves whether this database supports the SQL Integrity Enhancement Facility.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsOuterJoins

  boolean supportsOuterJoins() throws SQLException

  Retrieves whether this database supports some form of outer join.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsFullOuterJoins

  boolean supportsFullOuterJoins() throws SQLException

  Retrieves whether this database supports full nested outer joins.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsLimitedOuterJoins

  boolean supportsLimitedOuterJoins() throws SQLException

  Retrieves whether this database provides limited support for outer joins. (This will be true if the method supportsFullOuterJoins returns true).

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getSchemaTerm

  String getSchemaTerm() throws SQLException

  Retrieves the database vendor's preferred term for "schema".

  Returns:

  the vendor term for "schema"

  Throws:

  SQLException - if a database access error occurs

• getProcedureTerm

  String getProcedureTerm() throws SQLException

  Retrieves the database vendor's preferred term for "procedure".

  Returns:

  the vendor term for "procedure"

  Throws:

  SQLException - if a database access error occurs

• getCatalogTerm

  String getCatalogTerm() throws SQLException

  Retrieves the database vendor's preferred term for "catalog".

  Returns:

  the vendor term for "catalog"

  Throws:

  SQLException - if a database access error occurs

• isCatalogAtStart

  boolean isCatalogAtStart() throws SQLException

  Retrieves whether a catalog appears at the start of a fully qualified table name. If not, the catalog appears at the end.

  Returns:

  true if the catalog name appears at the beginning of a fully qualified table name; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getCatalogSeparator

  String getCatalogSeparator() throws SQLException

  Retrieves the String that this database uses as the separator between a catalog and table name.

  Returns:

  the separator string

  Throws:

  SQLException - if a database access error occurs

• supportsSchemasInDataManipulation

  boolean supportsSchemasInDataManipulation() throws SQLException

  Retrieves whether a schema name can be used in a data manipulation statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSchemasInProcedureCalls

  boolean supportsSchemasInProcedureCalls() throws SQLException

  Retrieves whether a schema name can be used in a procedure call statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSchemasInTableDefinitions

  boolean supportsSchemasInTableDefinitions() throws SQLException

  Retrieves whether a schema name can be used in a table definition statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSchemasInIndexDefinitions

  boolean supportsSchemasInIndexDefinitions() throws SQLException

  Retrieves whether a schema name can be used in an index definition statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSchemasInPrivilegeDefinitions

  boolean supportsSchemasInPrivilegeDefinitions() throws SQLException

  Retrieves whether a schema name can be used in a privilege definition statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCatalogsInDataManipulation

  boolean supportsCatalogsInDataManipulation() throws SQLException

  Retrieves whether a catalog name can be used in a data manipulation statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCatalogsInProcedureCalls

  boolean supportsCatalogsInProcedureCalls() throws SQLException

  Retrieves whether a catalog name can be used in a procedure call statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCatalogsInTableDefinitions

  boolean supportsCatalogsInTableDefinitions() throws SQLException

  Retrieves whether a catalog name can be used in a table definition statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCatalogsInIndexDefinitions

  boolean supportsCatalogsInIndexDefinitions() throws SQLException

  Retrieves whether a catalog name can be used in an index definition statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCatalogsInPrivilegeDefinitions

  boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException

  Retrieves whether a catalog name can be used in a privilege definition statement.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsPositionedDelete

  boolean supportsPositionedDelete() throws SQLException

  Retrieves whether this database supports positioned DELETE statements.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsPositionedUpdate

  boolean supportsPositionedUpdate() throws SQLException

  Retrieves whether this database supports positioned UPDATE statements.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSelectForUpdate

  boolean supportsSelectForUpdate() throws SQLException

  Retrieves whether this database supports SELECT FOR UPDATE statements.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsStoredProcedures

  boolean supportsStoredProcedures() throws SQLException

  Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSubqueriesInComparisons

  boolean supportsSubqueriesInComparisons() throws SQLException

  Retrieves whether this database supports subqueries in comparison expressions.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSubqueriesInExists

  boolean supportsSubqueriesInExists() throws SQLException

  Retrieves whether this database supports subqueries in EXISTS expressions.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSubqueriesInIns

  boolean supportsSubqueriesInIns() throws SQLException

  Retrieves whether this database supports subqueries in IN expressions.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsSubqueriesInQuantifieds

  boolean supportsSubqueriesInQuantifieds() throws SQLException

  Retrieves whether this database supports subqueries in quantified expressions.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsCorrelatedSubqueries

  boolean supportsCorrelatedSubqueries() throws SQLException

  Retrieves whether this database supports correlated subqueries.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsUnion

  boolean supportsUnion() throws SQLException

  Retrieves whether this database supports SQL UNION.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsUnionAll

  boolean supportsUnionAll() throws SQLException

  Retrieves whether this database supports SQL UNION ALL.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsOpenCursorsAcrossCommit

  boolean supportsOpenCursorsAcrossCommit() throws SQLException

  Retrieves whether this database supports keeping cursors open across commits.

  Returns:

  true if cursors always remain open; false if they might not remain open

  Throws:

  SQLException - if a database access error occurs

• supportsOpenCursorsAcrossRollback

  boolean supportsOpenCursorsAcrossRollback() throws SQLException

  Retrieves whether this database supports keeping cursors open across rollbacks.

  Returns:

  true if cursors always remain open; false if they might not remain open

  Throws:

  SQLException - if a database access error occurs

• supportsOpenStatementsAcrossCommit

  boolean supportsOpenStatementsAcrossCommit() throws SQLException

  Retrieves whether this database supports keeping statements open across commits.

  Returns:

  true if statements always remain open; false if they might not remain open

  Throws:

  SQLException - if a database access error occurs

• supportsOpenStatementsAcrossRollback

  boolean supportsOpenStatementsAcrossRollback() throws SQLException

  Retrieves whether this database supports keeping statements open across rollbacks.

  Returns:

  true if statements always remain open; false if they might not remain open

  Throws:

  SQLException - if a database access error occurs

• getMaxBinaryLiteralLength

  int getMaxBinaryLiteralLength() throws SQLException

  Retrieves the maximum number of hex characters this database allows in an inline binary literal.

  Returns:

  max the maximum length (in hex characters) for a binary literal; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxCharLiteralLength

  int getMaxCharLiteralLength() throws SQLException

  Retrieves the maximum number of characters this database allows for a character literal.

  Returns:

  the maximum number of characters allowed for a character literal; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxColumnNameLength

  int getMaxColumnNameLength() throws SQLException

  Retrieves the maximum number of characters this database allows for a column name.

  Returns:

  the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxColumnsInGroupBy

  int getMaxColumnsInGroupBy() throws SQLException

  Retrieves the maximum number of columns this database allows in a GROUP BY clause.

  Returns:

  the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxColumnsInIndex

  int getMaxColumnsInIndex() throws SQLException

  Retrieves the maximum number of columns this database allows in an index.

  Returns:

  the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxColumnsInOrderBy

  int getMaxColumnsInOrderBy() throws SQLException

  Retrieves the maximum number of columns this database allows in an ORDER BY clause.

  Returns:

  the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxColumnsInSelect

  int getMaxColumnsInSelect() throws SQLException

  Retrieves the maximum number of columns this database allows in a SELECT list.

  Returns:

  the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxColumnsInTable

  int getMaxColumnsInTable() throws SQLException

  Retrieves the maximum number of columns this database allows in a table.

  Returns:

  the maximum number of columns allowed; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxConnections

  int getMaxConnections() throws SQLException

  Retrieves the maximum number of concurrent connections to this database that are possible.

  Returns:

  the maximum number of active connections possible at one time; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxCursorNameLength

  int getMaxCursorNameLength() throws SQLException

  Retrieves the maximum number of characters that this database allows in a cursor name.

  Returns:

  the maximum number of characters allowed in a cursor name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxIndexLength

  int getMaxIndexLength() throws SQLException

  Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

  Returns:

  the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxSchemaNameLength

  int getMaxSchemaNameLength() throws SQLException

  Retrieves the maximum number of characters that this database allows in a schema name.

  Returns:

  the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxProcedureNameLength

  int getMaxProcedureNameLength() throws SQLException

  Retrieves the maximum number of characters that this database allows in a procedure name.

  Returns:

  the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxCatalogNameLength

  int getMaxCatalogNameLength() throws SQLException

  Retrieves the maximum number of characters that this database allows in a catalog name.

  Returns:

  the maximum number of characters allowed in a catalog name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxRowSize

  int getMaxRowSize() throws SQLException

  Retrieves the maximum number of bytes this database allows in a single row.

  Returns:

  the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• doesMaxRowSizeIncludeBlobs

  boolean doesMaxRowSizeIncludeBlobs() throws SQLException

  Retrieves whether the return value for the method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getMaxStatementLength

  int getMaxStatementLength() throws SQLException

  Retrieves the maximum number of characters this database allows in an SQL statement.

  Returns:

  the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxStatements

  int getMaxStatements() throws SQLException

  Retrieves the maximum number of active statements to this database that can be open at the same time.

  Returns:

  the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxTableNameLength

  int getMaxTableNameLength() throws SQLException

  Retrieves the maximum number of characters this database allows in a table name.

  Returns:

  the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxTablesInSelect

  int getMaxTablesInSelect() throws SQLException

  Retrieves the maximum number of tables this database allows in a SELECT statement.

  Returns:

  the maximum number of tables allowed in a SELECT statement; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getMaxUserNameLength

  int getMaxUserNameLength() throws SQLException

  Retrieves the maximum number of characters this database allows in a user name.

  Returns:

  the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

• getDefaultTransactionIsolation

  int getDefaultTransactionIsolation() throws SQLException

  Retrieves this database's default transaction isolation level. The possible values are defined in java.sql.Connection.

  Returns:

  the default isolation level

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • Connection

• supportsTransactions

  boolean supportsTransactions() throws SQLException

  Retrieves whether this database supports transactions. If not, invoking the method commit is a noop, and the isolation level is TRANSACTION_NONE.

  Returns:

  true if transactions are supported; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsTransactionIsolationLevel

  boolean supportsTransactionIsolationLevel(int level) throws SQLException

  Retrieves whether this database supports the given transaction isolation level.

  Parameters:

  level - one of the transaction isolation levels defined in java.sql.Connection

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • Connection

• supportsDataDefinitionAndDataManipulationTransactions

  boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException

  Retrieves whether this database supports both data definition and data manipulation statements within a transaction.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• supportsDataManipulationTransactionsOnly

  boolean supportsDataManipulationTransactionsOnly() throws SQLException

  Retrieves whether this database supports only data manipulation statements within a transaction.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• dataDefinitionCausesTransactionCommit

  boolean dataDefinitionCausesTransactionCommit() throws SQLException

  Retrieves whether a data definition statement within a transaction forces the transaction to commit.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• dataDefinitionIgnoredInTransactions

  boolean dataDefinitionIgnoredInTransactions() throws SQLException

  Retrieves whether this database ignores a data definition statement within a transaction.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

• getProcedures

  ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException

  Retrieves a description of the stored procedures available in the given catalog.

  Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_ NAME.

  Each procedure description has 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 - Cannot determine if a return value will be returned
     • procedureNoResult - Does not return a return value
     • procedureReturnsResult - Returns a return value
  9. SPECIFIC_NAME String => The name which uniquely identifies this procedure within its schema.

  A user may not have permissions to execute any of the procedures that are returned by getProcedures

  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

  procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database

  Returns:

  ResultSet - each row is a procedure description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getSearchStringEscape()

• getProcedureColumns

  ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException

  Retrieves a description of the given catalog's stored procedure parameter and result columns.

  Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

  Each row in the ResultSet is a parameter description or column description with the following fields:

  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. 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 int => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
  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
  14. COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
      • The string NULL (not enclosed in quotes) - if NULL was specified as the default value
      • TRUNCATE (not enclosed in quotes) - if the specified default value cannot be represented without truncation
      • NULL - if a default value was not specified
  15. SQL_DATA_TYPE int => reserved for future use
  16. SQL_DATETIME_SUB int => reserved for future use
  17. CHAR_OCTET_LENGTH int => the maximum length of binary and character based columns. For any other datatype the returned value is a NULL
  18. ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0 is returned if this row describes the procedure's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. If there are multiple result sets, the column ordinal positions are implementation defined.
  19. IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
      • YES --- if the column can include NULLs
      • NO --- if the column cannot include NULLs
      • empty string --- if the nullability for the column is unknown
  20. SPECIFIC_NAME String => the name which uniquely identifies this procedure within its schema.

  Note: Some databases may not return the column descriptions for a procedure.

  The PRECISION column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  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

  procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database

  columnNamePattern - a column name pattern; must match the column name as it is stored in the database

  Returns:

  ResultSet - each row describes a stored procedure parameter or column

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getSearchStringEscape()

• getTables

  ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException

  Retrieves a description of the tables available in the given catalog. Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_CAT, 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. REMARKS String => explanatory comment on the table (may be null)
  6. TYPE_CAT String => the types catalog (may be null)
  7. TYPE_SCHEM String => the types schema (may be null)
  8. TYPE_NAME String => type name (may be null)
  9. SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
  10. REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null)

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

  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

  tableNamePattern - a table name pattern; must match the table name as it is stored in the database

  types - a list of table types, which must be from the list of table types returned from getTableTypes(), to include; null returns all types

  Returns:

  ResultSet - each row is a table description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getSearchStringEscape()

• getSchemas

  ResultSet getSchemas() throws SQLException

  Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

  The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)

  Returns:

  a ResultSet object in which each row is a schema description

  Throws:

  SQLException - if a database access error occurs

• getCatalogs

  ResultSet getCatalogs() throws SQLException

  Retrieves the catalog names available in this database. The results are ordered by catalog name.

  The catalog column is:

  1. TABLE_CAT String => catalog name

  Returns:

  a ResultSet object in which each row has a single String column that is a catalog name

  Throws:

  SQLException - if a database access error occurs

• getTableTypes

  ResultSet getTableTypes() throws SQLException

  Retrieves 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".

  Returns:

  a ResultSet object in which each row has a single String column that is a table type

  Throws:

  SQLException - if a database access error occurs

• getColumns

  ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException

  Retrieves a description of table columns available in the specified catalog.

  Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,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 int => SQL type from java.sql.Types
  6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  7. COLUMN_SIZE int => column size.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  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 for the column, which should be interpreted as a string when the value is enclosed in single quotes (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 => ISO rules are used to determine the nullability for a column.
      • YES --- if the column can include NULLs
      • NO --- if the column cannot include NULLs
      • empty string --- if the nullability for the column is unknown
  19. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
  20. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  21. SCOPE_TABLE String => table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF)
  22. 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)
  23. IS_AUTOINCREMENT String => Indicates whether this column is auto incremented
      • YES --- if the column is auto incremented
      • NO --- if the column is not auto incremented
      • empty string --- if it cannot be determined whether the column is auto incremented
  24. IS_GENERATEDCOLUMN String => Indicates whether this is a generated column
      • YES --- if this a generated column
      • NO --- if this not a generated column
      • empty string --- if it cannot be determined whether this is a generated column

  The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  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

  tableNamePattern - a table name pattern; must match the table name as it is stored in the database

  columnNamePattern - a column name pattern; must match the column name as it is stored in the database

  Returns:

  ResultSet - each row is a column description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getSearchStringEscape()

• getColumnPrivileges

  ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException

  Retrieves a description of the access rights for a table's columns.

  Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.

  Each privilege 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 String => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFERENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

  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

  schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in the database

  columnNamePattern - a column name pattern; must match the column name as it is stored in the database

  Returns:

  ResultSet - each row is a column privilege description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getSearchStringEscape()

• getTablePrivileges

  ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException

  Retrieves a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)

  Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.

  Each privilege 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. GRANTOR String => grantor of access (may be null)
  5. GRANTEE String => grantee of access
  6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFERENCES, ...)
  7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

  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

  tableNamePattern - a table name pattern; must match the table name as it is stored in the database

  Returns:

  ResultSet - each row is a table privilege description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getSearchStringEscape()

• getBestRowIdentifier

  ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException

  Retrieves a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.

  Each column description has the following columns:

  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 int => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => not used
  7. DECIMAL_DIGITS short => scale - Null is returned for data types where DECIMAL_DIGITS is not applicable.
  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

  The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  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

  schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in the database

  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:

  SQLException - if a database access error occurs

• getVersionColumns

  ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException

  Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.

  Each column description has the following columns:

  1. SCOPE short => is not used
  2. COLUMN_NAME String => column name
  3. DATA_TYPE int => 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 - Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. PSEUDO_COLUMN short => whether this is pseudo column like an Oracle ROWID
     • versionColumnUnknown - may or may not be pseudo column
     • versionColumnNotPseudo - is NOT a pseudo column
     • versionColumnPseudo - is a pseudo column

  The COLUMN_SIZE column represents the specified column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  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

  schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in the database

  Returns:

  a ResultSet object in which each row is a column description

  Throws:

  SQLException - if a database access error occurs

• getPrimaryKeys

  ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException

  Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.

  Each primary key column description has the following columns:

  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( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key).
  6. PK_NAME String => primary key name (may be null)

  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

  schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in the database

  Returns:

  ResultSet - each row is a primary key column description

  Throws:

  SQLException - if a database access error occurs

• getImportedKeys

  ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException

  Retrieves a description of the primary key columns that are referenced by the given 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 a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
  10. UPDATE_RULE short => What happens to a foreign key when the primary key is updated:
      • importedNoAction - do not allow update of primary key if it has been imported
      • importedKeyCascade - change imported key to agree with primary key update
      • importedKeySetNull - change imported key to NULL if its primary key has been updated
      • importedKeySetDefault - change imported key to default values if its primary key has been updated
      • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
      • importedKeyNoAction - do not allow delete of primary key if it has been imported
      • importedKeyCascade - delete rows that import a deleted key
      • importedKeySetNull - change imported key to NULL if its primary key has been deleted
      • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
      • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
      • importedKeyInitiallyDeferred - see SQL92 for definition
      • importedKeyInitiallyImmediate - see SQL92 for definition
      • importedKeyNotDeferrable - see SQL92 for definition

  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

  schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in the database

  Returns:

  ResultSet - each row is a primary key column description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getExportedKeys(java.lang.String, java.lang.String, java.lang.String)

• getExportedKeys

  ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException

  Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

  Each foreign key column description has the following columns:

  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( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
      • importedNoAction - do not allow update of primary key if it has been imported
      • importedKeyCascade - change imported key to agree with primary key update
      • importedKeySetNull - change imported key to NULL if its primary key has been updated
      • importedKeySetDefault - change imported key to default values if its primary key has been updated
      • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
      • importedKeyNoAction - do not allow delete of primary key if it has been imported
      • importedKeyCascade - delete rows that import a deleted key
      • importedKeySetNull - change imported key to NULL if its primary key has been deleted
      • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
      • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
      • importedKeyInitiallyDeferred - see SQL92 for definition
      • importedKeyInitiallyImmediate - see SQL92 for definition
      • importedKeyNotDeferrable - see SQL92 for definition

  Parameters:

  catalog - a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search

  schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in this database

  Returns:

  a ResultSet object in which each row is a foreign key column description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

• getCrossReference

  ResultSet getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException

  Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table). The number of columns returned from the parent table must match the number of columns that make up the foreign key. 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 => parent key table catalog (may be null)
  2. PKTABLE_SCHEM String => parent key table schema (may be null)
  3. PKTABLE_NAME String => parent key table name
  4. PKCOLUMN_NAME String => parent 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( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
  10. UPDATE_RULE short => What happens to foreign key when parent key is updated:
      • importedNoAction - do not allow update of parent key if it has been imported
      • importedKeyCascade - change imported key to agree with parent key update
      • importedKeySetNull - change imported key to NULL if its parent key has been updated
      • importedKeySetDefault - change imported key to default values if its parent key has been updated
      • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when parent key is deleted.
      • importedKeyNoAction - do not allow delete of parent key if it has been imported
      • importedKeyCascade - delete rows that import a deleted key
      • importedKeySetNull - change imported key to NULL if its primary key has been deleted
      • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
      • importedKeySetDefault - change imported key to default if its parent key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => parent key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
      • importedKeyInitiallyDeferred - see SQL92 for definition
      • importedKeyInitiallyImmediate - see SQL92 for definition
      • importedKeyNotDeferrable - see SQL92 for definition

  Parameters:

  parentCatalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

  parentSchema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria

  parentTable - the name of the table that exports the key; must match the table name as it is stored in the database

  foreignCatalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

  foreignSchema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means drop schema name from the selection criteria

  foreignTable - the name of the table that imports the key; must match the table name as it is stored in the database

  Returns:

  ResultSet - each row is a foreign key column description

  Throws:

  SQLException - if a database access error occurs

  See Also:

  • getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

• getTypeInfo

  ResultSet getTypeInfo() throws SQLException

  Retrieves a description of all the data 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.

  If the database supports SQL distinct types, then getTypeInfo() will return a single row with a TYPE_NAME of DISTINCT and a DATA_TYPE of Types.DISTINCT. If the database supports SQL structured types, then getTypeInfo() will return a single row with a TYPE_NAME of STRUCT and a DATA_TYPE of Types.STRUCT.

  If SQL distinct or structured types are supported, then information on the individual types may be obtained from the getUDTs() method.

  Each type description has the following columns:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE int => 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

  The PRECISION column represents the maximum column size that the server supports for the given datatype. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  Returns:

  a ResultSet object in which each row is an SQL type description

  Throws:

  SQLException - if a database access error occurs

• getIndexInfo

  ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException

  Retrieves a description of the given table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

  Each index column description has the following columns:

  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 conjunction 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 long => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
  12. PAGES long => When TYPE is tableIndexStatistic 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)

  Parameters:

  catalog - a catalog name; must match the catalog name as it is stored in this database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search

  schema - a schema name; must match the schema name as it is stored in this database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  table - a table name; must match the table name as it is stored in this database

  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:

  SQLException - if a database access error occurs

• supportsResultSetType

  boolean supportsResultSetType(int type) throws SQLException

  Retrieves whether this database supports the given result set type.

  Parameters:

  type - defined in java.sql.ResultSet

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

  See Also:

  • Connection

• supportsResultSetConcurrency

  boolean supportsResultSetConcurrency(int type, int concurrency) throws SQLException

  Retrieves whether this database supports the given concurrency type in combination with the given result set type.

  Parameters:

  type - defined in java.sql.ResultSet

  concurrency - type defined in java.sql.ResultSet

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

  See Also:

  • Connection

• ownUpdatesAreVisible

  boolean ownUpdatesAreVisible(int type) throws SQLException

  Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if updates are visible for the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• ownDeletesAreVisible

  boolean ownDeletesAreVisible(int type) throws SQLException

  Retrieves whether a result set's own deletes are visible.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if deletes are visible for the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• ownInsertsAreVisible

  boolean ownInsertsAreVisible(int type) throws SQLException

  Retrieves whether a result set's own inserts are visible.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if inserts are visible for the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• othersUpdatesAreVisible

  boolean othersUpdatesAreVisible(int type) throws SQLException

  Retrieves whether updates made by others are visible.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if updates made by others are visible for the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• othersDeletesAreVisible

  boolean othersDeletesAreVisible(int type) throws SQLException

  Retrieves whether deletes made by others are visible.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if deletes made by others are visible for the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• othersInsertsAreVisible

  boolean othersInsertsAreVisible(int type) throws SQLException

  Retrieves whether inserts made by others are visible.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if inserts made by others are visible for the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• updatesAreDetected

  boolean updatesAreDetected(int type) throws SQLException

  Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if changes are detected by the result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• deletesAreDetected

  boolean deletesAreDetected(int type) throws SQLException

  Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted. If the method deletesAreDetected returns false, it means that deleted rows are removed from the result set.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if deletes are detected by the given result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• insertsAreDetected

  boolean insertsAreDetected(int type) throws SQLException

  Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted.

  Parameters:

  type - the ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

  Returns:

  true if changes are detected by the specified result set type; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• supportsBatchUpdates

  boolean supportsBatchUpdates() throws SQLException

  Retrieves whether this database supports batch updates.

  Returns:

  true if this database supports batch updates; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• getUDTs

  ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException

  Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

  Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_CAT, 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 (may be null)
  2. TYPE_SCHEM String => type's schema (may be null)
  3. TYPE_NAME String => type name
  4. CLASS_NAME String => Java class name
  5. DATA_TYPE int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
  6. REMARKS String => explanatory comment on the type
  7. BASE_TYPE short => type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (null if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)

  Note: If the driver does not support UDTs, an empty result set is returned.

  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 pattern name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search

  typeNamePattern - a type name pattern; must match the type name as it is stored in the database; may be a fully qualified name

  types - a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include; null returns all types

  Returns:

  ResultSet object in which each row describes a UDT

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

  See Also:

  • getSearchStringEscape()

• getConnection

  Connection getConnection() throws SQLException

  Retrieves the connection that produced this metadata object.

  Returns:

  the connection that produced this metadata object

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.2

• supportsSavepoints

  boolean supportsSavepoints() throws SQLException

  Retrieves whether this database supports savepoints.

  Returns:

  true if savepoints are supported; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• supportsNamedParameters

  boolean supportsNamedParameters() throws SQLException

  Retrieves whether this database supports named parameters to callable statements.

  Returns:

  true if named parameters are supported; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• supportsMultipleOpenResults

  boolean supportsMultipleOpenResults() throws SQLException

  Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.

  Returns:

  true if a CallableStatement object can return multiple ResultSet objects simultaneously; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• supportsGetGeneratedKeys

  boolean supportsGetGeneratedKeys() throws SQLException

  Retrieves whether auto-generated keys can be retrieved after a statement has been executed

  Returns:

  true if auto-generated keys can be retrieved after a statement has executed; false otherwise

  If true is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getSuperTypes

  ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException

  Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.

  Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.

  If a UDT does not have a direct super type, it is not listed here. A row of the ResultSet object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:

  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.

  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:

  SQLException - if a database access error occurs

  Since:

  1.4

  See Also:

  • getSearchStringEscape()

• getSuperTables

  ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException

  Retrieves a description of the table hierarchies defined in a particular schema in this database.

  Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.

  Each type description has the following columns:

  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.

  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:

  SQLException - if a database access error occurs

  Since:

  1.4

  See Also:

  • getSearchStringEscape()

• getAttributes

  ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException

  Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.

  Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by TYPE_CAT, 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 int => 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. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  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 the attribute in the UDT (starting at 1)
  17. IS_NULLABLE String => ISO rules are used to determine the nullability for a attribute.
      • YES --- if the attribute can include NULLs
      • NO --- if the attribute cannot include NULLs
      • empty string --- if the nullability for the attribute is 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)

  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:

  SQLException - if a database access error occurs

  Since:

  1.4

  See Also:

  • getSearchStringEscape()

• supportsResultSetHoldability

  boolean supportsResultSetHoldability(int holdability) throws SQLException

  Retrieves whether this database supports the given result set holdability.

  Parameters:

  holdability - one of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

  See Also:

  • Connection

• getResultSetHoldability

  int getResultSetHoldability() throws SQLException

  Retrieves this database's default holdability for ResultSet objects.

  Returns:

  the default holdability; either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getDatabaseMajorVersion

  int getDatabaseMajorVersion() throws SQLException

  Retrieves the major version number of the underlying database.

  Returns:

  the underlying database's major version

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getDatabaseMinorVersion

  int getDatabaseMinorVersion() throws SQLException

  Retrieves the minor version number of the underlying database.

  Returns:

  underlying database's minor version

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getJDBCMajorVersion

  int getJDBCMajorVersion() throws SQLException

  Retrieves the major JDBC version number for this driver.

  Returns:

  JDBC version major number

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getJDBCMinorVersion

  int getJDBCMinorVersion() throws SQLException

  Retrieves the minor JDBC version number for this driver.

  Returns:

  JDBC version minor number

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getSQLStateType

  int getSQLStateType() throws SQLException

  Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

  Returns:

  the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• locatorsUpdateCopy

  boolean locatorsUpdateCopy() throws SQLException

  Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

  Returns:

  true if updates are made to a copy of the LOB; false if updates are made directly to the LOB

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• supportsStatementPooling

  boolean supportsStatementPooling() throws SQLException

  Retrieves whether this database supports statement pooling.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.4

• getRowIdLifetime

  RowIdLifetime getRowIdLifetime() throws SQLException

  Indicates whether this data source supports the SQL ROWID type, and the lifetime for which a RowId object remains valid.

  Returns:

  the status indicating the lifetime of a RowId

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

• getSchemas

  ResultSet getSchemas(String catalog, String schemaPattern) throws SQLException

  Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

  The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)

  Parameters:

  catalog - a catalog name; must match the catalog name as it is stored in the database;"" retrieves those without a catalog; null means catalog name should not be used to narrow down the search.

  schemaPattern - a schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search.

  Returns:

  a ResultSet object in which each row is a schema description

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

  See Also:

  • getSearchStringEscape()

• supportsStoredFunctionsUsingCallSyntax

  boolean supportsStoredFunctionsUsingCallSyntax() throws SQLException

  Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

• autoCommitFailureClosesAllResultSets

  boolean autoCommitFailureClosesAllResultSets() throws SQLException

  Retrieves whether a SQLException while autoCommit is true indicates that all open ResultSets are closed, even ones that are holdable. When a SQLException occurs while autocommit is true, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

• getClientInfoProperties

  ResultSet getClientInfoProperties() throws SQLException

  Retrieves a list of the client info properties that the driver supports. The result set contains the following columns

  1. NAME String=> The name of the client info property
     
  2. MAX_LEN int=> The maximum length of the value for the property
     
  3. DEFAULT_VALUE String=> The default value of the property
     
  4. DESCRIPTION String=> A description of the property. This will typically contain information as to where this property is stored in the database.

  The ResultSet is sorted by the NAME column

  Returns:

  A ResultSet object; each row is a supported client info property

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

• getFunctions

  ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException

  Retrieves a description of the system and user functions available in the given catalog.

  Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME.

  Each function description has the following columns:

  1. FUNCTION_CAT String => function catalog (may be null)
  2. FUNCTION_SCHEM String => function schema (may be null)
  3. FUNCTION_NAME String => function name. This is the name used to invoke the function
  4. REMARKS String => explanatory comment on the function
  5. FUNCTION_TYPE short => kind of function:
     • functionResultUnknown - Cannot determine if a return value or table will be returned
     • functionNoTable- Does not return a table
     • functionReturnsTable - Returns a table
  6. SPECIFIC_NAME String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions

  A user may not have permission to execute any of the functions that are returned by getFunctions

  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

  functionNamePattern - a function name pattern; must match the function name as it is stored in the database

  Returns:

  ResultSet - each row is a function description

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

  See Also:

  • getSearchStringEscape()

• getFunctionColumns

  ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException

  Retrieves a description of the given catalog's system or user function parameters and return type.

  Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

  Each row in the ResultSet is a parameter description, column description or return type description with the following fields:

  1. FUNCTION_CAT String => function catalog (may be null)
  2. FUNCTION_SCHEM String => function schema (may be null)
  3. FUNCTION_NAME String => function name. This is the name used to invoke the function
  4. COLUMN_NAME String => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
     • functionColumnUnknown - nobody knows
     • functionColumnIn - IN parameter
     • functionColumnInOut - INOUT parameter
     • functionColumnOut - OUT parameter
     • functionColumnReturn - function return value
     • functionColumnResult - Indicates that the parameter or column is a column in the ResultSet
  6. DATA_TYPE int => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale - null is returned for data types where SCALE is not applicable.
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL.
      • functionNoNulls - does not allow NULL values
      • functionNullable - allows NULL values
      • functionNullableUnknown - nullability unknown
  13. REMARKS String => comment describing column/parameter
  14. CHAR_OCTET_LENGTH int => the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL
  15. ORDINAL_POSITION int => the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1.
  16. IS_NULLABLE String => ISO rules are used to determine the nullability for a parameter or column.
      • YES --- if the parameter or column can include NULLs
      • NO --- if the parameter or column cannot include NULLs
      • empty string --- if the nullability for the parameter or column is unknown
  17. SPECIFIC_NAME String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions

  The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  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

  functionNamePattern - a procedure name pattern; must match the function name as it is stored in the database

  columnNamePattern - a parameter name pattern; must match the parameter or column name as it is stored in the database

  Returns:

  ResultSet - each row describes a user function parameter, column or return type

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.6

  See Also:

  • getSearchStringEscape()

• getPseudoColumns

  ResultSet getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException

  Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema. Pseudo or hidden columns may not always be stored within a table and are not visible in a ResultSet unless they are specified in the query's outermost SELECT list. Pseudo or hidden columns may not necessarily be able to be modified. If there are no pseudo or hidden columns, an empty ResultSet is returned.

  Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,TABLE_SCHEM, TABLE_NAME and 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. DATA_TYPE int => SQL type from java.sql.Types
  6. COLUMN_SIZE int => column size.
  7. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  9. COLUMN_USAGE String => The allowed usage for the column. The value returned will correspond to the enum name returned by PseudoColumnUsage.name()
  10. REMARKS String => comment describing column (may be null)
  11. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  12. IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
      • YES --- if the column can include NULLs
      • NO --- if the column cannot include NULLs
      • empty string --- if the nullability for the column is unknown

  The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

  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

  tableNamePattern - a table name pattern; must match the table name as it is stored in the database

  columnNamePattern - a column name pattern; must match the column name as it is stored in the database

  Returns:

  ResultSet - each row is a column description

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.7

  See Also:

  • PseudoColumnUsage

• generatedKeyAlwaysReturned

  boolean generatedKeyAlwaysReturned() throws SQLException

  Retrieves whether a generated key will always be returned if the column name(s) or index(es) specified for the auto generated key column(s) are valid and the statement succeeds. The key that is returned may or may not be based on the column(s) for the auto generated key. Consult your JDBC driver documentation for additional details.

  Returns:

  true if so; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.7

• getMaxLogicalLobSize

  default long getMaxLogicalLobSize() throws SQLException

  Retrieves the maximum number of bytes this database allows for the logical size for a LOB.

  The default implementation will return 0

  Returns:

  the maximum number of bytes allowed; a result of zero means that there is no limit or the limit is not known

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.8

• supportsRefCursors

  default boolean supportsRefCursors() throws SQLException

  Retrieves whether this database supports REF CURSOR.

  The default implementation will return false

  Returns:

  true if this database supports REF CURSOR; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  1.8

• supportsSharding

  default boolean supportsSharding() throws SQLException

  Retrieves whether this database supports sharding.

  Implementation Requirements:

  The default implementation will return false

  Returns:

  true if this database supports sharding; false otherwise

  Throws:

  SQLException - if a database access error occurs

  Since:

  9