Nonstop Database, HiRDB Version 9 UAP Development Guide

[Contents][Index][Back][Next]

18.4.7 DatabaseMetaData interface

Organization of this subsection
(1) Overview
(2) Methods
(3) Package and class names

(1) Overview

The DatabaseMetaData interface provides the following principal functions:

Some methods of the DatabaseMetaData class use a String pattern character string as an argument. The following table shows the special characters that can be specified in such a pattern character string.

Special character Description
_ (underscore) Any single character
% A character string of any length, including no characters (as well as any number of characters)
\ Escape character (enables a special character immediately following this escape character in a pattern character string to be treated as a regular character)

(2) Methods

The table below lists the methods of the DatabaseMetaData interface. The interface does not support methods that are not listed in the table. If an unsupported method is specified, the interface throws an SQLException.

Table 18-37 DatabaseMetaData interface methods

Subsection Method Function
(a) allProceduresAreCallable() Returns a value indicating whether all the procedures returned by the getProcedures() method can be called by the current user.
(b) allTablesAreSelectable() Returns a value indicating whether all the tables returned by the getTables() method can be used by the current user.
(c) dataDefinitionCausesTransactionCommit() Returns a value indicating whether a data definition statement in a transaction is to forcibly commit the transaction.
(d) dataDefinitionIgnoredInTransactions() Returns a value indicating whether data definition statements are ignored in transactions.
(e) deletesAreDetected(int type) Returns a value indicating whether deletions of visible rows can be detected by calling the ResultSet.rowDeleted() method.
(f) doesMaxRowSizeIncludeBlobs() Returns a value indicating whether the getMaxRowSize() method contains the LONGVARCHAR and LONGVARBINARY SQL data types.
(g) getAttributes(String catalog,String schemaPattern,String typeNamePattern,String attributeNamePattern) Returns attribute-related information for user-defined types that can be used in catalogs and specified schemas.
(h) getBestRowIdentifier(String catalog,String schema,String table,int scope,boolean nullable) Returns information about the optimum column set for a table in which rows are identified uniquely.
(i) getCatalogs() Returns the available catalog names.
(j) getCatalogSeparator() Returns the separator between the catalog name and the table name.
(k) getCatalogTerm() Returns a word recommended for catalog.
(l) getColumnPrivileges (String catalog,String schema,String table,String columnNamePattern) Returns information about table column access permissions.
(m) getColumns(String catalog,String schemaPattern,String tableNamePattern,String columnNamePattern) Returns information about specified table columns.
(n) getConnection() Returns the Connection instance that created this DatabaseMetaData instance.
(o) getCrossReference (String primaryCatalog,String primarySchema,String primaryTable,String foreignCatalog,1String foreignSchema) Returns cross-reference information between a specified referencing table and referenced table.
(p) getDatabaseMajorVersion() Returns the database's major version information.
(q) getDatabaseMinorVersion() Returns the database's minor version information.
(r) getDatabaseProductName() Returns the connected database's product name.
(s) getDatabaseProductVersion() Returns the connected database's version.
(t) getDefaultTransactionIsolation() Returns the default transaction cut-off level.
(u) getDriverMajorVersion() Returns this JDBC driver's major version as int type.
(v) getDriverMinorVersion() Returns this JDBC driver's minor version as int type.
(w) getDriverName() Returns the JDBC driver name HiRDB_Type4_JDBC_Driver.
(x) getDriverVersion() Returns the version of this JDBC driver as String.
(y) getExportedKeys (String catalog,String schema,String table) Returns information about a specified table's foreign keys.
(z) getExtraNameCharacters() Returns the special characters (characters other than a to z, A to Z, 0 to 9, and the underscore (_)) that can be used in an SQL ID name that is not enclosed in double quotation marks.
(aa) getIdentifierQuoteString() Returns the character string used to enclose SQL identifiers.
(ab) getImportedKeys (String catalog,String schema,String table) Returns information about a specified table's primary key.
(ac) getIndexInfo(String catalog,String schema,String table,boolean unique,boolean approximate) Returns information about the indexes of a specified table.
(ad) getJDBCMajorVersion() Returns the driver's JDBC major version.
(ae) getJDBCMinorVersion() Returns the driver's JDBC minor version.
(af) getMaxBinaryLiteralLength() Returns the maximum number of hexadecimal characters that can be used in a binary literal.
(ag) getMaxCatalogNameLength() Returns the maximum length of a catalog name (number of characters).
(ah) getMaxCharLiteralLength() Returns the maximum length of a character literal (number of characters).
(ai) getMaxColumnNameLength() Returns the maximum length of a column name (number of characters).
(aj) getMaxColumnsInGroupBy() Returns the maximum number of columns in a GROUP BY clause.
(ak) getMaxColumnsInIndex() Returns the maximum number of columns permitted for an index.
(al) getMaxColumnsInOrderBy() Returns the maximum number of columns in an ORDER BY clause.
(am) getMaxColumnsInSelect() Returns the maximum number of columns in a SELECT list.
(an) getMaxColumnsInTable() Returns the maximum number of columns in a table.
(ao) getMaxConnections() Returns the maximum number of concurrent connections.
(ap) getMaxCursorNameLength() Returns the maximum length of a cursor name (number of characters).
(aq) getMaxIndexLength() Returns the maximum length of an index, including all parts of the index.
(ar) getMaxProcedureNameLength() Returns the maximum length of a procedure name (number of characters).
(as) getMaxRowSize() Returns the maximum length of a row (in bytes).
(at) getMaxSchemaNameLength() Returns the maximum length of a schema name (number of characters).
(au) getMaxStatementLength() Returns the maximum length of an SQL statement.
(av) getMaxStatements() Returns the maximum number of SQL statements that can be active.
(aw) getMaxTableNameLength() Returns the maximum length of a table name (number of characters).
(ax) getMaxTablesInSelect() Returns the maximum number of tables in a SELECT statement.
(ay) getMaxUserNameLength() Returns the maximum length of a user name (number of characters).
(az) getNumericFunctions() Returns a list of the available mathematical functions (delimited by a comma).
(ba) getPrimaryKeys(String catalog, String schema, String table) Returns information about a specified table's primary key columns.
(bb) getProcedureColumns(String catalog,String schemaPattern,String procedureNamePattern, String columnNamePattern) Returns information about stored procedure parameters.
(bc) getProcedures(String catalog,String schemaPattern,String procedureNamePattern) Returns information about stored procedures.
(bd) getProcedureTerm() Returns a word recommended for procedure.
(be) getResultSetHoldability() Returns the holding facility for ResultSet objects.
(bf) getSchemas() Returns the available schema names.
(bg) getSchemaTerm() Returns a word recommended for schema.
(bh) getSearchStringEscape() Returns the character string used as the escape sequence for wildcard characters.
(bi) getSQLKeywords() Returns a list (delimited by a comma) of all database-specific SQL keywords that are not SQL92 keywords.
(bj) getSQLStateType() Returns a value indicating whether SQLSTATE returned by SQLException.getSQLState is an X/Open SQL CLI or SQL99.
(bk) getStringFunctions() Returns a list of string functions (delimited by a comma).
(bl) getSuperTables(String catalog,String schemaPattern,String tableNamePattern) Returns a description of table hierarchies defined in a specified schema.
(bm) getSuperTypes(String catalog,String schemaPattern,String typeNamePattern) Returns a description of user-defined-type hierarchies that are defined in a specified schema.
(bn) getSystemFunctions() Returns the available system functions.
(bo) getTablePrivileges(String catalog,String schemaPattern,String tableNamePattern) Returns information about table access privileges.
(bp) getTables(String catalog,String schemaPattern,String tableNamePattern,String[] types) Returns information about tables.
(bq) getTableTypes() Returns the available table types.
(br) getTimeDateFunctions() Returns a list of the available time and date functions (delimited by a comma).
(bs) getTypeInfo() Returns information about the default SQL types.
(bt) getUDTs(String catalog,String schemaPattern,String typeNamePattern,int[] types) Returns information about the user-defined types.
(bu) getURL() Returns the URL used for the connection to HiRDB or XDM/RD E2.
(bv) getUserName() Returns the user name used to connect to HiRDB or XDM/RD E2.
(bw) getVersionColumns(String catalog,String schema,String table) Returns information about the table columns that are updated automatically when rows in the table are updated.
(bx) insertsAreDetected(int type) Returns a value indicating whether insertion of a visible row can be detected by calling the ResultSet.rowInserted() method.
(by) isCatalogAtStart() Returns a value indicating whether a catalog appears at the leading (or trailing) end of a fully qualified table name.
(bz) isReadOnly() Returns a value indicating whether the database is in read-only mode.
(ca) locatorsUpdateCopy() Indicates whether a change was made to a LOB copy or directly to the LOB.
(cb) nullPlusNonNullIsNull() Returns a value indicating whether a join of a NULL value and a non-NULL value is treated as being NULL.
(cc) nullsAreSortedAtEnd() Returns a value indicating whether the NULL value is sorted during termination processing (regardless of the sort order).
(cd) nullsAreSortedAtStart() Returns a value indicating whether the NULL value is sorted during startup processing (regardless of the sort order).
(ce) nullsAreSortedHigh() Returns a value indicating whether the NULL value is sorted in ascending order.
(cf) nullsAreSortedLow() Returns a value indicating whether the NULL value is sorted in descending order.
(cg) othersDeletesAreVisible(int type) Returns a value indicating whether a deletion performed externally is visible.
(ch) othersInsertsAreVisible(int type) Returns a value indicating whether an insertion performed externally is visible.
(ci) othersUpdatesAreVisible(int type) Returns a value indicating whether a deletion performed externally is visible.
(cj) ownDeletesAreVisible(int type) Returns a value indicating whether a deletion of a result set itself is visible.
(ck) ownInsertsAreVisible(int type) Returns a value indicating whether an insertion of a result set itself is visible.
(cl) ownUpdatesAreVisible(int type) Returns a value indicating whether an updating of a result set itself is visible.
(cm) storesLowerCaseIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all lower-case letters.
(cn) storesLowerCaseQuotedIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all lower-case letters.
(co) storesMixedCaseIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in upper-case and lower-case letters.
(cp) storesMixedCaseQuotedIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in upper-case and lower-case letters.
(cq) storesUpperCaseIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all upper-case letters.
(cr) storesUpperCaseQuotedIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all upper-case letters.
(cs) supportsAlterTableWithAddColumn() Returns a value indicating whether ALTER TABLE with added columns is supported.
(ct) supportsAlterTableWithDropColumn() Returns a value indicating whether ALTER TABLE with dropped columns is supported.
(cu) supportsANSI92EntryLevelSQL() Returns a value indicating whether the ANSI92 entry-level SQL grammar is supported.
(cv) supportsANSI92FullSQL() Returns a value indicating whether the ANSI92 full-level SQL grammar is supported.
(cw) supportsANSI92IntermediateSQL() Returns a value indicating whether the ANSI92 intermediate-level SQL grammar is supported.
(cx) supportsBatchUpdates() Returns a value indicating whether batch updating is supported.
(cy) supportsCatalogsInDataManipulation() Returns a value indicating whether catalog names can be used in data manipulation statements.
(cz) supportsCatalogsInIndexDefinitions() Returns a value indicating whether catalog names can be used in index definition statements.
(da) supportsCatalogsInPrivilegeDefinitions() Returns a value indicating whether catalog names can be used in privilege definition statements.
(db) supportsCatalogsInProcedureCalls() Returns a value indicating whether catalog names can be used in procedure call statements.
(dc) supportsCatalogsInTableDefinitions() Returns a value indicating whether catalog names can be used in table definition statements.
(dd) supportsColumnAliasing() Returns a value indicating whether aliases are supported for columns.
(de) supportsConvert() Returns a value indicating whether the CONVERT function is supported for SQL types.
(df) supportsConvert(int fromType,int toType) Returns a value indicating whether the CONVERT function is supported for given SQL types.
(dg) supportsCoreSQLGrammar() Returns a value indicating whether the ODBC Core SQL grammar is supported.
(dh) supportsCorrelatedSubqueries() Returns a value indicating whether correlated subqueries are supported.
(di) supportsDataDefinitionAndDataManipulationTransactions() Returns a value indicating whether data definition statements and data manipulation statements are both supported in transactions.
(dj) supportsDataManipulationTransactionsOnly() Returns a value indicating whether only data manipulation statements are supported in transactions.
(dk) supportsDifferentTableCorrelationNames() Returns a value indicating whether the table names must be different from the correlation names when table correlation names are supported.
(dl) supportsExpressionsInOrderBy() Returns a value indicating whether expressions are supported in an ORDER BY list.
(dm) supportsExtendedSQLGrammar() Returns a value indicating whether the ODBC Extended SQL grammar is supported.
(dn) supportsFullOuterJoins() Returns a value indicating whether full outer joins are supported.
(do) supportsGetGeneratedKeys() Returns a value indicating whether automatic generation keys can be acquired after statements have executed.
(dp) supportsGroupBy() Returns a value indicating whether the GROUP BY clause form is supported.
(dq) supportsGroupByBeyondSelect() Returns a value indicating whether a column for which the GROUP BY clause is not specified in SELECT can be used when all columns in SELECT must be specified.
(dr) supportsGroupByUnrelated() Returns a value indicating whether a column for which the GROUP BY clause is not specified in SELECT can be used.
(ds) supportsIntegrityEnhancementFacility() Returns a value indicating whether the SQL Integrity Enhancement Facility is supported.
(dt) supportsLikeEscapeClause() Returns a value indicating whether escape characters are supported in the LIKE clause.
(du) supportsLimitedOuterJoins() Returns a value indicating whether limited support is provided for outer joins.
(dv) supportsMinimumSQLGrammar() Returns a value indicating whether the ODBC Minimum SQL grammar is supported.
(dw) supportsMixedCaseIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being case sensitive, and then the results are stored in upper-case and lower-case letters.
(dx) supportsMixedCaseQuotedIdentifiers() Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being case sensitive, and then the results are stored in upper-case and lower-case letters.
(dy) supportsMultipleOpenResults() Returns a value indicating whether it is possible for multiple ResultSet objects to be returned simultaneously by a CallableStatement object.
(dz) supportsMultipleResultSets() Returns a value indicating whether multiple ResultSet objects can be acquired from execution of a single execute method.
(ea) supportsMultipleTransactions() Returns a value indicating whether multiple transactions can be open at the same time (for different connections).
(eb) supportsNamedParameters() Returns a value indicating whether named parameters are supported for the callable statement.
(ec) supportsNonNullableColumns() Returns a value indicating whether columns can be defined as non-null columns.
(ed) supportsOpenCursorsAcrossCommit() Returns a value indicating whether the cursor can remain open between commit operations.
(ee) supportsOpenCursorsAcrossRollback() Returns a value indicating whether the cursor can remain open between rollback operations.
(ef) supportsOpenStatementsAcrossCommit() Returns a value indicating whether statements can remain open between commit operations.
(eg) supportsOpenStatementsAcrossRollback() Returns a value indicating whether statements can remain open between rollback operations.
(eh) supportsOrderByUnrelated() Returns a value indicating whether a column for which the ORDER BY clause is not in SELECT can be used.
(ei) supportsOuterJoins() Returns a value indicating whether some form of outer join is supported.
(ej) supportsPositionedDelete() Returns a value indicating whether positioned DELETE is supported.
(ek) supportsPositionedUpdate() Returns a value indicating whether positioned UPDATE is supported.
(el) supportsResultSetConcurrency(int type, int concurrency) Returns a value indicating whether the combination of a specified type of ResultSet and a specified parallel processing type is supported.
(em) supportsResultSetHoldability(int holdability) Returns a value indicating whether the holding facility is supported for a specified ResultSet object.
(en) supportsResultSetType(int type) Returns a value indicating whether a specified type of ResultSet is supported.
(eo) supportsSavepoints() Returns a value indicating whether save points are supported.
(ep) supportsStatementPooling() Returns a value indicating whether statement pooling is supported.
(eq) supportsSchemasInDataManipulation() Returns a value indicating whether schema names can be used in data manipulation statements.
(er) supportsSchemasInIndexDefinitions() Returns a value indicating whether schema names can be used in index definition statements.
(es) supportsSchemasInPrivilegeDefinitions() Returns a value indicating whether schema names can be used in privilege definition statements.
(et) supportsSchemasInProcedureCalls() Returns a value indicating whether schema names can be used in procedure calls.
(eu) supportsSchemasInTableDefinitions() Returns a value indicating whether schema names can be used in table definition statements.
(ev) supportsSelectForUpdate() Returns a value indicating whether SELECT is supported for updating.
(ew) supportsStoredProcedures() Returns a value indicating whether stored procedure calls are supported.
(ex) supportsSubqueriesInComparisons() Returns a value indicating whether subqueries are supported in comparison expressions.
(ey) supportsSubqueriesInExists() Returns a value indicating whether subqueries are supported in exists expressions.
(ez) supportsSubqueriesInIns() Returns a value indicating whether subqueries are supported in in statements.
(fa) supportsSubqueriesInQuantifieds() Returns a value indicating whether subqueries are supported in quantified expressions.
(fb) supportsTableCorrelationNames() Returns a value indicating whether table correlation names are supported.
(fc) supportsTransactionIsolationLevel(int level) Returns a value indicating whether a specified transaction isolation level is supported.
(fd) supportsTransactions() Returns a value indicating whether transactions are supported.
(fe) supportsUnion() Returns a value indicating whether SQL UNION is supported.
(ff) supportsUnionAll() Returns a value indicating whether SQL UNION ALL is supported.
(fg) updatesAreDetected(int type) Returns a value indicating whether updating performed on a ResultSet of a specified ResultSet type can be detected by the ResultSet.rowUpdated method.
(fh) usesLocalFilePerTable() Returns a value indicating whether a file is to be used for each table.
(fi) usesLocalFiles() Returns a value indicating whether tables are to be stored in local files.
(a) allProceduresAreCallable()

