8.6.1 List of the methods in the DatabaseMetaData interface

Organization of this subsection

(1) Main functions of the DatabaseMetaData Interface
(2) Methods in the DatabaseMetaData interface that are supported by HADB
(3) Required package name and class name
(4) Special characters that can be specified in pattern character strings

(1) Main functions of the DatabaseMetaData Interface

The DatabaseMetaData interface provides the following main functions:

Return of various information about the connected database
Return of list information, such as lists of tables or columns (the information is stored in a ResultSet)

(2) Methods in the DatabaseMetaData interface that are supported by HADB

The following table lists and describes the methods in the DatabaseMetaData interface that are supported by HADB.

Table 8‒41: Methods in the DatabaseMetaData interface
No.	Method in the DatabaseMetaData interface	Function
1	`allProceduresAreCallable()`	Acquires a value indicating whether all the procedures returned by the `getProcedures` method can be called by the current HADB user.
2	`allTablesAreSelectable(`)	Acquires a value indicating whether all the tables returned by the `getTables` method can be used by the current HADB user.
3	`autoCommitFailureClosesAllResultSets()`	Returns a value indicating whether all open `ResultSet` objects are to be closed if an `SQLException` occurs while the automatic commit mode is enabled.
4	`dataDefinitionCausesTransactionCommit()`	Acquires a value indicating whether a data definition statement in a transaction is to forcibly commit the transaction.
5	`dataDefinitionIgnoredInTransactions()`	Acquires a value indicating whether data definition statements are ignored in transactions.
6	`deletesAreDetected(int type)`	Acquires a value indicating whether deletions of visible rows can be detected by calling the `rowDeleted` method of the `ResultSet` class.
7	`doesMaxRowSizeIncludeBlobs()`	Acquires a value indicating whether the `getMaxRowSize` method's return value contains the `LONGVARCHAR` or `LONGVARBINARY` SQL data type.
8	`generatedKeyAlwaysReturned()`	Acquires a value indicating whether a generated key will always be returned if the column names or indexes specified for the auto-generated key columns are valid and the statement succeeds.
9	`getAttributes(String` `catalog,` `String` `schemaPattern,` `String` `typeNamePattern,` `String` `attributeNamePattern)`	Acquires information related to a specified attribute of a specified type for user-defined types (UDTs) that can be used in specified schemas and catalogs.
10	`getBestRowIdentifier(String` `catalog,` `String` `schema,` `String` `table,` `int` `scope,` `boolean` `nullable)`	Acquires information about the optimum column set for a table in which rows are identified uniquely.
11	`getCatalogs()`	Acquires a catalog name.
12	`getCatalogSeparator()`	Acquires the separator between the catalog name and the table name.
13	`getCatalogTerm()`	Acquires a word recommended for `catalog`.
14	`getClientInfoProperties()`	Returns a list of the client information properties supported by the driver.
15	`getColumnPrivileges(String` `catalog,` `String` `schema,` `String` `table,` `String` `columnNamePattern)`	Acquires information about table column access permissions.
16	`getColumns(String` `catalog,` `String` `schemaPattern,` `String` `tableNamePattern,` `String` `columnNamePattern)`	Acquires information about table columns.
17	`getConnection()`	Acquires the `Connection` instance that created this `DatabaseMetaData` instance.
18	`getCrossReference(String` `parentCatalog,` `String` `parentSchema,` `String` `parentTable,` `String` `foreignCatalog,` `String` `foreignSchema,` `String` `foreignTable)`	Acquires cross-reference information between a specified referencing table and a specified referenced table.
19	`getDatabaseMajorVersion()`	Acquires the major version of the database (HADB server).
20	`getDatabaseMinorVersion()`	Acquires the minor version of the database (HADB server).
21	`getDatabaseProductName()`	Acquires the product name of the connected database (HADB server).
22	`getDatabaseProductVersion()`	Acquires the version of the connected database (HADB server).
23	`getDefaultTransactionIsolation()`	Acquires the default transaction isolation level for this database.
24	`getDriverMajorVersion()`	Acquires the JDBC driver's major version.
25	`getDriverMinorVersion()`	Acquires the JDBC driver's minor version.
26	`getDriverName()`	Acquires the JDBC driver's name.
27	`getDriverVersion()`	Acquires the JDBC driver's version.
28	`getExportedKeys(String` `catalog,` `String` `schema,` `String` `table)`	Acquires information about a referencing table's foreign keys.
29	`getExtraNameCharacters()`	Acquires all the special characters that can be used in an ID name that is not enclosed in double quotation marks (`"`).
30	`getFunctionColumns(String` `catalog,` `String` `schemaPattern,` `String` `functionNamePattern,` `String` `columnNamePattern)`	Returns information about the function's parameters and the types that are returned.
31	`getFunctions(String` `catalog,` `String` `schemaPattern,` `String` `functionNamePattern)`	Returns information about the function.
32	`getIdentifierQuoteString()`	Acquires the character string used to enclose SQL identifiers.
33	`getImportedKeys(String` `catalog,` `String` `schema,` `String` `table)`	Acquires information about a referenced table's primary key.
34	`getIndexInfo(String` `catalog,` `String` `schema,` `String` `table,` `boolean` `unique,` `boolean` `approximate)`	Acquires information about indexes.
35	`getJDBCMajorVersion()`	Acquires the driver's JDBC major version.
36	`getJDBCMinorVersion()`	Acquires the driver's JDBC minor version.
37	`getMaxBinaryLiteralLength()`	Acquires the maximum number of hexadecimal characters that can be used in a binary literal.
38	`getMaxCatalogNameLength()`	Acquires the maximum length of a catalog name (number of characters).
39	`getMaxCharLiteralLength()`	Acquires the maximum length of an item of character string data (number of characters).
40	`getMaxColumnNameLength()`	Acquires the maximum length of a column name (number of characters).
41	`getMaxColumnsInGroupBy()`	Acquires the maximum number of grouping columns that can be specified in the `GROUP` `BY` clause.
42	`getMaxColumnsInIndex()`	Acquires the maximum number of columns that can comprise an index.
43	`getMaxColumnsInOrderBy()`	Acquires the maximum number of columns that can be specified in an `ORDER` `BY` clause.
44	`getMaxColumnsInSelect()`	Acquires the maximum number of selection expressions that can be specified in a selection list.
45	`getMaxColumnsInTable()`	Acquires the maximum number of columns that can be defined in a table.
46	`getMaxConnections()`	Acquires the maximum number of HADB clients that can connect concurrently to the HADB server.
47	`getMaxCursorNameLength()`	Acquires the maximum length of a cursor name (number of characters).
48	`getMaxIndexLength()`	Acquires the maximum length of an index key.
49	`getMaxLogicalLobSize()`	Acquires the maximum number of bytes this database allows as the logical size for a LOB.
50	`getMaxProcedureNameLength()`	Acquires the maximum length of a procedure name (number of characters).
51	`getMaxRowSize()`	Acquires the maximum length of a row (in bytes).
52	`getMaxSchemaNameLength()`	Acquires the maximum length of a schema name (number of characters).
53	`getMaxStatementLength()`	Acquires the maximum length of a character string that can be specified as an SQL statement.
54	`getMaxStatements()`	Acquires the maximum number of SQL statements that can be executed concurrently.
55	`getMaxTableNameLength()`	Acquires the maximum length of a table name (number of characters).
56	`getMaxTablesInSelect()`	Acquires the maximum number of tables that can be specified in a `SELECT` statement.
57	`getMaxUserNameLength()`	Acquires the maximum length of an authorization identifier (number of characters).
58	`getNumericFunctions()`	Acquires a list of the available mathematical functions (delimited by the comma).
59	`getPrimaryKeys(String` `catalog,` `String` `schema,` `String` `table)`	Acquires information about a specified table's primary key columns.
60	`getProcedureColumns(String` `catalog,` `String` `schemaPattern,` `String` `procedureNamePattern,` `String` `columnNamePattern)`	Acquires information about stored procedure parameters.
61	`getProcedures(String` `catalog,` `String` `schemaPattern,` `String` `procedureNamePattern)`	Acquires information about stored procedures.
62	`getProcedureTerm()`	Acquires a word recommended for `procedure`.
63	`getPseudoColumns(String` `catalog,String` `schemaPattern,String` `tableNamePattern,String` `columnNamePattern)`	Acquires a description of the pseudo or hidden columns in a particular table within the specified catalog and schema.
64	`getResultSetHoldability()`	Acquires the holdability of the `ResultSet` object.
65	`getRowIdLifetime()`	Indicates whether the `RowId` type is supported. If the `RowId` type is supported, the method also indicates the period during which the `RowId` object is valid.
66	`getSchemas()`	Acquires schema names.
67	`getSchemas(String` `catalog,` `String` `schemaPattern)`	Acquires schema names.
68	`getSchemaTerm()`	Acquires a word recommended for `schema`.
69	`getSearchStringEscape()`	Acquires the character string used as the escape sequence for wildcard characters.
70	`getSQLKeywords()`	Acquires a list (delimited by the comma) of all database-specific SQL keywords that are not SQL:2003 keywords.
71	`getSQLStateType()`	Acquires a value indicating whether `SQLSTATE` returned by the `getSQLState` method of the `SQLException` class is an X/Open (currently Open Group) SQL CLI or SQL:2003.
72	`getStringFunctions()`	Acquires a list of string functions (delimited by the comma).
73	`getSuperTables(String` `catalog,` `String` `schemaPattern,` `String` `tableNamePattern`)	Acquires information about table hierarchies defined in a specified schema.
74	`getSuperTypes(String` `catalog,` `String` `schemaPattern,` `String` `typeNamePattern)`	Acquires information about the hierarchy of the user-defined types (UDT) that are defined in a specific schema.
75	`getSystemFunctions()`	Acquires the available system functions (delimited by the comma).
76	`getTablePrivileges(String` `catalog,` `String` `schemaPattern,` `String` `tableNamePattern)`	Acquires information about access privileges for a table.
77	`getTables(String` `catalog,` `String` `schemaPattern,` `String` `tableNamePattern,` `String[]` `types)`	Acquires information about tables.
78	`getTableTypes()`	Acquires the table types.
79	`getTimeDateFunctions()`	Acquires a list of the available time and date functions (delimited by the comma).
80	`getTypeInfo()`	Acquires information about the default SQL types.
81	`getUDTs(String` `catalog,` `String` `schemaPattern,` `String` `typeNamePattern,` `int[]` `types)`	Acquires information about the user-defined types (UDTs).
82	`getURL()`	Acquires the URL that specifies information about the HADB server at the connection destination.
83	`getUserName()`	Acquires the authorization identifier used to connect to the HADB server.
84	`getVersionColumns(String` `catalog,` `String` `schema,` `String` `table)`	Acquires information about the table columns that are updated automatically when rows in the table are modified.
85	`insertsAreDetected(int` `type)`	Acquires a value indicating whether insertion of a visible row can be detected by calling the `rowInserted` method of the `ResultSet` class.
86	`isCatalogAtStart()`	Acquires a value indicating whether a catalog appears as the leading (or trailing) part of a fully qualified table name.
87	`isReadOnly()`	Acquires a value indicating whether the database is in the read-only mode.
88	`locatorsUpdateCopy()`	Acquires a value indicating whether a change was made to a copy of a LOB or directly to the LOB.
89	`nullPlusNonNullIsNull()`	Acquires a value indicating whether a join of a null value and a non-null value is treated as being a null value.
90	`nullsAreSortedAtEnd()`	Acquires a value indicating whether null values are sorted at the end regardless of the sort order.
91	`nullsAreSortedAtStart()`	Acquires a value indicating whether null values are sorted at the start regardless of the sort order.
92	`nullsAreSortedHigh()`	Acquires a value indicating whether null values are sorted in ascending order.
93	`nullsAreSortedLow()`	Acquires a value indicating whether null values are sorted low.
94	`othersDeletesAreVisible(int` `type)`	Acquires a value indicating whether a deletion performed externally is visible.
95	`othersInsertsAreVisible(int` `type)`	Acquires a value indicating whether an insertion performed externally is visible.
96	`othersUpdatesAreVisible(int` `type)`	Acquires a value indicating whether an updating performed externally is visible.
97	`ownDeletesAreVisible(int` `type)`	Acquires a value indicating whether a deletion of a result set itself is visible.
98	`ownInsertsAreVisible(int` `type)`	Acquires a value indicating whether an insertion of a result set itself is visible.
99	`ownUpdatesAreVisible(int` `type)`	Acquires a value indicating whether an updating of a result set itself is visible.
100	`storesLowerCaseIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is not enclosed in double quotation marks is processed as being not case sensitive, and then the results are stored in all lowercase letters.
101	`storesLowerCaseQuotedIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is enclosed in double quotation marks is processed as being not case sensitive, and then the results are stored in all lowercase letters.
102	`storesMixedCaseIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is not enclosed in double quotation marks is processed as being not case sensitive, and then the results are stored in uppercase and lowercase letters.
103	`storesMixedCaseQuotedIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is enclosed in double quotation marks is processed as being not case sensitive, and then the results are stored in uppercase and lowercase letters.
104	`storesUpperCaseIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is not enclosed in double quotation marks is processed as being not case sensitive, and then the results are stored in all uppercase letters.
105	`storesUpperCaseQuotedIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is enclosed in double quotation marks is processed as being not case sensitive, and then the results are stored in all uppercase letters.
106	`supportsAlterTableWithAddColumn()`	Acquires a value indicating whether `ALTER` `TABLE` with added columns is supported.
107	`supportsAlterTableWithDropColumn()`	Acquires a value indicating whether `ALTER` `TABLE` with dropped columns is supported.
108	`supportsANSI92EntryLevelSQL()`	Acquires a value indicating whether the ANSI92 entry-level SQL grammar is supported.
109	`supportsANSI92FullSQL()`	Acquires a value indicating whether the ANSI92 full-level SQL grammar is supported.
110	`supportsANSI92IntermediateSQL()`	Acquires a value indicating whether the ANSI92 intermediate-level SQL grammar is supported.
111	`supportsBatchUpdates()`	Acquires a value indicating whether batch updating is supported.
112	`supportsCatalogsInDataManipulation()`	Acquires a value indicating whether catalog names can be used in data manipulation statements.
113	`supportsCatalogsInIndexDefinitions()`	Acquires a value indicating whether catalog names can be used in index definition statements.
114	`supportsCatalogsInPrivilegeDefinitions()`	Acquires a value indicating whether catalog names can be used in definition statements for granting privileges (`GRANT` statement) or revoking privileges (`REVOKE` statement).
115	`supportsCatalogsInProcedureCalls()`	Acquires a value indicating whether catalog names can be used in procedure call statements.
116	`supportsCatalogsInTableDefinitions()`	Acquires a value indicating whether catalog names can be used in table definition statements.
117	`supportsColumnAliasing()`	Acquires a value indicating whether aliases are supported for columns.
118	`supportsConvert()`	Acquires a value indicating whether the `CONVERT` function is supported for SQL types.
119	`supportsConvert(int` `fromType,` `int` `toType)`	Acquires a value indicating whether the `CONVERT` function is supported for specified SQL types.
120	`supportsCoreSQLGrammar()`	Acquires a value indicating whether the ODBC Core SQL grammar is supported.
121	`supportsCorrelatedSubqueries()`	Acquires a value indicating whether subqueries that contain external reference columns are supported.
122	`supportsDataDefinitionAndDataManipulationTransactions()`	Acquires a value indicating whether data definition statements and data manipulation statements are both supported in transactions.
123	`supportsDataManipulationTransactionsOnly()`	Acquires a value indicating whether only data manipulation statements are supported in transactions.
124	`supportsDifferentTableCorrelationNames()`	Acquires a value indicating whether the table names must be different from the correlation names when table correlation names are supported.
125	`supportsExpressionsInOrderBy()`	Acquires a value indicating whether value expressions are supported in an `ORDER` `BY` list.
126	`supportsExtendedSQLGrammar()`	Acquires a value indicating whether the ODBC Extended SQL grammar is supported.
127	`supportsFullOuterJoins()`	Acquires a value indicating whether nested full outer joins are supported.
128	`supportsGetGeneratedKeys()`	Acquires a value indicating whether automatic generation keys can be acquired after statements have executed.
129	`supportsGroupBy()`	Acquires a value indicating whether the `GROUP` `BY` clause form is supported.
130	`supportsGroupByBeyondSelect()`	Acquires a value indicating whether a column that is not in the `SELECT` statement can be used in the `GROUP` `BY` clause, provided that all columns in the `SELECT` statement are included in the `GROUP` `BY` clause.
131	`supportsGroupByUnrelated()`	Acquires a value indicating whether a column that is not in the `SELECT` statement can be used in the `GROUP` `BY` clause.
132	`supportsIntegrityEnhancementFacility()`	Acquires a value indicating whether the SQL Integrity Enhancement Facility is supported.
133	`supportsLikeEscapeClause()`	Acquires a value indicating whether the escape clause is supported in the `LIKE` clause.
134	`supportsLimitedOuterJoins()`	Acquires a value indicating whether limited support is provided for outer joins.
135	`supportsMinimumSQLGrammar()`	Acquires a value indicating whether the ODBC Minimum SQL grammar is supported.
136	`supportsMixedCaseIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is not enclosed in double quotation marks is processed as being case sensitive, and then the results are stored in uppercase and lowercase letters.
137	`supportsMixedCaseQuotedIdentifiers()`	Acquires a value indicating whether an SQL identifier containing uppercase and lowercase letters that is enclosed in double quotation marks is processed as being case sensitive, and then the results are stored in uppercase and lowercase letters.
138	`supportsMultipleOpenResults()`	Acquires a value indicating whether it is possible to have multiple `ResultSet` objects that have been returned by a `CallableStatement` object.
139	`supportsMultipleResultSets()`	Acquires a value indicating whether multiple `ResultSet` objects can be acquired from a single call of the `execute` method.
140	`supportsMultipleTransactions()`	Acquires a value indicating whether multiple transactions can be open at the same time (for different connections).
141	`supportsNamedParameters()`	Acquires a value indicating whether named parameters are supported for the `CALL` statement.
142	`supportsNonNullableColumns()`	Acquires a value indicating whether columns can be defined as non-null columns.
143	`supportsOpenCursorsAcrossCommit()`	Acquires a value indicating whether the cursor can remain open between commit operations.
144	`supportsOpenCursorsAcrossRollback()`	Acquires a value indicating whether the cursor can remain open between rollback operations.
145	`supportsOpenStatementsAcrossCommit()`	Acquires a value indicating whether the statement handle can remain open between commit operations.
146	`supportsOpenStatementsAcrossRollback()`	Acquires a value indicating whether the statement handle can remain open between rollback operations.
147	`supportsOrderByUnrelated()`	Acquires a value indicating whether a column that is not in the `SELECT` statement can be used in the `ORDER` `BY` clause.
148	`supportsOuterJoins()`	Acquires a value indicating whether some form of outer join is supported.
149	`supportsPositionedDelete()`	Acquires a value indicating whether positioned `DELETE` statements are supported.
150	`supportsPositionedUpdate()`	Acquires a value indicating whether positioned `UPDATE` statements are supported.
151	`supportsRefCursors()`	Acquires a value indicating whether the database supports `REF CURSOR`.
152	`supportsResultSetConcurrency(int` `type,` `int` `concurrency)`	Acquires a value indicating whether the combination of a specified result set type and a specified concurrent processing type is supported.
153	`supportsResultSetHoldability(int` `holdability)`	Acquires a value indicating whether holdability is supported for the specified `ResultSet` object.
154	`supportsResultSetType(int` `type)`	Acquires a value indicating whether a specified result set type is supported.
155	`supportsSavepoints()`	Acquires a value indicating whether save points are supported.
156	`supportsSchemasInDataManipulation()`	Acquires a value indicating whether schema names can be used in data manipulation statements.
157	`supportsSchemasInIndexDefinitions()`	Acquires a value indicating whether schema names can be used in index definition statements.
158	`supportsSchemasInPrivilegeDefinitions()`	Acquires a value indicating whether schema names can be used in definition statements for granting privileges (`GRANT` statement) or revoking privileges (`REVOKE` statement).
159	`supportsSchemasInProcedureCalls()`	Acquires a value indicating whether schema names can be used in procedure call statements.
160	`supportsSchemasInTableDefinitions()`	Acquires a value indicating whether schema names can be used in table definition statements.
161	`supportsSelectForUpdate()`	Acquires a value indicating whether `SELECT` `FOR` `UPDATE` statements are supported.
162	`supportsStatementPooling()`	Acquires a value indicating whether pooling of statement handles is supported.
163	`supportsStoredFunctionsUsingCallSyntax()`	Acquires a value indicating whether user-defined functions or vendor functions that use a stored procedure escape syntax are supported.
164	`supportsStoredProcedures()`	Acquires a value indicating whether stored procedure calls that use a stored procedure escape syntax are supported.
165	`supportsSubqueriesInComparisons()`	Acquires a value indicating whether subqueries are supported in comparison predicates.
166	`supportsSubqueriesInExists()`	Acquires a value indicating whether subqueries are supported in `EXISTS` predicates.
167	`supportsSubqueriesInIns()`	Acquires a value indicating whether subqueries are supported in `IN` predicates.
168	`supportsSubqueriesInQuantifieds()`	Acquires a value indicating whether subqueries are supported in quantified predicates.
169	`supportsTableCorrelationNames()`	Acquires a value indicating whether subqueries are supported in quantified predicates.
170	`supportsTransactionIsolationLevel(int` `level)`	Returns a value indicating whether a specified transaction isolation level is supported.
171	`supportsTransactions()`	Acquires a value indicating whether transactions are supported.
172	`supportsUnion()`	Acquires a value indicating whether `SQL` `UNION` is supported.
173	`supportsUnionAll()`	Acquires a value indicating whether `SQL` `UNION` `ALL` is supported.
174	`updatesAreDetected(int` `type)`	Acquires a value indicating whether updating performed on visible rows can be detected by calling the `rowUpdated` method of the `ResultSet` class.
175	`usesLocalFilePerTable()`	Acquires a value indicating whether a file is to be used for each table.
176	`usesLocalFiles()`	Acquires a value indicating whether tables are to be stored in local files.

Important: HADB does not support methods that are not listed in this table. If an unsupported method is executed, an SQLException might be thrown.

To Page Top

(3) Required package name and class name

The package and class names required in order to use the DatabaseMetaData interface are as follows:

Package name: com.hitachi.hadb.jdbc
Class name: AdbDatabaseMetaData

To Page Top

(4) Special characters that can be specified in pattern character strings

Some methods in 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.

Table 8‒42: Special characters that can be specified in pattern character strings
Special character that can be specified	Description
`_` (underscore)	Any single character
`%`	A character string of any length, including no characters.
`\`	An escape character. Special characters that immediately follow the escape character in a pattern character string are treated as normal characters. The character `\` is represented by the Shift-JIS code 0x5c (0x5c00 in UTF-16LE). In UTF-8, specify the character that appears as a backslash `\`.

To Page Top