public class JDBCDatabaseMetaData
extends java.lang.Object
implements java.sql.DatabaseMetaData, java.sql.Wrapper
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 JDBC 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.
Since HSQLDB 2.0 the INFORMATION_SCHEMA views have been vastly expanded in compliance with the SQL:2011 Standard and report the properties of all database objects.
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 <name> RENAME TO statement. As of version 2.1.0, HSQLDB supports qualification by the containing CATALOG of database objects at the syntactic level, but does not yet support operations such as opening, manipulating or querying against multiple database catalogs within a single session, not even in a one-at-a-time fashion.
approximate argument of getIndexInfo() as no data is returned for CARDINALITY and PAGES coloumns.
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.
DatabaseInformation| Modifier and Type | Field and Description |
|---|---|
static int |
JDBC_MAJOR |
static int |
JDBC_MINOR |
attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, sqlStateXOpen, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown| Modifier and Type | Method and Description |
|---|---|
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 indicates
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.
|
java.sql.ResultSet |
getAttributes(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String typeNamePattern,
java.lang.String attributeNamePattern)
Retrieves a description of the given attribute of the given type
for a user-defined type (UDT) that is available in the given schema
and catalog.
|
java.sql.ResultSet |
getBestRowIdentifier(java.lang.String catalog,
java.lang.String schema,
java.lang.String table,
int scope,
boolean nullable)
Retrieves a description of a table's optimal set of columns that
uniquely identifies a row.
|
java.sql.ResultSet |
getCatalogs()
Retrieves the catalog names available in this database.
|
java.lang.String |
getCatalogSeparator()
Retrieves the
String that this database uses as the
separator between a catalog and table name. |
java.lang.String |
getCatalogTerm()
Retrieves the database vendor's preferred term for "catalog".
|
java.sql.ResultSet |
getClientInfoProperties()
Retrieves a list of the client info properties
that the driver supports.
|
java.sql.ResultSet |
getColumnPrivileges(java.lang.String catalog,
java.lang.String schema,
java.lang.String table,
java.lang.String columnNamePattern)
Retrieves a description of the access rights for a table's columns.
|
java.sql.ResultSet |
getColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern,
java.lang.String columnNamePattern)
Retrieves a description of table columns available in
the specified catalog.
|
java.sql.Connection |
getConnection()
Retrieves the connection that produced this metadata object.
|
java.sql.ResultSet |
getCrossReference(java.lang.String parentCatalog,
java.lang.String parentSchema,
java.lang.String parentTable,
java.lang.String foreignCatalog,
java.lang.String foreignSchema,
java.lang.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.
|
java.lang.String |
getDatabaseProductName()
Retrieves the name of this database product.
|
java.lang.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.
|
java.lang.String |
getDriverName()
Retrieves the name of this JDBC driver.
|
java.lang.String |
getDriverVersion()
Retrieves the version number of this JDBC driver as a
String. |
java.sql.ResultSet |
getExportedKeys(java.lang.String catalog,
java.lang.String schema,
java.lang.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).
|
java.lang.String |
getExtraNameCharacters()
Retrieves all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, A-Z, 0-9 and _).
|
java.sql.ResultSet |
getFunctionColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String functionNamePattern,
java.lang.String columnNamePattern)
Retrieves a description of the given catalog's system or user
function parameters and return type.
|
java.sql.ResultSet |
getFunctions(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String functionNamePattern)
Retrieves a description of the JDBC 4.1[ system and ]user functions available
in the given catalog.
|
java.lang.String |
getIdentifierQuoteString()
Retrieves the string used to quote SQL identifiers.
|
java.sql.ResultSet |
getImportedKeys(java.lang.String catalog,
java.lang.String schema,
java.lang.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).
|
java.sql.ResultSet |
getIndexInfo(java.lang.String catalog,
java.lang.String schema,
java.lang.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.
|
java.lang.String |
getNumericFunctions()
Retrieves a comma-separated list of math functions available with
this database.
|
java.sql.ResultSet |
getPrimaryKeys(java.lang.String catalog,
java.lang.String schema,
java.lang.String table)
Retrieves a description of the given table's primary key columns.
|
java.sql.ResultSet |
getProcedureColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String procedureNamePattern,
java.lang.String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter
and result columns.
|
java.sql.ResultSet |
getProcedures(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String procedureNamePattern)
Retrieves a description of the stored procedures available in the given
catalog.
|
java.lang.String |
getProcedureTerm()
Retrieves the database vendor's preferred term for "procedure".
|
java.sql.ResultSet |
getPseudoColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern,
java.lang.String columnNamePattern)
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. |
java.sql.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. |
java.sql.ResultSet |
getSchemas()
Retrieves the schema names available in this database.
|
java.sql.ResultSet |
getSchemas(java.lang.String catalog,
java.lang.String schemaPattern)
Retrieves the schema names available in this database.
|
java.lang.String |
getSchemaTerm()
Retrieves the database vendor's preferred term for "schema".
|
java.lang.String |
getSearchStringEscape()
Retrieves the string that can be used to escape wildcard characters.
|
java.lang.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. |
java.lang.String |
getStringFunctions()
Retrieves a comma-separated list of string functions available with
this database.
|
java.sql.ResultSet |
getSuperTables(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular
schema in this database.
|
java.sql.ResultSet |
getSuperTypes(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a
particular schema in this database.
|
java.lang.String |
getSystemFunctions()
Retrieves a comma-separated list of system functions available with
this database.
|
java.sql.ResultSet |
getTablePrivileges(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern)
Retrieves a description of the access rights for each table available
in a catalog.
|
java.sql.ResultSet |
getTables(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern,
java.lang.String[] types)
Retrieves a description of the tables available in the given catalog.
|
java.sql.ResultSet |
getTableTypes()
Retrieves the table types available in this database.
|
java.lang.String |
getTimeDateFunctions()
Retrieves a comma-separated list of the time and date functions available
with this database.
|
java.sql.ResultSet |
getTypeInfo()
Retrieves a description of all the (JDBC4 clarification:) data types supported by
this database.
|
java.sql.ResultSet |
getUDTs(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String typeNamePattern,
int[] types)
Retrieves a description of the user-defined types (UDTs) defined
in a particular schema.
|
java.lang.String |
getURL()
Retrieves the URL for this DBMS.
|
java.lang.String |
getUserName()
Retrieves the user name as known to this database.
|
java.sql.ResultSet |
getVersionColumns(java.lang.String catalog,
java.lang.String schema,
java.lang.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(java.lang.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. |
<T> T |
unwrap(java.lang.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.
|
public static final int JDBC_MAJOR
public static final int JDBC_MINOR
public boolean allProceduresAreCallable()
throws java.sql.SQLException
getProcedures.
This method always returns
true because the listed procedures are those which
the current user can use.
allProceduresAreCallable in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean allTablesAreSelectable()
throws java.sql.SQLException
getTables in a SELECT
statement.
HSQLDB always reports true.
The getTables call returns the list of tables to which the
invoking user has some access rights.
allTablesAreSelectable in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.lang.String getURL()
throws java.sql.SQLException
getURL in interface java.sql.DatabaseMetaDatanull if it cannot be
generatedjava.sql.SQLException - if a database access error occurspublic java.lang.String getUserName()
throws java.sql.SQLException
getUserName in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic boolean isReadOnly()
throws java.sql.SQLException
This makes an SQL call to the isReadOnlyDatabase function which provides correct determination of the read-only status for both local and remote database instances.
isReadOnly in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean nullsAreSortedHigh()
throws java.sql.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 and
this method returns false.
But a different value is returned if sql.nulls_first or
sql.nulls_lasst properties have a non-default value.
nullsAreSortedHigh in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean nullsAreSortedLow()
throws java.sql.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 start and
this method returns false.
But a different value is returned if sql.nulls_first or
sql.nulls_lasst properties have a non-default value.
nullsAreSortedLow in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean nullsAreSortedAtStart()
throws java.sql.SQLException
NULL values are sorted at the start regardless
of sort order.
By default HSQLDB sorts null at start and
this method returns true.
But a different value is returned if sql.nulls_first or
sql.nulls_last properties have a non-default value.
Use NULLS LAST in the ORDER BY clause to sort null at the end.
nullsAreSortedAtStart in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean nullsAreSortedAtEnd()
throws java.sql.SQLException
NULL values are sorted at the end regardless of
sort order.
By default HSQLDB sorts null at start and
this method returns false.
But a different value is returned if sql.nulls_first or
sql.nulls_last properties have a non-default value.
Use NULLS LAST in the ORDER BY clause to sort null at the end.
nullsAreSortedAtEnd in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.lang.String getDatabaseProductName()
throws java.sql.SQLException
Returns the name of the HSQLDB engine.
getDatabaseProductName in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getDatabaseProductVersion()
throws java.sql.SQLException
Returns the full version string.
getDatabaseProductVersion in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getDriverName()
throws java.sql.SQLException
getDriverName in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getDriverVersion()
throws java.sql.SQLException
String.getDriverVersion in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getDriverMajorVersion()
getDriverMajorVersion in interface java.sql.DatabaseMetaDatapublic int getDriverMinorVersion()
getDriverMinorVersion in interface java.sql.DatabaseMetaDatapublic boolean usesLocalFiles()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean usesLocalFilePerTable()
throws java.sql.SQLException
HSQLDB does not use a file for each table.
This method always returns false.
usesLocalFilePerTable in interface java.sql.DatabaseMetaDatatrue if this database uses a local file for each table;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsMixedCaseIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean storesUpperCaseIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean storesLowerCaseIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean storesMixedCaseIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsMixedCaseQuotedIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean storesUpperCaseQuotedIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean storesLowerCaseQuotedIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean storesMixedCaseQuotedIdentifiers()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.lang.String getIdentifierQuoteString()
throws java.sql.SQLException
HSQLDB uses the standard SQL identifier quote character (the double quote character); this method always returns ".
getIdentifierQuoteString in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getSQLKeywords()
throws java.sql.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 java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getNumericFunctions()
throws java.sql.SQLException
getNumericFunctions in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getStringFunctions()
throws java.sql.SQLException
getStringFunctions in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getSystemFunctions()
throws java.sql.SQLException
getSystemFunctions in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getTimeDateFunctions()
throws java.sql.SQLException
getTimeDateFunctions in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getSearchStringEscape()
throws java.sql.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 java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getExtraNameCharacters()
throws java.sql.SQLException
By default HSQLDB does not support using any "extra" characters in unquoted identifier names; this method always returns the empty String.
getExtraNameCharacters in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic boolean supportsAlterTableWithAddColumn()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsAlterTableWithDropColumn()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsColumnAliasing()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean nullPlusNonNullIsNull()
throws java.sql.SQLException
NULL and non-NULL values being
NULL.
By default HSQLDB returns NULL when NULL and non-NULL values
are concatenated.
By default this method returns false.
But a different value is returned if the sql.concat_nulls
property has a non-default value.
nullPlusNonNullIsNull in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsConvert()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsConvert(int fromType,
int toType)
throws java.sql.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 java.sql.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.Typestrue if so; false otherwisejava.sql.SQLException - if a database access error occursTypespublic boolean supportsTableCorrelationNames()
throws java.sql.SQLException
HSQLDB supports table correlation names; this method always
returns true.
supportsTableCorrelationNames in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsDifferentTableCorrelationNames()
throws java.sql.SQLException
HSQLDB does not require that table correlation names are different from the
names of the tables; this method always returns false.
supportsDifferentTableCorrelationNames in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsExpressionsInOrderBy()
throws java.sql.SQLException
ORDER BY lists.
HSQLDB supports expressions in ORDER BY lists; this
method always returns true.
supportsExpressionsInOrderBy in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsOrderByUnrelated()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsGroupBy()
throws java.sql.SQLException
GROUP BY clause.
HSQLDB supports using the GROUP BY clause; this method
always returns true.
supportsGroupBy in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsGroupByUnrelated()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsGroupByBeyondSelect()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsLikeEscapeClause()
throws java.sql.SQLException
LIKE escape clause.
HSQLDB supports specifying a
LIKE escape clause; this method
always returns true.
supportsLikeEscapeClause in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsMultipleResultSets()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsMultipleTransactions()
throws java.sql.SQLException
HSQLDB allows having multiple
transactions open at once (on different connections); this method
always returns true.
supportsMultipleTransactions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsNonNullableColumns()
throws java.sql.SQLException
HSQLDB supports the specification of non-nullable columns; this method
always returns true.
supportsNonNullableColumns in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsMinimumSQLGrammar()
throws java.sql.SQLException
From 2.0, HSQLDB supports the ODBC Minimum SQL grammar;
this method always returns true.
supportsMinimumSQLGrammar in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCoreSQLGrammar()
throws java.sql.SQLException
From 2.0, HSQLDB supports the ODBC Core SQL grammar;
this method always returns true.
supportsCoreSQLGrammar in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsExtendedSQLGrammar()
throws java.sql.SQLException
From 2.0, HSQLDB supports the ODBC Extended SQL grammar;
this method always returns true.
supportsExtendedSQLGrammar in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsANSI92EntryLevelSQL()
throws java.sql.SQLException
From 2.0, HSQLDB supports the ANSI92 entry level SQL grammar;
this method always returns true.
supportsANSI92EntryLevelSQL in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsANSI92IntermediateSQL()
throws java.sql.SQLException
From 2.0, HSQLDB supports the ANSI92 intermediate SQL grammar;
this method always returns true.
supportsANSI92IntermediateSQL in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsANSI92FullSQL()
throws java.sql.SQLException
From 2.0, HSQLDB supports the ANSI92 full SQL grammar. The exceptions,
such as support for ASSERTION, are not considered grammar issues.
This method always returns true.
supportsANSI92FullSQL in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsIntegrityEnhancementFacility()
throws java.sql.SQLException
This method always returns true.
supportsIntegrityEnhancementFacility in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsOuterJoins()
throws java.sql.SQLException
HSQLDB supports outer joins; this method always returns
true.
supportsOuterJoins in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsFullOuterJoins()
throws java.sql.SQLException
From 2.0, HSQLDB supports full nested outer
joins; this method always returns true.
supportsFullOuterJoins in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsLimitedOuterJoins()
throws java.sql.SQLException
true if the method
supportsFullOuterJoins returns true).
HSQLDB supports the LEFT OUTER join syntax;
this method always returns true.
supportsLimitedOuterJoins in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.lang.String getSchemaTerm()
throws java.sql.SQLException
Starting with 1.8.0, HSQLDB supports schemas.
getSchemaTerm in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getProcedureTerm()
throws java.sql.SQLException
From 2.0, HSQLDB supports declaration of functions or procedures directly in SQL.
getProcedureTerm in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic java.lang.String getCatalogTerm()
throws java.sql.SQLException
HSQLDB uses the standard name CATALOG.
getCatalogTerm in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic boolean isCatalogAtStart()
throws java.sql.SQLException
When allowed, a catalog appears at the start of a fully qualified
table name; this method always returns true.
isCatalogAtStart in interface java.sql.DatabaseMetaDatatrue if the catalog name appears at the beginning
of a fully qualified table name; false otherwisejava.sql.SQLException - if a database access error occurspublic java.lang.String getCatalogSeparator()
throws java.sql.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 java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic boolean supportsSchemasInDataManipulation()
throws java.sql.SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInDataManipulation in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSchemasInProcedureCalls()
throws java.sql.SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInProcedureCalls in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSchemasInTableDefinitions()
throws java.sql.SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInTableDefinitions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSchemasInIndexDefinitions()
throws java.sql.SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInIndexDefinitions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSchemasInPrivilegeDefinitions()
throws java.sql.SQLException
From 2.0, HSQLDB supports schemas where allowed by the standard;
this method always returns true.
supportsSchemasInPrivilegeDefinitions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCatalogsInDataManipulation()
throws java.sql.SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInDataManipulation in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCatalogsInProcedureCalls()
throws java.sql.SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInProcedureCalls in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCatalogsInTableDefinitions()
throws java.sql.SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInTableDefinitions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCatalogsInIndexDefinitions()
throws java.sql.SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInIndexDefinitions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCatalogsInPrivilegeDefinitions()
throws java.sql.SQLException
From 2.0, HSQLDB supports catalog names where allowed by the standard;
this method always returns true.
supportsCatalogsInPrivilegeDefinitions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsPositionedDelete()
throws java.sql.SQLException
DELETE
statements.
HSQLDB 2.0 supports updatable result sets;
this method always returns true.
supportsPositionedDelete in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsPositionedUpdate()
throws java.sql.SQLException
UPDATE
statements.
HSQLDB 2.0 supports updatable result sets;
this method always returns true.
supportsPositionedUpdate in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSelectForUpdate()
throws java.sql.SQLException
SELECT FOR UPDATE
statements.
HSQLDB 2.0 supports updatable result sets;
this method always returns true.
supportsSelectForUpdate in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsStoredProcedures()
throws java.sql.SQLException
HSQLDB supports calling public static Java methods in the context of SQL
Stored Procedures; this method always returns true.
supportsStoredProcedures in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occursJDBCParameterMetaData,
JDBCConnection.prepareCall(java.lang.String)public boolean supportsSubqueriesInComparisons()
throws java.sql.SQLException
HSQLDB has always supported subqueries in comparison expressions;
this method always returns true.
supportsSubqueriesInComparisons in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSubqueriesInExists()
throws java.sql.SQLException
EXISTS expressions.
HSQLDB has always supported subqueries in EXISTS
expressions; this method always returns true.
supportsSubqueriesInExists in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSubqueriesInIns()
throws java.sql.SQLException
IN expressions.
HSQLDB has always supported subqueries in IN
statements; this method always returns true.
supportsSubqueriesInIns in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsSubqueriesInQuantifieds()
throws java.sql.SQLException
HSQLDB has always supported subqueries in quantified
expressions; this method always returns true.
supportsSubqueriesInQuantifieds in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsCorrelatedSubqueries()
throws java.sql.SQLException
HSQLDB has always supported correlated subqueries;
this method always returns true.
supportsCorrelatedSubqueries in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsUnion()
throws java.sql.SQLException
UNION.
HSQLDB supports SQL UNION;
this method always returns true.
supportsUnion in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsUnionAll()
throws java.sql.SQLException
UNION ALL.
HSQLDB supports SQL UNION ALL;
this method always returns true.
supportsUnionAll in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsOpenCursorsAcrossCommit()
throws java.sql.SQLException
HSQLDB 2.0 supports keeping cursors open across commits.
This method always returns true.
supportsOpenCursorsAcrossCommit in interface java.sql.DatabaseMetaDatatrue if cursors always remain open;
false if they might not remain openjava.sql.SQLException - if a database access error occurspublic boolean supportsOpenCursorsAcrossRollback()
throws java.sql.SQLException
HSQLDB 2.0 closes open cursors at rollback.
This method always returns false.
supportsOpenCursorsAcrossRollback in interface java.sql.DatabaseMetaDatatrue if cursors always remain open;
false if they might not remain openjava.sql.SQLException - if a database access error occurspublic boolean supportsOpenStatementsAcrossCommit()
throws java.sql.SQLException
HSQLDB supports keeping statements open across commits;
this method always returns true.
supportsOpenStatementsAcrossCommit in interface java.sql.DatabaseMetaDatatrue if statements always remain open;
false if they might not remain openjava.sql.SQLException - if a database access error occurspublic boolean supportsOpenStatementsAcrossRollback()
throws java.sql.SQLException
HSQLDB supports keeping statements open across rollbacks;
this method always returns true.
supportsOpenStatementsAcrossRollback in interface java.sql.DatabaseMetaDatatrue if statements always remain open;
false if they might not remain openjava.sql.SQLException - if a database access error occurspublic int getMaxBinaryLiteralLength()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxBinaryLiteralLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxCharLiteralLength()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxCharLiteralLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxColumnNameLength()
throws java.sql.SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxColumnNameLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxColumnsInGroupBy()
throws java.sql.SQLException
GROUP BY clause.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxColumnsInGroupBy in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxColumnsInIndex()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxColumnsInIndex in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxColumnsInOrderBy()
throws java.sql.SQLException
ORDER BY clause.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxColumnsInOrderBy in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxColumnsInSelect()
throws java.sql.SQLException
SELECT list.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxColumnsInSelect in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxColumnsInTable()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxColumnsInTable in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxConnections()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxConnections in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxCursorNameLength()
throws java.sql.SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxCursorNameLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxIndexLength()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory and disk availability; this method always returns 0.
getMaxIndexLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxSchemaNameLength()
throws java.sql.SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxSchemaNameLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxProcedureNameLength()
throws java.sql.SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxProcedureNameLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxCatalogNameLength()
throws java.sql.SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxCatalogNameLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxRowSize()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory and disk availability; this method always returns 0.
getMaxRowSize in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic boolean doesMaxRowSizeIncludeBlobs()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic int getMaxStatementLength()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxStatementLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxStatements()
throws java.sql.SQLException
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxStatements in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxTableNameLength()
throws java.sql.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 java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getMaxTablesInSelect()
throws java.sql.SQLException
SELECT statement.
HSQLDB does not impose a "known" limit. The limit is subject to
memory availability; this method always returns 0.
getMaxTablesInSelect in interface java.sql.DatabaseMetaDataSELECT
statement; a result of zero means that there is no limit or
the limit is not knownjava.sql.SQLException - if a database access error occurspublic int getMaxUserNameLength()
throws java.sql.SQLException
Starting with 2.0, HSQLDB implements the SQL standard, which is 128 for all names.
getMaxUserNameLength in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getDefaultTransactionIsolation()
throws java.sql.SQLException
java.sql.Connection.
getDefaultTransactionIsolation in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occursJDBCConnectionpublic boolean supportsTransactions()
throws java.sql.SQLException
commit is a noop, and the isolation level is
TRANSACTION_NONE.
HSQLDB supports transactions;
this method always returns true.
supportsTransactions in interface java.sql.DatabaseMetaDatatrue if transactions are supported;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsTransactionIsolationLevel(int level)
throws java.sql.SQLException
supportsTransactionIsolationLevel in interface java.sql.DatabaseMetaDatalevel - one of the transaction isolation levels defined in
java.sql.Connectiontrue if so; false otherwisejava.sql.SQLException - if a database access error occursJDBCConnectionpublic boolean supportsDataDefinitionAndDataManipulationTransactions()
throws java.sql.SQLException
HSQLDB does not support a mix of both data definition and
data manipulation statements within a transaction. DDL commits the
current transaction before proceeding;
this method always returns false.
supportsDataDefinitionAndDataManipulationTransactions in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsDataManipulationTransactionsOnly()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean dataDefinitionCausesTransactionCommit()
throws java.sql.SQLException
Including 2.0, a data definition statement within a transaction forces
the transaction to commit; this method always returns true.
dataDefinitionCausesTransactionCommit in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean dataDefinitionIgnoredInTransactions()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getProcedures(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String procedureNamePattern)
throws java.sql.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:
=> procedure catalog (may be null)
=> procedure schema (may be null)
=> procedure name
=> explanatory comment on the procedure
=> kind of procedure:
=> (JDBC4 new:) The name which uniquely identifies this
procedure within its schema.
A user may not have permissions to execute any of the procedures that are
returned by getProcedures
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 java.sql.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 databaseResultSet - each row is a procedure descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getProcedureColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String procedureNamePattern,
java.lang.String columnNamePattern)
throws java.sql.SQLException
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:
=> procedure catalog (may be null)
=> procedure schema (may be null)
=> procedure name
=> column/parameter name
=> kind of column/parameter:
ResultSet
=> SQL type from java.sql.Types
=> SQL type name, for a UDT type the
type name is fully qualified
=> precision
=> length in bytes of data
=> scale - null is returned for data types where
SCALE is not applicable.
=> radix
=> can it contain NULL.
=> comment describing parameter/column
=> default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)
=> (JDBC4 new:) Reserved for future use
HSQLDB-specific: CLI type from SQL 2003 Table 37,
tables 6-9 Annex A1, and/or addenda 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
=> (JDBC4 new:) reserved for future use
HSQLDB-specific: CLI SQL_DATETIME_SUB from SQL 2003 Table 37
=> (JDBC4 new:) the maximum length of binary and character based columns. For any other datatype the returned value is a
NULL
=> (JDBC4 new:) the ordinal position, starting from 1, for the input and output parameters for a procedure. A value of 0
is returned if this row describes the procedure's return value. JDBC 4.1[For result set columns, it is the
ordinal position of the column in the result set starting from 1. If there are
multiple result sets, the column ordinal positions are implementation
defined.]
=> ISO rules are used to determine the nullability for a column.
=> (JDBC4 new:) the name which uniquely identifies this procedure within its schema.
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 the org.hsqldb.dbinfo.DatabaseInformationFull class.
getProcedureColumns in interface java.sql.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 databaseResultSet - each row describes a stored procedure parameter or
columnjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getTables(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern,
java.lang.String[] types)
throws java.sql.SQLException
TABLE_TYPE, JDBC 4.1[TABLE_CAT,]
TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
=> explanatory comment on the table
=> the types catalog (may be null)
=> the types schema (may be null)
=> type name (may be null)
=> name of the designated
"identifier" column of a typed table (may be null)
=> specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are
"SYSTEM", "USER", "DERIVED". (may be null)
Note: Some databases may not return information for all tables.
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getTables in interface java.sql.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 typesResultSet - each row is a table descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getSchemas()
throws java.sql.SQLException
TABLE_CATALOG] and
TABLE_SCHEM.
The schema columns are:
=> schema name
=> catalog name (may be null)
Starting with 1.8.0, the list of schemas is returned.
getSchemas in interface java.sql.DatabaseMetaDataResultSet object in which each row is a
schema descriptionjava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getCatalogs()
throws java.sql.SQLException
The catalog column is:
=> catalog name
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getCatalogs in interface java.sql.DatabaseMetaDataResultSet object in which each row has a
single String column that is a catalog namejava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getTableTypes()
throws java.sql.SQLException
The table type is:
=> table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getTableTypes in interface java.sql.DatabaseMetaDataResultSet object in which each row has a
single String column that is a table typejava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern,
java.lang.String columnNamePattern)
throws java.sql.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:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> column name
=> SQL type from java.sql.Types
=> Data source dependent type name,
for a UDT the type name is fully qualified
=> column size.
=> the number of fractional digits. Null is returned for data types where
DECIMAL_DIGITS is not applicable.
=> Radix (typically either 10 or 2)
=> is NULL allowed.
NULL values
NULL values
=> comment describing column (may be null)
=> (JDBC4 clarification:) default value for the column, which should be interpreted as a string when the value is enclosed in quotes (may be null)
=> unused
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
=> unused (HSQLDB-specific: SQL 2003 CLI datetime/interval subcode)
=> for char types the
maximum number of bytes in the column
=> index of column in table
(starting at 1)
=> ISO rules are used to determine the nullability for a column.
=> catalog of table that is the scope
of a reference attribute (null if DATA_TYPE isn't REF)
=> schema of table that is the scope
of a reference attribute (null if the DATA_TYPE isn't REF)
=> table name that this the scope
of a reference attribute (null if the DATA_TYPE isn't REF)
=> source type of a distinct type or user-generated
Ref type, SQL type from java.sql.Types (null if DATA_TYPE
isn't DISTINCT or user-generated REF)
=> Indicates whether this column is auto incremented
=> Indicates whether this is a generated column
(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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getColumns in interface java.sql.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 databaseResultSet - each row is a column descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getColumnPrivileges(java.lang.String catalog,
java.lang.String schema,
java.lang.String table,
java.lang.String columnNamePattern)
throws java.sql.SQLException
Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilege description has the following columns:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> column name
=> grantor of access (may be null)
=> grantee of access
=> name of access (SELECT,
INSERT, UPDATE, REFRENCES, ...)
=> "YES" if grantee is permitted
to grant to others; "NO" if not; 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.
This feature is supported by default. The default implementation is the org.hsqldb.dbinfo.DatabaseInformationMain class.
getColumnPrivileges in interface java.sql.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 databaseResultSet - each row is a column privilege descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getTablePrivileges(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern)
throws java.sql.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:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> grantor of access (may be null)
=> grantee of access
=> name of access (SELECT,
INSERT, UPDATE, REFRENCES, ...)
=> "YES" if grantee is permitted
to grant to others; "NO" if not; 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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getTablePrivileges in interface java.sql.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 databaseResultSet - each row is a table privilege descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getBestRowIdentifier(java.lang.String catalog,
java.lang.String schema,
java.lang.String table,
int scope,
boolean nullable)
throws java.sql.SQLException
Each column description has the following columns:
=> actual scope of result
=> column name
=> SQL data type from java.sql.Types
=> Data source dependent type name,
for a UDT the type name is fully qualified
=> precision
=> not used
=> scale - Null is returned for data types where
DECIMAL_DIGITS is not applicable.
=> is this a pseudo column
like an Oracle ROWID
(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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getBestRowIdentifier in interface java.sql.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 descriptionjava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getVersionColumns(java.lang.String catalog,
java.lang.String schema,
java.lang.String table)
throws java.sql.SQLException
Each column description has the following columns:
=> is not used
=> column name
=> SQL data type from java.sql.Types
=> Data source-dependent type name
=> precision
=> length of column value in bytes
=> scale - Null is returned for data types where
DECIMAL_DIGITS is not applicable.
=> whether this is pseudo column
like an Oracle ROWID
(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 java.sql.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 databaseResultSet object in which each row is a
column descriptionjava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getPrimaryKeys(java.lang.String catalog,
java.lang.String schema,
java.lang.String table)
throws java.sql.SQLException
Each primary key column description has the following columns:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> column name
=> (JDBC4 Clarification:) sequence number within primary key( a value
of 1 represents the first column of the primary key, a value of 2 would
represent the second column within the primary key).
=> primary key name (may be 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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getPrimaryKeys in interface java.sql.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 databaseResultSet - each row is a primary key column descriptionjava.sql.SQLException - if a database access error occurssupportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()public java.sql.ResultSet getImportedKeys(java.lang.String catalog,
java.lang.String schema,
java.lang.String table)
throws java.sql.SQLException
Each primary key column description has the following columns:
=> primary key table catalog
being imported (may be null)
=> primary key table schema
being imported (may be null)
=> primary key table name
being imported
=> primary key column name
being imported
=> foreign key table catalog (may be null)
=> foreign key table schema (may be null)
=> foreign key table name
=> foreign key column name
=> (JDBC4 clarification) sequence number within a foreign key (a value
of 1 represents the first column of the foreign key, a value of 2 would
represent the second column within the foreign key).
=> What happens to a
foreign key when the primary key is updated:
NULL
if its primary key has been updated
=> What happens to
the foreign key when primary is deleted.
=> foreign key name (may be null)
=> primary key name (may be null)
=> can the evaluation of foreign key
constraints be deferred until commit
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getImportedKeys in interface java.sql.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 databaseResultSet - each row is a primary key column descriptionjava.sql.SQLException - if a database access error occursgetExportedKeys(java.lang.String, java.lang.String, java.lang.String),
supportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()public java.sql.ResultSet getExportedKeys(java.lang.String catalog,
java.lang.String schema,
java.lang.String table)
throws java.sql.SQLException
Each foreign key column description has the following columns:
=> primary key table catalog (may be null)
=> primary key table schema (may be null)
=> primary key table name
=> primary key column name
=> foreign key table catalog (may be null)
being exported (may be null)
=> foreign key table schema (may be null)
being exported (may be null)
=> foreign key table name
being exported
=> foreign key column name
being exported
=> (JDBC4 clarification:) sequence number within foreign key( a value
of 1 represents the first column of the foreign key, a value of 2 would
represent the second column within the foreign key).
=> What happens to
foreign key when primary is updated:
NULL if
its primary key has been updated
=> What happens to
the foreign key when primary is deleted.
NULL if
its primary key has been deleted
=> foreign key name (may be null)
=> primary key name (may be null)
=> can the evaluation of foreign key
constraints be deferred until commit
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getExportedKeys in interface java.sql.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 databaseResultSet object in which each row is a
foreign key column descriptionjava.sql.SQLException - if a database access error occursgetImportedKeys(java.lang.String, java.lang.String, java.lang.String),
supportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()public java.sql.ResultSet getCrossReference(java.lang.String parentCatalog,
java.lang.String parentSchema,
java.lang.String parentTable,
java.lang.String foreignCatalog,
java.lang.String foreignSchema,
java.lang.String foreignTable)
throws java.sql.SQLException
Each foreign key column description has the following columns:
=> parent key table catalog (may be null)
=> parent key table schema (may be null)
=> parent key table name
=> parent key column name
=> foreign key table catalog (may be null)
being exported (may be null)
=> foreign key table schema (may be null)
being exported (may be null)
=> foreign key table name
being exported
=> foreign key column name
being exported
=> sequence number within foreign key( a value
of 1 represents the first column of the foreign key, a value of 2 would
represent the second column within the foreign key).
=> What happens to
foreign key when parent key is updated:
NULL if
its parent key has been updated
=> What happens to
the foreign key when parent key is deleted.
NULL if
its primary key has been deleted
=> foreign key name (may be null)
=> parent key name (may be null)
=> can the evaluation of foreign key
constraints be deferred until commit
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getCrossReference in interface java.sql.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 databaseResultSet - each row is a foreign key column descriptionjava.sql.SQLException - if a database access error occursgetImportedKeys(java.lang.String, java.lang.String, java.lang.String),
supportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()public java.sql.ResultSet getTypeInfo()
throws java.sql.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:
=> Type name
=> SQL data type from java.sql.Types
=> maximum precision
=> prefix used to quote a literal
(may be null)
=> suffix used to quote a literal
(may be null)
=> parameters used in creating
the type (may be null)
=> can you use NULL for this type.
=> is it case sensitive.
=> can you use "WHERE" based on this type:
=> is it unsigned.
=> can it be a money value.
=> can it be used for an
auto-increment value.
=> localized version of type name
(may be null)
=> minimum scale supported
=> maximum scale supported
=> unused
=> unused
=> usually 2 or 10
(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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getTypeInfo in interface java.sql.DatabaseMetaDataResultSet object in which each row is an SQL
type descriptionjava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getIndexInfo(java.lang.String catalog,
java.lang.String schema,
java.lang.String table,
boolean unique,
boolean approximate)
throws java.sql.SQLException
Each index column description has the following columns:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> Can index values be non-unique.
false when TYPE is tableIndexStatistic
=> index catalog (may be null);
null when TYPE is tableIndexStatistic
=> index name; null when TYPE is
tableIndexStatistic
=> index type:
=> column sequence number
within index; zero when TYPE is tableIndexStatistic
=> column name; null when TYPE is
tableIndexStatistic
=> column sort sequence, "A" => ascending,
"D" => descending, may be null if sort sequence is not supported;
null when TYPE is tableIndexStatistic
=> When TYPE is tableIndexStatistic, then
this is the number of rows in the table; otherwise, it is the
number of unique values in the index.
=> When TYPE is tableIndexStatistic then
this is the number of pages used for the table, otherwise it
is the number of pages used for the current index.
=> Filter condition, if any.
(may be 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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getIndexInfo in interface java.sql.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
accurateResultSet - each row is an index column descriptionjava.sql.SQLException - if a database access error occurssupportsMixedCaseQuotedIdentifiers(),
storesUpperCaseIdentifiers()public boolean supportsResultSetType(int type)
throws java.sql.SQLException
supportsResultSetType in interface java.sql.DatabaseMetaDatatype - defined in java.sql.ResultSettrue if so; false otherwisejava.sql.SQLException - if a database access error occursJDBCConnectionpublic boolean supportsResultSetConcurrency(int type,
int concurrency)
throws java.sql.SQLException
supportsResultSetConcurrency in interface java.sql.DatabaseMetaDatatype - defined in java.sql.ResultSetconcurrency - type defined in java.sql.ResultSettrue if so; false otherwisejava.sql.SQLException - if a database access error occursJDBCConnectionpublic boolean ownUpdatesAreVisible(int type)
throws java.sql.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 java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if updates are visible for the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean ownDeletesAreVisible(int type)
throws java.sql.SQLException
Rows deleted from the ResultSet are still visible after moving from the deleted row.
ownDeletesAreVisible in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if deletes are visible for the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean ownInsertsAreVisible(int type)
throws java.sql.SQLException
Rows added to a ResultSet are not visible after moving from the
insert row; this method always returns false.
ownInsertsAreVisible in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if inserts are visible for the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean othersUpdatesAreVisible(int type)
throws java.sql.SQLException
Updates made by other connections or the same connection while the ResultSet is open are not visible in the ResultSet.
othersUpdatesAreVisible in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if updates made by others
are visible for the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean othersDeletesAreVisible(int type)
throws java.sql.SQLException
Deletes made by other connections or the same connection while the ResultSet is open are not visible in the ResultSet.
othersDeletesAreVisible in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if deletes made by others
are visible for the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean othersInsertsAreVisible(int type)
throws java.sql.SQLException
Inserts made by other connections or the same connection while the ResultSet is open are not visible in the ResultSet.
othersInsertsAreVisible in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if inserts made by others
are visible for the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean updatesAreDetected(int type)
throws java.sql.SQLException
ResultSet.rowUpdated.
Updates made to the rows of the ResultSet are not detected by
calling the ResultSet.rowUpdated.
updatesAreDetected in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if changes are detected by the result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean deletesAreDetected(int type)
throws java.sql.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 java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if deletes are detected by the given result set type;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean insertsAreDetected(int type)
throws java.sql.SQLException
ResultSet.rowInserted.
Inserts made into the ResultSet are not visible and thus not detected by
calling the ResultSet.rowInserted.
insertsAreDetected in interface java.sql.DatabaseMetaDatatype - the ResultSet type; one of
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVEtrue if changes are detected by the specified result
set type; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsBatchUpdates()
throws java.sql.SQLException
HSQLDB supports batch updates;
this method always returns true.
supportsBatchUpdates in interface java.sql.DatabaseMetaDatatrue if this database supports batch updates;
false otherwisejava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getUDTs(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String typeNamePattern,
int[] types)
throws java.sql.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:
=> the type's catalog (may be null)
=> type's schema (may be null)
=> type name
=> Java class name
=> type value defined in java.sql.Types.
One of JAVA_OBJECT, STRUCT, or DISTINCT
=> explanatory comment on the type
=> type code of the source type of a
DISTINCT type or the type that implements the user-generated
reference type of the SELF_REFERENCING_COLUMN of a structured
type as defined in java.sql.Types (null if DATA_TYPE is not
DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty result set is returned.
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 java.sql.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 typesResultSet object in which each row describes a UDTjava.sql.SQLException - if a database access error occurs(JDBC4 clarification)public java.sql.Connection getConnection()
throws java.sql.SQLException
getConnection in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic boolean supportsSavepoints()
throws java.sql.SQLException
Beginning with 1.7.2, this SQL feature is supported through JDBC as well as SQL.
supportsSavepoints in interface java.sql.DatabaseMetaDatatrue if savepoints are supported;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsNamedParameters()
throws java.sql.SQLException
Starting with 1.7.2, HSQLDB supports JDBC named parameters to callable statements; this method returns true.
supportsNamedParameters in interface java.sql.DatabaseMetaDatatrue if named parameters are supported;
false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsMultipleOpenResults()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if a CallableStatement object
can return multiple ResultSet objects
simultaneously; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean supportsGetGeneratedKeys()
throws java.sql.SQLException
HSQLDB supports retrieval of
autogenerated keys through the JDBC interface;
this method always returns true.
supportsGetGeneratedKeys in interface java.sql.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
java.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getSuperTypes(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String typeNamePattern)
throws java.sql.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:
=> the UDT's catalog (may be null)
=> UDT's schema (may be null)
=> type name of the UDT
=> the direct super type's catalog
(may be null)
=> the direct super type's schema
(may be null)
=> the direct super type's name
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 the org.hsqldb.dbinfo.DatabaseInformationMain class.
getSuperTypes in interface java.sql.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
nameResultSet object in which a row gives information
about the designated UDTjava.sql.SQLException - if a database access error occurs(JDBC4 clarification)public java.sql.ResultSet getSuperTables(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern)
throws java.sql.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:
=> the type's catalog (may be null)
=> type's schema (may be null)
=> type name
=> the direct super type's name
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. the org.hsqldb.dbinfo.DatabaseInformationMain class.
getSuperTables in interface java.sql.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
nameResultSet object in which each row is a type descriptionjava.sql.SQLException - if a database access error occurs(JDBC4 clarification)public java.sql.ResultSet getAttributes(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String typeNamePattern,
java.lang.String attributeNamePattern)
throws java.sql.SQLException
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:
=> type catalog (may be null)
=> type schema (may be null)
=> type name
=> attribute name
=> attribute type SQL type from java.sql.Types
=> Data source dependent type name.
For a UDT, the type name is fully qualified. For a REF, the type name is
fully qualified and represents the target type of the reference type.
=> column size. For char or date
types this is the maximum number of characters; for numeric or
decimal types this is precision.
=> the number of fractional digits. Null is returned for data types where
DECIMAL_DIGITS is not applicable.
=> Radix (typically either 10 or 2)
=> whether NULL is allowed
=> comment describing column (may be null)
=> default value (may be null)
=> unused
=> unused
=> for char types the
maximum number of bytes in the column
=> index of JDBC 4.1 correction[the attribute in the UDT]
(starting at 1)
=> ISO rules are used to determine
the nullability for a column.
=> catalog of table that is the
scope of a reference attribute (null if DATA_TYPE isn't REF)
=> schema of table that is the
scope of a reference attribute (null if DATA_TYPE isn't REF)
=> table name that is the scope of a
reference attribute (null if the DATA_TYPE isn't REF)
=> source type of a distinct type or user-generated
Ref type,SQL type from java.sql.Types (null if DATA_TYPE
isn't DISTINCT or user-generated REF)
This method is intended for attributes of structured types. From 2.0 this method returns an empty ResultSet.
getAttributes in interface java.sql.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 databaseResultSet object in which each row is an
attribute descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public boolean supportsResultSetHoldability(int holdability)
throws java.sql.SQLException
HSQLDB returns true for both alternatives.
supportsResultSetHoldability in interface java.sql.DatabaseMetaDataholdability - one of the following constants:
ResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMITtrue if so; false otherwisejava.sql.SQLException - if a database access error occursJDBCConnectionpublic int getResultSetHoldability()
throws java.sql.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 java.sql.DatabaseMetaDataResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMITjava.sql.SQLException - if a database access error occurspublic int getDatabaseMajorVersion()
throws java.sql.SQLException
Returns the major version
getDatabaseMajorVersion in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getDatabaseMinorVersion()
throws java.sql.SQLException
This returns the digit after the first point in version.
getDatabaseMinorVersion in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getJDBCMajorVersion()
throws java.sql.SQLException
getJDBCMajorVersion in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getJDBCMinorVersion()
throws java.sql.SQLException
getJDBCMinorVersion in interface java.sql.DatabaseMetaDatajava.sql.SQLException - if a database access error occurspublic int getSQLStateType()
throws java.sql.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 java.sql.DatabaseMetaDatasqlStateSQL is new in JDBC4 and its value is the same as JDBC3 sqlStateSQL99
java.sql.SQLException - if a database access error occurspublic boolean locatorsUpdateCopy()
throws java.sql.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 java.sql.DatabaseMetaDatatrue if updates are made to a copy of the LOB;
false if updates are made directly to the LOBjava.sql.SQLException - if a database access error occurspublic boolean supportsStatementPooling()
throws java.sql.SQLException
Starting with 2.0, HSQLDB supports statement pooling when built under JDK 1.6+.
supportsStatementPooling in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.sql.RowIdLifetime getRowIdLifetime()
throws java.sql.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 java.sql.DatabaseMetaDataRowIdjava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getSchemas(java.lang.String catalog,
java.lang.String schemaPattern)
throws java.sql.SQLException
TABLE_CATALOG] and
TABLE_SCHEM.
The schema columns are:
=> schema name
=> catalog name (may be null)
getSchemas in interface java.sql.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 descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public boolean supportsStoredFunctionsUsingCallSyntax()
throws java.sql.SQLException
supportsStoredFunctionsUsingCallSyntax in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic boolean autoCommitFailureClosesAllResultSets()
throws java.sql.SQLException
SQLException while autoCommit is true indicates
that all open ResultSets are closed, even ones that are holdable. When a SQLException occurs while
autocommit is true, it is vendor specific whether the JDBC driver responds with a commit operation, a
rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference
is in whether or not holdable ResultSets are closed.autoCommitFailureClosesAllResultSets in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occurspublic java.sql.ResultSet getClientInfoProperties()
throws java.sql.SQLException
=> The name of the client info property=> The maximum length of the value for the property=> The default value of the property=> A description of the property. This will typically
contain information as to where this property is
stored in the database.
The ResultSet is sorted by the NAME column
getClientInfoProperties in interface java.sql.DatabaseMetaDataResultSet object; each row is a supported client info
property
java.sql.SQLException - if a database access error occurs
public java.sql.ResultSet getFunctions(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String functionNamePattern)
throws java.sql.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:
=> function catalog (may be null)
=> function schema (may be null)
=> function name. This is the name
used to invoke the function
=> explanatory comment on the function
=> kind of function:
=> the name which uniquely identifies
this function within its schema. This is a user specified, or DBMS
generated, name that may be different then the FUNCTION_NAME
for example with overload functions
A user may not have permission to execute any of the functions that are
returned by getFunctions
getFunctions in interface java.sql.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 databaseResultSet - each row is a function descriptionjava.sql.SQLException - if a database access error occursgetSearchStringEscape()public java.sql.ResultSet getFunctionColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String functionNamePattern,
java.lang.String columnNamePattern)
throws java.sql.SQLException
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:
=> function catalog (may be null)
=> function schema (may be null)
=> function name. This is the name
used to invoke the function
=> column/parameter name
=> kind of column/parameter:
ResultSet
=> SQL type from java.sql.Types
=> SQL type name, for a UDT type the
type name is fully qualified
=> precision
=> length in bytes of data
=> scale - null is returned for data types where
SCALE is not applicable.
=> radix
=> can it contain NULL.
=> comment describing column/parameter
=> the maximum length of binary
and character based parameters or columns. For any other datatype the returned value
is a NULL
=> the ordinal position, starting
from 1, for the input and output parameters. A value of 0
is returned if this row describes the function's return value.
For result set columns, it is the
ordinal position of the column in the result set starting from 1.
=> ISO rules are used to determine
the nullability for a parameter or column.
=> the name which uniquely identifies
this function within its schema. This is a user specified, or DBMS
generated, name that may be different then the FUNCTION_NAME
for example with overload functions
The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
getFunctionColumns in interface java.sql.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 databaseResultSet - each row describes a
user function parameter, column or return typejava.sql.SQLException - if a database access error occursgetSearchStringEscape()public <T> T unwrap(java.lang.Class<T> iface)
throws java.sql.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 java.sql.Wrapperiface - A Class defining an interface that the result must implement.java.sql.SQLException - If no object found that implements the interfacepublic boolean isWrapperFor(java.lang.Class<?> iface)
throws java.sql.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 java.sql.Wrapperiface - a Class defining an interface.java.sql.SQLException - if an error occurs while determining whether this is a wrapper
for an object with the given interface.public java.sql.ResultSet getPseudoColumns(java.lang.String catalog,
java.lang.String schemaPattern,
java.lang.String tableNamePattern,
java.lang.String columnNamePattern)
throws java.sql.SQLException
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:
=> table catalog (may be null)
=> table schema (may be null)
=> table name
=> column name
=> SQL type from java.sql.Types
=> column size.
=> the number of fractional digits. Null is returned for data types where
DECIMAL_DIGITS is not applicable.
=> Radix (typically either 10 or 2)
=> The allowed usage for the column. The
value returned will correspond to the enum name returned by PseudoColumnUsage.name()
=> comment describing column (may be null)
=> for char types the
maximum number of bytes in the column
=> ISO rules are used to determine the nullability for a column.
The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
getPseudoColumns in interface java.sql.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 databaseResultSet - each row is a column descriptionjava.sql.SQLException - if a database access error occursPseudoColumnUsagepublic boolean generatedKeyAlwaysReturned()
throws java.sql.SQLException
generatedKeyAlwaysReturned in interface java.sql.DatabaseMetaDatatrue if so; false otherwisejava.sql.SQLException - if a database access error occursCopyright © 2001 - 2018 HSQL Development Group.