Function
Returns a value indicating whether all the procedures returned by the getProcedures() method can be called by the current user.

Format
 
public boolean allProceduresAreCallable() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Can be called.
false: Cannot be called.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(b) allTablesAreSelectable()

Function
Returns a value indicating whether all the tables returned by the getTables() method can be used by the current user.

Format
 
public boolean allTablesAreSelectable() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Can be used.
false: Cannot be used.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(c) dataDefinitionCausesTransactionCommit()

Function
Returns a value indicating whether a data definition statement in a transaction is to forcibly commit the transaction.

Format
 
public boolean dataDefinitionCausesTransactionCommit() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Commit
false: Not commit

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(d) dataDefinitionIgnoredInTransactions()

Function
Returns a value indicating whether data definition statements are ignored in transactions.

Format
 
public boolean dataDefinitionIgnoredInTransactions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Ignored
false: Not ignored

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(e) deletesAreDetected(int type)

Function
Returns a value indicating whether deletions of visible rows can be detected by calling the ResultSet.rowDeleted() method.

Format
 
public boolean deletesAreDetected(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Deletions are detected.
false: Deletions are not detected.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(f) doesMaxRowSizeIncludeBlobs()

Function
Returns a value indicating whether the getMaxRowSize() method contains the LONGVARCHAR and LONGVARBINARY SQL data types.

Format
 
public boolean doesMaxRowSizeIncludeBlobs() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Contains the LONGVARCHAR and LONGVARBINARY SQL data types.
false: Does not contain the LONGVARCHAR and LONGVARBINARY SQL data types.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(g) getAttributes (String catalog,String schemaPattern,String typeNamePattern,String attributeNamePattern)

Function
Returns attribute-related information for user-defined types that can be used in catalogs and specified schemas.

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

Arguments
String catalog
Catalog name
String schemaPattern
Schema name pattern
String typeNamePattern
Type name pattern
String attributeNamePattern
Attribute name pattern

Return value
ResultSet object

Functional detail
This method always returns a ResultSet in which the number of rows resulting from the retrieval is 0 because the Type4 JDBC driver does not support user-defined types. The method does not perform a validity check on any of the arguments. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Description
1 String CHAR TYPE_CAT Catalog name
2 String VARCHAR TYPE_SCHEM Authorization identifier
3 String VARCHAR TYPE_NAME Type name
4 String VARCHAR ATTR_NAME Attribute name
5 int INTEGER DATA_TYPE Attribute type
6 String VARCHAR ATTR_TYPE_NAME Type name
7 int INTEGER ATTR_SIZE Column size
8 int INTEGER DECIMAL_DIGITS Decimal places
9 int INTEGER NUM_PREC_RADIX Radix
10 int INTEGER NULLABLE Whether the NULL value is permitted
11 String VARCHAR REMARKS Comments
12 String VARCHAR ATTR_DEF Default value
13 int INTEGER SQL_DATA_TYPE Not used
14 int INTEGER SQL_DATETIME_SUB Not used
15 int INTEGER CHAR_OCTET_LENGTH Maximum length (in bytes) of a char-type column
16 int INTEGER ORDINAL_POSITION Column index in table
17 String VARCHAR IS_NULLABLE Whether the NULL value is permitted
18 String VARCHAR SCOPE_CATALOG Catalog for a table in the scope of reference attribute
19 String VARCHAR SCOPE_SCHEMA Schema for a table in the scope of reference attribute
20 String VARCHAR SCOPE_TABLE Table name in the scope of reference attribute
21 short SMALLINT SOURCE_DATA_TYPE Source data type for individual types, user-defined Ref type, or java.sql.Types SQL type

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(h) getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)

Function
Returns information about the optimum column set for a table in which rows are identified uniquely.

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

Arguments
String catalog
Catalog name
String schema
Schema name
String table
Table name
int scope
Target scale
boolean nullable
NULL value specification

Return value
ResultSet object

Functional detail
This method does not perform a validity check on any of the arguments. It always returns a ResultSet in which the number of rows resulting from retrieval is 0.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(i) getCatalogs()

Function
Returns the available catalog names.

Format
 
public ResultSet getCatalogs() throws SQLException
 

Arguments
None.

Return value
ResultSet object

Functional detail
This method always returns a ResultSet in which the number of rows resulting from the retrieval is 0.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(j) getCatalogSeparator()

Function
Returns the separator between the catalog name and the table name.

Format
 
public String getCatalogSeparator() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns null.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(k) getCatalogTerm()

Function
Returns a word recommended for catalog.

Format
 
public String getCatalogTerm() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns null.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(l) getColumnPrivileges (String catalog,String schema,String table,String columnNamePattern)

Function
Returns information about table column access permissions.

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

Arguments
String catalog
Catalog name (this driver ignores this argument)
String schema
Schema name pattern (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String table
Table name pattern (case sensitive). If null or a character string with a length of 0 is specified, a table name is not used to narrow down the search.
String columnNamePattern
Column name pattern (case sensitive). If null or a character string with a length of 0 is specified, a column name is not used to narrow down the search.

Return value
ResultSet object

Functional detail
This method returns information about the access permissions for the table to which the specified table column belongs. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR TABLE_CAT -- Catalog name
(NULL value is always returned)
2 String VARCHAR TABLE_SCHEM 1 (ascending order) Authorization identifier
3 String VARCHAR TABLE_NAME 2 (ascending order) Table name
4 String VARCHAR COLUMN_NAME 3 (ascending order) Column name
5 String VARCHAR GRANTOR -- User who grants access privileges
6 String VARCHAR GRANTEE -- User who receives access privileges
7 String VARCHAR PRIVILEGE 4 (ascending order) Names of granted access privileges (multiple access privilege names are delimited by the comma):
SELECT: SELECT privilege
INSERT: INSERT privilege
UPDATE: UPDATE privilege
DELETE: DELETE privilege
8 String VARCHAR IS_GRANTABLE -- Whether a user who has received access privileges can grant access privileges to other users:
YES: Can grant privileges to other users.
NO: Cannot grant privileges to other users.
null: Whether the user can grant privileges to other users is unknown.
If multiple access privileges are set in PRIVILEGE and at least one of the privileges can be granted to other users, the method sets YES. null is not returned in either HiRDB or XDM/RD E2.

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(m) getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)

Function
Returns information about specified table columns.

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

Arguments
String catalog
Catalog name (this driver ignores this argument)
String schemaPattern
Schema name pattern (case sensitive)
String tableNamePattern
Table name pattern (case sensitive)
String columnNamePattern
Column name pattern (case sensitive)

Return value
ResultSet object

Functional detail
Returns information about the specified table columns. The following table shows the format of the ResultSet that is returned.

Table 18-38 Format of ResultSet returned by getColumns

Column No. Type SQL type (Types) Column name Description
1 String CHAR TABLE_CAT NULL value is always returned
2 String VARCHAR TABLE_SCHEM Authorization identifier
3 String VARCHAR TABLE_NAME Table name
4 String VARCHAR COLUMN_NAME Column name
5 int INTEGER DATA_TYPE SQL type
6 String CHAR TYPE_NAME Type name
7 int INTEGER COLUMN_SIZE Column size
8 int INTEGER BUFFER_LENGTH NULL value is always returned
9 int INTEGER DECIMAL_DIGITS Decimal places
10 int INTEGER NUM_PREC_RADIX Radix
  • Approximate value: 2
  • Exact value: 10
  • Non-numeric value: 0
11 int INTEGER NULLABLE Whether the NULL value can be used for this type:
  • columnNoNulls: NULL value might not be permitted.
  • columnNullable: NULL value can be used.
  • columnNullableUnknown: Whether the NULL value can be used is unknown.
12 String VARCHAR REMARKS Comment column
13 String VARCHAR COLUMN_DEF Default value
14 int INTEGER SQL_DATA_TYPE NULL value is always returned
15 int INTEGER SQL_DATETIME_SUB NULL value is always returned
16 int INTEGER CHAR_OCTET_LENGTH Maximum length in bytes of char-type column (same
as COLUMN_SIZE)
17 int SMALLINT ORDINAL_POSITION Column number (beginning with 1)
18 String CHAR IS_NULLABLE Whether the NULL value can be used for this type:
  • NO: NULL value cannot be used.
  • YES: NULL value might be permitted.
