| java.lang.Object
 org.hsqldb.jdbc.jdbcDatabaseMetaData
| jdbcDatabaseMetaData | | public class jdbcDatabaseMetaData implements DatabaseMetaData(Code) | | Comprehensive information about the database as a whole.
This interface is implemented by driver vendors to let users know the
capabilities of a Database Management System (DBMS) in combination with
the driver based on JDBCTM technology
("JDBC driver") that is used with it. Different relational DBMSs often
support different features, implement features in different ways, and use
different data types. In addition, a driver may implement a feature on
top of what the DBMS offers. Information returned by methods in this
interface applies to the capabilities of a particular driver and a
particular DBMS working together. Note that as used in this documentation,
the term "database" is used generically to refer to both the driver and DBMS.
A user for this interface is commonly a tool that needs to discover how to
deal with the underlying DBMS. This is especially true for applications
that are intended to be used with more than one DBMS. For example, a tool
might use the method getTypeInfo to find out what data types
can be used in a CREATE TABLE statement. Or a user might call
the method supportsCorrelatedSubqueries to see if it is possible
to use a correlated subquery or supportsBatchUpdates to see if
it is possible to use batch updates.
Some DatabaseMetaData methods return lists of information
in the form of ResultSet objects. Regular ResultSet
methods, such as getString and getInt, can be used
to retrieve the data from these ResultSet objects. If a given
form of metadata is not available, the ResultSet getter methods
throw an SQLException.
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.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, an option is provided to allow alternate
system table production implementations. In this distribution, there are
three implementations whose behaviour ranges from producing no system
tables at all to producing a richer and more complete body of information
about an HSQLDB database than was previously available. The information
provided through the default implementation is, unlike previous
versions, accessible to all database users, regardless of admin status.
This is now possible because the table content it produces for each
user is pre-filtered, based on the user's access rights. That is, each
system table now acts like a security-aware View.
The process of installing a system table production class is transparent and
occurs dynamically at runtime during the opening sequence of a
Database instance, in the newDatabaseInformation() factory
method of the revised DatabaseInformation class, using the following
steps:
- If a class whose fully qualified name is org.hsqldb.DatabaseInformationFull
can be found and it has an accesible constructor that takes an
org.hsqldb.Database object as its single parameter, then an instance of
that class is reflectively instantiated and is used by the database
instance to produce its system tables.
- If 1.) fails, then the process is repeated, attempting to create an
instance of org.hsqldb.DatabaseInformationMain (which provides just the
core set of system tables required to service this class, but now does
so in a more security aware and comprehensive fashion).
- If 2.) fails, then an instance of org.hsqldb.DatabaseInformation is
installed (that, by default, produces no system tables, meaning that
calls to all related methods in this class will fail, throwing an
SQLException stating that a required system table is not found).
The process of searching for alternate implementations of database
support classes, ending with the installation of a minimal but functional
default will be refered to henceforth as graceful degradation.
This process is advantageous in that it allows developers and administrators
to easily choose packaging options, simply by adding to or deleting concerned
classes from an HSQLDB installation, without worry over providing complex
initialization properties or disrupting the core operation of the engine.
In this particular context, graceful degradation allows easy choices
regarding database metadata, spanning the range of full (design-time),
custom-written, minimal (production-time) or null
(space-constrained) system table production implementations.
In the default full implementation, a number of new system tables are
provided that, although not used directly by this class, present previously
unavailable information about the database, such as about its triggers and
aliases.
In order to better support graphical database exploration tools and as an
experimental intermediate step toward more fully supporting SQL9n and
SQL200n, the default installed DatabaseInformation implementation
is also capable of reporting pseudo name space information, such as
the catalog (database URI) of database objects.
The catalog reporting feature is turned off by default but
can be turned on by providing the appropriate entries in the database
properties file (see the advanced topics section of the product
documentation).
When the feature is turned on, catalog is reported using
the following conventions:
- All objects are reported as having a catalog equal to the URI of the
database, which is equivalent to the catenation of the
<type> and <path> portions of the HSQLDB
internal JDBC connection URL.
Examples:
"jdbc:hsqldb:file:test" => "file:test"
"jdbc:hsqldb:mem:." => "mem:."
"jdbc:hsqldb:hsql:/host/..." => URI of aliased database
"jdbc:hsqldb:http:/host/..." => URI of aliased database
Note: No provision is made for qualifying database objects
by catalog in DML or DDL SQL. This feature is functional only with
respect to browsing the database through the DatabaseMetaData and system
table interfaces.
Again, it should be well understood that this feature provide an
emulation of catalog support and is intended only
as an experimental implementation to enhance the browsing experience
when using graphical database explorers and to make a first foray
into tackling the issue of implementing true catalog support
in the future.
Due the nature of the new database system table production process, fewer
assumptions can be made by this class about what information is made
available in the system tables supporting DatabaseMetaData
methods. Because of this, the SQL queries behind the ResultSet
producing methods have been cleaned up and made to adhere more strictly to
the JDBC contracts specified in relation to the method parameters.
One of the remaining assumptions concerns the approximate
argument of
jdbcDatabaseMetaData.getIndexInfo getIndexInfo() . This parameter is still
ignored since there is not yet any process in place to internally gather
and persist table and index statistics. A primitive version of a statistics
gathering and reporting subsystem may be introduced some time in the
1.7.x series of releases, but no hard decision has yet been made.
Another assumption is that simple select queries against certain system
tables will return rows in JDBC contract order in the absence of an
"ORDER BY" clause. The reason for this is that results
come back much faster when no "ORDER BY" clause is used.
Developers wishing to extend or replace an existing system table production
class should be aware of this, either adding the contract
"ORDER BY" clause to the SQL in corresponding methods in this class,
or, better, by maintaing rows in the correct order in the underlying
system tables, prefereably by creating appropriate primary indices.
JRE 1.1.x Notes:
In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires
Java 1.4 and above. In HSQLDB, support for methods introduced in different
versions of JDBC depends on the JDK version used for compiling and building
HSQLDB.
Since 1.7.0, it is possible to build the product so that
all JDBC 2 methods can be called while executing under the version 1.1.x
Java Runtime EnvironmentTM.
However, some of these method calls require int values that
are defined only in the JDBC 2 or greater version of the
java.sql.ResultSet ResultSet interface. For this reason, when the
product is compiled under JDK 1.1.x, these values are defined in
jdbcResultSet jdbcResultSet .
In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the
JDBC2-only ResultSet values can be achieved by referring
to them in parameter specifications and return value comparisons,
respectively, as follows:
jdbcResultSet.FETCH_FORWARD
jdbcResultSet.TYPE_FORWARD_ONLY
jdbcResultSet.TYPE_SCROLL_INSENSITIVE
jdbcResultSet.CONCUR_READ_ONLY
// etc
However, please note that code written in such a manner will not be
compatible for use with other JDBC 2 drivers, since they expect and use
ResultSet, rather than jdbcResultSet. Also
note, this feature is offered solely as a convenience to developers
who must work under JDK 1.1.x due to operating constraints, yet wish to
use some of the more advanced features available under the JDBC 2
specification.
(fredt@users)
(boucherb@users)
author:
boucherb@users
author:
fredt@users
version:
1.7.2
See Also: org.hsqldb.DatabaseInformation
See Also: org.hsqldb.DatabaseInformationMain
See Also: org.hsqldb.DatabaseInformationFull |
| Method Summary | |
| public boolean | allProceduresAreCallable()
Retrieves whether the current user can call all the procedures
returned by the method getProcedures. | | public boolean | allTablesAreSelectable()
Retrieves whether the current user can use all the tables returned
by the method getTables in a SELECT
statement. | | public boolean | dataDefinitionCausesTransactionCommit()
Retrieves whether a data definition statement within a transaction forces
the transaction to commit. | | public boolean | dataDefinitionIgnoredInTransactions()
Retrieves whether this database ignores a data definition statement
within a transaction. | | public boolean | deletesAreDetected(int type)
Retrieves whether or not a visible row delete can be detected by
calling the method ResultSet.rowDeleted. | | public boolean | doesMaxRowSizeIncludeBlobs()
Retrieves whether the return value for the method
getMaxRowSize includes the SQL data types
LONGVARCHAR and LONGVARBINARY. | | public ResultSet | getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern)
Retrieves a description of the given attribute of the given type
for a user-defined type (UDT) that is available in the given schema
and catalog.
Descriptions are returned only for attributes of UDTs matching the
catalog, schema, type, and attribute name criteria. | | public ResultSet | getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
Retrieves a description of a table's optimal set of columns that
uniquely identifies a row. | | public String | getCatalogSeparator()
Retrieves the String that this database uses as the
separator between a catalog and table name. | | public String | getCatalogTerm()
Retrieves the database vendor's preferred term for "catalog". | | public ResultSet | getCatalogs()
Retrieves the catalog names available in this database. | | public ResultSet | getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)
Retrieves a description of the access rights for a table's columns.
Only privileges matching the column name criteria are
returned. | | public ResultSet | getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
Retrieves a description of table columns available in
the specified catalog.
Only column descriptions matching the catalog, schema, table
and column name criteria are returned. | | public Connection | getConnection()
Retrieves the connection that produced this metadata object. | | public ResultSet | getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)
Retrieves a description of the foreign key columns in the given foreign key
table that reference the primary key columns of the given primary key
table (describe how one table imports another's key). | | public int | getDatabaseMajorVersion()
Retrieves the major version number of the underlying database. | | public int | getDatabaseMinorVersion()
Retrieves the minor version number of the underlying database. | | public String | getDatabaseProductName()
Retrieves the name of this database product. | | public String | getDatabaseProductVersion()
Retrieves the version number of this database product. | | public int | getDefaultTransactionIsolation()
Retrieves this database's default transaction isolation level. | | public int | getDriverMajorVersion()
Retrieves this JDBC driver's major version number. | | public int | getDriverMinorVersion()
Retrieves this JDBC driver's minor version number. | | public String | getDriverName()
Retrieves the name of this JDBC driver. | | public String | getDriverVersion()
Retrieves the version number of this JDBC driver as a String. | | public ResultSet | getExportedKeys(String catalog, String schema, String table)
Retrieves a description of the foreign key columns that reference the
given table's primary key columns (the foreign keys exported by a
table). | | public String | getExtraNameCharacters()
Retrieves all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, A-Z, 0-9 and _). | | public String | getIdentifierQuoteString()
Retrieves the string used to quote SQL identifiers.
This method returns a space " " if identifier quoting is not supported. | | public ResultSet | getImportedKeys(String catalog, String schema, String table)
Retrieves a description of the primary key columns that are
referenced by a table's foreign key columns (the primary keys
imported by a table). | | public ResultSet | getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
Retrieves a description of the given table's indices and statistics. | | public int | getJDBCMajorVersion()
Retrieves the major JDBC version number for this
driver. | | public int | getJDBCMinorVersion()
Retrieves the minor JDBC version number for this
driver. | | public int | getMaxBinaryLiteralLength()
Retrieves the maximum number of hex characters this database allows in an
inline binary literal. | | public int | getMaxCatalogNameLength()
Retrieves the maximum number of characters that this database allows in a
catalog name. | | public int | getMaxCharLiteralLength()
Retrieves the maximum number of characters this database allows
for a character literal. | | public int | getMaxColumnNameLength()
Retrieves the maximum number of characters this database allows
for a column name. | | public int | getMaxColumnsInGroupBy()
Retrieves the maximum number of columns this database allows in a
GROUP BY clause. | | public int | getMaxColumnsInIndex()
Retrieves the maximum number of columns this database allows in
an index. | | public int | getMaxColumnsInOrderBy()
Retrieves the maximum number of columns this database allows in an
ORDER BY clause. | | public int | getMaxColumnsInSelect()
Retrieves the maximum number of columns this database allows in a
SELECT list. | | public int | getMaxColumnsInTable()
Retrieves the maximum number of columns this database allows in
a table. | | public int | getMaxConnections()
Retrieves the maximum number of concurrent connections to this
database that are possible. | | public int | getMaxCursorNameLength()
Retrieves the maximum number of characters that this database allows in a
cursor name. | | public int | getMaxIndexLength()
Retrieves the maximum number of bytes this database allows for an
index, including all of the parts of the index. | | public int | getMaxProcedureNameLength()
Retrieves the maximum number of characters that this database allows in a
procedure name. | | public int | getMaxRowSize()
Retrieves the maximum number of bytes this database allows in
a single row. | | public int | getMaxSchemaNameLength()
Retrieves the maximum number of characters that this database allows in a
schema name. | | public int | getMaxStatementLength()
Retrieves the maximum number of characters this database allows in
an SQL statement. | | public int | getMaxStatements()
Retrieves the maximum number of active statements to this database
that can be open at the same time. | | public int | getMaxTableNameLength()
Retrieves the maximum number of characters this database allows in
a table name. | | public int | getMaxTablesInSelect()
Retrieves the maximum number of tables this database allows in a
SELECT statement. | | public int | getMaxUserNameLength()
Retrieves the maximum number of characters this database allows in
a user name. | | public String | getNumericFunctions()
Retrieves a comma-separated list of math functions available with
this database. | | public ResultSet | getPrimaryKeys(String catalog, String schema, String table)
Retrieves a description of the given table's primary key columns. | | public ResultSet | getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
Retrieves a description of the given catalog's stored procedure parameter
and result columns.
Only descriptions matching the schema, procedure and
parameter name criteria are returned. | | public String | getProcedureTerm()
Retrieves the database vendor's preferred term for "procedure". | | public ResultSet | getProcedures(String catalog, String schemaPattern, String procedureNamePattern)
Retrieves a description of the stored procedures available in the given
catalog.
Only procedure descriptions matching the schema and
procedure name criteria are returned. | | public int | getResultSetHoldability()
Retrieves the default holdability of this ResultSet
object. | | public String | getSQLKeywords()
Retrieves a comma-separated list of all of this database's SQL keywords
that are NOT also SQL92 keywords. | | public int | getSQLStateType()
Indicates whether the SQLSTATEs returned by
SQLException.getSQLState is X/Open (now known as Open Group)
SQL CLI or SQL99. | | public String | getSchemaTerm()
Retrieves the database vendor's preferred term for "schema". | | public ResultSet | getSchemas()
Retrieves the schema names available in this database. | | public String | getSearchStringEscape()
Retrieves the string that can be used to escape wildcard characters.
This is the string that can be used to escape '_' or '%' in
the catalog search parameters that are a pattern (and therefore use one
of the wildcard characters).
The '_' character represents any single character;
the '%' character represents any sequence of zero or
more characters. | | public String | getStringFunctions()
Retrieves a comma-separated list of string functions available with
this database. | | public ResultSet | getSuperTables(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the table hierarchies defined in a particular
schema in this database.
Only supertable information for tables matching the catalog, schema
and table name are returned. | | public ResultSet | getSuperTypes(String catalog, String schemaPattern, String typeNamePattern)
Retrieves a description of the user-defined type (UDT) hierarchies defined in a
particular schema in this database. | | public String | getSystemFunctions()
Retrieves a comma-separated list of system functions available with
this database. | | public ResultSet | getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)
Retrieves a description of the access rights for each table available
in a catalog. | | public ResultSet | getTableTypes()
Retrieves the table types available in this database. | | public ResultSet | getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)
Retrieves a description of the tables available in the given catalog.
Only table descriptions matching the catalog, schema, table
name and type criteria are returned. | | public String | getTimeDateFunctions()
Retrieves a comma-separated list of the time and date functions available
with this database. | | public ResultSet | getTypeInfo()
Retrieves a description of all the standard SQL types supported by
this database. | | public ResultSet | getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)
Retrieves a description of the user-defined types (UDTs) defined
in a particular schema. | | public String | getURL()
Retrieves the URL for this DBMS. | | public String | getUserName()
Retrieves the user name as known to this database. | | public ResultSet | getVersionColumns(String catalog, String schema, String table)
Retrieves a description of a table's columns that are automatically
updated when any value in a row is updated. | | public boolean | insertsAreDetected(int type)
Retrieves whether or not a visible row insert can be detected
by calling the method ResultSet.rowInserted. | | public boolean | isCatalogAtStart()
Retrieves whether a catalog appears at the start of a fully qualified
table name. | | public boolean | isReadOnly()
Retrieves whether this database is in read-only mode. | | public boolean | locatorsUpdateCopy()
Indicates whether updates made to a LOB are made on a copy or directly
to the LOB. | | public boolean | nullPlusNonNullIsNull()
Retrieves whether this database supports concatenations between
NULL and non-NULL values being
NULL. | | public boolean | nullsAreSortedAtEnd()
Retrieves whether NULL values are sorted at the end regardless of
sort order. | | public boolean | nullsAreSortedAtStart()
Retrieves whether NULL values are sorted at the start regardless
of sort order. | | public boolean | nullsAreSortedHigh()
Retrieves whether NULL values are sorted high.
Sorted high means that NULL values
sort higher than any other value in a domain. | | public boolean | nullsAreSortedLow()
Retrieves whether NULL values are sorted low.
Sorted low means that NULL values
sort lower than any other value in a domain. | | public boolean | othersDeletesAreVisible(int type)
Retrieves whether deletes made by others are visible. | | public boolean | othersInsertsAreVisible(int type)
Retrieves whether inserts made by others are visible. | | public boolean | othersUpdatesAreVisible(int type)
Retrieves whether updates made by others are visible. | | public boolean | ownDeletesAreVisible(int type)
Retrieves whether a result set's own deletes are visible. | | public boolean | ownInsertsAreVisible(int type)
Retrieves whether a result set's own inserts are visible. | | public boolean | ownUpdatesAreVisible(int type)
Retrieves whether for the given type of ResultSet object,
the result set's own updates are visible. | | public boolean | storesLowerCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in lower case. | | public boolean | storesLowerCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in lower case. | | public boolean | storesMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in mixed case. | | public boolean | storesMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in mixed case. | | public boolean | storesUpperCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in upper case. | | public boolean | storesUpperCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in upper case. | | public boolean | supportsANSI92EntryLevelSQL()
Retrieves whether this database supports the ANSI92 entry level SQL
grammar. | | public boolean | supportsANSI92FullSQL()
Retrieves whether this database supports the ANSI92 full SQL
grammar supported. | | public boolean | supportsANSI92IntermediateSQL()
Retrieves whether this database supports the ANSI92 intermediate SQL
grammar supported. | | public boolean | supportsAlterTableWithAddColumn()
Retrieves whether this database supports ALTER TABLE
with add column. | | public boolean | supportsAlterTableWithDropColumn()
Retrieves whether this database supports ALTER TABLE
with drop column. | | public boolean | supportsBatchUpdates()
Retrieves whether this database supports batch updates. | | public boolean | supportsCatalogsInDataManipulation()
Retrieves whether a catalog name can be used in a data
manipulation statement. | | public boolean | supportsCatalogsInIndexDefinitions()
Retrieves whether a catalog name can be used in an
index definition statement. | | public boolean | supportsCatalogsInPrivilegeDefinitions()
Retrieves whether a catalog name can be used in a
privilege definition statement. | | public boolean | supportsCatalogsInProcedureCalls()
Retrieves whether a catalog name can be used in a
procedure call statement. | | public boolean | supportsCatalogsInTableDefinitions()
Retrieves whether a catalog name can be used in a
table definition statement. | | public boolean | supportsColumnAliasing()
Retrieves whether this database supports column aliasing.
If so, the SQL AS clause can be used to provide names for
computed columns or to provide alias names for columns as
required. | | public boolean | supportsConvert()
Retrieves whether this database supports the CONVERT
function between SQL types. | | public boolean | supportsConvert(int fromType, int toType)
Retrieves whether this database supports the CONVERT
for two given SQL types. | | public boolean | supportsCoreSQLGrammar()
Retrieves whether this database supports the ODBC Core SQL grammar. | | public boolean | supportsCorrelatedSubqueries()
Retrieves whether this database supports correlated subqueries. | | public boolean | supportsDataDefinitionAndDataManipulationTransactions()
Retrieves whether this database supports both data definition and
data manipulation statements within a transaction. | | public boolean | supportsDataManipulationTransactionsOnly()
Retrieves whether this database supports only data manipulation
statements within a transaction. | | public boolean | supportsDifferentTableCorrelationNames()
Retrieves whether, when table correlation names are supported, they
are restricted to being different from the names of the tables. | | public boolean | supportsExpressionsInOrderBy()
Retrieves whether this database supports expressions in
ORDER BY lists. | | public boolean | supportsExtendedSQLGrammar()
Retrieves whether this database supports the ODBC Extended SQL grammar. | | public boolean | supportsFullOuterJoins()
Retrieves whether this database supports full nested outer joins. | | public boolean | supportsGetGeneratedKeys()
Retrieves whether auto-generated keys can be retrieved after
a statement has been executed. | | public boolean | supportsGroupBy()
Retrieves whether this database supports some form of
GROUP BY clause. | | public 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. | | public boolean | supportsGroupByUnrelated()
Retrieves whether this database supports using a column that is
not in the SELECT statement in a
GROUP BY clause. | | public boolean | supportsIntegrityEnhancementFacility()
Retrieves whether this database supports the SQL Integrity
Enhancement Facility. | | public boolean | supportsLikeEscapeClause()
Retrieves whether this database supports specifying a
LIKE escape clause. | | public boolean | supportsLimitedOuterJoins()
Retrieves whether this database provides limited support for outer
joins. | | public boolean | supportsMinimumSQLGrammar()
Retrieves whether this database supports the ODBC Minimum SQL grammar. | | public boolean | supportsMixedCaseIdentifiers()
Retrieves whether this database treats mixed case unquoted SQL identifiers as
case sensitive and as a result stores them in mixed case. | | public boolean | supportsMixedCaseQuotedIdentifiers()
Retrieves whether this database treats mixed case quoted SQL identifiers as
case sensitive and as a result stores them in mixed case. | | public boolean | supportsMultipleOpenResults()
Retrieves whether it is possible to have multiple ResultSet
objects returned from a CallableStatement object
simultaneously. | | public boolean | supportsMultipleResultSets()
Retrieves whether this database supports getting multiple
ResultSet objects from a single call to the
method execute. | | public boolean | supportsMultipleTransactions()
Retrieves whether this database allows having multiple
transactions open at once (on different connections). | | public boolean | supportsNamedParameters()
Retrieves whether this database supports named parameters to callable
statements. | | public boolean | supportsNonNullableColumns()
Retrieves whether columns in this database may be defined as
non-nullable. | | public boolean | supportsOpenCursorsAcrossCommit()
Retrieves whether this database supports keeping cursors open
across commits. | | public boolean | supportsOpenCursorsAcrossRollback()
Retrieves whether this database supports keeping cursors open
across rollbacks. | | public boolean | supportsOpenStatementsAcrossCommit()
Retrieves whether this database supports keeping statements open
across commits. | | public boolean | supportsOpenStatementsAcrossRollback()
Retrieves whether this database supports keeping statements open
across rollbacks. | | public boolean | supportsOrderByUnrelated()
Retrieves whether this database supports using a column that is
not in the SELECT statement in an
ORDER BY clause. | | public boolean | supportsOuterJoins()
Retrieves whether this database supports some form of outer join. | | public boolean | supportsPositionedDelete()
Retrieves whether this database supports positioned DELETE
statements. | | public boolean | supportsPositionedUpdate()
Retrieves whether this database supports positioned UPDATE
statements. | | public boolean | supportsResultSetConcurrency(int type, int concurrency)
Retrieves whether this database supports the given concurrency type
in combination with the given result set type. | | public boolean | supportsResultSetHoldability(int holdability)
Retrieves whether this database supports the given result
set holdability. | | public boolean | supportsResultSetType(int type)
Retrieves whether this database supports the given result set type. | | public boolean | supportsSavepoints()
Retrieves whether this database supports savepoints. | | public boolean | supportsSchemasInDataManipulation()
Retrieves whether a schema name can be used in a data
manipulation statement. | | public boolean | supportsSchemasInIndexDefinitions()
Retrieves whether a schema name can be used in an index
definition statement. | | public boolean | supportsSchemasInPrivilegeDefinitions()
Retrieves whether a schema name can be used in a privilege
definition statement. | | public boolean | supportsSchemasInProcedureCalls()
Retrieves whether a schema name can be used in a procedure call
statement. | | public boolean | supportsSchemasInTableDefinitions()
Retrieves whether a schema name can be used in a table
definition statement. | | public boolean | supportsSelectForUpdate()
Retrieves whether this database supports SELECT FOR UPDATE
statements. | | public boolean | supportsStatementPooling()
Retrieves whether this database supports statement pooling. | | public boolean | supportsStoredProcedures()
Retrieves whether this database supports stored procedure calls
that use the stored procedure escape syntax. | | public boolean | supportsSubqueriesInComparisons()
Retrieves whether this database supports subqueries in comparison
expressions. | | public boolean | supportsSubqueriesInExists()
Retrieves whether this database supports subqueries in
EXISTS expressions. | | public boolean | supportsSubqueriesInIns()
JDBC4 correction: Retrieves whether this database supports subqueries in
IN expressions. | | public boolean | supportsSubqueriesInQuantifieds()
Retrieves whether this database supports subqueries in quantified
expressions. | | public boolean | supportsTableCorrelationNames()
Retrieves whether this database supports table correlation names. | | public boolean | supportsTransactionIsolationLevel(int level)
Retrieves whether this database supports the given transaction
isolation level. | | public boolean | supportsTransactions()
Retrieves whether this database supports transactions. | | public boolean | supportsUnion()
Retrieves whether this database supports SQL UNION. | | public boolean | supportsUnionAll()
Retrieves whether this database supports SQL UNION ALL. | | public boolean | updatesAreDetected(int type)
Retrieves whether or not a visible row update can be detected by
calling the method ResultSet.rowUpdated. | | public boolean | usesLocalFilePerTable()
Retrieves whether this database uses a file for each table. | | public boolean | usesLocalFiles()
Retrieves whether this database stores tables in a local file. |
| INT_COLUMNS_NO_NULLS | | final static Integer INT_COLUMNS_NO_NULLS(Code) | | Used by getBestRowIdentifier to avoid extra object construction
|
| jdbcDatabaseMetaData | | jdbcDatabaseMetaData(jdbcConnection c) throws SQLException(Code) | | Constructs a new jdbcDatabaseMetaData object using the
specified connection. This contructor is used by jdbcConnection
when producing a DatabaseMetaData object from a call to
jdbcConnection.getMetaData getMetaData .
Parameters:
c - the connection this object will use to retrieveinstance-specific metadata
throws:
SQLException - never - reserved for future use |
| allProceduresAreCallable | | public boolean allProceduresAreCallable() throws SQLException(Code) | | Retrieves whether the current user can call all the procedures
returned by the method getProcedures.
HSQLDB-Specific Information:
This method still always returns
true.
In a future release, the plugin interface may be modified to allow
implementors to report different values here, based on their
implementations.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| allTablesAreSelectable | | public boolean allTablesAreSelectable() throws SQLException(Code) | | Retrieves whether the current user can use all the tables returned
by the method getTables in a SELECT
statement.
HSQLDB-Specific Information:
HSQLDB always reports true.
Please note that the default 1.7.2 getTables behaviour is
omit from the list of requested tables only those to which the
invoking user has no access of any kind.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| dataDefinitionCausesTransactionCommit | | public boolean dataDefinitionCausesTransactionCommit() throws SQLException(Code) | | Retrieves whether a data definition statement within a transaction forces
the transaction to commit.
HSQLDB-Specific Information:
Including 1.7.2, a data definition statement within a transaction forces
the transaction to commit; this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| dataDefinitionIgnoredInTransactions | | public boolean dataDefinitionIgnoredInTransactions() throws SQLException(Code) | | Retrieves whether this database ignores a data definition statement
within a transaction.
HSQLDB-Specific Information:
Including 1.7.2, 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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| deletesAreDetected | | public boolean deletesAreDetected(int type) throws SQLException(Code) | | Retrieves whether or not a visible row delete can be detected by
calling the method ResultSet.rowDeleted. If the method
deletesAreDetected returns false, it means that
deleted rows are removed from the result set.
HSQLDB-Specific Information:
Including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if deletes are detected by the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| doesMaxRowSizeIncludeBlobs | | public boolean doesMaxRowSizeIncludeBlobs() throws SQLException(Code) | | Retrieves whether the return value for the method
getMaxRowSize includes the SQL data types
LONGVARCHAR and LONGVARBINARY.
HSQLDB-Specific Indormation:
Including 1.7.2,
jdbcDatabaseMetaData.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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| getAttributes | | public ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException(Code) | | Retrieves a description of the given attribute of the given type
for a user-defined type (UDT) that is available in the given schema
and catalog.
Descriptions are returned only for attributes of UDTs matching the
catalog, schema, type, and attribute name criteria. They are ordered by
TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description
does not contain inherited attributes.
The ResultSet object that is returned has the following
columns:
- TYPE_CAT String => type catalog (may be
null)
- TYPE_SCHEM String => type schema (may be
null)
- TYPE_NAME String => type name
- ATTR_NAME String => attribute name
- DATA_TYPE short => attribute type SQL type from java.sql.Types
- ATTR_TYPE_NAME String => Data source dependent type name.
For a UDT, the type name is fully qualified. For a REF, the type name is
fully qualified and represents the target type of the reference type.
- ATTR_SIZE int => column size. For char or date
types this is the maximum number of characters; for numeric or
decimal types this is precision.
- DECIMAL_DIGITS int => the number of fractional digits
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => whether NULL is allowed
- attributeNoNulls - might not allow NULL values
- attributeNullable - definitely allows NULL values
- attributeNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null)
- ATTR_DEF String => default value (may be
null)
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the
maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table
(starting at 1)
- IS_NULLABLE String => "NO" means column definitely
does not allow NULL values; "YES" means the column might
allow NULL values. An empty string means unknown.
- SCOPE_CATALOG String => catalog of table that is the
scope of a reference attribute (
null if DATA_TYPE isn't REF)
- SCOPE_SCHEMA String => schema of table that is the
scope of a reference attribute (
null if DATA_TYPE isn't REF)
- SCOPE_TABLE String => table name that is the scope of a
reference attribute (
null if the DATA_TYPE isn't REF)
- SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
Ref type,SQL type from java.sql.Types (
null if DATA_TYPE
isn't DISTINCT or user-generated REF)
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.
Including 1.7.1, this JDBC feature is not supported; calling
this method throws a SQLException stating that the operation
is not supported.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
typeNamePattern - a type name pattern; must match thetype name as it is stored in the database
Parameters:
attributeNamePattern - an attribute name pattern; must match theattribute name as it is declared in the database a ResultSet object in which each row is anattribute description
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getBestRowIdentifier | | public ResultSet getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable) throws SQLException(Code) | | Retrieves a description of a table's optimal set of columns that
uniquely identifies a row. They are ordered by SCOPE.
Each column description has the following columns:
- SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String => column name
- DATA_TYPE short => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name,
for a UDT the type name is fully qualified
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => not used
- DECIMAL_DIGITS short => scale
- PSEUDO_COLUMN short => is this a pseudo column
like an Oracle ROWID
- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should notbe used to narrow the search
Parameters:
table - a table name; must match the table name as it is storedin the database
Parameters:
scope - the scope of interest; use same values as SCOPE
Parameters:
nullable - include columns that are nullable. ResultSet - each row is a column description
exception:
SQLException - if a database access error occurs |
| getCatalogSeparator | | public String getCatalogSeparator() throws SQLException(Code) | | Retrieves the String that this database uses as the
separator between a catalog and table name.
HSQLDB-Specific Information:
Including 1.7.2, HSQLDB does not support catalogs in DDL or DML;
this method always returns an empty String.
the separator string
exception:
SQLException - if a database access error occurs |
| getCatalogTerm | | public String getCatalogTerm() throws SQLException(Code) | | Retrieves the database vendor's preferred term for "catalog".
HSQLDB-Specific Information:
Including 1.7.2, HSQLDB does not support catalogs in DDL or DML;
this method always returns the empty String.
the vendor term for "catalog"
exception:
SQLException - if a database access error occurs |
| getCatalogs | | public ResultSet getCatalogs() throws SQLException(Code) | | Retrieves the catalog names available in this database. The results
are ordered by catalog name.
The catalog column is:
- TABLE_CAT String => catalog name
HSQLDB-Specific Information:
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
a ResultSet object in which each row has asingle String column that is a catalog name
exception:
SQLException - if a database access error occurs |
| getColumnPrivileges | | public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException(Code) | | Retrieves a description of the access rights for a table's columns.
Only privileges matching the column name criteria are
returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- GRANTOR => grantor of access (may be
null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT,
INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted
to grant to others; "NO" if not;
null if unknown
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema name as it isstored in the database; "" retrieves those without a schema;null means that the schema name should not be usedto narrow the search
Parameters:
table - a table name; must match the table name as it isstored in the database
Parameters:
columnNamePattern - a column name pattern; must match the columnname as it is stored in the database ResultSet - each row is a column privilegedescription
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getSearchStringEscape |
| getColumns | | public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException(Code) | | Retrieves a description of table columns available in
the specified catalog.
Only column descriptions matching the catalog, schema, table
and column name criteria are returned. They are ordered by
TABLE_SCHEM, TABLE_NAME, and
ORDINAL_POSITION.
Each column description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE short => SQL type from java.sql.Types
- TYPE_NAME String => Data source dependent type name,
for a UDT the type name is fully qualified
- COLUMN_SIZE int => column size. For char or date
types this is the maximum number of characters, for numeric or
decimal types this is precision.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int => the number of fractional digits
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => is NULL allowed.
- columnNoNulls - might not allow
NULL values
- columnNullable - definitely allows
NULL values
- columnNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be
null)
- COLUMN_DEF String => default value (may be
null)
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the
maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table
(starting at 1)
- IS_NULLABLE String => "NO" means column definitely
does not allow NULL values; "YES" means the column might
allow NULL values. An empty string means nobody knows.
- SCOPE_CATLOG String => catalog of table that is the scope
of a reference attribute (
null if DATA_TYPE isn't REF)
- SCOPE_SCHEMA String => schema of table that is the scope
of a reference attribute (
null if the DATA_TYPE isn't REF)
- SCOPE_TABLE String => table name that this the scope
of a reference attribure (
null if the DATA_TYPE isn't REF)
- SOURCE_DATA_TYPE short => source type of a distinct type or user-generated
Ref type, SQL type from java.sql.Types (
null if DATA_TYPE
isn't DISTINCT or user-generated REF)
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.0, HSQLDB includes the new JDBC 3 columns SCOPE_CATLOG,
SCOPE_SCHEMA, SCOPE_TABLE and SOURCE_DATA_TYPE in anticipation
of JDBC 3 compliant tools. However, these columns are never filled in;
the engine does not support the related features.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
tableNamePattern - a table name pattern; must match thetable name as it is stored in the database
Parameters:
columnNamePattern - a column name pattern; must match the columnname as it is stored in the database ResultSet - each row is a column description
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getSearchStringEscape |
| getConnection | | public Connection getConnection() throws SQLException(Code) | | Retrieves the connection that produced this metadata object.
the connection that produced this metadata object
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| getCrossReference | | public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException(Code) | | Retrieves a description of the foreign key columns in the given foreign key
table that reference the primary key columns of the given primary key
table (describe how one table imports another's key). This
should normally return a single foreign key/primary key pair because
most tables import a foreign key from a table only once. They
are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and
KEY_SEQ.
Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be
null)
- PKTABLE_SCHEM String => primary key table schema (may be
null)
- PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null)
being exported (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be
null)
being exported (may be null)
- FKTABLE_NAME String => foreign key table name
being exported
- FKCOLUMN_NAME String => foreign key column name
being exported
- KEY_SEQ short => sequence number within foreign key
- UPDATE_RULE short => What happens to
foreign key when primary is updated:
- importedNoAction - do not allow update of primary
key if it has been imported
- importedKeyCascade - change imported key to agree
with primary key update
- importedKeySetNull - change imported key to
NULL if
its primary key has been updated
- importedKeySetDefault - change imported key to default values
if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction
(for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary
key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL if
its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction
(for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if
its primary key has been deleted
- FK_NAME String => foreign key name (may be
null)
- PK_NAME String => primary key name (may be
null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
primaryCatalog - a catalog name; must match the catalog nameas it is stored in the database; "" retrieves those without acatalog; null means drop catalog name from theselection criteria
Parameters:
primarySchema - a schema name; must match the schema name asit is stored in the database; "" retrieves those without a schema;null means drop schema name from the selection criteria
Parameters:
primaryTable - the name of the table that exports the key; mustmatch the table name as it is stored in the database
Parameters:
foreignCatalog - a catalog name; must match the catalog name asit is stored in the database; "" retrieves those without acatalog; null means drop catalog name from theselection criteria
Parameters:
foreignSchema - a schema name; must match the schema name as itis stored in the database; "" retrieves those without a schema;null means drop schema name from the selection criteria
Parameters:
foreignTable - the name of the table that imports the key; mustmatch the table name as it is stored in the database ResultSet - each row is a foreign key columndescription
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getImportedKeys
See Also: jdbcDatabaseMetaData.supportsMixedCaseQuotedIdentifiers
See Also: jdbcDatabaseMetaData.storesUpperCaseIdentifiers |
| getDatabaseMajorVersion | | public int getDatabaseMajorVersion() throws SQLException(Code) | | Retrieves the major version number of the underlying database.
HSQLDB-Specific Information:
Starting with 1.7.2, the feature is supported under JDK14 builds.
This value is retrieved through an SQL call to the new
Library.getDatabaseMajorVersion method which allows
correct determination of the database major version for both local
and remote database instances.
the underlying database's major version
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getDatabaseMinorVersion | | public int getDatabaseMinorVersion() throws SQLException(Code) | | Retrieves the minor version number of the underlying database.
HSQLDB-Specific Information:
Starting with 1.7.2, the feature is supported under JDK14 builds.
This value is retrieved through an SQL call to the new
Library.getDatabaseMinorVersion method which allows
correct determination of the database minor version for both local
and remote database instances.
underlying database's minor version
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getDatabaseProductName | | public String getDatabaseProductName() throws SQLException(Code) | | Retrieves the name of this database product.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this value is retrieved through an
SQL call to the new
Library.getDatabaseProductName method
which allows correct determination of the database product name
for both local and remote database instances.
database product name
exception:
SQLException - if a database access error occurs |
| getDatabaseProductVersion | | public String getDatabaseProductVersion() throws SQLException(Code) | | Retrieves the version number of this database product.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this value is retrieved through an
SQL call to the new
Library.getDatabaseProductVersion method
which allows correct determination of the database product name
for both local and remote database instances.
database version number
exception:
SQLException - if a database access error occurs |
| getDefaultTransactionIsolation | | public int getDefaultTransactionIsolation() throws SQLException(Code) | | Retrieves this database's default transaction isolation level. The
possible values are defined in java.sql.Connection.
HSQLDB-Specific Information
Including 1.7.2, HSQLDB supports only TRANSACTION_READ_UNCOMMITED
and always returns this value here.
the default isolation level
exception:
SQLException - if a database access error occurs
See Also: jdbcConnection |
| getDriverMajorVersion | | public int getDriverMajorVersion()(Code) | | Retrieves this JDBC driver's major version number.
JDBC driver major version |
| getDriverMinorVersion | | public int getDriverMinorVersion()(Code) | | Retrieves this JDBC driver's minor version number.
JDBC driver minor version number |
| getDriverName | | public String getDriverName() throws SQLException(Code) | | Retrieves the name of this JDBC driver.
JDBC driver name
exception:
SQLException - if a database access error occurs |
| getDriverVersion | | public String getDriverVersion() throws SQLException(Code) | | Retrieves the version number of this JDBC driver as a String.
JDBC driver version
exception:
SQLException - if a database access error occurs |
| getExportedKeys | | public ResultSet getExportedKeys(String catalog, String schema, String table) throws SQLException(Code) | | Retrieves a description of the foreign key columns that reference the
given table's primary key columns (the foreign keys exported by a
table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM,
FKTABLE_NAME, and KEY_SEQ.
Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be
null)
- PKTABLE_SCHEM String => primary key table schema (may be
null)
- PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be
null)
being exported (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be
null)
being exported (may be null)
- FKTABLE_NAME String => foreign key table name
being exported
- FKCOLUMN_NAME String => foreign key column name
being exported
- KEY_SEQ short => sequence number within foreign key
- UPDATE_RULE short => What happens to
foreign key when primary is updated:
- importedNoAction - do not allow update of primary
key if it has been imported
- importedKeyCascade - change imported key to agree
with primary key update
- importedKeySetNull - change imported key to
NULL if
its primary key has been updated
- importedKeySetDefault - change imported key to default values
if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction
(for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary
key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to
NULL if
its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction
(for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if
its primary key has been deleted
- FK_NAME String => foreign key name (may be
null)
- PK_NAME String => primary key name (may be
null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in this database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
table - a table name; must match the table name as it is storedin this database a ResultSet object in which each row is aforeign key column description
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getImportedKeys
See Also: jdbcDatabaseMetaData.supportsMixedCaseQuotedIdentifiers
See Also: jdbcDatabaseMetaData.storesUpperCaseIdentifiers |
| getExtraNameCharacters | | public String getExtraNameCharacters() throws SQLException(Code) | | Retrieves all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, A-Z, 0-9 and _).
HSQLDB-Specific Information:
HSQLDB does not support using any "extra" characters in unquoted
identifier names; this method always returns the empty String.
the string containing the extra characters
exception:
SQLException - if a database access error occurs |
| getIdentifierQuoteString | | public String getIdentifierQuoteString() throws SQLException(Code) | | Retrieves the string used to quote SQL identifiers.
This method returns a space " " if identifier quoting is not supported.
HSQLDB-Specific Information:
HSQLDB uses the standard SQL identifier quote character
(the double quote character); this method always returns ".
the quoting string or a space if quoting is not supported
exception:
SQLException - if a database access error occurs |
| getImportedKeys | | public ResultSet getImportedKeys(String catalog, String schema, String table) throws SQLException(Code) | | Retrieves a description of the primary key columns that are
referenced by a table's foreign key columns (the primary keys
imported by a table). They are ordered by PKTABLE_CAT,
PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.
Each primary key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog
being imported (may be
null)
- PKTABLE_SCHEM String => primary key table schema
being imported (may be
null)
- PKTABLE_NAME String => primary key table name
being imported
- PKCOLUMN_NAME String => primary key column name
being imported
- FKTABLE_CAT String => foreign key table catalog (may be
null)
- FKTABLE_SCHEM String => foreign key table schema (may be
null)
- FKTABLE_NAME String => foreign key table name
- FKCOLUMN_NAME String => foreign key column name
- KEY_SEQ short => sequence number within a foreign key
- UPDATE_RULE short => What happens to a
foreign key when the primary key is updated:
- importedNoAction - do not allow update of primary
key if it has been imported
- importedKeyCascade - change imported key to agree
with primary key update
- importedKeySetNull - change imported key to
NULL
if its primary key has been updated
- importedKeySetDefault - change imported key to default values
if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction
(for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary
key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if
its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction
(for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if
its primary key has been deleted
- FK_NAME String => foreign key name (may be
null)
- PK_NAME String => primary key name (may be
null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
table - a table name; must match the table name as it is storedin the database ResultSet - each row is a primary key columndescription
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getExportedKeys
See Also: jdbcDatabaseMetaData.supportsMixedCaseQuotedIdentifiers
See Also: jdbcDatabaseMetaData.storesUpperCaseIdentifiers |
| getIndexInfo | | public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException(Code) | | Retrieves a description of the given table's indices and statistics. They are
ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.
Each index column description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- NON_UNIQUE boolean => Can index values be non-unique.
false when TYPE is tableIndexStatistic
- INDEX_QUALIFIER String => index catalog (may be
null);
null when TYPE is tableIndexStatistic
- INDEX_NAME String => index name;
null when TYPE is
tableIndexStatistic
- TYPE short => index type:
- tableIndexStatistic - this identifies table statistics that are
returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short => column sequence number
within index; zero when TYPE is tableIndexStatistic
- COLUMN_NAME String => column name;
null when TYPE is
tableIndexStatistic
- ASC_OR_DESC String => column sort sequence, "A" => ascending,
"D" => descending, may be
null if sort sequence is not supported;
null when TYPE is tableIndexStatistic
- CARDINALITY int => When TYPE is tableIndexStatistic, then
this is the number of rows in the table; otherwise, it is the
number of unique values in the index.
- PAGES int => When TYPE is tableIndexStatisic then
this is the number of pages used for the table, otherwise it
is the number of pages used for the current index.
- FILTER_CONDITION String => Filter condition, if any.
(may be
null)
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in this database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema nameas it is stored in this database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
table - a table name; must match the table name as it is storedin this database
Parameters:
unique - when true, return only indices for unique values;when false, return indices regardless of whether unique or not
Parameters:
approximate - when true, result is allowed to reflect approximateor out of date values; when false, results are requested to beaccurate ResultSet - each row is an index column description
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.supportsMixedCaseQuotedIdentifiers
See Also: jdbcDatabaseMetaData.storesUpperCaseIdentifiers |
| getJDBCMajorVersion | | public int getJDBCMajorVersion() throws SQLException(Code) | | Retrieves the major JDBC version number for this
driver.
HSQLDB-Specific Information:
Starting with 1.7.2, the feature is supported under JDK14 builds.
JDBC version major number
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getJDBCMinorVersion | | public int getJDBCMinorVersion() throws SQLException(Code) | | Retrieves the minor JDBC version number for this
driver.
HSQLDB-Specific Information:
Starting with 1.7.2, the feature is supported under JDK14 builds.
JDBC version minor number
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getMaxBinaryLiteralLength | | public int getMaxBinaryLiteralLength() throws SQLException(Code) | | Retrieves the maximum number of hex characters this database allows in an
inline binary literal.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
max the maximum length (in hex characters) for a binary literal;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxCatalogNameLength | | public int getMaxCatalogNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters that this database allows in a
catalog name.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalogs in
DDL or DML; this method always returns 0.
the maximum number of characters allowed in a catalog name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxCharLiteralLength | | public int getMaxCharLiteralLength() throws SQLException(Code) | | Retrieves the maximum number of characters this database allows
for a character literal.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed for a character literal;a result of zero means that there is no limit or the limit isnot known
exception:
SQLException - if a database access error occurs |
| getMaxColumnNameLength | | public int getMaxColumnNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters this database allows
for a column name.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed for a column name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxColumnsInGroupBy | | public int getMaxColumnsInGroupBy() throws SQLException(Code) | | Retrieves the maximum number of columns this database allows in a
GROUP BY clause.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of columns allowed;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxColumnsInIndex | | public int getMaxColumnsInIndex() throws SQLException(Code) | | Retrieves the maximum number of columns this database allows in
an index.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of columns allowed;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxColumnsInOrderBy | | public int getMaxColumnsInOrderBy() throws SQLException(Code) | | Retrieves the maximum number of columns this database allows in an
ORDER BY clause.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of columns allowed;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxColumnsInSelect | | public int getMaxColumnsInSelect() throws SQLException(Code) | | Retrieves the maximum number of columns this database allows in a
SELECT list.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of columns allowed;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxColumnsInTable | | public int getMaxColumnsInTable() throws SQLException(Code) | | Retrieves the maximum number of columns this database allows in
a table.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of columns allowed;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxConnections | | public int getMaxConnections() throws SQLException(Code) | | Retrieves the maximum number of concurrent connections to this
database that are possible.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of active connections possible at one time;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxCursorNameLength | | public int getMaxCursorNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters that this database allows in a
cursor name.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed in a cursor name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxIndexLength | | public int getMaxIndexLength() throws SQLException(Code) | | Retrieves the maximum number of bytes this database allows for an
index, including all of the parts of the index.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit;
this method always returns 0.
the maximum number of bytes allowed; this limit includes thecomposite of all the constituent parts of the index;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxProcedureNameLength | | public int getMaxProcedureNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters that this database allows in a
procedure name.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed in a procedure name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxRowSize | | public int getMaxRowSize() throws SQLException(Code) | | Retrieves the maximum number of bytes this database allows in
a single row.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit;
this method always returns 0.
the maximum number of bytes allowed for a row; a result ofzero means that there is no limit or the limit is not known
exception:
SQLException - if a database access error occurs |
| getMaxSchemaNameLength | | public int getMaxSchemaNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters that this database allows in a
schema name.
HSQLDB-Specific Information:
1.8.0 supports schema names with no known limit imposed,
so this method always returns 0.
the maximum number of characters allowed in a schema name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxStatementLength | | public int getMaxStatementLength() throws SQLException(Code) | | Retrieves the maximum number of characters this database allows in
an SQL statement.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed for an SQL statement;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxStatements | | public int getMaxStatements() throws SQLException(Code) | | Retrieves the maximum number of active statements to this database
that can be open at the same time.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit;
this method always returns 0.
the maximum number of statements that can be open at one time;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxTableNameLength | | public int getMaxTableNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters this database allows in
a table name.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed for a table name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getMaxTablesInSelect | | public int getMaxTablesInSelect() throws SQLException(Code) | | Retrieves the maximum number of tables this database allows in a
SELECT statement.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a Java array (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of tables allowed in a SELECTstatement; a result of zero means that there is no limit orthe limit is not known
exception:
SQLException - if a database access error occurs |
| getMaxUserNameLength | | public int getMaxUserNameLength() throws SQLException(Code) | | Retrieves the maximum number of characters this database allows in
a user name.
HSQLDB-Specific Information:
HSQLDB does not impose a "known" limit. The hard limit is the maximum
length of a java.lang.String (java.lang.Integer.MAX_VALUE);
this method always returns 0.
the maximum number of characters allowed for a user name;a result of zero means that there is no limit or the limitis not known
exception:
SQLException - if a database access error occurs |
| getNumericFunctions | | public String getNumericFunctions() throws SQLException(Code) | | Retrieves a comma-separated list of math functions available with
this database. These are the Open Group CLI math function names used in
the JDBC function escape clause.
the list of math functions supported by this database
exception:
SQLException - if a database access error occurs |
| getPrimaryKeys | | public ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException(Code) | | Retrieves a description of the given table's primary key columns. They
are ordered by COLUMN_NAME.
Each primary key column description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- KEY_SEQ short => sequence number within primary key
- PK_NAME String => primary key name (may be
null)
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should notbe used to narrow the search
Parameters:
table - a table name; must match the table name as it is storedin the database ResultSet - each row is a primary key columndescription
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.supportsMixedCaseQuotedIdentifiers
See Also: jdbcDatabaseMetaData.storesUpperCaseIdentifiers |
| getProcedureColumns | | public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException(Code) | | Retrieves a description of the given catalog's stored procedure parameter
and result columns.
Only descriptions matching the schema, procedure and
parameter name criteria are returned. They are ordered by
PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value,
if any, is first. Next are the parameter descriptions in call
order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description or
column description with the following fields:
- PROCEDURE_CAT String => procedure catalog (may be
null)
- PROCEDURE_SCHEM String => procedure schema (may be
null)
- PROCEDURE_NAME String => procedure name
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in
ResultSet
- DATA_TYPE short => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name, for a UDT type the
type name is fully qualified
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale
- RADIX short => radix
- NULLABLE short => can it contain NULL.
- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String => comment describing parameter/column
Note: Some databases may not return the column
descriptions for a procedure. Additional columns beyond
REMARKS can be defined by the database.
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
procedureNamePattern - a procedure name pattern; must match theprocedure name as it is stored in the database
Parameters:
columnNamePattern - a column name pattern; must match the columnname as it is stored in the database ResultSet - each row describes a stored procedureparameter or column
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getSearchStringEscape |
| getProcedureTerm | | public String getProcedureTerm() throws SQLException(Code) | | Retrieves the database vendor's preferred term for "procedure".
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support declaration of
functions or procedures directly in SQL but instead relies on the
HSQLDB-specific CLASS grant mechanism to make public static
Java methods available as SQL routines; this method always returns
an empty String.
the vendor term for "procedure"
exception:
SQLException - if a database access error occurs |
| getProcedures | | public ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException(Code) | | Retrieves a description of the stored procedures available in the given
catalog.
Only procedure descriptions matching the schema and
procedure name criteria are returned. They are ordered by
PROCEDURE_SCHEM and PROCEDURE_NAME.
Each procedure description has the the following columns:
- PROCEDURE_CAT String => procedure catalog (may be
null)
- PROCEDURE_SCHEM String => procedure schema (may be
null)
- PROCEDURE_NAME String => procedure name
- reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String => explanatory comment on the procedure
- PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - May return a result
- procedureNoResult - Does not return a result
- procedureReturnsResult - Returns a result
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
procedureNamePattern - a procedure name pattern; must match theprocedure name as it is stored in the database ResultSet - each row is a procedure description
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getSearchStringEscape |
| getResultSetHoldability | | public int getResultSetHoldability() throws SQLException(Code) | | Retrieves the default holdability of this ResultSet
object.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this JDBC feature is supported.
Calling this method returns HOLD_CURSORS_OVER_COMMIT, since HSQLDB
ResultSet objects are never closed as the result of an implicit
or explicit commit operation.
the default holdability; eitherResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getSQLKeywords | | public String getSQLKeywords() throws SQLException(Code) | | Retrieves a comma-separated list of all of this database's SQL keywords
that are NOT also SQL92 keywords.
HSQLDB-Specific Information:
The list returned contains HSQLDB keywords that are not in the list
of reserved words. Some of these are in the list reserved
words for SQL 2003 but are not SQL92 keywords.
the list of this database's keywords that are not alsoSQL92 keywords
exception:
SQLException - if a database access error occurs |
| getSQLStateType | | public int getSQLStateType() throws SQLException(Code) | | Indicates whether the SQLSTATEs returned by
SQLException.getSQLState is X/Open (now known as Open Group)
SQL CLI or SQL99.
HSQLDB-Specific Information:
Starting with 1.7.2, HSQLDB returns sqlStateSQL99.
the type of SQLSTATEs, one of:sqlStateXOpen orsqlStateSQL99
throws:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getSchemaTerm | | public String getSchemaTerm() throws SQLException(Code) | | Retrieves the database vendor's preferred term for "schema".
HSQLDB-Specific Information:
Starting with 1.8.0, HSQLDB provides support for schemas.
the vendor term for "schema"
exception:
SQLException - if a database access error occurs |
| getSchemas | | public ResultSet getSchemas() throws SQLException(Code) | | Retrieves the schema names available in this database. The results
are ordered by schema name.
The schema column is:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name (may be
null)
HSQLDB-Specific Information:
In 1.8.0, the list of schemas is returned.
a ResultSet object in which each row is aschema decription
exception:
SQLException - if a database access error occurs |
| getSearchStringEscape | | public String getSearchStringEscape() throws SQLException(Code) | | Retrieves the string that can be used to escape wildcard characters.
This is the string that can be used to escape '_' or '%' in
the catalog search parameters that are a pattern (and therefore use one
of the wildcard characters).
The '_' character represents any single character;
the '%' character represents any sequence of zero or
more characters.
HSQLDB-Specific Information:
HSQLDB uses the "\" character to escape wildcard characters.
the string used to escape wildcard characters
exception:
SQLException - if a database access error occurs |
| getStringFunctions | | public String getStringFunctions() throws SQLException(Code) | | Retrieves a comma-separated list of string functions available with
this database. These are the Open Group CLI string function names used
in the JDBC function escape clause.
the list of string functions supported by this database
exception:
SQLException - if a database access error occurs |
| getSuperTables | | public ResultSet getSuperTables(String catalog, String schemaPattern, String tableNamePattern) throws SQLException(Code) | | Retrieves a description of the table hierarchies defined in a particular
schema in this database.
Only supertable information for tables matching the catalog, schema
and table name are returned. The table name parameter may be a fully-
qualified name, in which case, the catalog and schemaPattern parameters
are ignored. If a table does not have a super table, it is not listed here.
Supertables have to be defined in the same catalog and schema as the
sub tables. Therefore, the type description does not need to include
this information for the supertable.
Each type description has the following columns:
- TABLE_CAT String => the type's catalog (may be
null)
- TABLE_SCHEM String => type's schema (may be
null)
- TABLE_NAME String => type name
- SUPERTABLE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an
empty result set is returned.
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; "" retrieves those without a catalog;null means drop catalog name from the selectioncriteria
Parameters:
schemaPattern - a schema name pattern; "" retrieves thosewithout a schema
Parameters:
tableNamePattern - a table name pattern; may be a fully-qualifiedname a ResultSet object in which each row is a typedescription
throws:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getSuperTypes | | public ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException(Code) | | Retrieves a description of the user-defined type (UDT) hierarchies defined in a
particular schema in this database. Only the immediate super type
sub type relationship is modeled.
Only supertype information for UDTs matching the catalog,
schema, and type name is returned. The type name parameter
may be a fully-qualified name. When the UDT name supplied is a
fully-qualified name, the catalog and schemaPattern parameters are
ignored.
If a UDT does not have a direct super type, it is not listed here.
A row of the ResultSet object returned by this method
describes the designated UDT and a direct supertype. A row has the following
columns:
- TYPE_CAT String => the UDT's catalog (may be
null)
- TYPE_SCHEM String => UDT's schema (may be
null)
- TYPE_NAME String => type name of the UDT
- SUPERTYPE_CAT String => the direct super type's catalog
(may be
null)
- SUPERTYPE_SCHEM String => the direct super type's schema
(may be
null)
- SUPERTYPE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an
empty result set is returned.
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.
Including 1.7.1, this JDBC feature is not supported; calling
this method throws a SQLException stating that the operation
is not supported.
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; "" retrieves those without a catalog;null means drop catalog name from the selectioncriteria
Parameters:
schemaPattern - a schema name pattern; "" retrieves thosewithout a schema
Parameters:
typeNamePattern - a UDT name pattern; may be a fully-qualifiedname a ResultSet object in which a row gives informationabout the designated UDT
throws:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| getSystemFunctions | | public String getSystemFunctions() throws SQLException(Code) | | Retrieves a comma-separated list of system functions available with
this database. These are the Open Group CLI system function names used
in the JDBC function escape clause.
a list of system functions supported by this database
exception:
SQLException - if a database access error occurs |
| getTablePrivileges | | public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException(Code) | | Retrieves a description of the access rights for each table available
in a catalog. Note that a table privilege applies to one or
more columns in the table. It would be wrong to assume that
this privilege applies to all columns (this may be true for
some systems but is not true for all.)
Only privileges matching the schema and table name
criteria are returned. They are ordered by TABLE_SCHEM,
TABLE_NAME, and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- GRANTOR => grantor of access (may be
null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT,
INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted
to grant to others; "NO" if not;
null if unknown
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
tableNamePattern - a table name pattern; must match thetable name as it is stored in the database ResultSet - each row is a table privilegedescription
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getSearchStringEscape |
| getTableTypes | | public ResultSet getTableTypes() throws SQLException(Code) | | Retrieves the table types available in this database. The results
are ordered by table type.
The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
HSQLDB-Specific Information:
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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
a ResultSet object in which each row has asingle String column that is a table type
exception:
SQLException - if a database access error occurs |
| getTables | | public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException(Code) | | Retrieves a description of the tables available in the given catalog.
Only table descriptions matching the catalog, schema, table
name and type criteria are returned. They are ordered by
TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
- TABLE_CAT String => table catalog (may be
null)
- TABLE_SCHEM String => table schema (may be
null)
- TABLE_NAME String => table name
- TABLE_TYPE String => table type. Typical types are "TABLE",
"VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
"LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- REMARKS String => explanatory comment on the table
- TYPE_CAT String => the types catalog (may be
null)
- TYPE_SCHEM String => the types schema (may be
null)
- TYPE_NAME String => type name (may be
null)
- SELF_REFERENCING_COL_NAME String => name of the designated
"identifier" column of a typed table (may be
null)
- REF_GENERATION String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are
"SYSTEM", "USER", "DERIVED". (may be
null)
Note: Some databases may not return information for
all tables.
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.0, HSQLDB returns extra information on TEXT tables
in the REMARKS column.
Since 1.7.0, HSQLDB includes the new 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema name pattern; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
tableNamePattern - a table name pattern; must match thetable name as it is stored in the database
Parameters:
types - a list of table types to include; null returnsall types ResultSet - each row is a table description
exception:
SQLException - if a database access error occurs
See Also: jdbcDatabaseMetaData.getSearchStringEscape |
| getTimeDateFunctions | | public String getTimeDateFunctions() throws SQLException(Code) | | Retrieves a comma-separated list of the time and date functions available
with this database.
the list of time and date functions supported by this database
exception:
SQLException - if a database access error occurs |
| getTypeInfo | | public ResultSet getTypeInfo() throws SQLException(Code) | | Retrieves a description of all the standard SQL types supported by
this database. They are ordered by DATA_TYPE and then by how
closely the data type maps to the corresponding JDBC SQL type.
Each type description has the following columns:
- TYPE_NAME String => Type name
- DATA_TYPE short => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal
(may be
null)
- LITERAL_SUFFIX String => suffix used to quote a literal
(may be
null)
- CREATE_PARAMS String => parameters used in creating
the type (may be
null)
- NULLABLE short => can you use NULL for this type.
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive.
- SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned.
- FIXED_PREC_SCALE boolean => can it be a money value.
- AUTO_INCREMENT boolean => can it be used for an
auto-increment value.
- LOCAL_TYPE_NAME String => localized version of type name
(may be
null)
- MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
HSQLDB-Specific Information:
Since 1.7.2, this feature is supported by default. If the jar is
compiled without org.hsqldb.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
a ResultSet object in which each row is an SQLtype description
exception:
SQLException - if a database access error occurs |
| getUDTs | | public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException(Code) | | Retrieves a description of the user-defined types (UDTs) defined
in a particular schema. Schema-specific UDTs may have type
JAVA_OBJECT, STRUCT,
or DISTINCT.
Only types matching the catalog, schema, type name and type
criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM
and TYPE_NAME. The type name parameter may be a fully-qualified
name. In this case, the catalog and schemaPattern parameters are
ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be
null)
- TYPE_SCHEM String => type's schema (may be
null)
- TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE String => type value defined in java.sql.Types.
One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
- BASE_TYPE short => type code of the source type of a
DISTINCT type or the type that implements the user-generated
reference type of the SELF_REFERENCING_COLUMN of a structured
type as defined in java.sql.Types (
null if DATA_TYPE is not
DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs, an empty
result set is returned.
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.
Up to and including 1.7.1, HSQLDB does not support UDTs and
thus produces an empty result.
Starting with 1.7.2, there is an option to support this feature
to greater or lesser degrees. See the documentation specific to the
selected system table provider implementation. The default implementation
is org.hsqldb.DatabaseInformationFull.
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schemaPattern - a schema pattern name; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
typeNamePattern - a type name pattern; must match the type nameas it is stored in the database; may be a fully qualified name
Parameters:
types - a list of user-defined types (JAVA_OBJECT,STRUCT, or DISTINCT) to include; null returnsall types ResultSet object in which each row describes a UDT
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| getURL | | public String getURL() throws SQLException(Code) | | Retrieves the URL for this DBMS.
the URL for this DBMS or null if it cannot begenerated
exception:
SQLException - if a database access error occurs |
| getUserName | | public String getUserName() throws SQLException(Code) | | Retrieves the user name as known to this database.
the database user name
exception:
SQLException - if a database access error occurs |
| getVersionColumns | | public ResultSet getVersionColumns(String catalog, String schema, String table) throws SQLException(Code) | | Retrieves a description of a table's columns that are automatically
updated when any value in a row is updated. They are
unordered.
Each column description has the following columns:
- SCOPE short => is not used
- COLUMN_NAME String => column name
- DATA_TYPE short => SQL data type from
java.sql.Types
- TYPE_NAME String => Data source-dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale
- PSEUDO_COLUMN short => whether this is pseudo column
like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
HSQLDB-Specific Information:
HSQLDB treats unquoted identifiers as case insensitive in SQL but 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.DatabaseInformationFull or
org.hsqldb.DatabaseInformationMain, the feature is
not supported. The default implementation is
org.hsqldb.DatabaseInformationFull .
Parameters:
catalog - a catalog name; must match the catalog name as itis stored in the database; "" retrieves those without a catalog;null means that the catalog name should not be usedto narrow the search
Parameters:
schema - a schema name; must match the schema nameas it is stored in the database; "" retrieves those without aschema; null means that the schema name should not beused to narrow the search
Parameters:
table - a table name; must match the table name as it is storedin the database a ResultSet object in which each row is acolumn description
exception:
SQLException - if a database access error occurs |
| insertsAreDetected | | public boolean insertsAreDetected(int type) throws SQLException(Code) | | Retrieves whether or not a visible row insert can be detected
by calling the method ResultSet.rowInserted.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if changes are detected by the specified resultset type; false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| isCatalogAtStart | | public boolean isCatalogAtStart() throws SQLException(Code) | | Retrieves whether a catalog appears at the start of a fully qualified
table name. If not, the catalog appears at the end.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalogs in DDL or DML;
this method always returns false.
true if the catalog name appears at the beginningof a fully qualified table name; false otherwise
exception:
SQLException - if a database access error occurs |
| isReadOnly | | public boolean isReadOnly() throws SQLException(Code) | | Retrieves whether this database is in read-only mode.
HSQLDB-Specific Information:
Starting with 1.7.2, this makes
an SQL call to the new
Library.isReadOnlyDatabase method
which provides correct determination of the read-only status for
both local and remote database instances.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| locatorsUpdateCopy | | public boolean locatorsUpdateCopy() throws SQLException(Code) | | Indicates whether updates made to a LOB are made on a copy or directly
to the LOB.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB updates the LOB directly. This
method return false.
true if updates are made to a copy of the LOB;false if updates are made directly to the LOB
throws:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| nullPlusNonNullIsNull | | public boolean nullPlusNonNullIsNull() throws SQLException(Code) | | Retrieves whether this database supports concatenations between
NULL and non-NULL values being
NULL.
HSQLDB-Specific Information:
HSQLDB supports this; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| nullsAreSortedAtEnd | | public boolean nullsAreSortedAtEnd() throws SQLException(Code) | | Retrieves whether NULL values are sorted at the end regardless of
sort order.
HSQLDB-Specific Information:
HSQLDB sorts null low; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| nullsAreSortedAtStart | | public boolean nullsAreSortedAtStart() throws SQLException(Code) | | Retrieves whether NULL values are sorted at the start regardless
of sort order.
HSQLDB-Specific Information:
HSQLDB sorts null low; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| nullsAreSortedHigh | | public boolean nullsAreSortedHigh() throws SQLException(Code) | | Retrieves whether NULL values are sorted high.
Sorted high means that NULL values
sort higher than any other value in a domain. In an ascending order,
if this method returns true, NULL values
will appear at the end. By contrast, the method
nullsAreSortedAtEnd indicates whether NULL values
are sorted at the end regardless of sort order.
HSQLDB-Specific Information:
HSQLDB sorts null low; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| nullsAreSortedLow | | public boolean nullsAreSortedLow() throws SQLException(Code) | | Retrieves whether NULL values are sorted low.
Sorted low means that NULL values
sort lower than any other value in a domain. In an ascending order,
if this method returns true, NULL values
will appear at the beginning. By contrast, the method
nullsAreSortedAtStart indicates whether NULL values
are sorted at the beginning regardless of sort order.
HSQLDB-Specific Information:
HSQLDB sorts null low; this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| othersDeletesAreVisible | | public boolean othersDeletesAreVisible(int type) throws SQLException(Code) | | Retrieves whether deletes made by others are visible.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if deletes made by othersare visible for the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| othersInsertsAreVisible | | public boolean othersInsertsAreVisible(int type) throws SQLException(Code) | | Retrieves whether inserts made by others are visible.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if inserts made by othersare visible for the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| othersUpdatesAreVisible | | public boolean othersUpdatesAreVisible(int type) throws SQLException(Code) | | Retrieves whether updates made by others are visible.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if updates made by othersare visible for the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| ownDeletesAreVisible | | public boolean ownDeletesAreVisible(int type) throws SQLException(Code) | | Retrieves whether a result set's own deletes are visible.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if deletes are visible for the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| ownInsertsAreVisible | | public boolean ownInsertsAreVisible(int type) throws SQLException(Code) | | Retrieves whether a result set's own inserts are visible.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if inserts are visible for the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| ownUpdatesAreVisible | | public boolean ownUpdatesAreVisible(int type) throws SQLException(Code) | | Retrieves whether for the given type of ResultSet object,
the result set's own updates are visible.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if updates are visible for the given result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| storesLowerCaseIdentifiers | | public boolean storesLowerCaseIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in lower case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| storesLowerCaseQuotedIdentifiers | | public boolean storesLowerCaseQuotedIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in lower case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| storesMixedCaseIdentifiers | | public boolean storesMixedCaseIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in mixed case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| storesMixedCaseQuotedIdentifiers | | public boolean storesMixedCaseQuotedIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in mixed case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| storesUpperCaseIdentifiers | | public boolean storesUpperCaseIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case unquoted SQL identifiers as
case insensitive and stores them in upper case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| storesUpperCaseQuotedIdentifiers | | public boolean storesUpperCaseQuotedIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case quoted SQL identifiers as
case insensitive and stores them in upper case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsANSI92EntryLevelSQL | | public boolean supportsANSI92EntryLevelSQL() throws SQLException(Code) | | Retrieves whether this database supports the ANSI92 entry level SQL
grammar.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support the ANSI92 entry
level SQL grammar; this method
always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsANSI92FullSQL | | public boolean supportsANSI92FullSQL() throws SQLException(Code) | | Retrieves whether this database supports the ANSI92 full SQL
grammar supported.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support the ANSI92
full SQL grammar; this method always returns
false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsANSI92IntermediateSQL | | public boolean supportsANSI92IntermediateSQL() throws SQLException(Code) | | Retrieves whether this database supports the ANSI92 intermediate SQL
grammar supported.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support the ANSI92
intermediate SQL grammar; this method always returns
false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsAlterTableWithAddColumn | | public boolean supportsAlterTableWithAddColumn() throws SQLException(Code) | | Retrieves whether this database supports ALTER TABLE
with add column.
HSQLDB-Specific Information:
From 1.7.0, HSQLDB supports this type of
ALTER TABLE statement; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsAlterTableWithDropColumn | | public boolean supportsAlterTableWithDropColumn() throws SQLException(Code) | | Retrieves whether this database supports ALTER TABLE
with drop column.
HSQLDB-Specific Information:
From 1.7.0, HSQLDB supports this type of
ALTER TABLE statement; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsBatchUpdates | | public boolean supportsBatchUpdates() throws SQLException(Code) | | Retrieves whether this database supports batch updates.
HSQLDB-Specific Information:
Starting with 1.7.2, HSQLDB supports batch updates;
this method always returns true.
true if this database supports batch upcates;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| supportsCatalogsInDataManipulation | | public boolean supportsCatalogsInDataManipulation() throws SQLException(Code) | | Retrieves whether a catalog name can be used in a data
manipulation statement.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalog-qualified;
data manipulation; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsCatalogsInIndexDefinitions | | public boolean supportsCatalogsInIndexDefinitions() throws SQLException(Code) | | Retrieves whether a catalog name can be used in an
index definition statement.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalog-qualified
index definitions; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsCatalogsInPrivilegeDefinitions | | public boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException(Code) | | Retrieves whether a catalog name can be used in a
privilege definition statement.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalog-qualified
privilege definitions; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsCatalogsInProcedureCalls | | public boolean supportsCatalogsInProcedureCalls() throws SQLException(Code) | | Retrieves whether a catalog name can be used in a
procedure call statement.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalog-qualified
procedure calls; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsCatalogsInTableDefinitions | | public boolean supportsCatalogsInTableDefinitions() throws SQLException(Code) | | Retrieves whether a catalog name can be used in a
table definition statement.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support catalog-qualified
table definitions; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsColumnAliasing | | public boolean supportsColumnAliasing() throws SQLException(Code) | | Retrieves whether this database supports column aliasing.
If so, the SQL AS clause can be used to provide names for
computed columns or to provide alias names for columns as
required.
HSQLDB-Specific Information:
HSQLDB supports column aliasing; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsConvert | | public boolean supportsConvert() throws SQLException(Code) | | Retrieves whether this database supports the CONVERT
function between SQL types.
HSQLDB-Specific Information:
HSQLDB supports conversions; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsConvert | | public boolean supportsConvert(int fromType, int toType) throws SQLException(Code) | | Retrieves whether this database supports the CONVERT
for two given SQL types.
HSQLDB-Specific Information:
HSQLDB supports conversion though String intermediates, so everything
should be possible, short of number format errors (all Java objects
have a toString method); this method always returns true.
Parameters:
fromType - the type to convert from; one of the type codes fromthe class java.sql.Types
Parameters:
toType - the type to convert to; one of the type codes fromthe class java.sql.Types true if so; false otherwise
exception:
SQLException - if a database access error occurs
See Also: java.sql.Types |
| supportsCoreSQLGrammar | | public boolean supportsCoreSQLGrammar() throws SQLException(Code) | | Retrieves whether this database supports the ODBC Core SQL grammar.
HSQLDB-Specific Information:
From 1.7.2 this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsCorrelatedSubqueries | | public boolean supportsCorrelatedSubqueries() throws SQLException(Code) | | Retrieves whether this database supports correlated subqueries.
HSQLDB-Specific Information:
HSQLDB has always supported correlated subqueries;
this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsDataDefinitionAndDataManipulationTransactions | | public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException(Code) | | Retrieves whether this database supports both data definition and
data manipulation statements within a transaction.
HSQLDB-Specific Information:
HSQLDB does not support a mix of both data definition and
data manipulation statements within a transaction. DDL commits the
current transaction before proceding;
this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsDataManipulationTransactionsOnly | | public boolean supportsDataManipulationTransactionsOnly() throws SQLException(Code) | | Retrieves whether this database supports only data manipulation
statements within a transaction.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsDifferentTableCorrelationNames | | public boolean supportsDifferentTableCorrelationNames() throws SQLException(Code) | | Retrieves whether, when table correlation names are supported, they
are restricted to being different from the names of the tables.
HSQLDB-Specific Information:
HSQLDB requires that table correlation names are different from the
names of the tables; this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsExpressionsInOrderBy | | public boolean supportsExpressionsInOrderBy() throws SQLException(Code) | | Retrieves whether this database supports expressions in
ORDER BY lists.
HSQLDB-Specific Information:
HSQLDB supports expressions in ORDER BY lists; this
method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsExtendedSQLGrammar | | public boolean supportsExtendedSQLGrammar() throws SQLException(Code) | | Retrieves whether this database supports the ODBC Extended SQL grammar.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support the ODBC
Extended SQL grammar; this method
always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsFullOuterJoins | | public boolean supportsFullOuterJoins() throws SQLException(Code) | | Retrieves whether this database supports full nested outer joins.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support full nested outer
joins; this method always returns false.
This behaviour may change in a future release.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsGetGeneratedKeys | | public boolean supportsGetGeneratedKeys() throws SQLException(Code) | | Retrieves whether auto-generated keys can be retrieved after
a statement has been executed.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support retrieving
autogenerated keys through the JDBC interface at all, although
it is possible to retrieve them in a proprietary fashion;
this method always returns false.
true if auto-generated keys can be retrievedafter a statement has executed; false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| supportsGroupBy | | public boolean supportsGroupBy() throws SQLException(Code) | | Retrieves whether this database supports some form of
GROUP BY clause.
HSQLDB-Specific Information:
HSQLDB supports using the GROUP BY clause; this method
always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsGroupByBeyondSelect | | public boolean supportsGroupByBeyondSelect() throws SQLException(Code) | | 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.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsGroupByUnrelated | | public boolean supportsGroupByUnrelated() throws SQLException(Code) | | Retrieves whether this database supports using a column that is
not in the SELECT statement in a
GROUP BY clause.
HSQLDB-Specific Information:
HSQLDB supports using a column that is
not in the SELECT statement in a
GROUP BY clause; this method
always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsIntegrityEnhancementFacility | | public boolean supportsIntegrityEnhancementFacility() throws SQLException(Code) | | Retrieves whether this database supports the SQL Integrity
Enhancement Facility.
HSQLDB-Specific Information:
From 1.7.2, this method always returns
true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsLikeEscapeClause | | public boolean supportsLikeEscapeClause() throws SQLException(Code) | | Retrieves whether this database supports specifying a
LIKE escape clause.
HSQLDB-Specific Information:
HSQLDB supports specifying a
LIKE escape clause; this method
always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsLimitedOuterJoins | | public boolean supportsLimitedOuterJoins() throws SQLException(Code) | | Retrieves whether this database provides limited support for outer
joins. (This will be true if the method
supportsFullOuterJoins returns true).
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB support the LEFT OUTER join syntax;
this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsMinimumSQLGrammar | | public boolean supportsMinimumSQLGrammar() throws SQLException(Code) | | Retrieves whether this database supports the ODBC Minimum SQL grammar.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support the ODBC
Minimum SQL grammar; this method
always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsMixedCaseIdentifiers | | public boolean supportsMixedCaseIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case unquoted SQL identifiers as
case sensitive and as a result stores them in mixed case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsMixedCaseQuotedIdentifiers | | public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException(Code) | | Retrieves whether this database treats mixed case quoted SQL identifiers as
case sensitive and as a result stores them in mixed case.
HSQLDB-Specific Information:
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.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsMultipleOpenResults | | public boolean supportsMultipleOpenResults() throws SQLException(Code) | | Retrieves whether it is possible to have multiple ResultSet
objects returned from a CallableStatement object
simultaneously.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support multiple ResultSet
objects returned from a CallableStatement object at all;
this method always returns false.
true if a CallableStatement objectcan return multiple ResultSet objectssimultaneously; false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| supportsMultipleResultSets | | public boolean supportsMultipleResultSets() throws SQLException(Code) | | Retrieves whether this database supports getting multiple
ResultSet objects from a single call to the
method execute.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support getting multiple
ResultSet objects from a single call to the
method execute; this method
always returns false.
This behaviour may change in a future release.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsMultipleTransactions | | public boolean supportsMultipleTransactions() throws SQLException(Code) | | Retrieves whether this database allows having multiple
transactions open at once (on different connections).
HSQLDB-Specific Information:
HSQLDB allows having multiple
transactions open at once (on different connections); this method
always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsNamedParameters | | public boolean supportsNamedParameters() throws SQLException(Code) | | Retrieves whether this database supports named parameters to callable
statements.
HSQLDB-Specific Information:
Starting with 1.7.2, HSQLDB supports JDBC named parameters to
callable statements; this method returns true.
true if named parameters are supported;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| supportsNonNullableColumns | | public boolean supportsNonNullableColumns() throws SQLException(Code) | | Retrieves whether columns in this database may be defined as
non-nullable.
HSQLDB-Specific Information:
HSQLDB supports the specification of non-nullable columns; this method
always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsOpenCursorsAcrossCommit | | public boolean supportsOpenCursorsAcrossCommit() throws SQLException(Code) | | Retrieves whether this database supports keeping cursors open
across commits.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support keeping
cursors open across commits; this method always returns
false.
true if cursors always remain open;false if they might not remain open
exception:
SQLException - if a database access error occurs |
| supportsOpenCursorsAcrossRollback | | public boolean supportsOpenCursorsAcrossRollback() throws SQLException(Code) | | Retrieves whether this database supports keeping cursors open
across rollbacks.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support keeping
cursors open across rollbacks;
this method always returns false.
true if cursors always remain open;false if they might not remain open
exception:
SQLException - if a database access error occurs |
| supportsOpenStatementsAcrossCommit | | public boolean supportsOpenStatementsAcrossCommit() throws SQLException(Code) | | Retrieves whether this database supports keeping statements open
across commits.
HSQLDB-Specific Information:
HSQLDB supports keeping statements open
across commits;
this method always returns true.
true if statements always remain open;false if they might not remain open
exception:
SQLException - if a database access error occurs |
| supportsOpenStatementsAcrossRollback | | public boolean supportsOpenStatementsAcrossRollback() throws SQLException(Code) | | Retrieves whether this database supports keeping statements open
across rollbacks.
HSQLDB-Specific Information:
HSQLDB supports keeping statements open
across commits;
this method always returns true.
true if statements always remain open;false if they might not remain open
exception:
SQLException - if a database access error occurs |
| supportsOrderByUnrelated | | public boolean supportsOrderByUnrelated() throws SQLException(Code) | | Retrieves whether this database supports using a column that is
not in the SELECT statement in an
ORDER BY clause.
HSQLDB-Specific Information:
HSQLDB supports using a column that is not in the SELECT
statement in an ORDER BY clause; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsOuterJoins | | public boolean supportsOuterJoins() throws SQLException(Code) | | Retrieves whether this database supports some form of outer join.
HSQLDB-Specific Information:
HSQLDB supports outer joins; this method always returns
true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsPositionedDelete | | public boolean supportsPositionedDelete() throws SQLException(Code) | | Retrieves whether this database supports positioned DELETE
statements.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsPositionedUpdate | | public boolean supportsPositionedUpdate() throws SQLException(Code) | | Retrieves whether this database supports positioned UPDATE
statements.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsResultSetConcurrency | | public boolean supportsResultSetConcurrency(int type, int concurrency) throws SQLException(Code) | | Retrieves whether this database supports the given concurrency type
in combination with the given result set type.
Parameters:
type - defined in java.sql.ResultSet
Parameters:
concurrency - type defined in java.sql.ResultSet true if so; false otherwise
exception:
SQLException - if a database access error occurs
See Also: jdbcConnection
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| supportsResultSetHoldability | | public boolean supportsResultSetHoldability(int holdability) throws SQLException(Code) | | Retrieves whether this database supports the given result
set holdability.
HSQLDB-Specific Information:
Starting with 1.7.2, HSQLDB returns true for
HOLD_CURSORS_OVER_COMMIT, else false.
Parameters:
holdability - one of the following constants:ResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT true if so; false otherwise
exception:
SQLException - if a database access error occurs
See Also: jdbcConnection
since:
JDK 1.4, HSQLDB 1.7 |
| supportsResultSetType | | public boolean supportsResultSetType(int type) throws SQLException(Code) | | Retrieves whether this database supports the given result set type.
Parameters:
type - defined in java.sql.ResultSet true if so; false otherwise
exception:
SQLException - if a database access error occurs
See Also: jdbcConnection
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| supportsSavepoints | | public boolean supportsSavepoints() throws SQLException(Code) | | Retrieves whether this database supports savepoints.
HSQLDB-Specific Information:
Beginning with 1.7.2, this SQL feature is supported
through JDBC as well as SQL.
true if savepoints are supported;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| supportsSchemasInDataManipulation | | public boolean supportsSchemasInDataManipulation() throws SQLException(Code) | | Retrieves whether a schema name can be used in a data
manipulation statement.
HSQLDB-Specific Information:
In 1.8.0, HSQLDB supports schemas in table names but not in column names;
this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSchemasInIndexDefinitions | | public boolean supportsSchemasInIndexDefinitions() throws SQLException(Code) | | Retrieves whether a schema name can be used in an index
definition statement.
HSQLDB-Specific Information:
In 1.8.0, HSQLDB supports schemas;
By default, this method returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSchemasInPrivilegeDefinitions | | public boolean supportsSchemasInPrivilegeDefinitions() throws SQLException(Code) | | Retrieves whether a schema name can be used in a privilege
definition statement.
HSQLDB-Specific Information:
In 1.8.0, HSQLDB supports schemas;
By default, this method returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSchemasInProcedureCalls | | public boolean supportsSchemasInProcedureCalls() throws SQLException(Code) | | Retrieves whether a schema name can be used in a procedure call
statement.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support schema-qualified
procedure identifiers; this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSchemasInTableDefinitions | | public boolean supportsSchemasInTableDefinitions() throws SQLException(Code) | | Retrieves whether a schema name can be used in a table
definition statement.
HSQLDB-Specific Information:
In 1.8.0, HSQLDB supports schemas;
By default, this method returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSelectForUpdate | | public boolean supportsSelectForUpdate() throws SQLException(Code) | | Retrieves whether this database supports SELECT FOR UPDATE
statements.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support explicit locking;
this method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsStatementPooling | | public boolean supportsStatementPooling() throws SQLException(Code) | | Retrieves whether this database supports statement pooling.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support statement pooling.
This method returns false.
true is so;false otherwise
throws:
SQLException - if a database access error occurs
since:
JDK 1.4, HSQLDB 1.7 |
| supportsStoredProcedures | | public boolean supportsStoredProcedures() throws SQLException(Code) | | Retrieves whether this database supports stored procedure calls
that use the stored procedure escape syntax.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB supports calling public static
Java methods in the context of SQL Stored Procedures; this method
always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs
See Also: jdbcPreparedStatement
See Also: jdbcConnection.prepareCall |
| supportsSubqueriesInComparisons | | public boolean supportsSubqueriesInComparisons() throws SQLException(Code) | | Retrieves whether this database supports subqueries in comparison
expressions.
HSQLDB-Specific Information:
HSQLDB has always supported subqueries in comparison expressions;
this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSubqueriesInExists | | public boolean supportsSubqueriesInExists() throws SQLException(Code) | | Retrieves whether this database supports subqueries in
EXISTS expressions.
HSQLDB-Specific Information:
HSQLDB has always supported subqueries in EXISTS
expressions; this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSubqueriesInIns | | public boolean supportsSubqueriesInIns() throws SQLException(Code) | | JDBC4 correction: Retrieves whether this database supports subqueries in
IN expressions.
HSQLDB-Specific Information:
HSQLDB has always supported subqueries in IN
statements; this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsSubqueriesInQuantifieds | | public boolean supportsSubqueriesInQuantifieds() throws SQLException(Code) | | Retrieves whether this database supports subqueries in quantified
expressions.
HSQLDB-Specific Information:
HSQLDB has always supported subqueries in quantified
expressions; this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsTableCorrelationNames | | public boolean supportsTableCorrelationNames() throws SQLException(Code) | | Retrieves whether this database supports table correlation names.
HSQLDB-Specific Information:
HSQLDB supports table correlation names; this method always
returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsTransactionIsolationLevel | | public boolean supportsTransactionIsolationLevel(int level) throws SQLException(Code) | | Retrieves whether this database supports the given transaction
isolation level.
HSQLDB-Specific Information
HSQLDB supports TRANSACTION_READ_UNCOMMITED in all cases
and the rest of the isolation levels where there is only one connection
to the database.
Parameters:
level - one of the transaction isolation levels defined injava.sql.Connection true if so; false otherwise
exception:
SQLException - if a database access error occurs
See Also: jdbcConnection |
| supportsTransactions | | public boolean supportsTransactions() throws SQLException(Code) | | Retrieves whether this database supports transactions. If not, invoking the
method commit is a noop, and the isolation level is
TRANSACTION_NONE.
HSQLDB-Specific Information:
HSQLDB supports transactions;
this method always returns true.
true if transactions are supported;false otherwise
exception:
SQLException - if a database access error occurs |
| supportsUnion | | public boolean supportsUnion() throws SQLException(Code) | | Retrieves whether this database supports SQL UNION.
HSQLDB-Specific Information:
HSQLDB supports SQL UNION;
this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| supportsUnionAll | | public boolean supportsUnionAll() throws SQLException(Code) | | Retrieves whether this database supports SQL UNION ALL.
HSQLDB-Specific Information:
HSQLDB supports SQL UNION ALL;
this method always returns true.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
| updatesAreDetected | | public boolean updatesAreDetected(int type) throws SQLException(Code) | | Retrieves whether or not a visible row update can be detected by
calling the method ResultSet.rowUpdated.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not support updateable
result sets; this method always returns false.
Parameters:
type - the ResultSet type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE true if changes are detected by the result set type;false otherwise
exception:
SQLException - if a database access error occurs
since:
JDK 1.2 (JDK 1.1.x developers: read the new overview
since:
for jdbcDatabaseMetaData) |
| usesLocalFilePerTable | | public boolean usesLocalFilePerTable() throws SQLException(Code) | | Retrieves whether this database uses a file for each table.
HSQLDB-Specific Information:
Up to and including 1.7.2, HSQLDB does not use a file for each table.
This method always returns false.
true if this database uses a local file for each table;false otherwise
exception:
SQLException - if a database access error occurs |
| usesLocalFiles | | public boolean usesLocalFiles() throws SQLException(Code) | | Retrieves whether this database stores tables in a local file.
HSQLDB-Specific Information:
From HSQLDB 1.7.2 it is assumed that this refers to data being stored
by the JDBC client. This method always returns false.
true if so; false otherwise
exception:
SQLException - if a database access error occurs |
|
|