org.hsqldb.jdbc.JDBCDatabaseMetaData
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class JDBCDatabaseMetaData
Comprehensive information about the database as a whole.
This interface is implemented by driver vendors to let users know the capabilities of a Database Management System (DBMS) in combination with the driver based on JDBCTM technology ("JDBC driver") that is used with it. Different relational DBMSs often support different features, implement features in different ways, and use different data types. In addition, a driver may implement a feature on top of what the DBMS offers. Information returned by methods in this interface applies to the capabilities of a particular driver and a particular DBMS working together. Note that as used in this documentation, the term "database" is used generically to refer to both the driver and DBMS.
A user for this interface is commonly a tool that needs to discover how to
deal with the underlying DBMS. This is especially true for applications
that are intended to be used with more than one DBMS. For example, a tool might use the method
getTypeInfo to find out what data types can be used in a
CREATE TABLE statement. Or a user might call the method
supportsCorrelatedSubqueries to see if it is possible to use
a correlated subquery or supportsBatchUpdates to see if it is
possible to use batch updates.
Some DatabaseMetaData methods return lists of information
in the form of ResultSet objects.
Regular ResultSet methods, such as
getString and getInt, can be used
to retrieve the data from these ResultSet objects. If
a given form of metadata is not available, an empty ResultSet
will be returned. Additional columns beyond the columns defined to be
returned by the ResultSet object for a given method
can be defined by the JDBC driver vendor and must be accessed
by their column label.
Some DatabaseMetaData methods take arguments that are
String patterns. These arguments all have names such as fooPattern.
Within a pattern String, "%" means match any substring of 0 or more
characters, and "_" means match any one character. Only metadata
entries matching the search pattern are returned. If a search pattern
argument is set to null, that argument's criterion will
be dropped from the search.
A method that gets information about a feature that the driver does not
support will throw an SQLException.
In the case of methods that return a ResultSet
object, either a ResultSet object (which may be empty) is
returned or an SQLException is thrown.
Also starting with HSQLDB 1.7.2, the metadata table production implementation
classes are loaded dynamically, using a precedence policy to find and load
the richest producer available at runtime. In the event that no better
alternative is found, the default minimal (completely restricted) provider
is selected. Under this scheme, it is possible for third party packagers to
create custom distributions targeted at supporting full (design-time),
custom-written (proprietary / micro environment), minimal (production-time)
or completely-restricted (space-constrained | device embedded | real-time |
hostile environment) metadata table production scenarios. To learn more
about this option, interested parties can review the documentation and source
code for the org.hsqldb.dbinfo.DatabaseInformation class.
Please also note that in addition to the metadata tables produced to directly support this class, starting with HSQLDB 1.7.2, the default build provides many additional tables covering all or most HSQLDB features, such as descriptions of the triggers and aliases defined in the database.
For instance, in the default build, a fairly comprehensive description of
each INFORMATION_SCHEMA table and each INFORMATION_SCHEMA table
column is included in the REMARKS column of the getTables(...) and getColumns(...) results, which derive
from INFORMATION_SCHEMA.SYSTEM_TABLES and INFORMATION_SCHEMA.SYSTEM_COLUMNS,
respectively.
However, just as CATALOG semantics and handling are still considered to be implementation defined by the most recent SQL standard (SQL:2008), so is the HSQLDB CATALOG concept still in the process of being defined and refined in HSQLDB 2.x. and beyond.
Previous to HSQLDB 2.x, there were, at various points in time, experimental features provided to turn on pseudo catalog (and before that, pseudo-schema) reporting in the system tables, using the database properties 'hsqldb.catalogs' and 'hsqldb.schemas', respectively.
However, once the engine fully supported the SQL SCHEMA concept, the experimental 'hsqldb.schemas' * database property was retired.
Similarly, starting with HSQLDB 2.x, the 'hsqldb.catalogs' database property
has been retired and replaced with the convention that, from the perspective
of SQL identification, an HSQLDB JDBC URL connects to a single HSQLDB
database instance which consists of a single, default CATALOG
named PUBLIC in which each SCHEMA instance of the database resides. The name of
this catalog can be changed with the ALTER CATALOG
As such, when adding, extending or replacing a JDBC database metadata table
production routine, developers need to be aware of this fact and either add the
contract "ORDER BY" clause to the driving SQL or, when possible,
preferably maintain rows in the contract order by correctly coding the
primary index definition in the table producer class.
In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires
Java 1.4 and above. In HSQLDB, support for methods introduced in different
versions of JDBC depends on the JDK version used for compiling and building
HSQLDB.
Since 1.7.0, it is possible to build the product so that
all JDBC 2 methods can be called while executing under the version 1.1.x
Java Runtime EnvironmentTM.
However, some of these method calls require
In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the
JDBC2-only
(fredt@users)Index Metadata
It must still be noted that as of the most recent release, HSQLDB continues
to ignore the approximate argument of getIndexInfo() which continues to be simply indicative of absence of a fully
statistics-driven cost-based SQL plan optimization facility. When,
such a facility is implemented, corresponding improvements to
getIndexInfo will be provided. Notes for developers extending metadata table production
Note that in the absence of an ORDER BY clause, queries against the metadata
tables that directly support this class are expected to return rows in JDBC
contract order. The reason for this is that results typically come
back much faster when no "ORDER BY" clause is used.
JRE 1.1.x Notes: int values that
are defined only in the JDBC 2 or greater version of the
ResultSet interface. For this reason, when the
product is compiled under JDK 1.1.x, these values are defined in
JDBCResultSet.ResultSet values can be achieved by referring
to them in parameter specifications and return value comparisons,
respectively, as follows:
JDBCResultSet.FETCH_FORWARD
JDBCResultSet.TYPE_FORWARD_ONLY
JDBCResultSet.TYPE_SCROLL_INSENSITIVE
JDBCResultSet.CONCUR_READ_ONLY
// etc
However, please note that code written in such a manner will not be
compatible for use with other JDBC 2 drivers, since they expect and use
ResultSet, rather than JDBCResultSet. Also
note, this feature is offered solely as a convenience to developers
who must work under JDK 1.1.x due to operating constraints, yet wish to
use some of the more advanced features available under the JDBC 2
specification.
(boucherb@users)
DatabaseInformation,
DatabaseInformationMain,
DatabaseInformationFull| Field Summary | |
|---|---|
static int |
JDBC_MAJOR
|
| Method Summary | ||
|---|---|---|
boolean |
allProceduresAreCallable()
Retrieves whether the current user can call all the procedures returned by the method getProcedures. |
|
boolean |
allTablesAreSelectable()
Retrieves whether the current user can use all the tables returned by the method getTables in a SELECT
statement. |
|
boolean |
autoCommitFailureClosesAllResultSets()
Retrieves whether a SQLException while autoCommit is true inidcates
that all open ResultSets are closed, even ones that are holdable. |
|
boolean |
dataDefinitionCausesTransactionCommit()
Retrieves whether a data definition statement within a transaction forces the transaction to commit. |
|
boolean |
dataDefinitionIgnoredInTransactions()
Retrieves whether this database ignores a data definition statement within a transaction. |
|
boolean |
deletesAreDetected(int type)
Retrieves whether or not a visible row delete can be detected by calling the method ResultSet.rowDeleted. |
|
boolean |
doesMaxRowSizeIncludeBlobs()
Retrieves whether the return value for the method getMaxRowSize includes the SQL data types
LONGVARCHAR and LONGVARBINARY. |
|
boolean |
generatedKeyAlwaysReturned()
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. |
|
ResultSet |
getAttributes(String catalog,
String schemaPattern,
String typeNamePattern,
String attributeNamePattern)
Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog. |
|
ResultSet |
getBestRowIdentifier(String catalog,
String schema,
String table,
int scope,
boolean nullable)
Retrieves a description of a table's optimal set of columns that uniquely identifies a row. |
|
ResultSet |
getCatalogs()
Retrieves the catalog names available in this database. |
|
String |
getCatalogSeparator()
Retrieves the String that this database uses as the
separator between a catalog and table name. |
|
String |
getCatalogTerm()
Retrieves the database vendor's preferred term for "catalog". |
|
ResultSet |
getClientInfoProperties()
Retrieves a list of the client info properties that the driver supports. |
|
ResultSet |
getColumnPrivileges(String catalog,
String schema,
String table,
String columnNamePattern)
Retrieves a description of the access rights for a table's columns. |
|
ResultSet |
getColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern)
Retrieves a description of table columns available in the specified catalog. |
|
Connection |
getConnection()
Retrieves the connection that produced this metadata object. |
|
ResultSet |
getCrossReference(String parentCatalog,
String parentSchema,
String parentTable,
String foreignCatalog,
String foreignSchema,
String foreignTable)
(JDBC4 clarification:) 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). |
|
int |
getDatabaseMajorVersion()
Retrieves the major version number of the underlying database. |
|
int |
getDatabaseMinorVersion()
Retrieves the minor version number of the underlying database. |
|
String |
getDatabaseProductName()
Retrieves the name of this database product. |
|
String |
getDatabaseProductVersion()
Retrieves the version number of this database product. |
|
int |
getDefaultTransactionIsolation()
Retrieves this database's default transaction isolation level. |
|
int |
getDriverMajorVersion()
Retrieves this JDBC driver's major version number. |
|
int |
getDriverMinorVersion()
Retrieves this JDBC driver's minor version number. |
|
String |
getDriverName()
Retrieves the name of this JDBC driver. |
|
String |
getDriverVersion()
Retrieves the version number of this JDBC driver as a String. |
|
ResultSet |
getExportedKeys(String catalog,
String schema,
String table)
Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). |
|
String |
getExtraNameCharacters()
Retrieves all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). |
|
ResultSet |
getFunctionColumns(String catalog,
String schemaPattern,
String functionNamePattern,
String columnNamePattern)
Retrieves a description of the given catalog's system or user function parameters and return type. |
|
ResultSet |
getFunctions(String catalog,
String schemaPattern,
String functionNamePattern)
Retrieves a description of the JDBC 4.1[ system and ]user functions available in the given catalog. |
|
String |
getIdentifierQuoteString()
Retrieves the string used to quote SQL identifiers. |
|
ResultSet |
getImportedKeys(String catalog,
String schema,
String table)
Retrieves a description of the primary key columns that are referenced by the given table's foreign key columns (the primary keys imported by a table). |
|
ResultSet |
getIndexInfo(String catalog,
String schema,
String table,
boolean unique,
boolean approximate)
Retrieves a description of the given table's indices and statistics. |
|
int |
getJDBCMajorVersion()
Retrieves the major JDBC version number for this driver. |
|
int |
getJDBCMinorVersion()
Retrieves the minor JDBC version number for this driver. |
|
int |
getMaxBinaryLiteralLength()
Retrieves the maximum number of hex characters this database allows in an inline binary literal. |
|
int |
getMaxCatalogNameLength()
Retrieves the maximum number of characters that this database allows in a catalog name. |
|
int |
getMaxCharLiteralLength()
Retrieves the maximum number of characters this database allows for a character literal. |
|
int |
getMaxColumnNameLength()
Retrieves the maximum number of characters this database allows for a column name. |
|
int |
getMaxColumnsInGroupBy()
Retrieves the maximum number of columns this database allows in a GROUP BY clause. |
|
int |
getMaxColumnsInIndex()
Retrieves the maximum number of columns this database allows in an index. |
|
int |
getMaxColumnsInOrderBy()
Retrieves the maximum number of columns this database allows in an ORDER BY clause. |
|
int |
getMaxColumnsInSelect()
Retrieves the maximum number of columns this database allows in a SELECT list. |
|
int |
getMaxColumnsInTable()
Retrieves the maximum number of columns this database allows in a table. |
|
int |
getMaxConnections()
Retrieves the maximum number of concurrent connections to this database that are possible. |
|
int |
getMaxCursorNameLength()
Retrieves the maximum number of characters that this database allows in a cursor name. |
|
int |
getMaxIndexLength()
Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index. |
|
int |
getMaxProcedureNameLength()
Retrieves the maximum number of characters that this database allows in a procedure name. |
|
int |
getMaxRowSize()
Retrieves the maximum number of bytes this database allows in a single row. |
|
int |
getMaxSchemaNameLength()
Retrieves the maximum number of characters that this database allows in a schema name. |
|
int |
getMaxStatementLength()
Retrieves the maximum number of characters this database allows in an SQL statement. |
|
int |
getMaxStatements()
Retrieves the maximum number of active statements to this database that can be open at the same time. |
|
int |
getMaxTableNameLength()
Retrieves the maximum number of characters this database allows in a table name. |
|
int |
getMaxTablesInSelect()
Retrieves the maximum number of tables this database allows in a SELECT statement. |
|
int |
getMaxUserNameLength()
Retrieves the maximum number of characters this database allows in a user name. |
|
String |
getNumericFunctions()
Retrieves a comma-separated list of math functions available with this database. |
|
ResultSet |
getPrimaryKeys(String catalog,
String schema,
String table)
Retrieves a description of the given table's primary key columns. |
|
ResultSet |
getProcedureColumns(String catalog,
String schemaPattern,
String procedureNamePattern,
String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter and result columns. |
|
ResultSet |
getProcedures(String catalog,
String schemaPattern,
String procedureNamePattern)
Retrieves a description of the stored procedures available in the given catalog. |
|
String |
getProcedureTerm()
Retrieves the database vendor's preferred term for "procedure". |
|
ResultSet |
getPseudoColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern)
Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema. |
|
int |
getResultSetHoldability()
(JDBC4 clarification:) Retrieves this database's default holdability for ResultSet
objects. |
|
RowIdLifetime |
getRowIdLifetime()
Indicates whether or not this data source supports the SQL ROWID type,
and if so the lifetime for which a RowId object remains valid. |
|
ResultSet |
getSchemas()
Retrieves the schema names available in this database. |
|
ResultSet |
getSchemas(String catalog,
String schemaPattern)
Retrieves the schema names available in this database. |
|
String |
getSchemaTerm()
Retrieves the database vendor's preferred term for "schema". |
|
String |
getSearchStringEscape()
Retrieves the string that can be used to escape wildcard characters. |
|
String |
getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords. |
|
int |
getSQLStateType()
(JDBC4 modified:) Indicates whether the SQLSTATE returned by SQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003. |
|
String |
getStringFunctions()
Retrieves a comma-separated list of string functions available with this database. |
|
ResultSet |
getSuperTables(String catalog,
String schemaPattern,
String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular schema in this database. |
|
ResultSet |
getSuperTypes(String catalog,
String schemaPattern,
String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. |
|
String |
getSystemFunctions()
Retrieves a comma-separated list of system functions available with this database. |
|
ResultSet |
getTablePrivileges(String catalog,
String schemaPattern,
String tableNamePattern)
Retrieves a description of the access rights for each table available in a catalog. |
|
ResultSet |
getTables(String catalog,
String schemaPattern,
String tableNamePattern,
String[] types)
Retrieves a description of the tables available in the given catalog. |
|
ResultSet |
getTableTypes()
Retrieves the table types available in this database. |
|
String |
getTimeDateFunctions()
Retrieves a comma-separated list of the time and date functions available with this database. |
|
ResultSet |
getTypeInfo()
Retrieves a description of all the (JDBC4 clarification:) data types supported by this database. |
|
ResultSet |
getUDTs(String catalog,
String schemaPattern,
String typeNamePattern,
int[] types)
Retrieves a description of the user-defined types (UDTs) defined in a particular schema. |
|
String |
getURL()
Retrieves the URL for this DBMS. |
|
String |
getUserName()
Retrieves the user name as known to this database. |
|
ResultSet |
getVersionColumns(String catalog,
String schema,
String table)
Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. |
|
boolean |
insertsAreDetected(int type)
Retrieves whether or not a visible row insert can be detected by calling the method ResultSet.rowInserted. |
|
boolean |
isCatalogAtStart()
Retrieves whether a catalog appears at the start of a fully qualified table name. |
|
boolean |
isReadOnly()
Retrieves whether this database is in read-only mode. |
|
boolean |
isWrapperFor(Class<?> iface)
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. |
|
boolean |
locatorsUpdateCopy()
Indicates whether updates made to a LOB are made on a copy or directly to the LOB. |
|
boolean |
nullPlusNonNullIsNull()
Retrieves whether this database supports concatenations between NULL and non-NULL values being
NULL. |
|
boolean |
nullsAreSortedAtEnd()
Retrieves whether NULL values are sorted at the end regardless of
sort order. |
|
boolean |
nullsAreSortedAtStart()
Retrieves whether NULL values are sorted at the start regardless
of sort order. |
|
boolean |
nullsAreSortedHigh()
Retrieves whether NULL values are sorted high. |
|
boolean |
nullsAreSortedLow()
Retrieves whether NULL values are sorted low. |
|
boolean |
othersDeletesAreVisible(int type)
Retrieves whether deletes made by others are visible. |
|
boolean |
othersInsertsAreVisible(int type)
Retrieves whether inserts made by others are visible. |
|
boolean |
othersUpdatesAreVisible(int type)
Retrieves whether updates made by others are visible. |
|
boolean |
ownDeletesAreVisible(int type)
Retrieves whether a result set's own deletes are visible. |
|
boolean |
ownInsertsAreVisible(int type)
Retrieves whether a result set's own inserts are visible. |
|
boolean |
ownUpdatesAreVisible(int type)
Retrieves whether for the given type of ResultSet object,
the result set's own updates are visible. |
|
boolean |
storesLowerCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in lower case. |
|
boolean |
storesLowerCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in lower case. |
|
boolean |
storesMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in mixed case. |
|
boolean |
storesMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in mixed case. |
|
boolean |
storesUpperCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case. |
|
boolean |
storesUpperCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case insensitive and stores them in upper case. |
|
boolean |
supportsAlterTableWithAddColumn()
Retrieves whether this database supports ALTER TABLE
with add column. |
|
boolean |
supportsAlterTableWithDropColumn()
Retrieves whether this database supports ALTER TABLE
with drop column. |
|
boolean |
supportsANSI92EntryLevelSQL()
Retrieves whether this database supports the ANSI92 entry level SQL grammar. |
|
boolean |
supportsANSI92FullSQL()
Retrieves whether this database supports the ANSI92 full SQL grammar supported. |
|
boolean |
supportsANSI92IntermediateSQL()
Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported. |
|
boolean |
supportsBatchUpdates()
Retrieves whether this database supports batch updates. |
|
boolean |
supportsCatalogsInDataManipulation()
Retrieves whether a catalog name can be used in a data manipulation statement. |
|
boolean |
supportsCatalogsInIndexDefinitions()
Retrieves whether a catalog name can be used in an index definition statement. |
|
boolean |
supportsCatalogsInPrivilegeDefinitions()
Retrieves whether a catalog name can be used in a privilege definition statement. |
|
boolean |
supportsCatalogsInProcedureCalls()
Retrieves whether a catalog name can be used in a procedure call statement. |
|
boolean |
supportsCatalogsInTableDefinitions()
Retrieves whether a catalog name can be used in a table definition statement. |
|
boolean |
supportsColumnAliasing()
Retrieves whether this database supports column aliasing. |
|
boolean |
supportsConvert()
(JDBC4 clarification:) Retrieves whether this database supports the JDBC scalar function CONVERT for the conversion of one JDBC type to another. |
|
boolean |
supportsConvert(int fromType,
int toType)
(JDBC4 clarification:) Retrieves whether this database supports the JDBC scalar function CONVERT for conversions between the JDBC types fromType
and toType. |
|
boolean |
supportsCoreSQLGrammar()
Retrieves whether this database supports the ODBC Core SQL grammar. |
|
boolean |
supportsCorrelatedSubqueries()
Retrieves whether this database supports correlated subqueries. |
|
boolean |
supportsDataDefinitionAndDataManipulationTransactions()
Retrieves whether this database supports both data definition and data manipulation statements within a transaction. |
|
boolean |
supportsDataManipulationTransactionsOnly()
Retrieves whether this database supports only data manipulation statements within a transaction. |
|
boolean |
supportsDifferentTableCorrelationNames()
Retrieves whether, when table correlation names are supported, they are restricted to being different from the names of the tables. |
|
boolean |
supportsExpressionsInOrderBy()
Retrieves whether this database supports expressions in ORDER BY lists. |
|
boolean |
supportsExtendedSQLGrammar()
Retrieves whether this database supports the ODBC Extended SQL grammar. |
|
boolean |
supportsFullOuterJoins()
Retrieves whether this database supports full nested outer joins. |
|
boolean |
supportsGetGeneratedKeys()
Retrieves whether auto-generated keys can be retrieved after a statement has been executed |
|
boolean |
supportsGroupBy()
Retrieves whether this database supports some form of GROUP BY clause. |
|
boolean |
supportsGroupByBeyondSelect()
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. |
|
boolean |
supportsGroupByUnrelated()
Retrieves whether this database supports using a column that is not in the SELECT statement in a
GROUP BY clause. |
|
boolean |
supportsIntegrityEnhancementFacility()
Retrieves whether this database supports the SQL Integrity Enhancement Facility. |
|
boolean |
supportsLikeEscapeClause()
Retrieves whether this database supports specifying a LIKE escape clause. |
|
boolean |
supportsLimitedOuterJoins()
Retrieves whether this database provides limited support for outer joins. |
|
boolean |
supportsMinimumSQLGrammar()
Retrieves whether this database supports the ODBC Minimum SQL grammar. |
|
boolean |
supportsMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as case sensitive and as a result stores them in mixed case. |
|
boolean |
supportsMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as case sensitive and as a result stores them in mixed case. |
|
boolean |
supportsMultipleOpenResults()
Retrieves whether it is possible to have multiple ResultSet objects
returned from a CallableStatement object
simultaneously. |
|
boolean |
supportsMultipleResultSets()
Retrieves whether this database supports getting multiple ResultSet objects from a single call to the
method execute. |
|
boolean |
supportsMultipleTransactions()
Retrieves whether this database allows having multiple transactions open at once (on different connections). |
|
boolean |
supportsNamedParameters()
Retrieves whether this database supports named parameters to callable statements. |
|
boolean |
supportsNonNullableColumns()
Retrieves whether columns in this database may be defined as non-nullable. |
|
boolean |
supportsOpenCursorsAcrossCommit()
Retrieves whether this database supports keeping cursors open across commits. |
|
boolean |
supportsOpenCursorsAcrossRollback()
Retrieves whether this database supports keeping cursors open across rollbacks. |
|
boolean |
supportsOpenStatementsAcrossCommit()
Retrieves whether this database supports keeping statements open across commits. |
|
boolean |
supportsOpenStatementsAcrossRollback()
Retrieves whether this database supports keeping statements open across rollbacks. |
|
boolean |
supportsOrderByUnrelated()
Retrieves whether this database supports using a column that is not in the SELECT statement in an
ORDER BY clause. |
|
boolean |
supportsOuterJoins()
Retrieves whether this database supports some form of outer join. |
|
boolean |
supportsPositionedDelete()
Retrieves whether this database supports positioned DELETE
statements. |
|
boolean |
supportsPositionedUpdate()
Retrieves whether this database supports positioned UPDATE
statements. |
|
boolean |
supportsResultSetConcurrency(int type,
int concurrency)
Retrieves whether this database supports the given concurrency type in combination with the given result set type. |
|
boolean |
supportsResultSetHoldability(int holdability)
Retrieves whether this database supports the given result set holdability. |
|
boolean |
supportsResultSetType(int type)
Retrieves whether this database supports the given result set type. |
|
boolean |
supportsSavepoints()
Retrieves whether this database supports savepoints. |
|
boolean |
supportsSchemasInDataManipulation()
Retrieves whether a schema name can be used in a data manipulation statement. |
|
boolean |
supportsSchemasInIndexDefinitions()
Retrieves whether a schema name can be used in an index definition statement. |
|
boolean |
supportsSchemasInPrivilegeDefinitions()
Retrieves whether a schema name can be used in a privilege definition statement. |
|
boolean |
supportsSchemasInProcedureCalls()
Retrieves whether a schema name can be used in a procedure call statement. |
|
boolean |
supportsSchemasInTableDefinitions()
Retrieves whether a schema name can be used in a table definition statement. |
|
boolean |
supportsSelectForUpdate()
Retrieves whether this database supports SELECT FOR UPDATE
statements. |
|
boolean |
supportsStatementPooling()
Retrieves whether this database supports statement pooling. |
|
boolean |
supportsStoredFunctionsUsingCallSyntax()
Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax. |
|
boolean |
supportsStoredProcedures()
Retrieves whether this database supports stored procedure calls that use the stored procedure escape syntax. |
|
boolean |
supportsSubqueriesInComparisons()
Retrieves whether this database supports subqueries in comparison expressions. |
|
boolean |
supportsSubqueriesInExists()
Retrieves whether this database supports subqueries in EXISTS expressions. |
|
boolean |
supportsSubqueriesInIns()
(JDBC4 correction:) Retrieves whether this database supports subqueries in IN expressions. |
|
boolean |
supportsSubqueriesInQuantifieds()
Retrieves whether this database supports subqueries in quantified expressions. |
|
boolean |
supportsTableCorrelationNames()
Retrieves whether this database supports table correlation names. |
|
boolean |
supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction isolation level. |
|
boolean |
supportsTransactions()
Retrieves whether this database supports transactions. |
|
boolean |
supportsUnion()
Retrieves whether this database supports SQL UNION. |
|
boolean |
supportsUnionAll()
Retrieves whether this database supports SQL UNION ALL. |
|
|
unwrap(Class<T> iface)
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. |
|
boolean |
updatesAreDetected(int type)
Retrieves whether or not a visible row update can be detected by calling the method ResultSet.rowUpdated. |
|
boolean |
usesLocalFilePerTable()
Retrieves whether this database uses a file for each table. |
|
boolean |
usesLocalFiles()
Retrieves whether this database stores tables in a local file. |
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int JDBC_MAJOR
| Method Detail |
|---|
public boolean allProceduresAreCallable()
throws SQLException
getProcedures.
This method still always returns
true.
In a future release, the plugin interface may be modified to allow implementors to report different values here, based on their implementations.
allProceduresAreCallable in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean allTablesAreSelectable()
throws SQLException
getTables in a SELECT
statement.
HSQLDB always reports true.
Please note that the default HSQLDB getTables behaviour is
omit from the list of requested tables only those to which the
invoking user has no access of any kind.
allTablesAreSelectable in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public String getURL()
throws SQLException
getURL in interface DatabaseMetaDatanull if it cannot be
generated
SQLException - if a database access error occurs
public String getUserName()
throws SQLException
getUserName in interface DatabaseMetaDataSQLException - if a database access error occurs
public boolean isReadOnly()
throws SQLException
Starting with 1.7.2, this makes an SQL call to the new isReadOnlyDatabase function which provides correct determination of the read-only status for both local and remote database instances.
isReadOnly in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean nullsAreSortedHigh()
throws SQLException
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.
By default HSQLDB sorts null at start; this method always returns false.
nullsAreSortedHigh in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean nullsAreSortedLow()
throws SQLException
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.
By default HSQLDB sorts null at the start; this method always returns false.
nullsAreSortedLow in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean nullsAreSortedAtStart()
throws SQLException
NULL values are sorted at the start regardless
of sort order.
By default HSQLDB sorts null at the start; this method always returns true.
Use NULLS LAST in the ORDER BY clause to sort null at the end.
nullsAreSortedAtStart in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean nullsAreSortedAtEnd()
throws SQLException
NULL values are sorted at the end regardless of
sort order.
By default HSQLDB sorts null at the start; this method always returns true.
nullsAreSortedAtEnd in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public String getDatabaseProductName()
throws SQLException
Returns the name of the HSQLDB engine.
getDatabaseProductName in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getDatabaseProductVersion()
throws SQLException
Returns the full version string.
getDatabaseProductVersion in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getDriverName()
throws SQLException
getDriverName in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getDriverVersion()
throws SQLException
String.
getDriverVersion in interface DatabaseMetaDataSQLException - if a database access error occurspublic int getDriverMajorVersion()
getDriverMajorVersion in interface DatabaseMetaDatapublic int getDriverMinorVersion()
getDriverMinorVersion in interface DatabaseMetaData
public boolean usesLocalFiles()
throws SQLException
From HSQLDB 1.7.2 it is assumed that this refers to data being stored by the JDBC client. This method always returns false.
usesLocalFiles in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean usesLocalFilePerTable()
throws SQLException
HSQLDB does not use a file for each table.
This method always returns false.
usesLocalFilePerTable in interface DatabaseMetaDatatrue if this database uses a local file for each table;
false otherwise
SQLException - if a database access error occurs
public boolean supportsMixedCaseIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns false.
supportsMixedCaseIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean storesUpperCaseIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns true.
storesUpperCaseIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean storesLowerCaseIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns false.
storesLowerCaseIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean storesMixedCaseIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns false.
storesMixedCaseIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsMixedCaseQuotedIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns true.
supportsMixedCaseQuotedIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean storesUpperCaseQuotedIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns false.
storesUpperCaseQuotedIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean storesLowerCaseQuotedIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns false.
storesLowerCaseQuotedIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean storesMixedCaseQuotedIdentifiers()
throws SQLException
HSQLDB treats unquoted identifiers as case insensitive and stores
them in upper case. It treats quoted identifiers as case sensitive and
stores them verbatim; this method always returns false.
storesMixedCaseQuotedIdentifiers in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public String getIdentifierQuoteString()
throws SQLException
HSQLDB uses the standard SQL identifier quote character (the double quote character); this method always returns ".
getIdentifierQuoteString in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getSQLKeywords()
throws SQLException
The list is empty. However, HSQLDB also supports SQL:2008 keywords and disallows them for database object names without double quoting.
getSQLKeywords in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getNumericFunctions()
throws SQLException
getNumericFunctions in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getStringFunctions()
throws SQLException
getStringFunctions in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getSystemFunctions()
throws SQLException
getSystemFunctions in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getTimeDateFunctions()
throws SQLException
getTimeDateFunctions in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getSearchStringEscape()
throws SQLException
The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.
HSQLDB uses the "\" character to escape wildcard characters.
getSearchStringEscape in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getExtraNameCharacters()
throws SQLException
HSQLDB does not support using any "extra" characters in unquoted identifier names; this method always returns the empty String.
getExtraNameCharacters in interface DatabaseMetaDataSQLException - if a database access error occurs
public boolean supportsAlterTableWithAddColumn()
throws SQLException
ALTER TABLE
with add column.
From 1.7.0, HSQLDB supports this type of
ALTER TABLE statement; this method always
returns true.
supportsAlterTableWithAddColumn in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsAlterTableWithDropColumn()
throws SQLException
ALTER TABLE
with drop column.
From 1.7.0, HSQLDB supports this type of
ALTER TABLE statement; this method always
returns true.
supportsAlterTableWithDropColumn in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsColumnAliasing()
throws SQLException
If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
HSQLDB supports column aliasing; this method always
returns true.
supportsColumnAliasing in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean nullPlusNonNullIsNull()
throws SQLException
NULL and non-NULL values being
NULL.
HSQLDB supports this; this method always
returns true.
nullPlusNonNullIsNull in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsConvert()
throws SQLException
CONVERT for the conversion of one JDBC type to another.
The JDBC types are the generic SQL data types defined
in java.sql.Types.
HSQLDB supports conversions; this method always
returns true.
supportsConvert in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsConvert(int fromType,
int toType)
throws SQLException
CONVERT for conversions between the JDBC types fromType
and toType. The JDBC types are the generic SQL data types defined
in java.sql.Types.
HSQLDB 2.0 supports conversion according to SQL standards. In addition, it supports conversion between values of BOOLEAN and BIT types.
supportsConvert in interface DatabaseMetaDatafromType - the type to convert from; one of the type codes from
the class java.sql.TypestoType - the type to convert to; one of the type codes from
the class java.sql.Types
true if so; false otherwise
SQLException - if a database access error occursTypes
public boolean supportsTableCorrelationNames()
throws SQLException
HSQLDB supports table correlation names; this method always
returns true.
supportsTableCorrelationNames in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsDifferentTableCorrelationNames()
throws SQLException
HSQLDB requires that table correlation names are different from the
names of the tables; this method always returns true.
supportsDifferentTableCorrelationNames in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsExpressionsInOrderBy()
throws SQLException
ORDER BY lists.
HSQLDB supports expressions in ORDER BY lists; this
method always returns true.
supportsExpressionsInOrderBy in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsOrderByUnrelated()
throws SQLException
SELECT statement in an
ORDER BY clause.
HSQLDB supports using a column that is not in the SELECT
statement in an ORDER BY clause; this method always
returns true.
supportsOrderByUnrelated in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsGroupBy()
throws SQLException
GROUP BY clause.
HSQLDB supports using the GROUP BY clause; this method
always returns true.
supportsGroupBy in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsGroupByUnrelated()
throws SQLException
SELECT statement in a
GROUP BY clause.
HSQLDB supports using a column that is
not in the SELECT statement in a
GROUP BY clause; this method
always returns true.
supportsGroupByUnrelated in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsGroupByBeyondSelect()
throws SQLException
SELECT statement in a GROUP BY clause
provided that all of the columns in the SELECT statement
are included in the GROUP BY clause.
HSQLDB 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; this method
always returns true.
supportsGroupByBeyondSelect in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsLikeEscapeClause()
throws SQLException
LIKE escape clause.
HSQLDB supports specifying a
LIKE escape clause; this method
always returns true.
supportsLikeEscapeClause in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsMultipleResultSets()
throws SQLException
ResultSet objects from a single call to the
method execute.
HSQLDB 2.0 supports getting multiple
ResultSet objects from a single call to the method
execute of the CallableStatement interface;
this method returns true.
supportsMultipleResultSets in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsMultipleTransactions()
throws SQLException
HSQLDB allows having multiple
transactions open at once (on different connections); this method
always returns true.
supportsMultipleTransactions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsNonNullableColumns()
throws SQLException
HSQLDB supports the specification of non-nullable columns; this method
always returns true.
supportsNonNullableColumns in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsMinimumSQLGrammar()
throws SQLException
From 2.0, HSQLDB supports the ODBC Minimum SQL grammar;
this method always returns true.
supportsMinimumSQLGrammar in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCoreSQLGrammar()
throws SQLException
From 2.0, HSQLDB supports the ODBC Core SQL grammar;
this method always returns true.
supportsCoreSQLGrammar in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsExtendedSQLGrammar()
throws SQLException
From 2.0, HSQLDB supports the ODBC Extended SQL grammar;
this method always returns true.
supportsExtendedSQLGrammar in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsANSI92EntryLevelSQL()
throws SQLException
From 2.0, HSQLDB supports the ANSI92 entry level SQL grammar;
this method always returns true.
supportsANSI92EntryLevelSQL in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsANSI92IntermediateSQL()
throws SQLException
From 2.0, HSQLDB supports the ANSI92 intermediate SQL grammar;
this method always returns true.
supportsANSI92IntermediateSQL in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsANSI92FullSQL()
throws SQLException
From 2.0, HSQLDB supports the ANSI92 full SQL grammar. The exceptions,
such as support for ASSERTION, are not considered grammer issues.
This method always returns true.
supportsANSI92FullSQL in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsIntegrityEnhancementFacility()
throws SQLException
This method always returns true.
supportsIntegrityEnhancementFacility in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsOuterJoins()
throws SQLException
HSQLDB supports outer joins; this method always returns
true.
supportsOuterJoins in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsFullOuterJoins()
throws SQLException
From 2.0, HSQLDB supports full nested outer
joins; this method always returns true.
supportsFullOuterJoins in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsLimitedOuterJoins()
throws SQLException
true if the method
supportsFullOuterJoins returns true).
HSQLDB supports the LEFT OUTER join syntax;
this method always returns true.
supportsLimitedOuterJoins in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public String getSchemaTerm()
throws SQLException
Starting with 1.8.0, HSQLDB supports schemas.
getSchemaTerm in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getProcedureTerm()
throws SQLException
From 2.0, HSQLDB supports declaration of functions or procedures directly in SQL.
getProcedureTerm in interface DatabaseMetaDataSQLException - if a database access error occurs
public String getCatalogTerm()
throws SQLException
HSQLDB uses the standard name CATALOG.
getCatalogTerm in interface DatabaseMetaDataSQLException - if a database access error occurs
public boolean isCatalogAtStart()
throws SQLException
When allowed, a catalog appears at the start of a fully qualified
table name; this method always returns true.
isCatalogAtStart in interface DatabaseMetaDatatrue if the catalog name appears at the beginning
of a fully qualified table name; false otherwise
SQLException - if a database access error occurs
public String getCatalogSeparator()
throws SQLException
String that this database uses as the
separator between a catalog and table name.
When used, a catalog name is separated with period; this method always returns a period
getCatalogSeparator in interface DatabaseMetaDataSQLException - if a database access error occurs
public boolean supportsSchemasInDataManipulation()
throws SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInDataManipulation in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSchemasInProcedureCalls()
throws SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInProcedureCalls in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSchemasInTableDefinitions()
throws SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInTableDefinitions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSchemasInIndexDefinitions()
throws SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInIndexDefinitions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSchemasInPrivilegeDefinitions()
throws SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInPrivilegeDefinitions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCatalogsInDataManipulation()
throws SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInDataManipulation in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCatalogsInProcedureCalls()
throws SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInProcedureCalls in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCatalogsInTableDefinitions()
throws SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInTableDefinitions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCatalogsInIndexDefinitions()
throws SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInIndexDefinitions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCatalogsInPrivilegeDefinitions()
throws SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInPrivilegeDefinitions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsPositionedDelete()
throws SQLException
DELETE
statements.
HSQLDB 2.0 supports updateable result sets;
this method always returns true.
supportsPositionedDelete in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsPositionedUpdate()
throws SQLException
UPDATE
statements.
HSQLDB 2.0 supports updateable result sets;
this method always returns true.
supportsPositionedUpdate in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSelectForUpdate()
throws SQLException
SELECT FOR UPDATE
statements.
HSQLDB 2.0 supports updateable result sets;
this method always returns true.
supportsSelectForUpdate in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsStoredProcedures()
throws SQLException
HSQLDB supports calling public static Java methods in the context of SQL
Stored Procedures; this method always returns true.
supportsStoredProcedures in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occursJDBCParameterMetaData,
JDBCConnection.prepareCall(java.lang.String)
public boolean supportsSubqueriesInComparisons()
throws SQLException
HSQLDB has always supported subqueries in comparison expressions;
this method always returns true.
supportsSubqueriesInComparisons in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSubqueriesInExists()
throws SQLException
EXISTS expressions.
HSQLDB has always supported subqueries in EXISTS
expressions; this method always returns true.
supportsSubqueriesInExists in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSubqueriesInIns()
throws SQLException
IN expressions.
HSQLDB has always supported subqueries in IN
statements; this method always returns true.
supportsSubqueriesInIns in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsSubqueriesInQuantifieds()
throws SQLException
HSQLDB has always supported subqueries in quantified
expressions; this method always returns true.
supportsSubqueriesInQuantifieds in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsCorrelatedSubqueries()
throws SQLException
HSQLDB has always supported correlated subqueries;
this method always returns true.
supportsCorrelatedSubqueries in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsUnion()
throws SQLException
UNION.
HSQLDB supports SQL UNION;
this method always returns true.
supportsUnion in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsUnionAll()
throws SQLException
UNION ALL.
HSQLDB supports SQL UNION ALL;
this method always returns true.
supportsUnionAll in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsOpenCursorsAcrossCommit()
throws SQLException
HSQLDB 2.0 supports keeping cursors open across commits.
This method always returns true.
supportsOpenCursorsAcrossCommit in interface DatabaseMetaDatatrue if cursors always remain open;
false if they might not remain open
SQLException - if a database access error occurs
public boolean supportsOpenCursorsAcrossRollback()
throws SQLException
HSQLDB 2.0 closes open cursors at rollback.
This method always returns false.
supportsOpenCursorsAcrossRollback in interface DatabaseMetaDatatrue if cursors always remain open;
false if they might not remain open
SQLException - if a database access error occurs
public boolean supportsOpenStatementsAcrossCommit()
throws SQLException
HSQLDB supports keeping statements open across commits;
this method always returns true.
supportsOpenStatementsAcrossCommit in interface DatabaseMetaDatatrue if statements always remain open;
false if they might not remain open
SQLException - if a database access error occurs
public boolean supportsOpenStatementsAcrossRollback()
throws SQLException
HSQLDB supports keeping statements open across rollbacks;
this method always returns true.
supportsOpenStatementsAcrossRollback in interface DatabaseMetaDatatrue if statements always remain open;
false if they might not remain open
SQLException - if a database access error occurs
public int getMaxBinaryLiteralLength()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxBinaryLiteralLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxCharLiteralLength()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxCharLiteralLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxColumnNameLength()
throws SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxColumnNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxColumnsInGroupBy()
throws SQLException
GROUP BY clause.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxColumnsInGroupBy in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxColumnsInIndex()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxColumnsInIndex in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxColumnsInOrderBy()
throws SQLException
ORDER BY clause.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxColumnsInOrderBy in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxColumnsInSelect()
throws SQLException
SELECT list.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxColumnsInSelect in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxColumnsInTable()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxColumnsInTable in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxConnections()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxConnections in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxCursorNameLength()
throws SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxCursorNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxIndexLength()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory and disk availabily; this method always returns 0.
getMaxIndexLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxSchemaNameLength()
throws SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxSchemaNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxProcedureNameLength()
throws SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxProcedureNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxCatalogNameLength()
throws SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxCatalogNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxRowSize()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory and disk availabily; this method always returns 0.
getMaxRowSize in interface DatabaseMetaDataSQLException - if a database access error occurs
public boolean doesMaxRowSizeIncludeBlobs()
throws SQLException
getMaxRowSize includes the SQL data types
LONGVARCHAR and LONGVARBINARY.
Including 2.0, getMaxRowSize() always returns
0, indicating that the maximum row size is unknown or has no limit.
This applies to the above types as well; this method always
returns true.
doesMaxRowSizeIncludeBlobs in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public int getMaxStatementLength()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxStatementLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxStatements()
throws SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxStatements in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxTableNameLength()
throws SQLException
Up to and including 1.8.0.x, HSQLDB did not impose a "known" limit. Th
hard limit was the maximum length of a java.lang.String
(java.lang.Integer.MAX_VALUE); this method always returned
0.
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for
all names.
getMaxTableNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getMaxTablesInSelect()
throws SQLException
SELECT statement.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availabily; this method always returns 0.
getMaxTablesInSelect in interface DatabaseMetaDataSELECT
statement; a result of zero means that there is no limit or
the limit is not known
SQLException - if a database access error occurs
public int getMaxUserNameLength()
throws SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxUserNameLength in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getDefaultTransactionIsolation()
throws SQLException
java.sql.Connection.
getDefaultTransactionIsolation in interface DatabaseMetaDataSQLException - if a database access error occursJDBCConnection
public boolean supportsTransactions()
throws SQLException
commit is a noop, and the isolation level is
TRANSACTION_NONE.
HSQLDB supports transactions;
this method always returns true.
supportsTransactions in interface DatabaseMetaDatatrue if transactions are supported;
false otherwise
SQLException - if a database access error occurs
public boolean supportsTransactionIsolationLevel(int level)
throws SQLException
supportsTransactionIsolationLevel in interface DatabaseMetaDatalevel - one of the transaction isolation levels defined in
java.sql.Connection
true if so; false otherwise
SQLException - if a database access error occursJDBCConnection
public boolean supportsDataDefinitionAndDataManipulationTransactions()
throws SQLException
HSQLDB does not support a mix of both data definition and
data manipulation statements within a transaction. DDL commits the
current transaction before proceding;
this method always returns false.
supportsDataDefinitionAndDataManipulationTransactions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean supportsDataManipulationTransactionsOnly()
throws SQLException
HSQLDB supports only data manipulation
statements within a transaction. DDL commits the
current transaction before proceeding, while DML does not;
this method always returns true.
supportsDataManipulationTransactionsOnly in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean dataDefinitionCausesTransactionCommit()
throws SQLException
Including 2.0, a data definition statement within a transaction forces
the transaction to commit; this method always returns true.
dataDefinitionCausesTransactionCommit in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean dataDefinitionIgnoredInTransactions()
throws SQLException
Including 2.0, a data definition statement is not ignored within a
transaction. Rather, a data definition statement within a
transaction forces the transaction to commit; this method
always returns false.
dataDefinitionIgnoredInTransactions in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public ResultSet getProcedures(String catalog,
String schemaPattern,
String procedureNamePattern)
throws SQLException
Only procedure descriptions matching the schema and
procedure name criteria are returned. They are ordered by
JDBC 4.1[PROCEDURE_CAT,] PROCEDURE_SCHEM,
PROCEDURE_NAME and (new to JDBC4)[SPECIFIC_ NAME].
Each procedure description has the the following columns:
null)
null)
A user may not have permissions to execute any of the procedures that are
returned by getProcedures
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
In version 1.9, the rows returned by this method are based on rows in the INFORMATION_SCHEMA.ROUTINES table.
getProcedures in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchprocedureNamePattern - a procedure name pattern; must match the
procedure name as it is stored in the database
ResultSet - each row is a procedure description
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getProcedureColumns(String catalog,
String schemaPattern,
String procedureNamePattern,
String columnNamePattern)
throws SQLException
Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by JDBC 4.1[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:
null)
null)
ResultSet
null)
HSQLDB-specific: CLI type from SQL 2003 Table 37,
tables 6-9 Annex A1, and/or addendums in other
documents, such as:
SQL 2003 Part 9: Management of External Data (SQL/MED) : DATALINK
SQL 2003 Part 14: XML-Related Specifications (SQL/XML) : XML
HSQLDB-specific: CLI SQL_DATETIME_SUB from SQL 2003 Table 37
Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond (JDBC4 modified:) SPECIFIC_NAME can be defined by the database and must be accessed by their column name.
(JDBC4 clarification:)
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 [declared or implicit maximum] length in characters. For datetime datatypes, this is the [maximum] length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the [maximum] length in bytes. For the ROWID datatype, this is the length in bytes[, as returned by the implementation-specific java.sql.RowId.getBytes() method]. JDBC 4.1 Deleted[0] JDBC 4.1 Added[Null] is returned for data types where the column size is not applicable.
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationFull.
getProcedureColumns in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchprocedureNamePattern - a procedure name pattern; must match the
procedure name as it is stored in the databasecolumnNamePattern - a column name pattern; must match the column name
as it is stored in the database
ResultSet - each row describes a stored procedure parameter or
column
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getTables(String catalog,
String schemaPattern,
String tableNamePattern,
String[] types)
throws SQLException
TABLE_TYPE, JDBC 4.1[TABLE_CAT,]
TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
null)
null)
null)
null)
null)
null)
null)
Note: Some databases may not return information for all tables.
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
HSQLDB returns extra information on TEXT tables in the REMARKS column.
HSQLDB includes the JDBC3 columns TYPE_CAT, TYPE_SCHEM, TYPE_NAME and SELF_REFERENCING_COL_NAME in anticipation of JDBC3 compliant tools.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getTables in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtableNamePattern - a table name pattern; must match the
table name as it is stored in the databasetypes - a list of table types, which must be from the list of table types
returned from getTableTypes(),to include; null returns
all types
ResultSet - each row is a table description
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getSchemas()
throws SQLException
TABLE_CATALOG] and
TABLE_SCHEM.
The schema columns are:
null)
Starting with 1.8.0, the list of schemas is returned.
getSchemas in interface DatabaseMetaDataResultSet object in which each row is a
schema description
SQLException - if a database access error occurs
public ResultSet getCatalogs()
throws SQLException
The catalog column is:
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getCatalogs in interface DatabaseMetaDataResultSet object in which each row has a
single String column that is a catalog name
SQLException - if a database access error occurs
public ResultSet getTableTypes()
throws SQLException
The table type is:
Since 1.7.1, HSQLDB reports: "TABLE", "VIEW" and "GLOBAL TEMPORARY"
types.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getTableTypes in interface DatabaseMetaDataResultSet object in which each row has a
single String column that is a table type
SQLException - if a database access error occurs
public ResultSet getColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern)
throws SQLException
Only column descriptions matching the catalog, schema, table
and column name criteria are returned. They are ordered by
JDBC 4.1[TABLE_CAT, ]TABLE_SCHEM,
TABLE_NAME, and ORDINAL_POSITION.
Each column description has the following columns:
null)
null)
NULL values
NULL values
null)
null)
HSQLDB-specific: CLI type from SQL 2003 Table 37,
tables 6-9 Annex A1, and/or addendums in other
documents, such as:
SQL 2003 Part 9: Management of External Data (SQL/MED) : DATALINK
SQL 2003 Part 14: XML-Related Specifications (SQL/XML) : XML
null if DATA_TYPE isn't REF)
null if the DATA_TYPE isn't REF)
null if the DATA_TYPE isn't REF)
null if DATA_TYPE
isn't DISTINCT or user-generated REF)
(JDBC4 clarification:) 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 [declared or implicit maximum] length in characters. For datetime datatypes, this is the [maximum] length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the [maximum] length in bytes. For the ROWID datatype, this is the length in bytes[, as returned by the implementation-specific java.sql.RowId.getBytes() method]. JDBC 4.1 Deleted[0] JDBC 4.1 Added[Null] is returned for data types where the column size is not applicable.
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
This feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getColumns in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtableNamePattern - a table name pattern; must match the
table name as it is stored in the databasecolumnNamePattern - a column name pattern; must match the column
name as it is stored in the database
ResultSet - each row is a column description
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getColumnPrivileges(String catalog,
String schema,
String table,
String columnNamePattern)
throws SQLException
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
null)
null)
null)
null if unknown
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getColumnPrivileges in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name as it is
stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is
stored in the databasecolumnNamePattern - a column name pattern; must match the column
name as it is stored in the database
ResultSet - each row is a column privilege description
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getTablePrivileges(String catalog,
String schemaPattern,
String tableNamePattern)
throws SQLException
Only privileges matching the schema and table name
criteria are returned. They are ordered by
JDBC 4.1[TABLE_CAT,]
TABLE_SCHEM, TABLE_NAME,
and PRIVILEGE.
Each privilege description has the following columns:
null)
null)
null)
null if unknown
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getTablePrivileges in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtableNamePattern - a table name pattern; must match the
table name as it is stored in the database
ResultSet - each row is a table privilege description
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getBestRowIdentifier(String catalog,
String schema,
String table,
int scope,
boolean nullable)
throws SQLException
Each column description has the following columns:
(JDBC4 clarification:)
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 [declared or implicit maximum] length in characters. For datetime datatypes, this is the [maximum] length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the [maximum] length in bytes. For the ROWID datatype, this is the length in bytes[, as returned by the implementation-specific java.sql.RowId.getBytes() method]. JDBC 4.1 Deleted[0] JDBC 4.1 Added[Null] is returned for data types where the column size is not applicable.
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
If the name of a column is defined in the database without double quotes, an all-uppercase name must be specified when calling this method. Otherwise, the name must be specified in the exact case of the column definition in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getBestRowIdentifier in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is stored
in the databasescope - the scope of interest; use same values as SCOPEnullable - include columns that are nullable.
ResultSet - each row is a column description
SQLException - if a database access error occurs
public ResultSet getVersionColumns(String catalog,
String schema,
String table)
throws SQLException
Each column description has the following columns:
java.sql.Types
(JDBC4 clarification:)
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 [declared or implicit maximum] length in characters. For datetime datatypes, this is the [maximum] length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the [maximum] length in bytes. For the ROWID datatype, this is the length in bytes[, as returned by the implementation-specific java.sql.RowId.getBytes() method]. JDBC 4.1 Deleted[0], JDBC 4.1 Added[Null] is returned for data types where the column size is not applicable.
HSQLDB does not support version columns. This returns an empty result set.
getVersionColumns in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is stored
in the database
ResultSet object in which each row is a
column description
SQLException - if a database access error occurs
public ResultSet getPrimaryKeys(String catalog,
String schema,
String table)
throws SQLException
Each primary key column description has the following columns:
null)
null)
null)
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getPrimaryKeys in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is stored
in the database
ResultSet - each row is a primary key column description
SQLException - if a database access error occurssupportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()
public ResultSet getImportedKeys(String catalog,
String schema,
String table)
throws SQLException
Each primary key column description has the following columns:
null)
null)
null)
null)
NULL
if its primary key has been updated
null)
null)
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getImportedKeys in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is stored
in the database
ResultSet - each row is a primary key column description
SQLException - if a database access error occursgetExportedKeys(java.lang.String, java.lang.String, java.lang.String),
supportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()
public ResultSet getExportedKeys(String catalog,
String schema,
String table)
throws SQLException
Each foreign key column description has the following columns:
null)
null)
null)
being exported (may be null)
null)
being exported (may be null)
NULL if
its primary key has been updated
NULL if
its primary key has been deleted
null)
null)
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getExportedKeys in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in this database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is stored
in this database
ResultSet object in which each row is a
foreign key column description
SQLException - if a database access error occursgetImportedKeys(java.lang.String, java.lang.String, java.lang.String),
supportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()
public ResultSet getCrossReference(String parentCatalog,
String parentSchema,
String parentTable,
String foreignCatalog,
String foreignSchema,
String foreignTable)
throws SQLException
Each foreign key column description has the following columns:
null)
null)
null)
being exported (may be null)
null)
being exported (may be null)
NULL if
its parent key has been updated
NULL if
its primary key has been deleted
null)
null)
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getCrossReference in interface DatabaseMetaDataparentCatalog - 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 criteriaparentSchema - 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 criteriaparentTable - the name of the table that exports the key; must match
the table name as it is stored in the databaseforeignCatalog - a catalog name; must match the catalog name as
it is stored in the database; "" retrieves those without a
catalog; null means drop catalog name from the selection criteriaforeignSchema - a schema name; must match the schema name as it
is stored in the database; "" retrieves those without a schema;
null means drop schema name from the selection criteriaforeignTable - the name of the table that imports the key; must match
the table name as it is stored in the database
ResultSet - each row is a foreign key column description
SQLException - if a database access error occursgetImportedKeys(java.lang.String, java.lang.String, java.lang.String),
supportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()
public ResultSet getTypeInfo()
throws SQLException
(JDBC4 clarification:) 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.
(JDBC4 clarification:)
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:
null)
null)
null)
null)
(JDBC4 clarification:) 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 [maximum] length in characters. For datetime datatypes, this is the [maximum] length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the [maximum] length in bytes. For the ROWID datatype, this is the length in bytes[, as returned by the implementation-specific java.sql.RowId.getBytes() method]. JDBC 4.1 Deleted[0] JDBC 4.1 Added[Null] is returned for data types where the column size is not applicable.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getTypeInfo in interface DatabaseMetaDataResultSet object in which each row is an SQL
type description
SQLException - if a database access error occurs
public ResultSet getIndexInfo(String catalog,
String schema,
String table,
boolean unique,
boolean approximate)
throws SQLException
Each index column description has the following columns:
null)
null)
null);
null when TYPE is tableIndexStatistic
null when TYPE is
tableIndexStatistic
null when TYPE is
tableIndexStatistic
null if sort sequence is not supported;
null when TYPE is tableIndexStatistic
null)
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getIndexInfo in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in this database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschema - a schema name; must match the schema name
as it is stored in this database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtable - a table name; must match the table name as it is stored
in this databaseunique - when true, return only indices for unique values;
when false, return indices regardless of whether unique or notapproximate - when true, result is allowed to reflect approximate
or out of data values; when false, results are requested to be
accurate
ResultSet - each row is an index column description
SQLException - if a database access error occurssupportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()
public boolean supportsResultSetType(int type)
throws SQLException
supportsResultSetType in interface DatabaseMetaDatatype - defined in java.sql.ResultSet
true if so; false otherwise
SQLException - if a database access error occursJDBCConnection
public boolean supportsResultSetConcurrency(int type,
int concurrency)
throws SQLException
supportsResultSetConcurrency in interface DatabaseMetaDatatype - defined in java.sql.ResultSetconcurrency - type defined in java.sql.ResultSet
true if so; false otherwise
SQLException - if a database access error occursJDBCConnection
public boolean ownUpdatesAreVisible(int type)
throws SQLException
ResultSet object,
the result set's own updates are visible.
Updates to ResultSet rows are not visible after moving from the updated row.
ownUpdatesAreVisible in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if updates are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean ownDeletesAreVisible(int type)
throws SQLException
Rows deleted from the ResultSet are still visible after moving from the deleted row.
ownDeletesAreVisible in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if deletes are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean ownInsertsAreVisible(int type)
throws SQLException
Rows added to a ResultSet are not visible after moving from the
insert row; this method always returns false.
ownInsertsAreVisible in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if inserts are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean othersUpdatesAreVisible(int type)
throws SQLException
Updates made by other connections or the same connection while the ResultSet is open are not visible in the ResultSet.
othersUpdatesAreVisible in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if updates made by others
are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean othersDeletesAreVisible(int type)
throws SQLException
Deletes made by other connections or the same connection while the ResultSet is open are not visible in the ResultSet.
othersDeletesAreVisible in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if deletes made by others
are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean othersInsertsAreVisible(int type)
throws SQLException
Inserts made by other connections or the same connection while the ResultSet is open are not visible in the ResultSet.
othersInsertsAreVisible in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if inserts made by others
are visible for the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean updatesAreDetected(int type)
throws SQLException
ResultSet.rowUpdated.
Updates made to the rows of the ResultSet are not detected by
calling the ResultSet.rowUpdated.
updatesAreDetected in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if changes are detected by the result set type;
false otherwise
SQLException - if a database access error occurs
public boolean deletesAreDetected(int type)
throws SQLException
ResultSet.rowDeleted. If the method
deletesAreDetected returns false, it means that
deleted rows are removed from the result set.
Deletes made to the rows of the ResultSet are not detected by
calling the ResultSet.rowDeleted.
deletesAreDetected in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if deletes are detected by the given result set type;
false otherwise
SQLException - if a database access error occurs
public boolean insertsAreDetected(int type)
throws SQLException
ResultSet.rowInserted.
Inserts made into the ResultSet are not visible and thus not detected by
calling the ResultSet.rowInserted.
insertsAreDetected in interface DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
true if changes are detected by the specified result
set type; false otherwise
SQLException - if a database access error occurs
public boolean supportsBatchUpdates()
throws SQLException
HSQLDB supports batch updates;
this method always returns true.
supportsBatchUpdates in interface DatabaseMetaDatatrue if this database supports batch upcates;
false otherwise
SQLException - if a database access error occurs
public ResultSet getUDTs(String catalog,
String schemaPattern,
String typeNamePattern,
int[] types)
throws SQLException
JAVA_OBJECT, STRUCT,
or DISTINCT.
Only types matching the catalog, schema, type name and type
criteria are returned. They are ordered by DATA_TYPE,
JDBC 4.1[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:
null)
null)
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.
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
Starting with 2.0, DISTICT types are supported and are reported by this method.
getUDTs in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema pattern name; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtypeNamePattern - a type name pattern; must match the type name
as it is stored in the database; may be a fully qualified nametypes - a list of user-defined types (JAVA_OBJECT,
STRUCT, or DISTINCT) to include; null returns all types
ResultSet object in which each row describes a UDT
SQLException - if a database access error occurs(JDBC4 clarification)
public Connection getConnection()
throws SQLException
getConnection in interface DatabaseMetaDataSQLException - if a database access error occurs
public boolean supportsSavepoints()
throws SQLException
Beginning with 1.7.2, this SQL feature is supported through JDBC as well as SQL.
supportsSavepoints in interface DatabaseMetaDatatrue if savepoints are supported;
false otherwise
SQLException - if a database access error occurs
public boolean supportsNamedParameters()
throws SQLException
Starting with 1.7.2, HSQLDB supports JDBC named parameters to callable statements; this method returns true.
supportsNamedParameters in interface DatabaseMetaDatatrue if named parameters are supported;
false otherwise
SQLException - if a database access error occurs
public boolean supportsMultipleOpenResults()
throws SQLException
ResultSet objects
returned from a CallableStatement object
simultaneously.
HSQLDB supports multiple ResultSet
objects returned from a CallableStatement;
this method always returns true.
supportsMultipleOpenResults in interface DatabaseMetaDatatrue if a CallableStatement object
can return multiple ResultSet objects
simultaneously; false otherwise
SQLException - if a datanase access error occurs
public boolean supportsGetGeneratedKeys()
throws SQLException
HSQLDB supports retrieval of
autogenerated keys through the JDBC interface;
this method always returns true.
supportsGetGeneratedKeys in interface DatabaseMetaDatatrue if auto-generated keys can be retrieved
after a statement has executed; false otherwise
(JDBC4 Clarification:)
If true is returned, the JDBC driver must support the
returning of auto-generated keys for at least SQL INSERT statements
SQLException - if a database access error occurs
public ResultSet getSuperTypes(String catalog,
String schemaPattern,
String typeNamePattern)
throws SQLException
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:
null)
null)
null)
null)
Note: If the driver does not support type hierarchies, an empty result set is returned.
HSQLDB supports the SQL Standard. It treats unquoted identifiers as case insensitive in SQL and stores them in upper case; it treats quoted identifiers as case sensitive and stores them verbatim. All JDBCDatabaseMetaData methods perform case-sensitive comparison between name (pattern) arguments and the corresponding identifier values as they are stored in the database. Therefore, care must be taken to specify name arguments precisely (including case) as they are stored in the database.
From 2.0, this feature is supported by default and return supertypes for DOMAIN and DISTINCT types.
If the jar is
compiled without org.hsqldb.dbinfo.DatabaseInformationMain, the feature is
not supported. The default implementation is
DatabaseInformationMain.
getSuperTypes in interface DatabaseMetaDatacatalog - a catalog name; "" retrieves those without a catalog;
null means drop catalog name from the selection criteriaschemaPattern - a schema name pattern; "" retrieves those
without a schematypeNamePattern - a UDT name pattern; may be a fully-qualified
name
ResultSet object in which a row gives information
about the designated UDT
SQLException - if a database access error occurs(JDBC4 clarification)
public ResultSet getSuperTables(String catalog,
String schemaPattern,
String tableNamePattern)
throws SQLException
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:
null)
null)
Note: If the driver does not support type hierarchies, an empty result set is returned.
This method is intended for tables of structured types.
From 2.0 this method returns an empty ResultSet.
DatabaseInformationMain.
getSuperTables in interface DatabaseMetaDatacatalog - a catalog name; "" retrieves those without a catalog;
null means drop catalog name from the selection criteriaschemaPattern - a schema name pattern; "" retrieves those
without a schematableNamePattern - a table name pattern; may be a fully-qualified
name
ResultSet object in which each row is a type description
SQLException - if a database access error occurs(JDBC4 clarification)
public ResultSet getAttributes(String catalog,
String schemaPattern,
String typeNamePattern,
String attributeNamePattern)
throws SQLException
Descriptions are returned only for attributes of UDTs matching the
catalog, schema, type, and attribute name criteria. They are ordered by
JDBC 4.1[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:
null)
null)
null)
null)
null if DATA_TYPE isn't REF)
null if DATA_TYPE isn't REF)
null if the DATA_TYPE isn't REF)
null if DATA_TYPE
isn't DISTINCT or user-generated REF)
This method is intended for attributes of structured types. From 2.0 this method returns an empty ResultSet.
getAttributes in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtypeNamePattern - a type name pattern; must match the
type name as it is stored in the databaseattributeNamePattern - an attribute name pattern; must match the attribute
name as it is declared in the database
ResultSet object in which each row is an
attribute description
SQLException - if a database access error occursgetSearchStringEscape()
public boolean supportsResultSetHoldability(int holdability)
throws SQLException
HSQLDB returns true for both alternatives.
supportsResultSetHoldability in interface DatabaseMetaDataholdability - one of the following constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT
true if so; false otherwise
SQLException - if a database access error occursJDBCConnection
public int getResultSetHoldability()
throws SQLException
ResultSet
objects.
HSQLDB defaults to HOLD_CURSORS_OVER_COMMIT for CONSUR_READ_ONLY ResultSet objects. If the ResultSet concurrency is CONCUR_UPDATABLE, then holdability is is enforced as CLOSE_CURSORS_AT_COMMIT.
getResultSetHoldability in interface DatabaseMetaDataResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException - if a database access error occurs
public int getDatabaseMajorVersion()
throws SQLException
Returns the major version
getDatabaseMajorVersion in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getDatabaseMinorVersion()
throws SQLException
This returns the digit after the first point in version.
getDatabaseMinorVersion in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getJDBCMajorVersion()
throws SQLException
getJDBCMajorVersion in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getJDBCMinorVersion()
throws SQLException
getJDBCMinorVersion in interface DatabaseMetaDataSQLException - if a database access error occurs
public int getSQLStateType()
throws SQLException
SQLException.getSQLState
is X/Open (now known as Open Group) SQL CLI or SQL:2003.
HSQLDB returns sqlStateSQL under JDBC4 which is equivalent
to JDBC3 value of sqlStateSQL99.
getSQLStateType in interface DatabaseMetaDatasqlStateSQL is new in JDBC4 and its value is the same as JDBC3 sqlStateSQL99
SQLException - if a database access error occurs
public boolean locatorsUpdateCopy()
throws SQLException
Updates to a LOB are made directly. This means the lobs in an updatable ResultSet can be updated and the change is applied when the updateRow() method is applied. Lobs created by calling the Connection methods createClob() and createBlob() can be updated. The lob can then be sent to the database in a PreparedStatement with an UPDATE or INSERT SQL statement.
locatorsUpdateCopy in interface DatabaseMetaDatatrue if updates are made to a copy of the LOB;
false if updates are made directly to the LOB
SQLException - if a database access error occurs
public boolean supportsStatementPooling()
throws SQLException
Starting with 2.0, HSQLDB supports statement pooling when built under JDK 1.6+.
supportsStatementPooling in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public RowIdLifetime getRowIdLifetime()
throws SQLException
ROWID type,
and if so the lifetime for which a RowId object remains valid.
The returned int values have the following relationship:
ROWID_UNSUPPORTED < ROWID_VALID_OTHER < ROWID_VALID_TRANSACTION
< ROWID_VALID_SESSION < ROWID_VALID_FOREVER
so conditional logic such as
if (metadata.getRowIdLifetime() > DatabaseMetaData.ROWID_VALID_TRANSACTION)
can be used. Valid Forever means valid across all Sessions, and valid for
a Session means valid across all its contained Transactions.
getRowIdLifetime in interface DatabaseMetaDataRowId
SQLException - if a database access error occurs
public ResultSet getSchemas(String catalog,
String schemaPattern)
throws SQLException
TABLE_CATALOG] and
TABLE_SCHEM.
The schema columns are:
null)
getSchemas in interface DatabaseMetaDatacatalog - 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.
ResultSet object in which each row is a
schema description
SQLException - if a database access error occursgetSearchStringEscape()
public boolean supportsStoredFunctionsUsingCallSyntax()
throws SQLException
supportsStoredFunctionsUsingCallSyntax in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public boolean autoCommitFailureClosesAllResultSets()
throws SQLException
SQLException while autoCommit is true inidcates
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.
autoCommitFailureClosesAllResultSets in interface DatabaseMetaDatatrue if so; false otherwise
SQLException - if a database access error occurs
public ResultSet getClientInfoProperties()
throws SQLException
The ResultSet is sorted by the NAME column
getClientInfoProperties in interface DatabaseMetaDataResultSet object; each row is a supported client info
property
SQLException - if a database access error occurs
public ResultSet getFunctions(String catalog,
String schemaPattern,
String functionNamePattern)
throws SQLException
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 the following columns:
null)
null)
FUNCTION_NAME
for example with overload functions
A user may not have permission to execute any of the functions that are
returned by getFunctions
getFunctions in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchfunctionNamePattern - a function name pattern; must match the
function name as it is stored in the database
ResultSet - each row is a function description
SQLException - if a database access error occursgetSearchStringEscape()
public ResultSet getFunctionColumns(String catalog,
String schemaPattern,
String functionNamePattern,
String columnNamePattern)
throws SQLException
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:
null)
null)
ResultSet
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.
getFunctionColumns in interface DatabaseMetaDatacatalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchfunctionNamePattern - a procedure name pattern; must match the
function name as it is stored in the databasecolumnNamePattern - a parameter name pattern; must match the
parameter or column name as it is stored in the database
ResultSet - each row describes a
user function parameter, column or return type
SQLException - if a database access error occursgetSearchStringEscape()
public <T> T unwrap(Class<T> iface)
throws SQLException
unwrap recursively on the wrapped object. If the receiver is not a
wrapper and does not implement the interface, then an SQLException is thrown.
unwrap in interface Wrapperiface - A Class defining an interface that the result must implement.
SQLException - If no object found that implements the interface
public boolean isWrapperFor(Class<?> iface)
throws SQLException
isWrapperFor on the wrapped
object. If this does not implement the interface and is not a wrapper, return false.
This method should be implemented as a low-cost operation compared to unwrap so that
callers can use this method to avoid expensive unwrap calls that may fail. If this method
returns true then calling unwrap with the same argument should succeed.
isWrapperFor in interface Wrapperiface - a Class defining an interface.
SQLException - if an error occurs while determining whether this is a wrapper
for an object with the given interface.
public ResultSet getPseudoColumns(String catalog,
String schemaPattern,
String tableNamePattern,
String columnNamePattern)
throws SQLException
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:
null)
null)
PseudoColumnUsage.name()
null)
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.
catalog - a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the searchschemaPattern - a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the searchtableNamePattern - a table name pattern; must match the
table name as it is stored in the databasecolumnNamePattern - a column name pattern; must match the column
name as it is stored in the database
ResultSet - each row is a column description
SQLException - if a database access error occursPseudoColumnUsage
public boolean generatedKeyAlwaysReturned()
throws SQLException
true if so; false otherwise
SQLException - if a database access error occurs
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||