19 String CHAR SCOPE_CATLOG NULL value is always returned
20 String CHAR SCOPE_SCHEMA NULL value is always returned
21 String CHAR SCOPE_TABLE NULL value is always returned
22 short SMALLINT SOURCE_DATA_TYPE NULL value is always returned

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(n) getConnection()

Function
Returns the Connection instance that created this DatabaseMetaData instance.

Format
 
public Connection getConnection() throws SQLException
 

Arguments
None.

Return value
Connection object

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(o) getCrossReference (String primaryCatalog,String primarySchema,String primaryTable,String foreignCatalog,1String foreignSchema)

Function
Returns cross-reference information between a specified referencing table and referenced table.

Format
 
public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema) throws SQLException
 

Arguments
String primaryCatalog
Catalog name of the referenced table (this driver ignores this argument)
String primarySchema
Schema name pattern of the referenced table (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String primaryTable
Table name pattern of the referenced table (case sensitive). If null or a character string with a length of 0 is specified, a table name is not used to narrow down the search.
String foreignCatalog
Catalog name of the referencing table (this driver ignores this argument)
String foreignSchema
Schema name pattern of the referencing table (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.

Return value
ResultSet object

Functional detail
This method returns cross-reference information between a specified referencing table and referenced table. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR PKTABLE_CAT -- Catalog name of the referenced table (NULL value is always returned)
2 String VARCHAR PKTABLE_SCHEM -- Authorization identifier of the referenced table
3 String VARCHAR PKTABLE_NAME -- Table name of the referenced table
4 String VARCHAR PKCOLUMN_NAME -- Column name of primary key
5 String CHAR FKTABLE_CAT -- Catalog name of the referencing table (NULL value is always returned)
6 String VARCHAR FKTABLE_SCHEM 1 (ascending order) Authorization identifier of the referencing table
7 String VARCHAR FKTABLE_NAME 2 (ascending order) Table name of the referencing table
8 String VARCHAR FKCOLUMN_NAME -- Column name of foreign key
9 short SMALLINT KEY_SEQ 3 (ascending order) Sequence number of foreign key
10 short SMALLINT UPDATE_RULE -- Updating rules.
This indicates how a foreign key is affected when the foreign key is referencing the primary key and the primary key is updated.
  • importedKeyNoAction
    The primary key cannot be updated.
  • importedKeyCascade
    The foreign key is updated by the same value as for the primary key.
  • importedKeySetNull
    The value of the foreign key is set to NULL.
  • importedKeySetDefault
    The value of the foreign key is set to the default value.
  • importedKeyRestrict
    The primary key cannot be updated.
11 short SMALLINT DELETE_RULE -- Deletion rules.
This indicates how a foreign key is affected when the foreign key is referencing the primary key and the primary key is deleted.
  • importedKeyNoAction
    The primary key cannot be deleted.
  • importedKeyCascade
    The row containing the foreign key is deleted.
  • importedKeySetNull
    The value of the foreign key is set to NULL.
  • importedKeySetDefault
    The value of the foreign key is set to the default value.
  • importedKeyRestrict
    The primary key cannot be deleted.
12 String VARCHAR FK_NAME -- Constraint name of referential constraints
13 String VARCHAR PK_NAME -- Index name of the primary key
14 short SMALLINT DEFERRABILITY -- Whether evaluation of constraints on the foreign key can be postponed until the transaction is committed:
  • importedKeyInitiallyDeferred
    Can be postponed.
  • importedKeyInitiallyImmediate
    Currently set for immediate evaluation, but the setting can be changed to postpone evaluation.
  • importedKeyNotDeferrable
    Cannot be postponed.

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(p) getDatabaseMajorVersion()

Function
Returns the database's major version information.

Format
 
public int getDatabaseMajorVersion() throws SQLException
 

Arguments
None.

Return value
int type:
Database's major version

Functional detail
When a HiRDB server is used, this method returns the HiRDB server's major version. For example, if the HiRDB server's version is 08-02, the method returns 8 of the int type.
When an XDM/RD E2 server is used, this method returns the value obtained by adding 20 to the XDM/RD E2 server's major version. This return value is the same as the server's major version displayed in the header of SQL traces output by the JDBC driver.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(q) getDatabaseMinorVersion()

Function
Returns the database's minor version information.

Format
 
public int getDatabaseMinorVersion() throws SQLException
 

Arguments
None.

Return value
int type:
Database's minor version

Functional detail
When a HiRDB server is used, this method returns the HiRDB server's minor version. For example, if the HiRDB server's version is 08-02, the method returns 2 of the int type.
When an XDM/RD E2 server is used, this method returns the XDM/RD E2 server's minor version. For example, if the XDM/RD E2 server's version is 11-03, the method returns 3 of the int type.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(r) getDatabaseProductName()

Function
Returns the connected database's product name.
When a HiRDB server is used, this method returns HiRDB. When an XDM/RD E2 server is used, this method returns XDM/RD E2.

Format
 
public String getDatabaseProductName() throws SQLException
 

Arguments
None.

Return value
String object

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(s) getDatabaseProductVersion()

Function
Returns the connected database's version.

Format
 
public String getDatabaseProductVersion() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
When a HiRDB server is used, this method returns the HiRDB server's version in the format vv-rr (for example: 08-00).
When an XDM/RD E2 server is used, this method returns the value obtained by adding 20 to the XDM/RD E2 server's version, in the format vv-rr. For example, if the XDM/RD E2 server's version is 11-03, the method returns 31-03.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(t) getDefaultTransactionIsolation()

Function
Returns the default transaction cut-off level.

Format
 
public int getDefaultTransactionIsolation() throws SQLException
 

Arguments
None.

Return value
int type:
Cut-off level

Functional detail
This method always returns TRANSACTION_REPEATABLE_READ.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(u) getDriverMajorVersion()

Function
Returns this JDBC driver's major version as int type. For example, if the version is 08-00, the method returns 8 of the int type.

Format
 
public int getDriverMajorVersion() throws SQLException
 

Arguments
None.

Return value
int type:
JDBC driver's major version

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(v) getDriverMinorVersion()

Function
Returns this JDBC driver's minor version as int type. For example, if the version is 08-00, the method returns 0 of the int type.

Format
 
public int getDriverMinorVersion() throws SQLException
 

Arguments
None.

Return value
int type:
JDBC driver's minor version

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(w) getDriverName()

Function
Returns the JDBC driver name HiRDB_Type4_JDBC_Driver.

Format
 
public String getDriverName() throws SQLException
 

Arguments
None.

Return value
String object

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(x) getDriverVersion()

Function
Returns the version of this JDBC driver as String. For example, if the version is 08-00, the method returns 08-00 of the String type.

Format
 
public String getDriverVersion() throws SQLException
 

Arguments
None.

Return value
String object

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(y) getExportedKeys (String catalog,String schema,String table)

Function
Returns information about a specified table's foreign keys.

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

Arguments
String catalog
Catalog name of the referencing table (this driver ignores this argument)
String schema
Schema name pattern of the referencing table (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String table
Table name pattern of the referencing table (case sensitive). If null or a character string with a length of 0 is specified, a table name is not used to narrow down the search.

Return value
ResultSet object

Functional detail
This method returns information about the specified table's foreign keys. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR PKTABLE_CAT -- Catalog name of the referenced table (NULL value is always returned)
2 String VARCHAR PKTABLE_SCHEM -- Authorization identifier of the referenced table
3 String VARCHAR PKTABLE_NAME -- Table name of the referenced table
4 String VARCHAR PKCOLUMN_NAME -- Column name of primary key
5 String CHAR FKTABLE_CAT -- Catalog name of the referencing table (NULL value is always returned)
6 String VARCHAR FKTABLE_SCHEM 1 (ascending order) Authorization identifier of the referencing table
7 String VARCHAR FKTABLE_NAME 2 (ascending order) Table name of the referencing table
8 String VARCHAR FKCOLUMN_NAME -- Column name of foreign key
9 short SMALLINT KEY_SEQ 3 (ascending order) Sequence number of foreign key
10 short SMALLINT UPDATE_RULE -- Updating rules.
This indicates how a foreign key is affected when the foreign key is referencing the primary key and the primary key is updated.
  • importedKeyNoAction
    The primary key cannot be updated.
  • importedKeyCascade
    The foreign key is updated by the same value as for the primary key.
  • importedKeySetNull
    The value of the foreign key is set to NULL.
  • importedKeySetDefault
    The value of the foreign key is set to the default value.
  • importedKeyRestrict
    The primary key cannot be updated.
11 short SMALLINT DELETE_RULE -- Deletion rules.
This indicates how a foreign key is affected when the foreign key is referencing the primary key and the primary key is deleted.
  • importedKeyNoAction
    The primary key cannot be deleted.
  • importedKeyCascade
    The row containing the foreign key is deleted.
  • importedKeySetNull
    The value of the foreign key is set to NULL.
  • importedKeySetDefault
    The value of the foreign key is set to the default value.
  • importedKeyRestrict
    The primary key cannot be deleted.
12 String VARCHAR FK_NAME -- Constraint name of referential constraints
13 String VARCHAR PK_NAME -- Index name of the primary key
14 short SMALLINT DEFERRABILITY -- Whether evaluation of constraints on the foreign key can be postponed until the transaction is committed:
  • importedKeyInitiallyDeferred
    Can be postponed.
  • importedKeyInitiallyImmediate
    Currently set for immediate evaluation, but the setting can be changed to postpone the evaluation.
  • importedKeyNotDeferrable
    Cannot be postponed.

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(z) getExtraNameCharacters()

Function
Returns the special characters that can be used in an SQL ID name that is not enclosed in double quotation marks. The characters a to z, A to Z, 0 to 9, and the underscore (_) are not included.

Format
 
public String getExtraNameCharacters() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns \, @, and #.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(aa) getIdentifierQuoteString()

Function
Returns the character string used to enclose SQL identifiers.

Format
 
public String getIdentifierQuoteString() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns a double-quotation mark (").

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ab) getImportedKeys (String catalog,String schema,String table)

Function
Returns information about a specified table's primary key.

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

Arguments
String catalog
Catalog name of the referenced table (this driver ignores this argument)
String schema
Schema name pattern of the referenced table (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String table
Table name pattern of the referenced table (case sensitive). If null or a character string with a length of 0 is specified, a table name is not used to narrow down the search.

Return value
ResultSet object

Functional detail
This method returns information about the primary key of a specified referenced table. The following table shows the format of ResultSet that is returned:
Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR PKTABLE_CAT -- Catalog name of the referenced table (NULL value is always returned)
2 String VARCHAR PKTABLE_SCHEM 1 (ascending order) Authorization identifier of the referenced table
3 String VARCHAR PKTABLE_NAME 2 (ascending order) Table name of the referenced table
4 String VARCHAR PKCOLUMN_NAME -- Column name of primary key
5 String CHAR FKTABLE_CAT -- Catalog name of the referencing table (NULL value is always returned)
6 String VARCHAR FKTABLE_SCHEM -- Authorization identifier of the referencing table
7 String VARCHAR FKTABLE_NAME -- Table name of the referencing table
8 String VARCHAR FKCOLUMN_NAME -- Column name of foreign key
9 short SMALLINT KEY_SEQ 3 (ascending order) Sequence number of foreign key
10 short SMALLINT UPDATE_RULE -- Updating rules.
This indicates how a foreign key is affected when the foreign key is referencing the primary key and the primary key is updated.
  • importedKeyNoAction
    The primary key cannot be updated.
  • importedKeyCascade
    The foreign key is updated by the same value as for the primary key.
  • importedKeySetNull
    The value of the foreign key is set to NULL.
  • importedKeySetDefault
    The value of the foreign key is set to the default value.
  • importedKeyRestrict
    The primary key cannot be updated.
11 short SMALLINT DELETE_RULE -- Deletion rules.
This indicates how a foreign key is affected when the foreign key is referencing the primary key and the primary key is deleted.
  • importedKeyNoAction
    The primary key cannot be deleted.
  • importedKeyCascade
    The row containing the foreign key is deleted.
  • importedKeySetNull
    The value of the foreign key is set to NULL.
  • importedKeySetDefault
    The value of the foreign key is set to the default value.
  • importedKeyRestrict
    The primary key cannot be deleted.
12 String VARCHAR FK_NAME -- Constraint name of referential constraints
13 String VARCHAR PK_NAME -- Index name of the primary key
14 short SMALLINT DEFERRABILITY -- Whether evaluation of constraints on the foreign key can be postponed until the transaction is committed.
  • importedKeyInitiallyDeferred
    Can be postponed.
  • importedKeyInitiallyImmediate
    Currently set for immediate evaluation, but the setting can be changed to postpone the evaluation.
  • importedKeyNotDeferrable
    Cannot be postponed.

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(ac) getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)

Function
Returns information about the indexes of a specified table.

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

Arguments
String catalog
Catalog name (this value is not used)
String schema
Schema name pattern (case sensitive)
String table
Table name pattern (case sensitive)
boolean unique
Uniqueness attribute:
true: Returns information for unique indexes only.
false: Returns all index information, whether or not the indexes are unique.
boolean approximate
Result attribute (this value is not used)

Return value
ResultSet object

Functional detail
This method returns information about the indexes of a specified table. The following table shows the format of the ResultSet that is returned.

Table 18-39 Format of ResultSet returned by getIndexInf

Column No. Type SQL type Column name Description
1 String CHAR TABLE_CAT Catalog name (NULL value is always returned)
2 String VARCHAR TABLE_SCHEM Authorization identifier
3 String VARCHAR TABLE_NAME Table name
4 boolean BIT NON_UNIQUE If the key values for which the index is defined (total value of a single or multiple columns defined as index columns) are different in every row, the method returns false; otherwise, the method returns true.
5 String CHAR INDEX_QUALIFIER Index's catalog name (NULL value is always returned)
6 String VARCHAR INDEX_NAME Index identifier
7 short SMALLINT TYPE Index type:
  • For cluster keys: DatabaseMetaData.tableIndexClustered(1)
  • For hash indexes: DatabaseMetaData.tableIndexHashed(2)
  • For other indexes: DatabaseMetaData.tableIndexOther(3)
8 short SMALLINT ORDINAL_POSITION For a single-column index, the method returns 1. For a multicolumn index, the method returns the sequence number of a column that composes the index (integers beginning with 1 that identify in sequence the column names that constitute the index).
9 String VARCHAR COLUMN_NAME Column name
10 String VARCHAR ASC_OR_DESC For an index defined in ascending order, the method returns A; for an index defined in descending order, the method returns D. For a plug-in index, the method returns the NULL value.
11 int INTEGER CARDINALITY Number of unique values in the index (NULL value is always returned)
12 int INTEGER PAGES Number of pages used for the index (NULL value is always returned)
13 String CHAR FILTER_CONDITION Filter condition (NULL value is always returned.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ad) getJDBCMajorVersion ()

Function
Returns the driver's JDBC major version.

Format
 
public int getJDBCMajorVersion() throws SQLException
 

Arguments
None.

Return value
int type:
JDBC driver's major version

Functional detail
This method returns the driver's JDBC major version, which is 2.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ae) getJDBCMinorVersion ()

Function
Returns the driver's JDBC minor version.

Format
 
public int getJDBCMinorVersion () throws SQLException
 

Arguments
None.

Return value
int type:
JDBC minor version

Functional detail
This method returns the driver's JDBC minor version, which is 1.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(af) getMaxBinaryLiteralLength()

Function
Returns the maximum number of hexadecimal characters that can be used in a binary literal.

Format
 
public int getMaxBinaryLiteralLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of characters

Functional detail
This method always returns 64000.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ag) getMaxCatalogNameLength()

Function
Returns the maximum length of a catalog name (number of characters).

Format
 
public int getMaxCatalogNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of characters permitted for a catalog name. A value of 0 means there is no limit or the limit is not known.

Functional detail
This method always returns 0.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ah) getMaxCharLiteralLength()

Function
Returns the maximum length of a character literal (number of characters).

Format
 
public int getMaxCharLiteralLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of characters permitted for a character literal. A value of 0 means there is no limit or the limit is not known.

Functional detail
This method always returns 32000.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ai) getMaxColumnNameLength()

