Class EmbedDatabaseMetaData
- All Implemented Interfaces:
PrivilegedAction<Object>
,DatabaseMetaData
,Wrapper
Many of the methods here return lists of information in ResultSets. You can use the normal ResultSet methods such as getString and getInt to retrieve the data from these ResultSets. If a given form of metadata is not available, these methods should throw a SQLException.
Some of these methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern are returned. If a search pattern argument is set to a null ref, it means that argument's criteria should be dropped from the search.
A SQLException will be thrown if a driver does not support a meta data method. In the case of methods that return a ResultSet, either a ResultSet (which may be empty) is returned or a SQLException is thrown.
This implementation gets instructions from the Database for how to satisfy most requests for information. Each instruction is either a simple string containing the desired information, or the text of a query that may be executed on the database connection to gather the information. We get the instructions via an "InstructionReader," which requires the database Connection for initialization.
Those few pieces of metadata that are related to the driver, rather than the database, come from a separate InstructionReader. Note that in that case it probably doesn't make sense to allow an instruction to specify a query.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate GenericConstantActionFactory
private static final int
private static Properties
Cached query descriptions from metadata.properties.private static Properties
Cached query descriptions from metadata_net.properties.private final String
Fields inherited from class org.apache.derby.impl.jdbc.ConnectionChild
factory, localConn
Fields inherited from interface java.sql.DatabaseMetaData
attributeNoNulls, attributeNullable, attributeNullableUnknown, bestRowNotPseudo, bestRowPseudo, bestRowSession, bestRowTemporary, bestRowTransaction, bestRowUnknown, columnNoNulls, columnNullable, columnNullableUnknown, functionColumnIn, functionColumnInOut, functionColumnOut, functionColumnResult, functionColumnUnknown, functionNoNulls, functionNoTable, functionNullable, functionNullableUnknown, functionResultUnknown, functionReturn, functionReturnsTable, importedKeyCascade, importedKeyInitiallyDeferred, importedKeyInitiallyImmediate, importedKeyNoAction, importedKeyNotDeferrable, importedKeyRestrict, importedKeySetDefault, importedKeySetNull, procedureColumnIn, procedureColumnInOut, procedureColumnOut, procedureColumnResult, procedureColumnReturn, procedureColumnUnknown, procedureNoNulls, procedureNoResult, procedureNullable, procedureNullableUnknown, procedureResultUnknown, procedureReturnsResult, sqlStateSQL, sqlStateSQL99, sqlStateXOpen, tableIndexClustered, tableIndexHashed, tableIndexOther, tableIndexStatistic, typeNoNulls, typeNullable, typeNullableUnknown, typePredBasic, typePredChar, typePredNone, typeSearchable, versionColumnNotPseudo, versionColumnPseudo, versionColumnUnknown
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Can all the procedures returned by getProcedures be called by the current user?boolean
Can all the tables returned by getTable be SELECTed by the current user?boolean
Returns whether or not all openResultSet
s on aConnection
are closed if an error occurs when auto-commit in enabled.boolean
Does a data definition statement within a transaction force the transaction to commit?boolean
Is a data definition statement within a transaction ignored?boolean
deletesAreDetected
(int type) JDBC 2.0 Determine whether or not a visible row delete can be detected by calling ResultSet.rowDeleted().boolean
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?private ResultSet
doGetBestRowId
(String catalogPattern, String schemaPattern, String table, int scope, boolean nullable, String queryPrefix) Does the actual work for the getBestRowIdentifier metadata calls.private ResultSet
doGetCols
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern, String queryName) Does the actual work for the getColumns metadata calls.private ResultSet
doGetIndexInfo
(String catalog, String schema, String table, boolean unique, boolean approximate, String queryName) Does the actual work for the getIndexInfo metadata calls.private ResultSet
doGetProcCols
(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern, String queryName) Does the actual work for the getProcedureColumns metadata calls.private ResultSet
doGetProcs
(String catalog, String schemaPattern, String procedureNamePattern, String queryName) Does the actual work for the getProcedures and getFunctions metadata calls.private ResultSet
doGetVersionCols
(String catalog, String schema, String table, String queryName) Does the actual work for the getVersionColumns metadata calls.boolean
See DatabaseMetaData javadocgetAttributes
(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) JDBC 3.0 Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.getBestRowIdentifier
(String catalogPattern, String schemaPattern, String table, int scope, boolean nullable) Get a description of a table's optimal set of columns that uniquely identifies a row.getBestRowIdentifierForODBC
(String catalogPattern, String schemaPattern, String table, int scope, boolean nullable) Get a description of a table's optimal set of columns that uniquely identifies a row.Get the catalog names available in this database.What's the separator between catalog and table name?What's the database vendor's preferred term for "catalog"?Get metadata that the client driver will cache.JDBC 4.0getColumnPrivileges
(String catalog, String schema, String table, String columnNamePattern) Get a description of the access rights for a table's columns.getColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) Get a description of table columns available in a catalog.getColumnsForODBC
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) Get a description of table columns available in a catalog.JDBC 2.0 Return the connection that produced this metadata object.getCrossReference
(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) Get a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.)getCrossReferenceForODBC
(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) In contrast to the JDBC version of getCrossReference, this method allows null values for table names.int
JDBC 3.0 Retrieves the major version number of the underlying database.int
JDBC 3.0 Retrieves the minor version number of the underlying database.What's the name of this database product?What's the version of this database product?int
What's the database's default transaction isolation level?int
What's this JDBC driver's major version number?int
What's this JDBC driver's minor version number?What's the name of this JDBC driver?What's the version of this JDBC driver?getExportedKeys
(String catalog, String schema, String table) Get a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).getFunctionColumns
(String catalog, String schemaPattern, String functionNamePattern, String parameterNamePattern) Implements DatabaseMetaData.getFunctionColumns() for an embedded database.getFunctions
(String catalog, String schemaPattern, String functionNamePattern) Implements DatabaseMetaData.getFunctions() for an embedded database.What's the string used to quote SQL identifiers?getImportedKeys
(String catalog, String schema, String table) Get a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).getIndexInfo
(String catalog, String schema, String table, boolean unique, boolean approximate) Get a description of a table's indices and statistics.getIndexInfoForODBC
(String catalog, String schema, String table, boolean unique, boolean approximate) Get a description of a table's indices and statistics.int
JDBC 3.0 Retrieves the major JDBC version number for this driver.int
JDBC 3.0 Retrieves the minor JDBC version number for this driver.private LanguageConnectionContext
Gets the LanguageConnectionContext for this connection.int
How many hex characters can you have in an inline binary literal?int
What's the maximum length of a catalog name?int
What's the max length for a character literal?int
What's the limit on column name length?int
What's the maximum number of columns in a "GROUP BY" clause?int
What's the maximum number of columns allowed in an index?int
What's the maximum number of columns in an "ORDER BY" clause?int
What's the maximum number of columns in a "SELECT" list?int
What's the maximum number of columns in a table?int
How many active connections can we have at a time to this database?int
What's the maximum cursor name length?int
What's the maximum length of an index (in bytes)?long
Added in JDBC 4.2.int
What's the maximum length of a procedure name?int
What's the maximum length of a single row?int
What's the maximum length allowed for a schema name?int
What's the maximum length of a SQL statement?int
How many active statements can we have open at one time to this database?int
What's the maximum length of a table name?int
What's the maximum number of tables in a SELECT?int
What's the maximum length of a user name?Get a comma separated list of JDBC escaped numeric functions.protected PreparedStatement
getPreparedQuery
(String queryName) Get a prepared query from system tables or metadata.properties.private PreparedStatement
getPreparedQuery
(String queryName, boolean net) Either get the prepared query for the metadata call from the system tables, or from the metadata.properties or metadata_net.properties file.private PreparedStatement
getPreparedQueryUsingSystemTables
(String nameKey, boolean net) Get a stored prepared statement from the system tables.getPrimaryKeys
(String catalog, String schema, String table) Get a description of a table's primary key columns.getProcedureColumns
(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) Get a description of a catalog's stored procedure parameters and result columns.getProcedureColumnsForODBC
(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) Get a description of a catalog's stored procedure parameters and result columns.getProcedures
(String catalog, String schemaPattern, String procedureNamePattern) Get a description of stored procedures available in a catalog.getProceduresForODBC
(String catalog, String schemaPattern, String procedureNamePattern) Get a description of stored procedures available in a catalog.What's the database vendor's preferred term for "procedure"?getPseudoColumns
(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) See DatabaseMetaData javadoc.private Properties
getQueryDescriptions
(boolean net) Return all queries found in either metadata.properties or metadata_net.properties.private String
getQueryFromDescription
(String queryName, boolean net) Given a queryName, find closest match in queryDescriptions.int
JDBC 3.0 Retrieves the default holdability of this ResultSet object.Get the schema names available in this database.getSchemas
(String catalog, String schemaPattern) JDBC 4.0What's the database vendor's preferred term for "schema"?This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters.protected ResultSet
getSimpleQuery
(String nameKey) Execute a query in metadata.properties, or an SPS in the SYS schema.private ResultSet
getSimpleQuery
(String nameKey, boolean net) Execute a query in metadata.properties (or SPS in the SYS schema) or metadata_net.properties (or SPS in the SYSIBM schema).Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.int
JDBC 3.0 Indicates whether the SQLSTATEs returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.Get a comma separated list of JDBC escaped string functions.getSuperTables
(String catalog, String schemaPattern, String typeNamePattern) JDBC 3.0 Retrieves a description of the table hierarchies defined in a particular schema in this database.getSuperTypes
(String catalog, String schemaPattern, String typeNamePattern) JDBC 3.0 Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.Get a comma separated list of JDBC escaped system functions.getTablePrivileges
(String catalog, String schemaPattern, String tableNamePattern) Get a description of the access rights for each table available in a catalog.Get a description of tables available in a catalog.Get the table types available in this database.Get a comma separated list of JDBC escaped time date functions.Get a description of all the standard SQL types supported by this database.Get a description of all the standard SQL types supported by this database.private ResultSet
getTypeInfoMinion
(String queryName) Get a description of the standard SQL types supported by this database.JDBC 2.0 Get a description of the user-defined types defined in a particular schema.final String
getURL()
What's the url for this database?What's our user name as known to the database?getVersionColumns
(String catalog, String schema, String table) Get a description of a table's columns that are automatically updated when any value in a row is updated.getVersionColumnsForODBC
(String catalog, String schema, String table) Get a description of a table's columns that are automatically updated when any value in a row is updated.boolean
insertsAreDetected
(int type) JDBC 2.0 Determine whether or not a visible row insert can be detected by calling ResultSet.rowInserted().boolean
Does a catalog appear at the start of a qualified table name?boolean
Is the database in read-only mode?final boolean
isWrapperFor
(Class<?> iface) Returns whether or not this instance implements the specified interface.private void
Loads the query descriptions from metadata.properties and metadata_net.properties intoqueryDescriptions
andqueryDescriptions_net
.boolean
JDBC 3.0 Indicates whether updates made to a LOB are made on a copy or directly to the LOB.private boolean
check if the dictionary is at the same version as the engine.boolean
Are concatenations between NULL and non-NULL values NULL?boolean
Are NULL values sorted at the end regardless of sort order?boolean
Are NULL values sorted at the start regardless of sort order?boolean
Are NULL values sorted high?boolean
Are NULL values sorted low?boolean
othersDeletesAreVisible
(int type) JDBC 2.0 Determine whether deletes made by others are visible.boolean
othersInsertsAreVisible
(int type) JDBC 2.0 Determine whether inserts made by others are visible.boolean
othersUpdatesAreVisible
(int type) JDBC 2.0 Determine whether updates made by others are visible.boolean
ownDeletesAreVisible
(int type) JDBC 2.0 Determine whether a result set's deletes are visible.boolean
ownInsertsAreVisible
(int type) JDBC 2.0 Determine whether a result set's inserts are visible.boolean
ownUpdatesAreVisible
(int type) JDBC 2.0 Determine whether a result set's updates are visible.private void
Read the query descriptions from metadata.properties and metadata_net.properties.private PreparedStatement
prepareSPS
(String spsName, String spsText, boolean net) final Object
run()
Performs a privileged action.boolean
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?boolean
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?boolean
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?boolean
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?boolean
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?boolean
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?boolean
Is "ALTER TABLE" with add column supported?boolean
Is "ALTER TABLE" with drop column supported?boolean
Is the ANSI92 entry level SQL grammar supported?boolean
Is the ANSI92 full SQL grammar supported?boolean
Is the ANSI92 intermediate SQL grammar supported?boolean
JDBC 2.0 Return true if the driver supports batch updates, else return false.boolean
Can a catalog name be used in a data manipulation statement?boolean
Can a catalog name be used in an index definition statement?boolean
Can a catalog name be used in a privilege definition statement?boolean
Can a catalog name be used in a procedure call statement?boolean
Can a catalog name be used in a table definition statement?boolean
Is column aliasing supported?boolean
Is the CONVERT function between SQL types supported?boolean
supportsConvert
(int fromType, int toType) Is CONVERT between the given SQL types supported?boolean
Is the ODBC Core SQL grammar supported?boolean
Are correlated subqueries supported?boolean
Are both data definition and data manipulation statements within a transaction supported?boolean
Are only data manipulation statements within a transaction supported?boolean
If table correlation names are supported, are they restricted to be different from the names of the tables?boolean
Are expressions in "ORDER BY" lists supported?boolean
Is the ODBC Extended SQL grammar supported?boolean
Are full nested outer joins supported?boolean
JDBC 3.0 Retrieves whether auto-generated keys can be retrieved after a statement has been executed.boolean
Is some form of "GROUP BY" clause supported?boolean
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?boolean
Can a "GROUP BY" clause use columns not in the SELECT?boolean
Is the SQL Integrity Enhancement Facility supported?boolean
Is the escape character in "LIKE" clauses supported?boolean
Is there limited support for outer joins?boolean
Is the ODBC Minimum SQL grammar supported?boolean
Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case?boolean
Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case?boolean
JDBC 3.0 Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.boolean
Are multiple ResultSets from a single execute supported?boolean
Can we have multiple transactions open at once (on different connections)?boolean
JDBC 3.0 Retrieves whether this database supports named parameters to callable statements.boolean
Can columns be defined as non-nullable?boolean
Can cursors remain open across commits?boolean
Can cursors remain open across rollbacks?boolean
Can statements remain open across commits?boolean
Can statements remain open across rollbacks?boolean
Can an "ORDER BY" clause use columns not in the SELECT?boolean
Is some form of outer join supported?boolean
Is positioned DELETE supported?boolean
Is positioned UPDATE supported?boolean
Added in JDBC 4.2.boolean
supportsResultSetConcurrency
(int type, int concurrency) JDBC 2.0 Does the database support the concurrency type in combination with the given result set type?boolean
supportsResultSetHoldability
(int holdability) JDBC 3.0 Retrieves whether this database supports the given result set holdability.boolean
supportsResultSetType
(int type) JDBC 2.0 Does the database support the given result set type?boolean
JDBC 3.0 Retrieves whether this database supports savepoints.boolean
Can a schema name be used in a data manipulation statement?boolean
Can a schema name be used in an index definition statement?boolean
Can a schema name be used in a privilege definition statement?boolean
Can a schema name be used in a procedure call statement?boolean
Can a schema name be used in a table definition statement?boolean
Is SELECT for UPDATE supported?boolean
JDBC 3.0 Retrieves whether this database supports statement pooling.boolean
boolean
Are stored procedure calls using the stored procedure escape syntax supported?boolean
Are subqueries in comparison expressions supported?boolean
Are subqueries in 'exists' expressions supported?boolean
Are subqueries in 'in' statements supported?boolean
Are subqueries in quantified expressions supported?boolean
Are table correlation names supported?boolean
supportsTransactionIsolationLevel
(int level) Does the database support the given transaction isolation level?boolean
Are transactions supported?boolean
Is SQL UNION supported?boolean
Is SQL UNION ALL supported?protected static final String
final <T> T
Returnsthis
if this class implements the interface.boolean
updatesAreDetected
(int type) JDBC 2.0 Determine whether or not a visible row update can be detected by calling ResultSet.rowUpdated().boolean
Does the database use a file for each table?boolean
Does the database store tables in a local file?Methods inherited from class org.apache.derby.impl.jdbc.ConnectionChild
commitIfAutoCommit, commitIfNeeded, getCal, getConnectionSynchronization, getEmbedConnection, getLanguageConnectionContext, getLCC, handleException, needCommit, newSQLException, restoreContextStack, restoreIntrFlagIfSeen, setupContextStack
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.sql.DatabaseMetaData
supportsSharding
-
Field Details
-
ILLEGAL_UDT_TYPE
private static final int ILLEGAL_UDT_TYPE- See Also:
-
url
-
constantActionFactory
-
queryDescriptions
Cached query descriptions from metadata.properties. -
queryDescriptions_net
Cached query descriptions from metadata_net.properties.
-
-
Constructor Details
-
EmbedDatabaseMetaData
- Throws:
SQLException
- on error
-
-
Method Details
-
getQueryDescriptions
Return all queries found in either metadata.properties or metadata_net.properties.- Parameters:
net
- iftrue
, read metadata_net.properties; otherwise, read metadata.properties.- Returns:
- a
Properties
value with the queries
-
PBloadQueryDescriptions
private void PBloadQueryDescriptions()Read the query descriptions from metadata.properties and metadata_net.properties. This method must be invoked from within a privileged block. -
allProceduresAreCallable
public boolean allProceduresAreCallable()Can all the procedures returned by getProcedures be called by the current user?- Specified by:
allProceduresAreCallable
in interfaceDatabaseMetaData
- Returns:
- true if so
-
allTablesAreSelectable
public boolean allTablesAreSelectable()Can all the tables returned by getTable be SELECTed by the current user?- Specified by:
allTablesAreSelectable
in interfaceDatabaseMetaData
- Returns:
- true if so
-
getURL
What's the url for this database?- Specified by:
getURL
in interfaceDatabaseMetaData
- Returns:
- the url or null if it can't be generated
-
getUserName
What's our user name as known to the database?- Specified by:
getUserName
in interfaceDatabaseMetaData
- Returns:
- our database user name
-
isReadOnly
public boolean isReadOnly()Is the database in read-only mode?- Specified by:
isReadOnly
in interfaceDatabaseMetaData
- Returns:
- true if so
-
nullsAreSortedHigh
public boolean nullsAreSortedHigh()Are NULL values sorted high?- Specified by:
nullsAreSortedHigh
in interfaceDatabaseMetaData
- Returns:
- true if so
-
nullsAreSortedLow
public boolean nullsAreSortedLow()Are NULL values sorted low?- Specified by:
nullsAreSortedLow
in interfaceDatabaseMetaData
- Returns:
- true if so
-
nullsAreSortedAtStart
public boolean nullsAreSortedAtStart()Are NULL values sorted at the start regardless of sort order?- Specified by:
nullsAreSortedAtStart
in interfaceDatabaseMetaData
- Returns:
- true if so
-
nullsAreSortedAtEnd
public boolean nullsAreSortedAtEnd()Are NULL values sorted at the end regardless of sort order?- Specified by:
nullsAreSortedAtEnd
in interfaceDatabaseMetaData
- Returns:
- true if so
-
getDatabaseProductName
What's the name of this database product?- Specified by:
getDatabaseProductName
in interfaceDatabaseMetaData
- Returns:
- database product name
-
getDatabaseProductVersion
What's the version of this database product?- Specified by:
getDatabaseProductVersion
in interfaceDatabaseMetaData
- Returns:
- database version
-
getDriverName
What's the name of this JDBC driver?- Specified by:
getDriverName
in interfaceDatabaseMetaData
- Returns:
- JDBC driver name
-
getDriverVersion
What's the version of this JDBC driver?- Specified by:
getDriverVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver version
-
getDriverMajorVersion
public int getDriverMajorVersion()What's this JDBC driver's major version number?- Specified by:
getDriverMajorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver major version
-
getDriverMinorVersion
public int getDriverMinorVersion()What's this JDBC driver's minor version number?- Specified by:
getDriverMinorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC driver minor version number
-
usesLocalFiles
public boolean usesLocalFiles()Does the database store tables in a local file?- Specified by:
usesLocalFiles
in interfaceDatabaseMetaData
- Returns:
- true if so
-
usesLocalFilePerTable
public boolean usesLocalFilePerTable()Does the database use a file for each table?- Specified by:
usesLocalFilePerTable
in interfaceDatabaseMetaData
- Returns:
- true if the database uses a local file for each table
-
supportsMixedCaseIdentifiers
public boolean supportsMixedCaseIdentifiers()Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC-Compliant driver will always return false.- Specified by:
supportsMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
storesUpperCaseIdentifiers
public boolean storesUpperCaseIdentifiers()Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?- Specified by:
storesUpperCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
storesLowerCaseIdentifiers
public boolean storesLowerCaseIdentifiers()Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?- Specified by:
storesLowerCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
storesMixedCaseIdentifiers
public boolean storesMixedCaseIdentifiers()Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?- Specified by:
storesMixedCaseIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsMixedCaseQuotedIdentifiers
public boolean supportsMixedCaseQuotedIdentifiers()Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC-Compliant driver will always return true.- Specified by:
supportsMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
storesUpperCaseQuotedIdentifiers
public boolean storesUpperCaseQuotedIdentifiers()Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?- Specified by:
storesUpperCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
storesLowerCaseQuotedIdentifiers
public boolean storesLowerCaseQuotedIdentifiers()Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?- Specified by:
storesLowerCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
storesMixedCaseQuotedIdentifiers
public boolean storesMixedCaseQuotedIdentifiers()Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?- Specified by:
storesMixedCaseQuotedIdentifiers
in interfaceDatabaseMetaData
- Returns:
- true if so
-
getIdentifierQuoteString
What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting isn't supported. A JDBC-Compliant driver always uses a double quote character.- Specified by:
getIdentifierQuoteString
in interfaceDatabaseMetaData
- Returns:
- the quoting string
-
getSQLKeywords
Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords. includes reserved and non-reserved keywords.- Specified by:
getSQLKeywords
in interfaceDatabaseMetaData
- Returns:
- the list
-
getNumericFunctions
Get a comma separated list of JDBC escaped numeric functions. Must be a complete or sub set of functions in appendix C.1 of JDBC 3.0 specification (pp. 183).- Specified by:
getNumericFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
-
getStringFunctions
Get a comma separated list of JDBC escaped string functions. Must be a complete or sub set of functions in appendix C.2 of JDBC 3.0 specification (pp. 184).- Specified by:
getStringFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
-
getSystemFunctions
Get a comma separated list of JDBC escaped system functions. Must be a complete or sub set of functions in appendix C.4 of JDBC 3.0 specification (pp. 185).- Specified by:
getSystemFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
-
getTimeDateFunctions
Get a comma separated list of JDBC escaped time date functions. Must be a complete or sub set of functions in appendix C.3 of JDBC 3.0 specification.- Specified by:
getTimeDateFunctions
in interfaceDatabaseMetaData
- Returns:
- the list
-
getSearchStringEscape
This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters. we have no default escape value, so = is the end of the next lineThe '_' character represents any single character.
The '%' character represents any sequence of zero or more characters.
- Specified by:
getSearchStringEscape
in interfaceDatabaseMetaData
- Returns:
- the string used to escape wildcard characters
-
getExtraNameCharacters
Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).- Specified by:
getExtraNameCharacters
in interfaceDatabaseMetaData
- Returns:
- the string containing the extra characters
-
supportsAlterTableWithAddColumn
public boolean supportsAlterTableWithAddColumn()Is "ALTER TABLE" with add column supported?- Specified by:
supportsAlterTableWithAddColumn
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsAlterTableWithDropColumn
public boolean supportsAlterTableWithDropColumn()Is "ALTER TABLE" with drop column supported?- Specified by:
supportsAlterTableWithDropColumn
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsColumnAliasing
public boolean supportsColumnAliasing()Is column aliasing supported?If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. A JDBC-Compliant driver always returns true.
- Specified by:
supportsColumnAliasing
in interfaceDatabaseMetaData
- Returns:
- true if so
-
nullPlusNonNullIsNull
public boolean nullPlusNonNullIsNull()Are concatenations between NULL and non-NULL values NULL? A JDBC-Compliant driver always returns true.- Specified by:
nullPlusNonNullIsNull
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsConvert
public boolean supportsConvert()Is the CONVERT function between SQL types supported?- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsConvert
public boolean supportsConvert(int fromType, int toType) Is CONVERT between the given SQL types supported?- Specified by:
supportsConvert
in interfaceDatabaseMetaData
- Parameters:
fromType
- the type to convert fromtoType
- the type to convert to- Returns:
- true if so
- See Also:
-
supportsTableCorrelationNames
public boolean supportsTableCorrelationNames()Are table correlation names supported? A JDBC-Compliant driver always returns true.- Specified by:
supportsTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsDifferentTableCorrelationNames
public boolean supportsDifferentTableCorrelationNames()If table correlation names are supported, are they restricted to be different from the names of the tables?- Specified by:
supportsDifferentTableCorrelationNames
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsExpressionsInOrderBy
public boolean supportsExpressionsInOrderBy()Are expressions in "ORDER BY" lists supported?- Specified by:
supportsExpressionsInOrderBy
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsGroupBy
public boolean supportsGroupBy()Is some form of "GROUP BY" clause supported?- Specified by:
supportsGroupBy
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsGroupByBeyondSelect
public boolean supportsGroupByBeyondSelect()Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?- Specified by:
supportsGroupByBeyondSelect
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsLikeEscapeClause
public boolean supportsLikeEscapeClause()Is the escape character in "LIKE" clauses supported? A JDBC-Compliant driver always returns true.- Specified by:
supportsLikeEscapeClause
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsMultipleResultSets
public boolean supportsMultipleResultSets()Are multiple ResultSets from a single execute supported?- Specified by:
supportsMultipleResultSets
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsMultipleTransactions
public boolean supportsMultipleTransactions()Can we have multiple transactions open at once (on different connections)?- Specified by:
supportsMultipleTransactions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsNonNullableColumns
public boolean supportsNonNullableColumns()Can columns be defined as non-nullable? A JDBC-Compliant driver always returns true.- Specified by:
supportsNonNullableColumns
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsMinimumSQLGrammar
public boolean supportsMinimumSQLGrammar()Is the ODBC Minimum SQL grammar supported? All JDBC-Compliant drivers must return true.- Specified by:
supportsMinimumSQLGrammar
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsCoreSQLGrammar
public boolean supportsCoreSQLGrammar()Is the ODBC Core SQL grammar supported?- Specified by:
supportsCoreSQLGrammar
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsExtendedSQLGrammar
public boolean supportsExtendedSQLGrammar()Is the ODBC Extended SQL grammar supported?- Specified by:
supportsExtendedSQLGrammar
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsANSI92EntryLevelSQL
public boolean supportsANSI92EntryLevelSQL()Is the ANSI92 entry level SQL grammar supported? All JDBC-Compliant drivers must return true.- Specified by:
supportsANSI92EntryLevelSQL
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsANSI92IntermediateSQL
public boolean supportsANSI92IntermediateSQL()Is the ANSI92 intermediate SQL grammar supported?- Specified by:
supportsANSI92IntermediateSQL
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsANSI92FullSQL
public boolean supportsANSI92FullSQL()Is the ANSI92 full SQL grammar supported?- Specified by:
supportsANSI92FullSQL
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsIntegrityEnhancementFacility
public boolean supportsIntegrityEnhancementFacility()Is the SQL Integrity Enhancement Facility supported?- Specified by:
supportsIntegrityEnhancementFacility
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsOuterJoins
public boolean supportsOuterJoins()Is some form of outer join supported?- Specified by:
supportsOuterJoins
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsFullOuterJoins
public boolean supportsFullOuterJoins()Are full nested outer joins supported?- Specified by:
supportsFullOuterJoins
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsLimitedOuterJoins
public boolean supportsLimitedOuterJoins()Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)- Specified by:
supportsLimitedOuterJoins
in interfaceDatabaseMetaData
- Returns:
- true if so
-
getSchemaTerm
What's the database vendor's preferred term for "schema"?- Specified by:
getSchemaTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
-
getProcedureTerm
What's the database vendor's preferred term for "procedure"?- Specified by:
getProcedureTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
-
getCatalogTerm
What's the database vendor's preferred term for "catalog"?- Specified by:
getCatalogTerm
in interfaceDatabaseMetaData
- Returns:
- the vendor term
-
isCatalogAtStart
public boolean isCatalogAtStart()Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end)- Specified by:
isCatalogAtStart
in interfaceDatabaseMetaData
- Returns:
- true if it appears at the start
-
getCatalogSeparator
What's the separator between catalog and table name?- Specified by:
getCatalogSeparator
in interfaceDatabaseMetaData
- Returns:
- the separator string
-
supportsSchemasInDataManipulation
public boolean supportsSchemasInDataManipulation()Can a schema name be used in a data manipulation statement?- Specified by:
supportsSchemasInDataManipulation
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSchemasInProcedureCalls
public boolean supportsSchemasInProcedureCalls()Can a schema name be used in a procedure call statement?- Specified by:
supportsSchemasInProcedureCalls
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSchemasInTableDefinitions
public boolean supportsSchemasInTableDefinitions()Can a schema name be used in a table definition statement?- Specified by:
supportsSchemasInTableDefinitions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSchemasInIndexDefinitions
public boolean supportsSchemasInIndexDefinitions()Can a schema name be used in an index definition statement?- Specified by:
supportsSchemasInIndexDefinitions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSchemasInPrivilegeDefinitions
public boolean supportsSchemasInPrivilegeDefinitions()Can a schema name be used in a privilege definition statement?- Specified by:
supportsSchemasInPrivilegeDefinitions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsCatalogsInDataManipulation
public boolean supportsCatalogsInDataManipulation()Can a catalog name be used in a data manipulation statement?- Specified by:
supportsCatalogsInDataManipulation
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsCatalogsInProcedureCalls
public boolean supportsCatalogsInProcedureCalls()Can a catalog name be used in a procedure call statement?- Specified by:
supportsCatalogsInProcedureCalls
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsCatalogsInTableDefinitions
public boolean supportsCatalogsInTableDefinitions()Can a catalog name be used in a table definition statement?- Specified by:
supportsCatalogsInTableDefinitions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsCatalogsInIndexDefinitions
public boolean supportsCatalogsInIndexDefinitions()Can a catalog name be used in an index definition statement?- Specified by:
supportsCatalogsInIndexDefinitions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsCatalogsInPrivilegeDefinitions
public boolean supportsCatalogsInPrivilegeDefinitions()Can a catalog name be used in a privilege definition statement?- Specified by:
supportsCatalogsInPrivilegeDefinitions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsPositionedDelete
public boolean supportsPositionedDelete()Is positioned DELETE supported?- Specified by:
supportsPositionedDelete
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsPositionedUpdate
public boolean supportsPositionedUpdate()Is positioned UPDATE supported?- Specified by:
supportsPositionedUpdate
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsRefCursors
public boolean supportsRefCursors()Added in JDBC 4.2. Derby does not support the Types.REF_CURSOR type.- Specified by:
supportsRefCursors
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSelectForUpdate
public boolean supportsSelectForUpdate()Is SELECT for UPDATE supported?- Specified by:
supportsSelectForUpdate
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsStoredProcedures
public boolean supportsStoredProcedures()Are stored procedure calls using the stored procedure escape syntax supported?- Specified by:
supportsStoredProcedures
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSubqueriesInComparisons
public boolean supportsSubqueriesInComparisons()Are subqueries in comparison expressions supported? A JDBC-Compliant driver always returns true.- Specified by:
supportsSubqueriesInComparisons
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSubqueriesInExists
public boolean supportsSubqueriesInExists()Are subqueries in 'exists' expressions supported? A JDBC-Compliant driver always returns true.- Specified by:
supportsSubqueriesInExists
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSubqueriesInIns
public boolean supportsSubqueriesInIns()Are subqueries in 'in' statements supported? A JDBC-Compliant driver always returns true.- Specified by:
supportsSubqueriesInIns
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsSubqueriesInQuantifieds
public boolean supportsSubqueriesInQuantifieds()Are subqueries in quantified expressions supported? A JDBC-Compliant driver always returns true.- Specified by:
supportsSubqueriesInQuantifieds
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsUnion
public boolean supportsUnion()Is SQL UNION supported?- Specified by:
supportsUnion
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsUnionAll
public boolean supportsUnionAll()Is SQL UNION ALL supported?- Specified by:
supportsUnionAll
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsOpenCursorsAcrossCommit
public boolean supportsOpenCursorsAcrossCommit()Can cursors remain open across commits?- Specified by:
supportsOpenCursorsAcrossCommit
in interfaceDatabaseMetaData
- Returns:
- true if cursors always remain open; false if they might not remain open
-
supportsOpenCursorsAcrossRollback
public boolean supportsOpenCursorsAcrossRollback()Can cursors remain open across rollbacks?- Specified by:
supportsOpenCursorsAcrossRollback
in interfaceDatabaseMetaData
- Returns:
- true if cursors always remain open; false if they might not remain open
-
supportsOpenStatementsAcrossCommit
public boolean supportsOpenStatementsAcrossCommit()Can statements remain open across commits?- Specified by:
supportsOpenStatementsAcrossCommit
in interfaceDatabaseMetaData
- Returns:
- true if statements always remain open; false if they might not remain open
-
supportsOpenStatementsAcrossRollback
public boolean supportsOpenStatementsAcrossRollback()Can statements remain open across rollbacks?- Specified by:
supportsOpenStatementsAcrossRollback
in interfaceDatabaseMetaData
- Returns:
- true if statements always remain open; false if they might not remain open
-
getMaxBinaryLiteralLength
public int getMaxBinaryLiteralLength()How many hex characters can you have in an inline binary literal?- Specified by:
getMaxBinaryLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max literal length
-
getMaxCharLiteralLength
public int getMaxCharLiteralLength()What's the max length for a character literal?- Specified by:
getMaxCharLiteralLength
in interfaceDatabaseMetaData
- Returns:
- max literal length
-
getMaxColumnNameLength
public int getMaxColumnNameLength()What's the limit on column name length?- Specified by:
getMaxColumnNameLength
in interfaceDatabaseMetaData
- Returns:
- max literal length
-
getMaxColumnsInGroupBy
public int getMaxColumnsInGroupBy()What's the maximum number of columns in a "GROUP BY" clause?- Specified by:
getMaxColumnsInGroupBy
in interfaceDatabaseMetaData
- Returns:
- max number of columns
-
getMaxColumnsInIndex
public int getMaxColumnsInIndex()What's the maximum number of columns allowed in an index?- Specified by:
getMaxColumnsInIndex
in interfaceDatabaseMetaData
- Returns:
- max columns
-
getMaxColumnsInOrderBy
public int getMaxColumnsInOrderBy()What's the maximum number of columns in an "ORDER BY" clause?- Specified by:
getMaxColumnsInOrderBy
in interfaceDatabaseMetaData
- Returns:
- max columns
-
getMaxColumnsInSelect
public int getMaxColumnsInSelect()What's the maximum number of columns in a "SELECT" list? we don't have a limit...- Specified by:
getMaxColumnsInSelect
in interfaceDatabaseMetaData
- Returns:
- max columns
-
getMaxColumnsInTable
public int getMaxColumnsInTable()What's the maximum number of columns in a table?- Specified by:
getMaxColumnsInTable
in interfaceDatabaseMetaData
- Returns:
- max columns
-
getMaxConnections
public int getMaxConnections()How many active connections can we have at a time to this database?- Specified by:
getMaxConnections
in interfaceDatabaseMetaData
- Returns:
- max connections
-
getMaxCursorNameLength
public int getMaxCursorNameLength()What's the maximum cursor name length?- Specified by:
getMaxCursorNameLength
in interfaceDatabaseMetaData
- Returns:
- max cursor name length in bytes
-
getMaxIndexLength
public int getMaxIndexLength()What's the maximum length of an index (in bytes)?- Specified by:
getMaxIndexLength
in interfaceDatabaseMetaData
- Returns:
- max index length in bytes
-
getMaxLogicalLobSize
public long getMaxLogicalLobSize()Added in JDBC 4.2. What's the maximum length of Derby LOB? This is the maximum number of bytes in a LOB. We return the default value of 0, which means "unknown". The maximum size of a CLOB is a complicated because it depends on how many bytes are needed to encode its string value on disk.- Specified by:
getMaxLogicalLobSize
in interfaceDatabaseMetaData
- Returns:
- max index length in bytes
-
getMaxSchemaNameLength
public int getMaxSchemaNameLength()What's the maximum length allowed for a schema name?- Specified by:
getMaxSchemaNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
-
getMaxProcedureNameLength
public int getMaxProcedureNameLength()What's the maximum length of a procedure name?- Specified by:
getMaxProcedureNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
-
getMaxCatalogNameLength
public int getMaxCatalogNameLength()What's the maximum length of a catalog name?- Specified by:
getMaxCatalogNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
-
getMaxRowSize
public int getMaxRowSize()What's the maximum length of a single row?- Specified by:
getMaxRowSize
in interfaceDatabaseMetaData
- Returns:
- max row size in bytes
-
doesMaxRowSizeIncludeBlobs
public boolean doesMaxRowSizeIncludeBlobs()Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?- Specified by:
doesMaxRowSizeIncludeBlobs
in interfaceDatabaseMetaData
- Returns:
- true if so
-
getMaxStatementLength
public int getMaxStatementLength()What's the maximum length of a SQL statement?- Specified by:
getMaxStatementLength
in interfaceDatabaseMetaData
- Returns:
- max length in bytes
-
getMaxStatements
public int getMaxStatements()How many active statements can we have open at one time to this database?- Specified by:
getMaxStatements
in interfaceDatabaseMetaData
- Returns:
- the maximum
-
getMaxTableNameLength
public int getMaxTableNameLength()What's the maximum length of a table name?- Specified by:
getMaxTableNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
-
getMaxTablesInSelect
public int getMaxTablesInSelect()What's the maximum number of tables in a SELECT?- Specified by:
getMaxTablesInSelect
in interfaceDatabaseMetaData
- Returns:
- the maximum
-
getMaxUserNameLength
public int getMaxUserNameLength()What's the maximum length of a user name?- Specified by:
getMaxUserNameLength
in interfaceDatabaseMetaData
- Returns:
- max name length in bytes
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()What's the database's default transaction isolation level? The values are defined in java.sql.Connection.- Specified by:
getDefaultTransactionIsolation
in interfaceDatabaseMetaData
- Returns:
- the default isolation level
- See Also:
-
supportsTransactions
public boolean supportsTransactions()Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.- Specified by:
supportsTransactions
in interfaceDatabaseMetaData
- Returns:
- true if transactions are supported
-
supportsTransactionIsolationLevel
public boolean supportsTransactionIsolationLevel(int level) Does the database support the given transaction isolation level? DatabaseMetaData.supportsTransactionIsolation() should return false for isolation levels that are not supported even if a higher level can be substituted.- Specified by:
supportsTransactionIsolationLevel
in interfaceDatabaseMetaData
- Parameters:
level
- the values are defined in java.sql.Connection- Returns:
- true if so
- See Also:
-
supportsDataDefinitionAndDataManipulationTransactions
public boolean supportsDataDefinitionAndDataManipulationTransactions()Are both data definition and data manipulation statements within a transaction supported?- Specified by:
supportsDataDefinitionAndDataManipulationTransactions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
supportsDataManipulationTransactionsOnly
public boolean supportsDataManipulationTransactionsOnly()Are only data manipulation statements within a transaction supported?- Specified by:
supportsDataManipulationTransactionsOnly
in interfaceDatabaseMetaData
- Returns:
- true if so
-
dataDefinitionCausesTransactionCommit
public boolean dataDefinitionCausesTransactionCommit()Does a data definition statement within a transaction force the transaction to commit?- Specified by:
dataDefinitionCausesTransactionCommit
in interfaceDatabaseMetaData
- Returns:
- true if so
-
dataDefinitionIgnoredInTransactions
public boolean dataDefinitionIgnoredInTransactions()Is a data definition statement within a transaction ignored?- Specified by:
dataDefinitionIgnoredInTransactions
in interfaceDatabaseMetaData
- Returns:
- true if so
-
getProcedures
public ResultSet getProcedures(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException Get a description of stored procedures available in a catalog.Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.
Each procedure description has the the following columns:
- PROCEDURE_CAT String => procedure catalog (may be null)
- PROCEDURE_SCHEM String => procedure schema (may be null)
- PROCEDURE_NAME String => procedure name
- reserved for future use
- reserved for future use
- reserved for future use
- REMARKS String => explanatory comment on the procedure
- PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - May return a result
- procedureNoResult - Does not return a result
- procedureReturnsResult - Returns a result
- SPECIFIC_NAME String => The name which uniquely identifies this procedure within its schema (since JDBC 4.0)
- Specified by:
getProcedures
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schemaprocedureNamePattern
- a procedure name pattern- Returns:
- ResultSet - each row is a procedure description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getProceduresForODBC
public ResultSet getProceduresForODBC(String catalog, String schemaPattern, String procedureNamePattern) throws SQLException Get a description of stored procedures available in a catalog. Same as getProcedures() above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
getFunctions
public ResultSet getFunctions(String catalog, String schemaPattern, String functionNamePattern) throws SQLException Implements DatabaseMetaData.getFunctions() for an embedded database. Queries the database to get information about functions (procedures returning values). Executes the 'getFunctions' query from metadata.properties to obtain the ResultSet to return.Compatibility: This is a new method in the API which is only available with with Derby versions > 10.1 and JDK versions >= 1.6
Upgrade: Since this is a new query it does not have an SPS, and will be available as soon as any database, new or old, is booted with the new version of Derby, (in soft and hard upgrade).
- Specified by:
getFunctions
in interfaceDatabaseMetaData
- Parameters:
catalog
- limit the search to functions in this catalog (not used)schemaPattern
- limit the search to functions in schemas matching this patternfunctionNamePattern
- limit the search to functions matching this pattern- Returns:
- a ResultSet with metadata information
- Throws:
SQLException
- if any of the underlying jdbc methods fail
-
doGetProcs
private ResultSet doGetProcs(String catalog, String schemaPattern, String procedureNamePattern, String queryName) throws SQLException Does the actual work for the getProcedures and getFunctions metadata calls. See getProcedures() method above for parameter descriptions.- Parameters:
queryName
- Name of the query to execute; is used to determine whether the result set should conform to JDBC or ODBC specifications.- Throws:
SQLException
-
getProcedureColumns
public ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException Get a description of a catalog's stored procedure parameters and result columns.Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description or column description with the following fields:
- PROCEDURE_CAT String => procedure catalog (may be null)
- PROCEDURE_SCHEM String => procedure schema (may be null)
- PROCEDURE_NAME String => procedure name
- COLUMN_NAME String => column/parameter name
- COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in ResultSet
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => SQL type name
- PRECISION int => precision
- LENGTH int => length in bytes of data
- SCALE short => scale
- RADIX short => radix
- NULLABLE short => can it contain NULL?
- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
- REMARKS String => comment describing parameter/column
- COLUMN_DEF String
- SQL_DATA_TYPE int
- SQL_DATETIME_SUB int
- CHAR_OCTET_LENGTH int
- ORDINAL_POSITION int
- IS_NULLABLE String
- SPECIFIC_NAME String
Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond SPECIFIC_NAME can be defined by the database.
- Specified by:
getProcedureColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schemaprocedureNamePattern
- a procedure name patterncolumnNamePattern
- a column name pattern- Returns:
- ResultSet - each row is a stored procedure parameter or column description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getProcedureColumnsForODBC
public ResultSet getProcedureColumnsForODBC(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException Get a description of a catalog's stored procedure parameters and result columns. Same as getProcedureColumns() above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
getFunctionColumns
public ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String parameterNamePattern) throws SQLException Implements DatabaseMetaData.getFunctionColumns() for an embedded database. Queries the database to get information about function parameters. Executes the 'getFunctionColumns' query from metadata.properties to obtain the ResultSet.Compatibility: This is a new method in the API which is only available with with Derby versions > 10.1 and JDK versions >= 1.6
Upgrade: Since this is a new query it does not have an SPS, and will be available as soon as any database, new or old, is booted with the new version of Derby, (in soft and hard upgrade).
- Specified by:
getFunctionColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- limit the search to functions in this catalog (not used)schemaPattern
- limit the search to functions in schemas matching this patternfunctionNamePattern
- limit the search to functions matching this patternparameterNamePattern
- limit the search parameters matching this pattern- Returns:
- a ResultSet with metadata information
- Throws:
SQLException
- if a database error occurs
-
doGetProcCols
private ResultSet doGetProcCols(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern, String queryName) throws SQLException Does the actual work for the getProcedureColumns metadata calls. See getProcedureColumns() method above for parameter descriptions.- Parameters:
queryName
- Name of the query to execute; is used to determine whether the result set should conform to JDBC or ODBC specifications.- Throws:
SQLException
-
getTables
public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types) throws SQLException Get a description of tables available in a catalog.Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- REMARKS String => explanatory comment on the table
- TYPE_CAT String => the types catalog (may be
null
) - TYPE_SCHEM String => the types schema (may be
null
) - TYPE_NAME String => type name (may be
null
) - SELF_REFERENCING_COL_NAME String => name of the
designated "identifier" column of a typed table (may
be
null
) - REF_GENERATION String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are
"SYSTEM", "USER", "DERIVED". (may be
null
)
Note: Some databases may not return information for all tables.
- Specified by:
getTables
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name patterntypes
- a list of table types to include; null returns all types- Returns:
- ResultSet - each row is a table description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getSchemas
Get the schema names available in this database. The results are ordered by schema name.The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name
(may be
null
)
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row is a schema description
- Throws:
SQLException
- thrown on failure.
-
getCatalogs
Get the catalog names available in this database. The results are ordered by catalog name.The catalog column is:
- TABLE_CAT String => catalog name
- Specified by:
getCatalogs
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row has a single String column that is a catalog name
- Throws:
SQLException
- thrown on failure.
-
getTableTypes
Get the table types available in this database. The results are ordered by table type.The table type is:
- TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
- Specified by:
getTableTypes
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row has a single String column that is a table type
- Throws:
SQLException
- thrown on failure.
-
getColumns
public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Get a description of table columns available in a catalog.Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.
Each column description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL type from java.sql.Types
- TYPE_NAME String => Data source dependent type name
- COLUMN_SIZE int => column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
- BUFFER_LENGTH is not used.
- DECIMAL_DIGITS int => the number of fractional digits
- NUM_PREC_RADIX int => Radix (typically either 10 or 2)
- NULLABLE int => is NULL allowed?
- columnNoNulls - might not allow NULL values
- columnNullable - definitely allows NULL values
- columnNullableUnknown - nullability unknown
- REMARKS String => comment describing column (may be null)
- COLUMN_DEF String => default value (may be null)
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
- ORDINAL_POSITION int => index of column in table (starting at 1)
- IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.
- SCOPE_CATALOG String => catalog of table that is the
scope of a reference attribute (
null
if DATA_TYPE isn't REF) - SCOPE_SCHEMA String => schema of table that is the
scope of a reference attribute (
null
if the DATA_TYPE isn't REF) - SCOPE_TABLE String => table name that this the
scope of a reference attribure (
null
if the DATA_TYPE isn't REF) - SOURCE_DATA_TYPE short => source type of a distinct
type or user-generated Ref type, SQL type from java.sql.Types
(
null
if DATA_TYPE isn't DISTINCT or user-generated REF) - IS_AUTOINCREMENT String => Indicates whether this
column is auto incremented
- YES --- if the column is auto incremented
- NO --- if the column is not auto incremented
- empty string --- if it cannot be determined whether the column is auto incremented parameter is unknown
- SCOPE_CATLOG A redundant copy of SCOPE_CATALOG. The name of this column is deliberately mis-spelled in order to support a typo in the javadoc for DatabaseMetaData.getColumns() which was corrected by JDBC 4.1.
- Specified by:
getColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name patterncolumnNamePattern
- a column name pattern- Returns:
- ResultSet - each row is a column description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getColumnsForODBC
public ResultSet getColumnsForODBC(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException Get a description of table columns available in a catalog. Same as getColumns() above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
doGetCols
private ResultSet doGetCols(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern, String queryName) throws SQLException Does the actual work for the getColumns metadata calls. See getColumns() method above for parameter descriptions.- Parameters:
queryName
- Name of the query to execute; is used to determine whether the result set should conform to JDBC or ODBC specifications.- Throws:
SQLException
-
getColumnPrivileges
public ResultSet getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern) throws SQLException Get a description of the access rights for a table's columns.Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- GRANTOR => grantor of access (may be null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
- Specified by:
getColumnPrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table namecolumnNamePattern
- a column name pattern- Returns:
- ResultSet - each row is a column privilege description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getTablePrivileges
public ResultSet getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern) throws SQLException Get a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this priviledge applies to all columns (this may be true for some systems but is not true for all.)Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.
Each privilige description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- GRANTOR => grantor of access (may be null)
- GRANTEE String => grantee of access
- PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
- IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
- Specified by:
getTablePrivileges
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematableNamePattern
- a table name pattern- Returns:
- ResultSet - each row is a table privilege description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getBestRowIdentifier
public ResultSet getBestRowIdentifier(String catalogPattern, String schemaPattern, String table, int scope, boolean nullable) throws SQLException Get a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.Each column description has the following columns:
- SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => not used
- DECIMAL_DIGITS short => scale
- PSEUDO_COLUMN short => is this a pseudo column
like an Oracle ROWID
- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column
- Specified by:
getBestRowIdentifier
in interfaceDatabaseMetaData
- Parameters:
catalogPattern
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name; "" retrieves those without a schematable
- a table namescope
- the scope of interest; use same values as SCOPEnullable
- include columns that are nullable?- Returns:
- ResultSet - each row is a column description
- Throws:
SQLException
- thrown on failure.
- SCOPE short => actual scope of result
-
getBestRowIdentifierForODBC
public ResultSet getBestRowIdentifierForODBC(String catalogPattern, String schemaPattern, String table, int scope, boolean nullable) throws SQLException Get a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE. Same as getBestRowIdentifier() above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
doGetBestRowId
private ResultSet doGetBestRowId(String catalogPattern, String schemaPattern, String table, int scope, boolean nullable, String queryPrefix) throws SQLException Does the actual work for the getBestRowIdentifier metadata calls. See getBestRowIdentifier() method above for parameter descriptions.- Parameters:
queryPrefix
- Prefix to be appended to the names of the queries used in this method. This is used to determine whether the result set should conform to JDBC or ODBC specifications.- Throws:
SQLException
-
getVersionColumns
Get a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.Each column description has the following columns:
- SCOPE short => is not used
- COLUMN_NAME String => column name
- DATA_TYPE int => SQL data type from java.sql.Types
- TYPE_NAME String => Data source dependent type name
- COLUMN_SIZE int => precision
- BUFFER_LENGTH int => length of column value in bytes
- DECIMAL_DIGITS short => scale
- PSEUDO_COLUMN short => is this a pseudo column
like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column
- Specified by:
getVersionColumns
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a column description
- Throws:
SQLException
- thrown on failure.
-
getVersionColumnsForODBC
public ResultSet getVersionColumnsForODBC(String catalog, String schema, String table) throws SQLException Get a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered. Same as getVersionColumns() above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
doGetVersionCols
private ResultSet doGetVersionCols(String catalog, String schema, String table, String queryName) throws SQLException Does the actual work for the getVersionColumns metadata calls. See getVersionColumns() method above for parameter descriptions.- Parameters:
queryName
- Name of the query to execute; is used to determine whether the result set should conform to JDBC or ODBC specifications.- Throws:
SQLException
-
notInSoftUpgradeMode
check if the dictionary is at the same version as the engine. If not, then that means stored versions of the JDBC database metadata queries may not be compatible with this version of the software. This can happen if we are in soft upgrade mode. Since in soft upgrade mode, we can't change these stored metadata queries in a backward incompatible way, engine needs to read the metadata sql from metadata.properties or metadata_net.properties file rather than rely on system tables.- Returns:
- true if we are not in soft upgrade mode
- Throws:
SQLException
-
getPrimaryKeys
Get a description of a table's primary key columns. They are ordered by COLUMN_NAME.Each primary key column description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- COLUMN_NAME String => column name
- KEY_SEQ short => sequence number within primary key
- PK_NAME String => primary key name (may be null)
- Specified by:
getPrimaryKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name pattern; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a primary key column description
- Throws:
SQLException
- thrown on failure.
-
getImportedKeys
Get a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.Each primary key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog being imported (may be null)
- PKTABLE_SCHEM String => primary key table schema being imported (may be null)
- PKTABLE_NAME String => primary key table name being imported
- PKCOLUMN_NAME String => primary key column name being imported
- FKTABLE_CAT String => foreign key table catalog (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be null)
- FKTABLE_NAME String => foreign key table name
- FKCOLUMN_NAME String => foreign key column name
- KEY_SEQ short => sequence number within foreign key
- UPDATE_RULE short => What happens to
foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be null)
- PK_NAME String => primary key name (may be null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getImportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name pattern; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a primary key column description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getExportedKeys
Get a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be null)
- PKTABLE_SCHEM String => primary key table schema (may be null)
- PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
- FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key
- UPDATE_RULE short => What happens to
foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be null)
- PK_NAME String => primary key name (may be null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getExportedKeys
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name pattern; "" retrieves those without a schematable
- a table name- Returns:
- ResultSet - each row is a foreign key column description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getCrossReference
public ResultSet getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException Get a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.) This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.) They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.Each foreign key column description has the following columns:
- PKTABLE_CAT String => primary key table catalog (may be null)
- PKTABLE_SCHEM String => primary key table schema (may be null)
- PKTABLE_NAME String => primary key table name
- PKCOLUMN_NAME String => primary key column name
- FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
- FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
- FKTABLE_NAME String => foreign key table name being exported
- FKCOLUMN_NAME String => foreign key column name being exported
- KEY_SEQ short => sequence number within foreign key
- UPDATE_RULE short => What happens to
foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- DELETE_RULE short => What happens to
the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
- FK_NAME String => foreign key name (may be null)
- PK_NAME String => primary key name (may be null)
- DEFERRABILITY short => can the evaluation of foreign key
constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition
- Specified by:
getCrossReference
in interfaceDatabaseMetaData
- Parameters:
primaryCatalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaprimarySchema
- a schema name pattern; "" retrieves those without a schemaprimaryTable
- the table name that exports the keyforeignCatalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaforeignSchema
- a schema name pattern; "" retrieves those without a schemaforeignTable
- the table name that imports the key- Returns:
- ResultSet - each row is a foreign key column description
- Throws:
SQLException
- thrown on failure.- See Also:
-
getCrossReferenceForODBC
public ResultSet getCrossReferenceForODBC(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable) throws SQLException In contrast to the JDBC version of getCrossReference, this method allows null values for table names.- Throws:
SQLException
-
getTypeInfo
Get a description of all the standard SQL types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.Each type description has the following columns:
- TYPE_NAME String => Type name
- DATA_TYPE int => SQL data type from java.sql.Types
- PRECISION int => maximum precision
- LITERAL_PREFIX String => prefix used to quote a literal (may be null)
- LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
- CREATE_PARAMS String => parameters used in creating the type (may be null)
- NULLABLE short => can you use NULL for this type?
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
- CASE_SENSITIVE boolean=> is it case sensitive?
- SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
- UNSIGNED_ATTRIBUTE boolean => is it unsigned?
- FIXED_PREC_SCALE boolean => can it be a money value?
- AUTO_INCREMENT boolean => can it be used for an auto-increment value?
- LOCAL_TYPE_NAME String => localized version of type name (may be null)
- MINIMUM_SCALE short => minimum scale supported
- MAXIMUM_SCALE short => maximum scale supported
- SQL_DATA_TYPE int => unused
- SQL_DATETIME_SUB int => unused
- NUM_PREC_RADIX int => usually 2 or 10
- Specified by:
getTypeInfo
in interfaceDatabaseMetaData
- Returns:
- ResultSet - each row is a SQL type description
- Throws:
SQLException
- thrown on failure.
-
getTypeInfoForODBC
Get a description of all the standard SQL types supported by this database. They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type. Same as getTypeInfo above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
getTypeInfoMinion
Get a description of the standard SQL types supported by this database.- Parameters:
queryName
- the name of the query that fetches the information- Returns:
- a result set with SQL type description
- Throws:
SQLException
-
getIndexInfo
public ResultSet getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException Get a description of a table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.Each index column description has the following columns:
- TABLE_CAT String => table catalog (may be null)
- TABLE_SCHEM String => table schema (may be null)
- TABLE_NAME String => table name
- NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
- INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
- INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
- TYPE short => index type:
- tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
- ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
- COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
- ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
- CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
- PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
- FILTER_CONDITION String => Filter condition, if any. (may be null)
- Specified by:
getIndexInfo
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschema
- a schema name pattern; "" retrieves those without a schematable
- a table nameunique
- when true, return only indices for unique values; when false, return indices regardless of whether unique or notapproximate
- when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate- Returns:
- ResultSet - each row is an index column description
- Throws:
SQLException
- thrown on failure.
-
getIndexInfoForODBC
public ResultSet getIndexInfoForODBC(String catalog, String schema, String table, boolean unique, boolean approximate) throws SQLException Get a description of a table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION. Same as getIndexInfo above, except that the result set will conform to ODBC specifications.- Throws:
SQLException
-
doGetIndexInfo
private ResultSet doGetIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate, String queryName) throws SQLException Does the actual work for the getIndexInfo metadata calls. See getIndexInfo() method above for parameter descriptions.- Parameters:
queryName
- Name of the query to execute; is used to determine whether the result set should conform to JDBC or ODBC specifications.- Throws:
SQLException
-
supportsResultSetType
public boolean supportsResultSetType(int type) JDBC 2.0 Does the database support the given result set type?- Specified by:
supportsResultSetType
in interfaceDatabaseMetaData
- Parameters:
type
- defined in java.sql.ResultSet- Returns:
- true if so
- See Also:
-
supportsResultSetConcurrency
public boolean supportsResultSetConcurrency(int type, int concurrency) JDBC 2.0 Does the database support the concurrency type in combination with the given result set type?- Specified by:
supportsResultSetConcurrency
in interfaceDatabaseMetaData
- Parameters:
type
- defined in java.sql.ResultSetconcurrency
- type defined in java.sql.ResultSet- Returns:
- true if so
- See Also:
-
ownUpdatesAreVisible
public boolean ownUpdatesAreVisible(int type) JDBC 2.0 Determine whether a result set's updates are visible.- Specified by:
ownUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if updates are visible for the result set type
-
ownDeletesAreVisible
public boolean ownDeletesAreVisible(int type) JDBC 2.0 Determine whether a result set's deletes are visible.- Specified by:
ownDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if deletes are visible for the result set type
-
ownInsertsAreVisible
public boolean ownInsertsAreVisible(int type) JDBC 2.0 Determine whether a result set's inserts are visible.- Specified by:
ownInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if inserts are visible for the result set type
-
othersUpdatesAreVisible
public boolean othersUpdatesAreVisible(int type) JDBC 2.0 Determine whether updates made by others are visible.- Specified by:
othersUpdatesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if updates are visible for the result set type
-
othersDeletesAreVisible
public boolean othersDeletesAreVisible(int type) JDBC 2.0 Determine whether deletes made by others are visible.- Specified by:
othersDeletesAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if deletes are visible for the result set type
-
othersInsertsAreVisible
public boolean othersInsertsAreVisible(int type) JDBC 2.0 Determine whether inserts made by others are visible.- Specified by:
othersInsertsAreVisible
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if inserts are visible for the result set type
-
updatesAreDetected
public boolean updatesAreDetected(int type) JDBC 2.0 Determine whether or not a visible row update can be detected by calling ResultSet.rowUpdated().- Specified by:
updatesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if updates are detected by the resultset type
-
deletesAreDetected
public boolean deletesAreDetected(int type) JDBC 2.0 Determine whether or not a visible row delete can be detected by calling ResultSet.rowDeleted(). If deletesAreDetected() returns false, then deleted rows are removed from the result set.- Specified by:
deletesAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if deletes are detected by the resultset type
-
insertsAreDetected
public boolean insertsAreDetected(int type) JDBC 2.0 Determine whether or not a visible row insert can be detected by calling ResultSet.rowInserted().- Specified by:
insertsAreDetected
in interfaceDatabaseMetaData
- Parameters:
type
- result set type, i.e. ResultSet.TYPE_XXX- Returns:
- true if inserts are detected by the resultset type
-
supportsBatchUpdates
public boolean supportsBatchUpdates()JDBC 2.0 Return true if the driver supports batch updates, else return false.- Specified by:
supportsBatchUpdates
in interfaceDatabaseMetaData
-
getUDTs
public ResultSet getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException JDBC 2.0 Get a description of the user-defined types defined in a particular schema. Schema specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully qualified name. In this case, the catalog and schemaPattern parameters are ignored.
Each type description has the following columns:
- TYPE_CAT String => the type's catalog (may be null)
- TYPE_SCHEM String => type's schema (may be null)
- TYPE_NAME String => type name
- CLASS_NAME String => Java class name
- DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
- REMARKS String => explanatory comment on the type
- BASE_TYPE short => type code of the source type of
a DISTINCT type or the type that implements the user-generated
reference type of the SELF_REFERENCING_COLUMN of a structured
type as defined in java.sql.Types (
null
if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED)
Note: If the driver does not support UDTs then an empty result set is returned.
- Specified by:
getUDTs
in interfaceDatabaseMetaData
- Parameters:
catalog
- a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- a schema name pattern; "" retrieves those without a schematypeNamePattern
- a type name pattern; may be a fully qualified nametypes
- a list of user-named types to include (JAVA_OBJECT, STRUCT, or DISTINCT); null returns all types- Returns:
- ResultSet - each row is a type description
- Throws:
SQLException
- if a database-access error occurs.
-
getConnection
JDBC 2.0 Return the connection that produced this metadata object.- Specified by:
getConnection
in interfaceDatabaseMetaData
-
supportsStatementPooling
public boolean supportsStatementPooling()JDBC 3.0 Retrieves whether this database supports statement pooling.- Specified by:
supportsStatementPooling
in interfaceDatabaseMetaData
- Returns:
- true if statement pooling is supported; false otherwise
-
supportsSavepoints
public boolean supportsSavepoints()JDBC 3.0 Retrieves whether this database supports savepoints.- Specified by:
supportsSavepoints
in interfaceDatabaseMetaData
- Returns:
- true if savepoints are supported; false otherwise
-
supportsNamedParameters
public boolean supportsNamedParameters()JDBC 3.0 Retrieves whether this database supports named parameters to callable statements.- Specified by:
supportsNamedParameters
in interfaceDatabaseMetaData
- Returns:
- true if named parameters are supported; false otherwise
-
supportsMultipleOpenResults
public boolean supportsMultipleOpenResults()JDBC 3.0 Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.- Specified by:
supportsMultipleOpenResults
in interfaceDatabaseMetaData
- Returns:
- true if a CallableStatement object can return multiple ResultSet objects simultaneously; false otherwise
-
supportsGetGeneratedKeys
public boolean supportsGetGeneratedKeys()JDBC 3.0 Retrieves whether auto-generated keys can be retrieved after a statement has been executed.- Specified by:
supportsGetGeneratedKeys
in interfaceDatabaseMetaData
- Returns:
- true if auto-generated keys can be retrieved after a statement has executed; false otherwise
-
supportsResultSetHoldability
public boolean supportsResultSetHoldability(int holdability) JDBC 3.0 Retrieves whether this database supports the given result set holdability.- Specified by:
supportsResultSetHoldability
in interfaceDatabaseMetaData
- Parameters:
holdability
- - one of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT- Returns:
- true if so; false otherwise executed; false otherwise
-
getResultSetHoldability
public int getResultSetHoldability()JDBC 3.0 Retrieves the default holdability of this ResultSet object.- Specified by:
getResultSetHoldability
in interfaceDatabaseMetaData
- Returns:
- the default holdability which is ResultSet.HOLD_CURSORS_OVER_COMMIT
-
getDatabaseMajorVersion
public int getDatabaseMajorVersion()JDBC 3.0 Retrieves the major version number of the underlying database.- Specified by:
getDatabaseMajorVersion
in interfaceDatabaseMetaData
- Returns:
- the underlying database's major version
-
getDatabaseMinorVersion
public int getDatabaseMinorVersion()JDBC 3.0 Retrieves the minor version number of the underlying database.- Specified by:
getDatabaseMinorVersion
in interfaceDatabaseMetaData
- Returns:
- the underlying database's minor version
-
getJDBCMajorVersion
public int getJDBCMajorVersion()JDBC 3.0 Retrieves the major JDBC version number for this driver.- Specified by:
getJDBCMajorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC version major number
-
getJDBCMinorVersion
public int getJDBCMinorVersion()JDBC 3.0 Retrieves the minor JDBC version number for this driver.- Specified by:
getJDBCMinorVersion
in interfaceDatabaseMetaData
- Returns:
- JDBC version minor number
-
getSQLStateType
public int getSQLStateType()JDBC 3.0 Indicates whether the SQLSTATEs returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.- Specified by:
getSQLStateType
in interfaceDatabaseMetaData
- Returns:
- the type of SQLSTATEs, one of: sqlStateXOpen or sqlStateSQL99
-
locatorsUpdateCopy
JDBC 3.0 Indicates whether updates made to a LOB are made on a copy or directly to the LOB.For the embedded driver, all updates will be made to a copy. Hence, this call will always return
true
- Specified by:
locatorsUpdateCopy
in interfaceDatabaseMetaData
- Returns:
- true if updates are made to a copy of the LOB; false if updates are made directly to the LOB
- Throws:
SQLException
- Feature not implemented for now.
-
getSuperTypes
public ResultSet getSuperTypes(String catalog, String schemaPattern, String typeNamePattern) throws SQLException JDBC 3.0 Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.- Specified by:
getSuperTypes
in interfaceDatabaseMetaData
- Parameters:
catalog
- - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- - a schema name pattern; "" retrieves those without a schematypeNamePattern
- - a UDT name pattern; may be a fully-qualified name- Returns:
- a ResultSet object in which a row gives information about the designated UDT
- Throws:
SQLException
- Feature not implemented for now.
-
getSuperTables
public ResultSet getSuperTables(String catalog, String schemaPattern, String typeNamePattern) throws SQLException JDBC 3.0 Retrieves a description of the table hierarchies defined in a particular schema in this database.- Specified by:
getSuperTables
in interfaceDatabaseMetaData
- Parameters:
catalog
- - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteriaschemaPattern
- - a schema name pattern; "" retrieves those without a schematypeNamePattern
- - a UDT name pattern; may be a fully-qualified name- Returns:
- a ResultSet object in which each row is a type description
- Throws:
SQLException
- if a database access error occurs
-
getAttributes
public ResultSet getAttributes(String catalog, String schemaPattern, String typeNamePattern, String attributeNamePattern) throws SQLException JDBC 3.0 Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.- Specified by:
getAttributes
in interfaceDatabaseMetaData
- Parameters:
catalog
- - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the searchschemaPattern
- - a schema name pattern; "" retrieves those without a schema; null means that the schema name should not be used to narrow the searchtypeNamePattern
- - a type name pattern; must match the type name as it is stored in the databaseattributeNamePattern
- - an attribute name pattern; must match the attribute name as it is declared in the database- Returns:
- a ResultSet object in which each row is a type description
- Throws:
SQLException
- if a database access error occurs.
-
getClientInfoProperties
JDBC 4.0Returns a list of the client info properties supported by the driver. The result set contains the following columns:
- NAME String=> The name of the client info property.
- MAX_LEN int=> The maximum length of the value for the property.
- DEFAULT_VALUE String=> The default value of the property.
- DESCRIPTION String=> A description of the property.
The
ResultSet
is sorted by the NAME column.- Specified by:
getClientInfoProperties
in interfaceDatabaseMetaData
- Returns:
- A
ResultSet
object; each row is a supported client info property - Throws:
SQLException
- if an error occurs
-
getSchemas
JDBC 4.0Get the schema names available in this database. The results are ordered by schema name.
The schema columns are:
- TABLE_SCHEM String => schema name
- TABLE_CATALOG String => catalog name
(may be
null
)
- Specified by:
getSchemas
in interfaceDatabaseMetaData
- Parameters:
catalog
- catalog name used to narrow down the search; "" means no catalog,null
means any catalogschemaPattern
- schema name used to narrow down the search,null
means schema name should not be used to narrow down search- Returns:
- a
ResultSet
object in which each row is a schema description - Throws:
SQLException
- if a database error occurs
-
getRowIdLifetime
- Specified by:
getRowIdLifetime
in interfaceDatabaseMetaData
- Throws:
SQLException
-
supportsStoredFunctionsUsingCallSyntax
- Specified by:
supportsStoredFunctionsUsingCallSyntax
in interfaceDatabaseMetaData
- Throws:
SQLException
-
autoCommitFailureClosesAllResultSets
Returns whether or not all openResultSet
s on aConnection
are closed if an error occurs when auto-commit in enabled.- Specified by:
autoCommitFailureClosesAllResultSets
in interfaceDatabaseMetaData
- Returns:
true
, since the embedded driver will close the openResultSet
s- Throws:
SQLException
-
isWrapperFor
Returns whether or not this instance implements the specified interface.- Specified by:
isWrapperFor
in interfaceWrapper
- Parameters:
iface
- the interface to check for- Returns:
- true if this implements the interface
-
unwrap
Returnsthis
if this class implements the interface.- Specified by:
unwrap
in interfaceWrapper
- Parameters:
iface
- the interface- Returns:
- an object that implements the interface
- Throws:
SQLException
- if no object is found that implements the interface
-
generatedKeyAlwaysReturned
public boolean generatedKeyAlwaysReturned()See DatabaseMetaData javadoc- Specified by:
generatedKeyAlwaysReturned
in interfaceDatabaseMetaData
-
getPseudoColumns
public ResultSet getPseudoColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern) throws SQLException See DatabaseMetaData javadoc. Empty ResultSet because Derby does not support pseudo columns.- Specified by:
getPseudoColumns
in interfaceDatabaseMetaData
- Throws:
SQLException
-
getClientCachedMetaData
Get metadata that the client driver will cache. The metadata is fetched using SYSIBM.METADATA (found in metadata_net.properties).- Returns:
- the result set returned by SYSIBM.METADATA
- Throws:
SQLException
- if a database error occurs
-
getSimpleQuery
Execute a query in metadata.properties (or SPS in the SYS schema) or metadata_net.properties (or SPS in the SYSIBM schema).- Parameters:
nameKey
- the name of the querynet
- iftrue
, execute a query in metadata_net.properties; otherwise, execute a query in metadata.properties- Returns:
- a
ResultSet
value - Throws:
SQLException
- if a database error occurs
-
getSimpleQuery
Execute a query in metadata.properties, or an SPS in the SYS schema.- Parameters:
nameKey
- the name of the query- Returns:
- a
ResultSet
value - Throws:
SQLException
- if a database error occurs
-
getPreparedQueryUsingSystemTables
private PreparedStatement getPreparedQueryUsingSystemTables(String nameKey, boolean net) throws SQLException Get a stored prepared statement from the system tables.- Parameters:
nameKey
- the name of the querynet
- iftrue
, find query in SYSIBM schema; otherwise, find query in SYS schema- Returns:
- a
PreparedStatement
value - Throws:
SQLException
- if a database error occurs
-
getPreparedQuery
Either get the prepared query for the metadata call from the system tables, or from the metadata.properties or metadata_net.properties file. In soft upgrade mode, the queries stored in the system tables might not be upto date with the Derby engine release because system tables can't be modified in backward incompatible way in soft upgrade mode. Because of this, if the database is in soft upgrade mode, get the queries from metadata.properties file rather than from the system tables. Getting queries from metadata(_net).properties might cause problems if system catalogs have been changed between versions either by addition of columns or have new catalogs. To continue to support soft upgrade from older versions of database, find query that most closely matches database dictionary version.- Parameters:
queryName
- Name of the metadata query for which we need a prepared statementnet
- iftrue
, use metadata_net.properties instead of metadata.properties- Returns:
- PreparedStatement
- Throws:
SQLException
- if a database error occurs
-
getPreparedQuery
Get a prepared query from system tables or metadata.properties.- Parameters:
queryName
- name of the query- Returns:
- a
PreparedStatement
value - Throws:
SQLException
- if a database error occurs
-
getQueryFromDescription
Given a queryName, find closest match in queryDescriptions. This method should be called in soft-upgrade mode only, where current software version doesn't match dictionary version. For these cases, there may be multiple entries in queryDescriptions for given queryName. Find a version of the query that closely matches dictionary version. This method is currently coded to handle two specific queries, getColumnPrivileges and getTablePrivileges. Derby databases that are 10.1 or earlier will not have new system tables added for 10.2 for privileges. It should be possible to automate finding closest match by generating all Major_Minor versions between software version and dictionary version and try each one from Dictionary version to current version. Since only needed for two queries, overhead may not be worth it yet.- Parameters:
queryName
- name of the querynet
- iftrue
, get the query from metadata_net.properties instead of metadata.properties- Returns:
- the query text
- Throws:
StandardException
- if an error occurs
-
prepareSPS
private PreparedStatement prepareSPS(String spsName, String spsText, boolean net) throws StandardException, SQLException - Throws:
StandardException
SQLException
-
swapNull
-
getLanguageConnectionContext
Gets the LanguageConnectionContext for this connection.- Returns:
- the lcc for this connection
-
loadQueryDescriptions
private void loadQueryDescriptions()Loads the query descriptions from metadata.properties and metadata_net.properties intoqueryDescriptions
andqueryDescriptions_net
. -
run
Performs a privileged action. Reads the query descriptions.- Specified by:
run
in interfacePrivilegedAction<Object>
- Returns:
null
-