Function
Returns the maximum length of a column name (number of characters).

Format
 
public int getMaxColumnNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of characters permitted for a column name

Functional detail
This method always returns 30.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(aj) getMaxColumnsInGroupBy()

Function
Returns the maximum number of columns in a GROUP BY clause.

Format
 
public int getMaxColumnsInGroupBy() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum number of columns

Functional detail
This method always returns 255.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ak) getMaxColumnsInIndex()

Function
Returns the maximum number of columns permitted for an index.

Format
 
public int getMaxColumnsInIndex() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum number of columns

Functional detail
This method always returns 16.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(al) getMaxColumnsInOrderBy()

Function
Returns the maximum number of columns in an ORDER BY clause.

Format
 
public int getMaxColumnsInOrderBy() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum number of columns

Functional detail
This method always returns 255.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(am) getMaxColumnsInSelect()

Function
Returns the maximum number of columns in a SELECT list.

Format
 
public int getMaxColumnsInSelect() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum number of columns

Functional detail
This method always returns 30000.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(an) getMaxColumnsInTable()

Function
Returns the maximum number of columns in a table.

Format
 
public int getMaxColumnsInTable() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum number of columns

Functional detail
This method always returns 30000.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ao) getMaxConnections()

Function
Returns the maximum number of concurrent connections.

Format
 
public int getMaxConnections() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of connections that can be active at the same time. A value of 0 means there is no limit or the limit is not known.

Functional detail
This method always returns 0.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ap) getMaxCursorNameLength()

Function
Returns the maximum length of a cursor name (number of characters).

Format
 
public int getMaxCursorNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of characters permitted for a cursor name

Functional detail
This method always returns 30.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(aq) getMaxIndexLength()

Function
Returns the maximum length of an index, including all parts of the index.

Format
 
public int getMaxIndexLength() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum length of an index

Functional detail
This method always returns 4036.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ar) getMaxProcedureNameLength()

Function
Returns the maximum length of a procedure name (number of characters).

Format
 
public int getMaxProcedureNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum length of a procedure name

Functional detail
This method always returns 30.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(as) getMaxRowSize()

Function
Returns the maximum length of a row (in bytes).

Format
 
public int getMaxRowSize() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of bytes permitted for one row. A value of 0 means there is no limit or the limit is not known.

Functional detail
This method always returns 0.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(at) getMaxSchemaNameLength()

Function
Returns the maximum length of a schema name (number of characters).

Format
 
public int getMaxSchemaNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum length of a schema name

Functional detail
When a HiRDB server is used, this method returns 8.
When an XDM/RD E2 server is used, this method returns 30.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(au) getMaxStatementLength()

Function
Returns the maximum length of an SQL statement.

Format
 
public int getMaxStatementLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum length of an SQL statement

Functional detail
When a HiRDB server is used, this method returns 2,000,000.
When an XDM/RD E2 server is used, this method returns 30,000.
Note
When you are using an XDM/RD E2 server and you specify MAX SQL LENGTH in the RDB clause of a server space start control statement for Database Connection Server, you can extend the maximum SQL statement length to up to 2,000,000 bytes. However, this method will still return the default value (30,000), as if MAX SQL LENGTH had not been specified; this is because the JDBC driver does not acquire the MAX SQL LENGTH specification information from the server. However, the JDBC driver will be able to process the set maximum SQL statement length (up to 2,000,000 bytes).

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(av) getMaxStatements()

Function
Returns the maximum number of SQL statements that can be active.

Format
 
public int getMaxStatements() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of SQL statements

Functional detail
This method always returns 4095.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(aw) getMaxTableNameLength()

Function
Returns the maximum length of a table name (number of characters).

Format
 
public int getMaxTableNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum length of a table name

Functional detail
This method always returns 30.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ax) getMaxTablesInSelect()

Function
Returns the maximum number of tables in a SELECT statement.

Format
 
public int getMaxTablesInSelect() throws SQLException
 

Arguments
None.

Return value
int type:
Maximum number of tables permitted in a SELECT statement

Functional detail
When a HiRDB server is used, this method returns 64.
When an XDM/RD E2 server is used, this method returns 256.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ay) getMaxUserNameLength()

Function
Returns the maximum length of a user name (number of characters).

Format
 
public int getMaxUserNameLength() throws SQLException
 

Arguments
None.

Return value
int type:
Permitted maximum length of a user name

Functional detail
When a HiRDB server is used, this method returns 8.
When an XDM/RD E2 server is used, this method returns 7.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(az) getNumericFunctions()

Function
Returns a list of the available mathematical functions (delimited by a comma).

Format
 
public String getNumericFunctions() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
When a HiRDB server is used, this method returns the following list:
ABS,ACOS,ASIN,ATAN,ATAN2,CEILING,COS,DEGREES,EXP,FLOOR,LOG,LOG10,MOD,PI,POWER,RADIANS,ROUND,SIGN,SIN,SQRT,TAN,TRUNCATE
When an XDM/RD E2 server is used, this method returns the following list:
ABS,CEILING,EXP,FLOOR,LOG,MOD,POWER,SQRT

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ba) getPrimaryKeys(String catalog, String schema, String table)

Function
Returns information about a specified table's primary key columns.

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

Arguments
String catalog
Catalog name (this value is not used)
String schema
Schema name pattern (case sensitive)
String table
Table name pattern (case sensitive)

Return value
ResultSet object

Functional detail
This method returns information about a specified table's primary key columns. The following table shows the format of the ResultSet that is returned.

Table 18-40 Format of ResultSet returned by getPrimaryKeys

Column No. Type SQL type Column name Description
1 String CHAR TABLE_CAT Catalog name (NULL value is always returned)
2 String VARCHAR TABLE_SCHEM Authorization identifier
3 String VARCHAR TABLE_NAME Table name
4 String VARCHAR COLUMN_NAME Column name
5 short SMALLINT KEY_SEQ Sequence number of a column that composes the index (an integer beginning with 1 that identifies in sequence the column names that constitute the index)
6 String VARCHAR PK_NAME Primary index identifier

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bb) getProcedureColumns (String catalog,String schemaPattern,String procedureNamePattern, String columnNamePattern)

Function
Returns information about stored procedure parameters.

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

Arguments
String catalog
Catalog name (this driver ignores this argument)
String schemaPattern
Schema name pattern (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String procedureNamePattern
Procedure name pattern (case sensitive). If null or a character string with a length of 0 is specified, a procedure name is not used to narrow down the search.
String columnNamePattern
Parameter name pattern (case sensitive). If null or a character string with a length of 0 is specified, a parameter name is not used to narrow down the search.

Return value
ResultSet object

Functional detail
This method returns information about the parameters of a specified stored procedure. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR PROCEDURE_CAT -- Catalog name (NULL value is always returned)
2 String VARCHAR PROCEDURE_SCHEM 1 (ascending order) Authorization identifier
3 String VARCHAR PROCEDURE_NAME 2 (ascending order) Procedure name
4 String VARCHAR COLUMN_NAME 3 (ascending order) Parameter name
5 short SMALLINT COLUMN_TYPE -- Parameter type:
  • procedureColumnUnknown
    Unknown
  • procedureColumnIn
    IN parameter
  • procedureColumnInOut
    INOUT parameter
  • procedureColumnOut
    OUT parameter
  • procedureColumnReturn
    Procedure return value
  • procedureColumnResult
    Result column of ResultSet
In HiRDB and XDM/RD E2, neither procedureColumnReturn nor procedureColumnResult will be set. In HiRDB, procedureColumnUnknown will not be set.
6 int INTEGER DATA_TYPE -- Parameter's SQL type
(value defined in java.sql.Types)
7 String VARCHAR TYPE_NAME -- Parameter's SQL type name
(type name expressed as a character string)
8 int INTEGER PRECISION -- Parameter's precision
If the parameter's SQL type name is not DECIMAL, the method returns 0.
9 int INTEGER LENGTH -- Parameter size
10 short SMALLINT SCALE -- Parameter scaling (number of digits in the fraction part)
If the parameter's SQL type name is neither DECIMAL nor TIMESTAMP, the method returns 0.
11 short SMALLINT RADIX -- Radix of parameter
  • Approximate value: 2
  • Exact value: 10
  • Non-numeric value: 0
12 short SMALLINT NULLABLE -- Whether the NULL value is permitted:
  • procedureNoNulls
    NULL value is not permitted.
  • procedureNullable
    NULL value is permitted.
  • procedureNullableUnknown
    Whether NULL value is permitted is unknown.
The method always returns procedureNullable.
13 String VARCHAR REMARKS -- Comment related to the parameter (NULL value is always returned)

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(bc) getProcedures (String catalog,String schemaPattern,String procedureNamePattern)

Function
Returns information about stored procedures.

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

Arguments
String catalog
Catalog name (this driver ignores this argument)
String schemaPattern
Schema name pattern (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String procedureNamePattern
Procedure name pattern (case sensitive). If null or a character string with a length of 0 is specified, a procedure name is not used to narrow down the search.

Return value
ResultSet object

Functional detail

This method returns information about stored procedures. The following table shows the format of the ResultSet that is returned:

Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR PROCEDURE_CAT -- Catalog name (NULL value is always returned)
2 String VARCHAR PROCEDURE_SCHEM 1 (ascending order) Authorization identifier
3 String VARCHAR PROCEDURE_NAME 2 (ascending order) Procedure name
4 String VARCHAR RESERVE1 -- Reserved
5 String VARCHAR RESERVE2 -- Reserved
6 String VARCHAR RESERVE3 -- Reserved
7 String VARCHAR REMARKS -- Description of procedure
8 short SMALLINT PROCEDURE_TYPE -- Procedure type:
  • procedureResultUnknown
    Results might be returned.
  • procedureNoResult
    Results are not returned.
  • procedureReturnsResult
    Results are returned.

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(bd) getProcedureTerm()

Function
Returns a word recommended for procedure.

Format
 
public String getProcedureTerm() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns procedure.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(be) getResultSetHoldability ()

Function
Returns the holding facility for ResultSet objects.

Format
 
public int getResultSetHoldability() throws SQLException
 

Arguments
None.

Return value
This method returns the holding facility for ResultSet objects. This indicates whether a ResultSet object is to be closed when the Connection.commit method is called:
ResultSet.HOLD_CURSORS_OVER_COMMIT: ResultSet object is not to be closed.
ResultSet.CLOSE_CURSORS_AT_COMMIT: ResultSet object is to be closed.

Functional detail
This method returns the holding facility for valid ResultSet objects.
If holdable cursor is enabled in the cursor operation mode (HIRDB_CURSOR) when a Connection instance is created, the method returns ResultSet.HOLD_CURSORS_OVER_COMMIT; if holdable cursor is disabled, the method returns ResultSet.CLOSE_CURSORS_AT_COMMIT.
For details about how to specify the cursor operation mode, see 18.2.2(2) User properties.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bf) getSchemas()

Function
Returns the available schema names.

Format
 
public ResultSet getSchemas() throws SQLException
 

Arguments
None.

Return value
ResultSet object

Functional detail
This method returns only the names of schemas that own tables. The following table shows the format of the ResultSet that is returned.

Table 18-41 Format of ResultSet returned by getSchemas

Column No. Type SQL type Column name Description
1 String VARCHAR TABLE_SCHEM Authorization identifier
2 String CHAR TABLE_CATALOG NULL value is always returned.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bg) getSchemaTerm()

Function
Returns a word recommended for schema.

Format
 
public String getSchemaTerm() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns schema.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bh) getSearchStringEscape()

Function
Returns the character string used as the escape sequence for wildcard characters.

Format
 
public String getSearchStringEscape() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns a backslash (\).

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bi) getSQLKeywords()

Function
Returns a list (delimited by a comma) of all database-specific SQL keywords that are not SQL92 keywords.

Format
 
public String getSQLKeywords() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
When a HiRDB server is used, this method returns the following list:
ABS,ACCESS,AFTER,ALIAS,AMOUNT,ANDNOT,ANSI,ARRAY,ASSIGN,
ASYNC,AUTO,BASE,BEFORE,BINARY,BIT_AND_TEST,BLOB,BOOLEAN,
BREADTH,BTREE,BUFFER,BYTE,CALL,CHANGE,CLUSTER,COLUMNS,
COMMENT,COMPLETION,CONDITION,CONFIGURATION,CONST,
CONSTRUCTOR,CONTIGUOUS,CURAID,CYCLE,DATA,DATABASE,DAYS,
DBA,DEFER,DEMOTING,DEPTH,DEVICE,DICTIONARY,DIGITS,DIRECT,DO,
DOUBLE_PRECISION,EACH,EDIT,ELSEIF,EQUALS,ESTIMATED,
EXCLUSIVE,EXIT,EXTERN,FILE,FIX,FIXED,FLAT,FORCE,FREE,FUNCTION,
GENERAL,GET_JAVA_STORED_ROUTINE_SOURCE,HANDLER,HASH,HELP,
HEX,HiRDB,HOURS,HUGE,IDENTIFIED,IF,IGNORE,INDEX,INOUT,
IS_USER_CONTAINED_IN_HDS_GROUP,LARGE,LEAVE,LENGTH,LESS,
LIMIT,LINES,LINK,LIST,LOCATOR,LOCK,LOCKS,LOGID,LOGNAME,LONG,
LOOP,MASTER,MAXUSAGES,MCHAR,MINUTES,MOD,MODE,MODIFY,
MONTHS,MOVE,MVARCHAR,NEW,NONE,NOWAIT,NULLABLE,NVARCHAR,
OBJECT,OFF,OFFSET,OID,OLD,OPERATION,OPERATORS,OPTIMIZE,
OTHERS,OUT,OVER,OVERFLOW,OWN,PAGE,PARAMETERS,PARTITIONED,
PCTFREE,PENDANT,PIC,PICTURE,PREALLOCATED,PREFERRED,
PREORDER,PRIVATE,PROGRAM,PROTECTED,PURGE,RANDOM,RD,
RDAREA,RECOMPILE,RECOVERABLE,RECOVERY,RECURSIVE,REF,
REFERENCING,REGLIKE,RELEASE,RELEASING,RENAME,RESIGNAL,
RESTART,RETURN,RETURNS,ROLE,ROOT,ROUTINE,ROW,ROWID,
SAVEPOINT,SCALE,SCAN,SCHEMAS,SCOPE,SD,SEARCH,SECONDS,
SEGMENT,SENSITIVE,SEPARATE,SEPARATOR,SEQUENCE,SFLIKE,SHARE,
SHORT,SIGNAL,SIMILAR,SLOCK,SMALLFLT,SPLIT,SQLCODE_TYPE,
SQLCOUNT,SQLDA,SQLERRM,SQLERRMC,SQLERRML,SQLEXCEPTION,
SQLNAME,SQL_STANDARD,SQLWARN,SQLWARNING,START,STATIC,
STOP,STOPPING,STRUCTURE,SUBSTR,SUPPRESS,SYNONYM,TEST,TEXT,
THERE,TIMESTAMP_FORMAT,TREAT,TRIGGER,TYPE,UAMT,UBINBUF,
UCHAR,UDATE,UHANT,UHDATE,UNDER,UNIFY_2000,UNIONALL,
UNLIMITED,UNLOCK,UNTIL,USE,UTIME,UTXTBUF,VARCHAR_FORMAT,
VARIABLE,VIRTUAL,VISIBLE,VOLATILE,VOLUME,VOLUMES,WAIT,
WHILE,WITHOUT,XLIKE,XLOCK,YEARS
When an XDM/RD E2 server is used, this method returns the following list:
ABS,ANDNOT,ARRAY,ASSIGN,AUDIT,BINARY,BLOB,BOOLEAN,CALL,
CARDINALITY,CHANGE,CLOB,CLUSTER,COMMENT,COMPRESSED,CORR,
COUNT,COVAR_POP,COVAR_SAMP,CUBE,CUME_DIST,CURRENT_ROLE,
DATA,DAYS,DBA,DENSE_RANK,DIGITS,DO,EACH,ELSEIF,EVERY,
EXCLUSIVE,FALSE,FILTER,FIX,FLAT,FORCE,FUNCTION,GROUPING,HEX,
HOURS,IDENTIFIED,IF,INDEX,INOUT,ITERATE,LABEL,LARGE,LEAVE,
LENGTH,LIMIT,LIST,LOCK,LONG,LOOP,MCHAR,MICROSECOND,
MICROSECONDS,MINUTES,MOD,MODE,MONTHS,MVARCHAR,NEW,
NONLOCAL,NOWAIT,NVARCHAR,OLD,OPTIMIZE,OUT,OVER,OVERLAY,
OWN,PARTITION,PCTFREE,PERCENT_RANK,PERCENTILE_CONT,
PERCENTILE_DISC,PRIVATE,PROGRAM,PROTECTED,PURGE,RANGE,
RANK,RDAREA,RDNODE,RECURSIVE,REFERENCING,REGR_AVGX,
REGR_AVGY,REGR_COUNT,REGR_INTERCEPT,REGR_R2,REGR_SLOPE,
REGR_SXX,REGR_SXY,REGR_SYY,RELEASE,REPEAT,RESERVED,RETURN,
RETURNS,ROLLUP,ROUTINE,ROW,ROW_NUMBER,ROWID,SECONDS,
SHARE,SIGNAL,SMALLFLT,SPECIFIC,SQLCOUNT,SQLDA,SQLERRM,
SQLERRMC,SQLERRML,SQLNAME,SQLWARN,STDDEV_POP,
STDDEV_SAMP,STOPPING,SUBSTR,TIMESTAMP_FORMAT,TRIGGER,TYPE,
UNBOUNDED,UNDER,UNTIL,USER_AUDIT,USER_GROUP,USER_LEVEL,
VAR_POP,VAR_SAMP,VARCHAR_FORMAT,WAIT,WHILE,WINDOW,WITHIN,
WITHOUT,YEARS

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bj) getSQLStateType ()

Function
Returns a value indicating whether SQLSTATE returned by SQLException.getSQLState is an X/Open SQL CLI or SQL99.

Format
 
public int getSQLStateType() throws SQLException
 

Arguments
None.

Return value
int type:
SQLSTATE type, which is sqlStateXOpen or sqlStateSQL99

Functional detail
  • For a HiRDB server
    If you specified YES in the PDSTANDARDSQLSTATE client environment variable (or you omitted the PDSTANDARDSQLSTATE client environment variable and you specified Y in the pd_standard_sqlstate system common definition), the method sets sqlStateSQL99 as the return value because the value for SQL2003 is set in SQLSTATE.
    For other than the above, the method sets 0 as the return value because an HiRDB-specific value is set in SQLSTATE.
  • For an XDM/RD E2 server
    The method sets sqlStateSQL99 as the return value.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bk) getStringFunctions()

Function
Returns a list of string functions (delimited by a comma).

Format
 
public String getStringFunctions() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
When a HiRDB server is used, this method returns the following list:
ASCII,CHAR,INSERT,LCASE,LEFT,LENGTH,LOCATE,LTRIM,REPLACE,RIGHT,RTRIM,SUBSTRING,UCASE
When an XDM/RD E2 server is used, this method returns the following list:
LCASE,LENGTH,LOCATE,LTRIM,POSITION,REPLACE,RTRIM,SUBSTRING,UCASE

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bl) getSuperTables (String catalog,String schemaPattern,String tableNamePattern)

Function
Returns a description of table hierarchies defined in a specified schema.

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

Arguments
String catalog
Catalog name
String schemaPattern
Schema name pattern
String tableNamePattern
Table name pattern

Return value
ResultSet object

Functional detail
This method always returns a ResultSet in which the number of rows resulting from the retrieval is 0 because HiRDB and XDM/RD E2 do not support table hierarchies. The method does not perform a validity check on any of the arguments. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Description
1 String CHAR TABLE_CAT Catalog name
2 String VARCHAR TABLE_SCHEM Authorization identifier
3 String VARCHAR TABLE_NAME Type name
4 String VARCHAR SUPERTABLE_NAME Super type name

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bm) getSuperTypes (String catalog,String schemaPattern,String typeNamePattern)

Function
Returns a description of user-defined-type hierarchies that are defined in a specified schema.

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

Arguments
String catalog
Catalog name
String schemaPattern
Schema name pattern
String typeNamePattern
User-defined type name pattern

Return value
ResultSet object

Functional detail
This method always returns a ResultSet in which the number of rows resulting from the retrieval is 0 because the Type4 JDBC driver does not support user-defined types. The method does not perform a validity check on any of the arguments. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Description
1 String CHAR TYPE_CAT Catalog name of the user-defined type
2 String VARCHAR TYPE_SCHEM Schema name of the user-defined type
3 String VARCHAR TYPE_NAME Type name of the user-defined type
4 String CHAR SUPERTYPE_CAT Catalog name of the direct super type
5 String VARCHAR SUPERTYPE_SCHEM Schema name of the direct super type
6 String VARCHAR SUPERTYPE_NAME Type name of the direct super type

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bn) getSystemFunctions()

Function
Returns the available system functions.

Format
 
public String getSystemFunctions() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
This method always returns USER.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bo) getTablePrivileges (String catalog,String schemaPattern,String tableNamePattern)

Function
Returns information about table access privileges.

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

Arguments
String catalog
Catalog name (this driver ignores this argument)
String schemaPattern
Schema name pattern (case sensitive). If null or a character string with a length of 0 is specified, a schema name is not used to narrow down the search.
String tableNamePattern
Table name pattern (case sensitive). If null or a character string with a length of 0 is specified, a table name is not used to narrow down the search.

Return value
ResultSet object

Functional detail
This method returns information about the access privileges for tables. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Sorting# Description
1 String CHAR TABLE_CAT -- Catalog name (NULL value is always returned)
2 String VARCHAR TABLE_SCHEM 1 (ascending order) Authorization identifier
3 String VARCHAR TABLE_NAME 2 (ascending order) Table name
4 String VARCHAR GRANTOR -- User who grants access privileges
5 String VARCHAR GRANTEE -- User who receives access privileges
6 String VARCHAR PRIVILEGE 3 (ascending order) Names of granted access privileges (multiple access privilege names are separated by a comma):
SELECT: SELECT privilege
INSERT: INSERT privilege
UPDATE: UPDATE privilege
DELETE: DELETE privilege
7 String VARCHAR IS_GRANTABLE -- Whether a user who has received access privileges can grant access privileges to other users:
YES: User can grant privileges to other users.
NO: User cannot grant privileges to other users.
null: Whether the user can grant privileges to other users is unknown.
In both HiRDB and XDM/RD E2, null will not be returned. If multiple access privileges are set in PRIVILEGE and at least one of the privileges can be granted to other users, the method sets YES.

Legend:
--: Not applicable

#
Priority level of the sort key column

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • A database access error occurred.
(bp) getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)

Function
Returns information about tables.

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

Arguments
String catalog
Not used
String schemaPattern
Schema name pattern (case sensitive)
String tableNamePattern
Table name pattern (case sensitive)
String[] types
List of table types (case sensitive). You can specify any table types that are returned by the getTableTypes() method. If null is specified, the method assumes that TABLE, VIEW, and SYSTEM TABLE are all specified.

Return value
ResultSet object

Functional detail
This method returns information about tables. The following table shows the format of the ResultSet that is returned.

Table 18-42 Format of ResultSet returned by getTables

Column No. Type SQL type Column name Description
1 String CHAR TABLE_CAT NULL value is always returned
2 String VARCHAR TABLE_SCHEM Authorization identifier
3 String VARCHAR TABLE_NAME Table name
4 String VARCHAR TABLE_TYPE Table type:
  • TABLE: Base table (if BASE TABLE is specified in the DABroker for Java-compatible mode, the method assumes that TABLE is specified)
  • VIEW: View table
  • SYSTEM TABLE: Data dictionary table
5 String VARCHAR REMARKS Comment
6 String CHAR TYPE_CAT NULL value is always returned
7 String CHAR TYPE_SCHEM NULL value is always returned
8 String CHAR TYPE_NAME NULL value is always returned
9 String CHAR SELF_REFERENCING_COL_NAME NULL value is always returned
10 String CHAR REF_GENERATION NULL value is always returned

Exceptions
The JDBC driver throws an SQLException in the following cases:
  • close() was executed on the Connection object before this method executed.
  • At lease one element in the String[] type argument is null.
  • At least one element in the String[] type argument is not one of the following character strings:
    TABLE, VIEW, SYSTEM TABLE, BASE TABLE
(bq) getTableTypes ()

Function
Returns the available table types.

Format
 
public ResultSet getTableTypes()throws SQLException
 

Arguments
None.

Return value
ResultSet object

Functional detail
This method returns the available table types. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type Column name Description
1 String VARCHAR TABLE_TYPE Table type:
  • TABLE: Base table
  • VIEW: View table
  • SYSTEM TABLE: Data dictionary table

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(br) getTimeDateFunctions()

Function
Returns a list of the available time and date functions (delimited by a comma).

Format
 
public String getTimeDateFunctions() throws SQLException
 

Arguments
None.

Return value
String object

Functional detail
When a HiRDB server is used, this method returns the following list:
ADD_INTERVAL,CENTURY,CHARACTER,CURRENT_DATE,CURRENT_TIME,CURRENT_TIMESTAMP,
DATE,DATE_TIME,DAYNAME,DAYOFWEEK,DAYOFYEAR,DAY,DAYS,INTERVAL_DATETIMES,
HALF,HOUR,LAST_DAY,MIDNIGHTSECONDS,MINUTE,MONTH,MONTHNAME,MONTHS_BETWEEN,
NEXT_DAY,QUARTER,ROUNDMONTH,SECOND,TIME,TIMESTAMP,TIMESTAMP_FORMAT,TRUNCYEAR,
VARCHAR_FORMAT,WEEK,WEEKOFMONTH,YEAR,YEARS_BETWEEN
When an XDM/RD E2 server is used, this method returns the following list:
CURDATE,CURRENT_DATE,CURTIME,CURRENT_TIME,CURRENT_TIMESTAMP,HOUR,MINUTE,MONTH,NOW,SECOND,YEAR

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bs) getTypeInfo()

Function
Returns information about the default SQL types.

Format
 
public ResultSet getTypeInfo() throws SQLException
 

Arguments
None.

Return value
ResultSet object

Functional detail
This method returns information about the default SQL types. The following table shows the format of the ResultSet that is returned.

Table 18-43 Format of ResultSet returned by getTypeInfo

Column No. Type SQL type Column name Description
1 String VARCHAR TYPE_NAME Type name
2 short SMALLINT DATA_TYPE SQL data type of java.sql.Types
3 int INTEGER PRECISION Maximum precision
4 String VARCHAR LITERAL_PREFIX Prefix used to quote literals
5 String VARCHAR LITERAL_SUFFIX Suffix used to quote literals
6 String VARCHAR CREATE_PARAMS Parameter used to create types
7 short SMALLINT NULLABLE Whether the NULL value can be used for this type:
  • typeNoNulls: NULL value cannot be used.
  • typeNullable: NULL value can be used.
  • typeNullableUnknown: Whether the NULL value can be used is unknown.
The method always returns typeNullableUnknown.
8 boolean BIT CASE_SENSITIVE Whether the value is case sensitive:
  • true: Character string data types
  • false: Other data types
9 short SMALLINT SEARCHABLE Whether WHERE can be used for this type:
  • typePredNone: Cannot be used.
  • typePredChar: Only WHERE..LIKE can be used.
  • typePredBasic: Values other than WHERE..LIKE can be used.
  • typeSearchable: All WHERE.. can be used
The method always returns typeSearchable.
10 boolean BIT UNSIGNED_ATTRIBUTE Whether the attribute is unsigned.
The method returns false for numeric data (because it is signed) and true for other data types (because they are unsigned).
11 boolean BIT FIXED_PREC_SCALE Whether this can be a currency value.
The method always returns false.
12 boolean BIT AUTO_INCREMENT Whether this can be used as an automatic increment value.
The method always returns false.
13 String VARCHAR LOCAL_TYPE_NAME The type name's localized version
The method returns the same value as the type name.
14 short SMALLINT MINIMUM_SCALE Supported minimum scale
15 short SMALLINT MAXIMUM_SCALE Supported maximum scale
16 int INTEGER SQL_DATA_TYPE NULL value is always returned
17 int INTEGER SQL_DATETIME_SUB NULL value is always returned
18 int INTEGER NUM_PREC_RADIX 2 or 10 for numeric data, 0 for all other data.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bt) getUDTs (String catalog,String schemaPattern,String typeNamePattern,int[] types)

Function
Returns information about the user-defined types.

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

Arguments
String catalog
Catalog name
String schemaPattern
Schema name pattern
String typeNamePattern
Type name pattern
int[] types
List of user-defined types

Return value
ResultSet object

Functional detail
This method always returns a ResultSet in which the number of rows resulting from the retrieval is 0 because the Type4 JDBC driver does not support user-defined types. The method does not perform a validity check on any of the arguments. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Description
1 String CHAR TYPE_CAT Catalog name of the user-defined type
2 String VARCHAR TYPE_SCHEM Schema name of the user-defined type
3 String VARCHAR TYPE_NAME Type name of the user-defined type
4 String VARCHAR CLASS_NAME Java class name
5 int INTEGER DATA_TYPE Type value defined by java.sql.Types
6 String VARCHAR REMARKS Description of the type
7 short SMALLINT BASE_TYPE Type code of DISTINCT-type source or type code of an implementation of SELF_REFERENCING_COLUMN user-defined reference type

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bu) getURL()

Function
Returns the URL used for the connection to HiRDB or XDM/RD E2. If there is no URL, the method returns NULL.

Format
 
public String getURL() throws SQLException
 

Arguments
None.

Return value
String object

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bv) getUserName()

Function
Returns the user name used to connect to HiRDB or XDM/RD E2.

Format
 
public String getUserName() throws SQLException
 

Arguments
None.

Return value
String object

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bw) getVersionColumns (String catalog,String schema,String table)

Function
Returns information about the table columns that are updated automatically when rows in the table are updated.

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

Arguments
String catalog
Catalog name
String schema
Schema name
String table
Table name

Return value
ResultSet object

Functional detail
This method always returns a ResultSet in which the number of rows resulting from the retrieval is 0 because HiRDB and XDM/RD E2 do not support a function for updating columns automatically. The method does not perform a validity check on any of the arguments. The following table shows the format of the ResultSet that is returned:
Column No. Type SQL type (Types) Column name Description
1 short SMALLINT SCOPE Not used
2 String VARCHAR COLUMN_NAME Column name
3 int INTEGER DATA_TYPE SQL type
4 String VARCHAR TYPE_NAME Data source-dependent type name
5 int INTEGER COLUMN_SIZE Data precision
6 int INTEGER BUFFER_LENGTH Data length in bytes
7 short SMALLINT DECIMAL_DIGITS Scale
8 short SMALLINT PSEUDO_COLUMN Whether this is a pseudo column

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bx) insertsAreDetected(int type)

Function
Returns a value indicating whether insertion of a visible row can be detected by calling the ResultSet.rowInserted() method.

Format
 
public boolean insertsAreDetected(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Changes are detected by the specified type of result set.
false: Changes are not detected by the specified type of result set.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(by) isCatalogAtStart()

Function
Returns a value indicating whether a catalog appears at the leading (or trailing) end of a fully qualified table name.

Format
 
public boolean isCatalogAtStart() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: The catalog name appears at the beginning of a fully qualified table name.
false: The catalog name does not appear at the beginning of a fully qualified table name.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(bz) isReadOnly()

Function
Returns a value indicating whether the database is in read-only mode.

Format
 
public boolean isReadOnly() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: The database is in read-only mode.
false: The database is not in read-only mode.

Functional detail
This method always returns false.
Note
When you are using an XDM/RD E2 server and have used the Database Connection Server start control statement or an operation command to set the database access mode to READ, the database is placed in read-only mode. However, the JDBC driver assumes that the access mode is UPDATE because it does not acquire the access mode information from the server.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ca) locatorsUpdateCopy ()

Function
Indicates whether a change was made to a LOB copy or directly to the LOB.

Format
 
public boolean locatorsUpdateCopy() throws SQLException
 

Arguments
None.

Return value
boolean type:
true : Change was made to a LOB copy.
false: Change was made directly to the LOB.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cb) nullPlusNonNullIsNull()

Function
Returns a value indicating whether a join of a NULL value and a non-NULL value is treated as being NULL.

Format
 
public boolean nullPlusNonNullIsNull() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: A join of a NULL and a non-NULL values is treated as NULL.
false: A join of a NULL and a non-NULL values is not treated as NULL.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cc) nullsAreSortedAtEnd()

Function
Returns a value indicating whether the NULL value is sorted during termination processing (regardless of the sort order).

Format
 
public boolean nullsAreSortedAtEnd() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Sorted
false: Not sorted

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cd) nullsAreSortedAtStart()

Function
Returns a value indicating whether the NULL value is sorted during startup processing (regardless of the sort order).

Format
 
public boolean nullsAreSortedAtStart() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Sorted
false: Not sorted

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ce) nullsAreSortedHigh()

Function
Returns a value indicating whether the NULL value is sorted in ascending order.

Format
 
public boolean nullsAreSortedHigh() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Sorted
false: Not sorted

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cf) nullsAreSortedLow()

Function
Returns a value indicating whether the NULL value is sorted in descending order.

Format
 
public boolean nullsAreSortedLow() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Sorted
false: Not sorted

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cg) othersDeletesAreVisible(int type)

Function
Returns a value indicating whether a deletion performed externally is visible.

Format
 
public boolean othersDeletesAreVisible(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Visible
false: Not visible

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ch) othersInsertsAreVisible(int type)

Function
Returns a value indicating whether an insertion performed externally is visible.

Format
 
public boolean othersInsertsAreVisible(int type) throws SQLException
 

Arguments
int type:
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Visible
false: Not visible

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ci) othersUpdatesAreVisible(int type)

Function
Returns a value indicating whether a deletion performed externally is visible.

Format
 
public boolean othersUpdatesAreVisible(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Visible
false: Not visible

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cj) ownDeletesAreVisible(int type)

Function
Returns a value indicating whether a deletion of a result set itself is visible.

Format
 
public boolean ownDeletesAreVisible(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Visible
false: Not visible

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ck) ownInsertsAreVisible(int type)

Function
Returns a value indicating whether an insertion of a result set itself is visible.

Format
 
public boolean ownInsertsAreVisible(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Visible
false: Not visible

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cl) ownUpdatesAreVisible(int type)

Function
Returns a value indicating whether an updating of a result set itself is visible.

Format
 
public boolean ownUpdatesAreVisible(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Visible
false: Not visible

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cm) storesLowerCaseIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all lower-case letters.

Format
 
public boolean storesLowerCaseIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Such SQL identifiers are processed as being not case sensitive and are stored in all lower-case letters.
false: Such SQL identifiers are stored as being case sensitive.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cn) storesLowerCaseQuotedIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all lower-case letters.

Format
 
public boolean storesLowerCaseQuotedIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Such SQL identifiers are processed as being not case sensitive and are stored in all lower-case letters.
false: Other than the above.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(co) storesMixedCaseIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in upper-case and lower-case letters.

Format
 
public boolean storesMixedCaseIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Such SQL identifiers are processed as being not case sensitive and are stored in upper-case and lower-case letters.
false: Other than the above.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cp) storesMixedCaseQuotedIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in upper-case and lower-case letters.

Format
 
public boolean storesMixedCaseQuotedIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Such SQL identifiers are processed as being not case sensitive and are stored in upper-case and lower-case letters.
false: Other than the above.

Functional detail
This method always returns true.
Note
  1. Such SQL identifiers are actually processed as being case sensitive, but the method returns true because the results are stored as upper-case and lower-case letters. You can use the supportsMixedCaseQuotedIdentifiers method to determine whether such SQL identifiers are processed as being case sensitive.
  2. When you use an XDM/RD E2 server and you specify YES (the default is NO) in the DELIMITED ID UPPER operand in the RD environment definition for XDM/RD E2, the method stores the SQL identifiers in upper-case letters. However, the method assumes that NO is specified because the JDBC driver does not acquire information about the DELIMITED ID UPPER operand from the server.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cq) storesUpperCaseIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all upper-case letters.

Format
 
public boolean storesUpperCaseIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Such SQL identifiers are processed as being not case sensitive and are stored in all upper-case letters.
false: Other than the above.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cr) storesUpperCaseQuotedIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being not case sensitive, and then the results are stored in all upper-case letters.

Format
 
public boolean storesUpperCaseQuotedIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Such SQL identifiers are processed as being not case sensitive and are stored in all upper-case letters.
false: Other than the above.

Functional detail
This method always returns false.
Note
When you are using an XDM/RD E2 server and you specify YES (the default is NO) in the DELIMITED ID UPPER operand in the RD environment definition for XDM/RD E2, the method stores the SQL identifiers in upper-case letters. However, the JDBC driver assumes that NO (the default value) is specified because the driver cannot acquire information about the DELIMITED ID UPPER operand.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cs) supportsAlterTableWithAddColumn()

Function
Returns a value indicating whether ALTER TABLE with added columns is supported.

Format
 
public boolean supportsAlterTableWithAddColumn() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ct) supportsAlterTableWithDropColumn()

Function
Returns a value indicating whether ALTER TABLE with dropped columns is supported.

Format
 
public boolean supportsAlterTableWithDropColumn() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cu) supportsANSI92EntryLevelSQL()

Function
Returns a value indicating whether the ANSI92 entry-level SQL grammar is supported.

Format
 
public boolean supportsANSI92EntryLevelSQL() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cv) supportsANSI92FullSQL()

Function
Returns a value indicating whether the ANSI92 full-level SQL grammar is supported.

Format
 
public boolean supportsANSI92FullSQL() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cw) supportsANSI92IntermediateSQL()

Function
Returns a value indicating whether the ANSI92 intermediate-level SQL grammar is supported.

Format
 
public boolean supportsANSI92IntermediateSQL() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cx) supportsBatchUpdates()

Function
Returns a value indicating whether batch updating is supported.

Format
 
public boolean supportsBatchUpdates() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cy) supportsCatalogsInDataManipulation()

Function
Returns a value indicating whether catalog names can be used in data manipulation statements.

Format
 
public boolean supportsCatalogsInDataManipulation() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Catalog names can be used.
false: Catalog names cannot be used.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(cz) supportsCatalogsInIndexDefinitions()

Function
Returns a value indicating whether catalog names can be used in index definition statements.

Format
 
public boolean supportsCatalogsInIndexDefinitions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Catalog names can be used.
false: Catalog names cannot be used.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(da) supportsCatalogsInPrivilegeDefinitions()

Function
Returns a value indicating whether catalog names can be used in privilege definition statements.

Format
 
public boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Catalog names can be used.
false: Catalog names cannot be used.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(db) supportsCatalogsInProcedureCalls()

Function
Returns a value indicating whether catalog names can be used in procedure call statements.

Format
 
public boolean supportsCatalogsInProcedureCalls() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Catalog names can be used.
false: Catalog names cannot be used.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dc) supportsCatalogsInTableDefinitions()

Function
Returns a value indicating whether catalog names can be used in table definition statements.

Format
 
public boolean supportsCatalogsInTableDefinitions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Catalog names can be used.
false: Catalog names cannot be used.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dd) supportsColumnAliasing()

Function
Returns a value indicating whether aliases are supported for columns.

Format
 
public boolean supportsColumnAliasing() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(de) supportsConvert()

Function
Returns a value indicating whether the CONVERT function is supported for SQL types.

Format
 
public boolean supportsConvert() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(df) supportsConvert(int fromType, int toType)

Function
Returns a value indicating whether the CONVERT function is supported for a specified combination of SQL types.

Format
 
public boolean supportsConvert(int fromType, int toType) throws SQLException
 

Arguments
int fromType
Conversion source type. This is a type code of the java.sql.Types class.
int toType
Conversion target type. This is a type code of the java.sql.Types class.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method returns a value that depends on the combination of the conversion source type and the conversion target type. The following tables show the return value depending on the combination of the conversion source and target types.

Table 18-44 Return value depending on the combination of the conversion source and target types (part 1)

Conversion source
Type of java.sql.Types
Conversion target
Type of java.sql.Types
BIT TINYINT SMALLINT INTEGER BIGINT FLOAT REAL DOUBLE NUMERIC DECIMAL CHAR VARCHAR LONGVARCHAR
BIT 1 1 1 1 1 1 1 1 1 1 1 1 1
TINYINT 1 1 1 1 1 1 1 1 1 1 1 1 1
SMALLINT 1 1 1 1 1 1 1 1 1 1 1 1 1
INTEGER 1 1 1 1 1 1 1 1 1 1 1 1 1
BIGINT 1 1 1 1 1 1 1 1 1 1 1 1 1
FLOAT 1 1 1 1 1 1 1 1 1 1 1 1 1
REAL 1 1 1 1 1 1 1 1 1 1 1 1 1
DOUBLE 1 1 1 1 1 1 1 1 1 1 1 1 1
NUMERIC 1 1 1 1 1 1 1 1 1 1 1 1 1
DECIMAL 1 1 1 1 1 1 1 1 1 1 1 1 1
CHAR 1 1 1 1 1 1 1 1 1 1 1 1 1
VARCHAR 1 1 1 1 1 1 1 1 1 1 1 1 1
LONGVARCHAR 1 1 1 1 1 1 1 1 1 1 1 1 1
DATE 0 0 0 0 0 0 0 0 0 0 1 1 1
TIME 0 0 0 0 0 0 0 0 0 0 1 1 1
TIMESTAMP 0 0 0 0 0 0 0 0 0 0 1 1 1
BINARY 0 0 0 0 0 0 0 0 0 0 0 0 0
VARBINARY 0 0 0 0 0 0 0 0 0 0 0 0 0
LONGVARBINARY 0 0 0 0 0 0 0 0 0 0 0 0 0
JAVA_OBJECT 0 0 0 0 0 0 0 0 0 0 0 0 0
STRUCT 0 0 0 0 0 0 0 0 0 0 0 0 0
ARRAY 0 0 0 0 0 0 0 0 0 0 0 0 0
BLOB 0 0 0 0 0 0 0 0 0 0 0 0 0
CLOB 0 0 0 0 0 0 0 0 0 0 0 0 0
REF 0 0 0 0 0 0 0 0 0 0 0 0 0

Legend:
0: false
1: true

Table 18-45 Return value depending on the combination of the conversion source and target types (part 2)

Conversion source
Type of java.sql.Types
Conversion target
Type of java.sql.Types
DATE TIME TIMESTAMP BINARY VARBINARY LONGVARBINARY JAVA_OBJECT STRUCT ARRAY BLOB CLOB REF
BIT 0 0 0 0 0 0 0 0 0 0 0 0
TINYINT 0 0 0 0 0 0 0 0 0 0 0 0
SMALLINT 0 0 0 0 0 0 0 0 0 0 0 0
INTEGER 0 0 0 0 0 0 0 0 0 0 0 0
BIGINT 0 0 0 0 0 0 0 0 0 0 0 0
FLOAT 0 0 0 0 0 0 0 0 0 0 0 0
REAL 0 0 0 0 0 0 0 0 0 0 0 0
DOUBLE 0 0 0 0 0 0 0 0 0 0 0 0
NUMERIC 0 0 0 0 0 0 0 0 0 0 0 0
DECIMAL 0 0 0 0 0 0 0 0 0 0 0 0
CHAR 1 1 1 0 0 0 0 0 0 0 0 0
VARCHAR 1 1 1 0 0 0 0 0 0 0 0 0
LONGVARCHAR 1 1 1 0 0 0 0 0 0 0 0 0
DATE 1 0 1 0 0 0 0 0 0 0 0 0
TIME 0 1 0 0 0 0 0 0 0 0 0 0
TIMESTAMP 1 0 1 0 0 0 0 0 0 0 0 0
BINARY 0 0 0 1 1 1 0 0 0 0 0 0
VARBINARY 0 0 0 1 1 1 0 0 0 0 0 0
LONGVARBINARY 0 0 0 1 1 1 0 0 0 0 0 0
JAVA_OBJECT 0 0 0 0 0 0 0 0 0 0 0 0
STRUCT 0 0 0 0 0 0 0 0 0 0 0 0
ARRAY 0 0 0 0 0 0 0 0 0 0 0 0
BLOB 0 0 0 0 0 0 0 0 0 0 0 0
CLOB 0 0 0 0 0 0 0 0 0 0 0 0
REF 0 0 0 0 0 0 0 0 0 0 0 0

Legend:
0: false
1: true

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dg) supportsCoreSQLGrammar()

Function
Returns a value indicating whether the ODBC Core SQL grammar is supported.

Format
 
public boolean supportsCoreSQLGrammar() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dh) supportsCorrelatedSubqueries()

Function
Returns a value indicating whether correlated subqueries are supported.

Format
 
public boolean supportsCorrelatedSubqueries() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(di) supportsDataDefinitionAndDataManipulationTransactions()

Function
Returns a value indicating whether data definition statements and data manipulation statements are both supported in transactions.

Format
 
public boolean supportsDataDefinitionAndDataManipulationTransactions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
When a HiRDB server is used, this method returns false.
When an XDM/RD E2 server is used, this method returns true.
Note
When you are using an XDM/RD E2 server, you can execute a data definition statement before a transaction that executes a data manipulation statement has been completed. In such a case, the data definition statement forcibly commits the transaction.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dj) supportsDataManipulationTransactionsOnly()

Function
Returns a value indicating whether only data manipulation statements are supported in transactions.

Format
 
public boolean supportsDataManipulationTransactionsOnly() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dk) supportsDifferentTableCorrelationNames()

Function
Returns a value indicating whether the table names must be different from the correlation names when table correlation names are supported.

Format
 
public boolean supportsDifferentTableCorrelationNames() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Must be different
false: May be the same

Functional detail
When a HiRDB server is used, this method returns false.
When an XDM/RD E2 server is used, this method returns true.
Note
When you are using an XDM/RD E2 server and you specify USE (the default is NOUSE) in the RANGE VARIABLE operand in the RD environment definition for XDM/RD E2, you can use the same correlation name as the table name. However, this method assumes that NOUSE (the default value) is specified and returns true because the JDBC driver has not acquired information about the RANGE VARIABLE operand from the server. The JDBC driver itself does not require table names to be different from the correlation names.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dl) supportsExpressionsInOrderBy()

Function
Returns a value indicating whether expressions are supported in an ORDER BY list.

Format
 
public boolean supportsExpressionsInOrderBy() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
When a HiRDB server is used, this method returns false.
When an XDM/RD E2 server is used, this method returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dm) supportsExtendedSQLGrammar()

Function
Returns a value indicating whether the ODBC Extended SQL grammar is supported.

Format
 
public boolean supportsExtendedSQLGrammar() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dn) supportsFullOuterJoins()

Function
Returns a value indicating whether full outer joins are supported.

Format
 
public boolean supportsFullOuterJoins() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(do) supportsGetGeneratedKeys ()

Function
Returns a value indicating whether automatic generation keys can be acquired after statements have executed.

Format
 
public boolean supportsGetGeneratedKeys() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Automatic generation keys can be acquired.
false: Automatic generation keys cannot be acquired.

Functional detail
This method always returns false because the Type4 JDBC driver does not support automatic generation keys.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dp) supportsGroupBy()

Function
Returns a value indicating whether the GROUP BY clause form is supported.

Format
 
public boolean supportsGroupBy() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dq) supportsGroupByBeyondSelect()

Function
Returns a value indicating whether a column for which the GROUP BY clause is not specified in SELECT can be used when all columns in SELECT must be specified.

Format
 
public boolean supportsGroupByBeyondSelect() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Can be used
false: Cannot be used

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dr) supportsGroupByUnrelated()

Function
Returns a value indicating whether a column for which the GROUP BY clause is not specified in SELECT can be used.

Format
 
public boolean supportsGroupByUnrelated() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Can be used
false: Cannot be used

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ds) supportsIntegrityEnhancementFacility()

Function
Returns a value indicating whether the SQL Integrity Enhancement Facility is supported.

Format
 
public boolean supportsIntegrityEnhancementFacility() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dt) supportsLikeEscapeClause()

Function
Returns a value indicating whether escape characters are supported in the LIKE clause.

Format
 
public boolean supportsLikeEscapeClause() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(du) supportsLimitedOuterJoins()

Function
Returns a value indicating whether limited support is provided for outer joins.

Format
 
public boolean supportsLimitedOuterJoins() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Limited support is provided.
false: Limited support is not provided.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dv) supportsMinimumSQLGrammar()

Function
Returns a value indicating whether the ODBC Minimum SQL grammar is supported.

Format
 
public boolean supportsMinimumSQLGrammar() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dw) supportsMixedCaseIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is not enclosed in quotation marks is processed as being case sensitive, and then the results are stored in upper-case and lower-case letters.

Format
 
public boolean supportsMixedCaseIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Results are stored in upper-case and lower-case letters.
false: Results are not stored using both upper-case and lower-case letters.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dx) supportsMixedCaseQuotedIdentifiers()

Function
Returns a value indicating whether an SQL identifier containing upper-case and lower-case letters that is enclosed in quotation marks is processed as being case sensitive, and then the results are stored in upper-case and lower-case letters.

Format
 
public boolean supportsMixedCaseQuotedIdentifiers() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Results are stored in upper-case and lower-case letters.
false: Results are not stored using both upper-case and lower-case letters.

Functional detail
This method always returns true.
Note
When you are using an XDM/RD E2 server and you specify YES (the default is NO) in the DELIMITED ID UPPER operand in the RD environment definition for XDM/RD E2, the method stores SQL identifiers in upper-case letters. However, the JDBC driver assumes that NO (the default value) is specified because the JDBC driver has not acquired information about the DELIMITED ID UPPER operand from the server.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dy) supportsMultipleOpenResults ()

Function
Returns a value indicating whether it is possible for multiple ResultSet objects to be returned simultaneously by a CallableStatement object.

Format
 
public boolean supportsMultipleOpenResults() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: A CallableStatement object can return multiple ResultSet objects simultaneously.
false: A CallableStatement object cannot return multiple ResultSet objects simultaneously.

Functional detail
When a HiRDB server is used, this method returns true.
When an XDM/RD E2 server is used, this method returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(dz) supportsMultipleResultSets()

Function
Returns a value indicating whether multiple ResultSet objects can be acquired from execution of a single execute method.

Format
 
public boolean supportsMultipleResultSets() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Multiple ResultSet objects can be acquired.
false: Multiple ResultSet objects cannot be acquired.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ea) supportsMultipleTransactions()

Function
Returns a value indicating whether multiple transactions can be open at the same time (for different connections).

Format
 
public boolean supportsMultipleTransactions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true Multiple transactions can be open at the same time.
false: Multiple transactions cannot be open at the same time.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(eb) supportsNamedParameters ()

Function
Returns a value indicating whether named parameters are supported for the callable statement.

Format
 
public boolean supportsNamedParameters() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ec) supportsNonNullableColumns()

Function
Returns a value indicating whether columns can be defined as non-null columns.

Format
 
public boolean supportsNonNullableColumns() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Columns can be defined as non-null columns.
false: Columns cannot be defined as non-null columns.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ed) supportsOpenCursorsAcrossCommit()

Function
Returns a value indicating whether the cursor can remain open between commit operations.

Format
 
public boolean supportsOpenCursorsAcrossCommit() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: The cursor can remain open between commit operations.
false: The cursor cannot remain open between commit operations.

Functional detail
If a holdable cursor is enabled in the cursor operation mode (HIRDB_CURSOR) when a Connection instance is created, the method returns true; if a holdable cursor is disabled, the method returns false. For details about how to specify the cursor operation mode, see 18.2.2(2) User properties.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ee) supportsOpenCursorsAcrossRollback()

Function
Returns a value indicating whether the cursor can remain open between rollback operations.

Format
 
public boolean supportsOpenCursorsAcrossRollback() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: The cursor can remain open between rollback operations.
false: The cursor cannot remain open between rollback operations.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ef) supportsOpenStatementsAcrossCommit()

Function
Returns a value indicating whether statements can remain open between commit operations.

Format
 
public boolean supportsOpenStatementsAcrossCommit() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Statements can remain open between commit operations.
false: Statements cannot remain open between commit operations.

Functional detail
If you specify TRUE in STATEMENT_COMMIT_BEHAVIOR in the URL specification items during Connection instance creation or if you omit STATEMENT_COMMIT_BEHAVIOR, the method returns true. If you specify FALSE in STATEMENT_COMMIT_BEHAVIOR, the method returns false. For details about how to specify the STATEMENT_COMMIT_BEHAVIOR URL specification item, see 18.2.2(2) User properties.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(eg) supportsOpenStatementsAcrossRollback()

Function
Returns a value indicating whether statements can remain open between rollback operations.

Format
 
public boolean supportsOpenStatementsAcrossRollback() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Statements can remain open between rollback operations.
false: Statements cannot remain open between rollback operations.

Functional detail
If you specify TRUE in STATEMENT_COMMIT_BEHAVIOR in the URL specification items during Connection instance creation or if you omit STATEMENT_COMMIT_BEHAVIOR, the method returns true. If you specify FALSE in STATEMENT_COMMIT_BEHAVIOR, the method returns false. For details about how to specify the STATEMENT_COMMIT_BEHAVIOR URL specification item, see 18.2.2(2) User properties.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(eh) supportsOrderByUnrelated()

Function
Returns a value indicating whether a column for which the ORDER BY clause is not in SELECT can be used.

Format
 
public boolean supportsOrderByUnrelated() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Can be used
false: Cannot be used

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ei) supportsOuterJoins()

Function
Returns a value indicating whether some form of outer join is supported.

Format
 
public boolean supportsOuterJoins() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ej) supportsPositionedDelete()

Function
Returns a value indicating whether positioned DELETE is supported.

Format
 
public boolean supportsPositionedDelete() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ek) supportsPositionedUpdate()

Function
Returns a value indicating whether positioned UPDATE is supported.

Format
 
public boolean supportsPositionedUpdate() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(el) supportsResultSetConcurrency(int type, int concurrency)

Function
Returns a value indicating whether the combination of a specified type of ResultSet and a specified parallel processing type is supported.

Format
 
public boolean supportsResultSetConcurrency(int type, int concurrency) throws SQLException
 

Arguments
int type
Type defined in java.sql.ResultSet for the result set type
int concurrency
Type defined by java.sql.ResultSet as the parallel processing type

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
When type is TYPE_FORWARD_ONLY or TYPE_SCROLL_INSENSITIVE and concurrency is CONCUR_READ_ONLY, the method returns true; otherwise, the method returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(em) supportsResultSetHoldability (int holdability)

Function
Returns a value indicating whether the holding facility is supported for a specified ResultSet object.

Format
 
public boolean supportsResultSetHoldability(int holdability) throws SQLException
 

Arguments
int holdability
Literal
ResultSet.HOLD_CURSORS_OVER_COMMIT: The ResultSet object is not closed when the Connection.commit method is called.
ResultSet.CLOSE_CURSORS_AT_COMMIT: The ResultSet object is closed when the Connection.commit method is called.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method returns a value indicating whether the holding facility is supported for a specified ResultSet object. The method returns the following values:
holdability argument HIRDB_CURSOR#
Enabled Disabled
HOLD_CURSORS_OVER_COMMIT Returns true Returns false
CLOSE_CURSORS_AT_COMMIT Returns false Returns true

#
Cursor operation mode (HIRDB_CURSOR) when a Connection instance is created.
For details about how to specify the cursor operation mode, see 18.2.2(2) User properties.

Exceptions
If one of the following is true, the JDBC driver throws an SQLException:
  • close() was executed on the Connection object before this method executed.
  • The holdability argument value is invalid.
(en) supportsResultSetType(int type)

Function
Returns a value indicating whether a specified type of ResultSet is supported.

Format
 
public boolean supportsResultSetType(int type) throws SQLException
 

Arguments
int type
Type of result set defined in java.sql.ResultSet

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
When type is TYPE_FORWARD_ONLY or TYPE_SCROLL_INSENSITIVE, the method returns true; otherwise, the method returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(eo) supportsSavepoints ()

Function
Returns a value indicating whether save points are supported.

Format
 
public boolean supportsSavepoints() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false because the JDBC driver does not support save points in HiRDB or XDM/RD E2.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ep) supportsStatementPooling ()

Function
Returns a value indicating whether statement pooling is supported.

Format
 
public boolean supportsStatementPooling() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false because the Type4 JDBC driver does not support statement pooling.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(eq) supportsSchemasInDataManipulation()

Function
Returns a value indicating whether schema names can be used in data manipulation statements.

Format
 
public boolean supportsSchemasInDataManipulation() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Schema names can be used.
false: Schema names cannot be used.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(er) supportsSchemasInIndexDefinitions()

Function
Returns a value indicating whether schema names can be used in index definition statements.

Format
 
public boolean supportsSchemasInIndexDefinitions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Schema names can be used.
false: Schema names cannot be used.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(es) supportsSchemasInPrivilegeDefinitions()

Function
Returns a value indicating whether schema names can be used in privilege definition statements.

Format
 
public boolean supportsSchemasInPrivilegeDefinitions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Schema names can be used.
false: Schema names cannot be used.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(et) supportsSchemasInProcedureCalls()

Function
Returns a value indicating whether schema names can be used in procedure calls.

Format
 
public boolean supportsSchemasInProcedureCalls() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Schema names can be used.
false: Schema names cannot be used.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(eu) supportsSchemasInTableDefinitions()

Function
Returns a value indicating whether schema names can be used in table definition statements.

Format
 
public boolean supportsSchemasInTableDefinitions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Schema names can be used.
false: Schema names cannot be used.

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ev) supportsSelectForUpdate()

Function
Returns a value indicating whether SELECT is supported for updating.

Format
 
public boolean supportsSelectForUpdate() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ew) supportsStoredProcedures()

Function
Returns a value indicating whether stored procedure calls are supported.

Format
 
public boolean supportsStoredProcedures() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ex) supportsSubqueriesInComparisons()

Function
Returns a value indicating whether subqueries are supported in comparison expressions.

Format
 
public boolean supportsSubqueriesInComparisons() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ey) supportsSubqueriesInExists()

Function
Returns a value indicating whether subqueries are supported in exists expressions.

Format
 
public boolean supportsSubqueriesInExists() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ez) supportsSubqueriesInIns()

Function
Returns a value indicating whether subqueries are supported in in statements.

Format
 
public boolean supportsSubqueriesInIns() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fa) supportsSubqueriesInQuantifieds()

Function
Returns a value indicating whether subqueries are supported in quantified expressions.

Format
 
public boolean supportsSubqueriesInQuantifieds() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fb) supportsTableCorrelationNames()

Function
Returns a value indicating whether table correlation names are supported.

Format
 
public boolean supportsTableCorrelationNames() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fc) supportsTransactionIsolationLevel(int level)

Function
Returns a value indicating whether a specified transaction isolation level is supported.

Format
 
public boolean supportsTransactionIsolationLevel(int level) throws SQLException
 

Arguments
int level
Transaction cut-off level defined in java.sql.Connection

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
When level is TRANSACTION_REPEATABLE_READ, TRANSACTION_READ_COMMITTED, or TRANSACTION_READ_UNCOMMITTED, the method returns true; otherwise, the method returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fd) supportsTransactions()

Function
Returns a value indicating whether transactions are supported.

Format
 
public boolean supportsTransactions() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fe) supportsUnion()

Function
Returns a value indicating whether SQL UNION is supported.

Format
 
public boolean supportsUnion() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(ff) supportsUnionAll()

Function
Returns a value indicating whether SQL UNION ALL is supported.

Format
 
public boolean supportsUnionAll() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Supported
false: Not supported

Functional detail
This method always returns true.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fg) updatesAreDetected(int type)

Function
Returns a value indicating whether updating performed on a ResultSet of a specified ResultSet type can be detected by the ResultSet.rowUpdated method.

Format
 
public boolean updatesAreDetected(int type) throws SQLException
 

Arguments
int type
One of the following ResultSet types:
  • ResultSet.TYPE_FORWARD_ONLY
  • ResultSet.TYPE_SCROLL_INSENSITIVE
  • ResultSet.TYPE_SCROLL_SENSITIVE

Return value
boolean type:
true: Can be detected.
false: Cannot be detected.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fh) usesLocalFilePerTable()

Function
Returns a value indicating whether a file is to be used for each table.

Format
 
public boolean usesLocalFilePerTable() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Used
false: Not used

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.
(fi) usesLocalFiles()

Function
Returns a value indicating whether tables are to be stored in local files.

Format
 
public boolean usesLocalFiles() throws SQLException
 

Arguments
None.

Return value
boolean type:
true: Tables are to be stored in local files.
false: Tables are not to be stored in local files.

Functional detail
This method always returns false.

Exceptions
If close() has been executed on the Connection object before this method is executed, the JDBC driver throws an SQLException.

(3) Package and class names

The names of the package and class for installing this interface are as follows:

Package name: JP.co.Hitachi.soft.HiRDB.JDBC

Class name: PrdbDatabaseMetaData