Class EmbedDatabaseMetaData

  • All Implemented Interfaces:
    java.security.PrivilegedAction<java.lang.Object>, java.sql.DatabaseMetaData, java.sql.Wrapper

    public class EmbedDatabaseMetaData
    extends ConnectionChild
    implements java.sql.DatabaseMetaData, java.security.PrivilegedAction<java.lang.Object>
    This class provides information about the database as a whole.

    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:
    JDBC 3.0 Specification
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private GenericConstantActionFactory constantActionFactory  
      private static int ILLEGAL_UDT_TYPE  
      private static java.util.Properties queryDescriptions
      Cached query descriptions from metadata.properties.
      private static java.util.Properties queryDescriptions_net
      Cached query descriptions from metadata_net.properties.
      private java.lang.String url  
      • 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
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean allProceduresAreCallable()
      Can all the procedures returned by getProcedures be called by the current user?
      boolean allTablesAreSelectable()
      Can all the tables returned by getTable be SELECTed by the current user?
      boolean autoCommitFailureClosesAllResultSets()
      Returns whether or not all open ResultSets on a Connection are closed if an error occurs when auto-commit in enabled.
      boolean dataDefinitionCausesTransactionCommit()
      Does a data definition statement within a transaction force the transaction to commit?
      boolean dataDefinitionIgnoredInTransactions()
      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 doesMaxRowSizeIncludeBlobs()
      Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
      private java.sql.ResultSet doGetBestRowId​(java.lang.String catalogPattern, java.lang.String schemaPattern, java.lang.String table, int scope, boolean nullable, java.lang.String queryPrefix)
      Does the actual work for the getBestRowIdentifier metadata calls.
      private java.sql.ResultSet doGetCols​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern, java.lang.String queryName)
      Does the actual work for the getColumns metadata calls.
      private java.sql.ResultSet doGetIndexInfo​(java.lang.String catalog, java.lang.String schema, java.lang.String table, boolean unique, boolean approximate, java.lang.String queryName)
      Does the actual work for the getIndexInfo metadata calls.
      private java.sql.ResultSet doGetProcCols​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern, java.lang.String columnNamePattern, java.lang.String queryName)
      Does the actual work for the getProcedureColumns metadata calls.
      private java.sql.ResultSet doGetProcs​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern, java.lang.String queryName)
      Does the actual work for the getProcedures and getFunctions metadata calls.
      private java.sql.ResultSet doGetVersionCols​(java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String queryName)
      Does the actual work for the getVersionColumns metadata calls.
      boolean generatedKeyAlwaysReturned()
      See DatabaseMetaData javadoc
      java.sql.ResultSet getAttributes​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typeNamePattern, java.lang.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.
      java.sql.ResultSet getBestRowIdentifier​(java.lang.String catalogPattern, java.lang.String schemaPattern, java.lang.String table, int scope, boolean nullable)
      Get a description of a table's optimal set of columns that uniquely identifies a row.
      java.sql.ResultSet getBestRowIdentifierForODBC​(java.lang.String catalogPattern, java.lang.String schemaPattern, java.lang.String table, int scope, boolean nullable)
      Get a description of a table's optimal set of columns that uniquely identifies a row.
      java.sql.ResultSet getCatalogs()
      Get the catalog names available in this database.
      java.lang.String getCatalogSeparator()
      What's the separator between catalog and table name?
      java.lang.String getCatalogTerm()
      What's the database vendor's preferred term for "catalog"?
      java.sql.ResultSet getClientCachedMetaData()
      Get metadata that the client driver will cache.
      java.sql.ResultSet getClientInfoProperties()
      JDBC 4.0
      java.sql.ResultSet getColumnPrivileges​(java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String columnNamePattern)
      Get a description of the access rights for a table's columns.
      java.sql.ResultSet getColumns​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern)
      Get a description of table columns available in a catalog.
      java.sql.ResultSet getColumnsForODBC​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern)
      Get a description of table columns available in a catalog.
      java.sql.Connection getConnection()
      JDBC 2.0 Return the connection that produced this metadata object.
      java.sql.ResultSet getCrossReference​(java.lang.String primaryCatalog, java.lang.String primarySchema, java.lang.String primaryTable, java.lang.String foreignCatalog, java.lang.String foreignSchema, java.lang.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.)
      java.sql.ResultSet getCrossReferenceForODBC​(java.lang.String primaryCatalog, java.lang.String primarySchema, java.lang.String primaryTable, java.lang.String foreignCatalog, java.lang.String foreignSchema, java.lang.String foreignTable)
      In contrast to the JDBC version of getCrossReference, this method allows null values for table names.
      int getDatabaseMajorVersion()
      JDBC 3.0 Retrieves the major version number of the underlying database.
      int getDatabaseMinorVersion()
      JDBC 3.0 Retrieves the minor version number of the underlying database.
      java.lang.String getDatabaseProductName()
      What's the name of this database product?
      java.lang.String getDatabaseProductVersion()
      What's the version of this database product?
      int getDefaultTransactionIsolation()
      What's the database's default transaction isolation level?
      int getDriverMajorVersion()
      What's this JDBC driver's major version number?
      int getDriverMinorVersion()
      What's this JDBC driver's minor version number?
      java.lang.String getDriverName()
      What's the name of this JDBC driver?
      java.lang.String getDriverVersion()
      What's the version of this JDBC driver?
      java.sql.ResultSet getExportedKeys​(java.lang.String catalog, java.lang.String schema, java.lang.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).
      java.lang.String getExtraNameCharacters()
      Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
      java.sql.ResultSet getFunctionColumns​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String functionNamePattern, java.lang.String parameterNamePattern)
      Implements DatabaseMetaData.getFunctionColumns() for an embedded database.
      java.sql.ResultSet getFunctions​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String functionNamePattern)
      Implements DatabaseMetaData.getFunctions() for an embedded database.
      java.lang.String getIdentifierQuoteString()
      What's the string used to quote SQL identifiers?
      java.sql.ResultSet getImportedKeys​(java.lang.String catalog, java.lang.String schema, java.lang.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).
      java.sql.ResultSet getIndexInfo​(java.lang.String catalog, java.lang.String schema, java.lang.String table, boolean unique, boolean approximate)
      Get a description of a table's indices and statistics.
      java.sql.ResultSet getIndexInfoForODBC​(java.lang.String catalog, java.lang.String schema, java.lang.String table, boolean unique, boolean approximate)
      Get a description of a table's indices and statistics.
      int getJDBCMajorVersion()
      JDBC 3.0 Retrieves the major JDBC version number for this driver.
      int getJDBCMinorVersion()
      JDBC 3.0 Retrieves the minor JDBC version number for this driver.
      private LanguageConnectionContext getLanguageConnectionContext()
      Gets the LanguageConnectionContext for this connection.
      int getMaxBinaryLiteralLength()
      How many hex characters can you have in an inline binary literal?
      int getMaxCatalogNameLength()
      What's the maximum length of a catalog name?
      int getMaxCharLiteralLength()
      What's the max length for a character literal?
      int getMaxColumnNameLength()
      What's the limit on column name length?
      int getMaxColumnsInGroupBy()
      What's the maximum number of columns in a "GROUP BY" clause?
      int getMaxColumnsInIndex()
      What's the maximum number of columns allowed in an index?
      int getMaxColumnsInOrderBy()
      What's the maximum number of columns in an "ORDER BY" clause?
      int getMaxColumnsInSelect()
      What's the maximum number of columns in a "SELECT" list?
      int getMaxColumnsInTable()
      What's the maximum number of columns in a table?
      int getMaxConnections()
      How many active connections can we have at a time to this database?
      int getMaxCursorNameLength()
      What's the maximum cursor name length?
      int getMaxIndexLength()
      What's the maximum length of an index (in bytes)?
      long getMaxLogicalLobSize()
      Added in JDBC 4.2.
      int getMaxProcedureNameLength()
      What's the maximum length of a procedure name?
      int getMaxRowSize()
      What's the maximum length of a single row?
      int getMaxSchemaNameLength()
      What's the maximum length allowed for a schema name?
      int getMaxStatementLength()
      What's the maximum length of a SQL statement?
      int getMaxStatements()
      How many active statements can we have open at one time to this database?
      int getMaxTableNameLength()
      What's the maximum length of a table name?
      int getMaxTablesInSelect()
      What's the maximum number of tables in a SELECT?
      int getMaxUserNameLength()
      What's the maximum length of a user name?
      java.lang.String getNumericFunctions()
      Get a comma separated list of JDBC escaped numeric functions.
      protected java.sql.PreparedStatement getPreparedQuery​(java.lang.String queryName)
      Get a prepared query from system tables or metadata.properties.
      private java.sql.PreparedStatement getPreparedQuery​(java.lang.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 java.sql.PreparedStatement getPreparedQueryUsingSystemTables​(java.lang.String nameKey, boolean net)
      Get a stored prepared statement from the system tables.
      java.sql.ResultSet getPrimaryKeys​(java.lang.String catalog, java.lang.String schema, java.lang.String table)
      Get a description of a table's primary key columns.
      java.sql.ResultSet getProcedureColumns​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern, java.lang.String columnNamePattern)
      Get a description of a catalog's stored procedure parameters and result columns.
      java.sql.ResultSet getProcedureColumnsForODBC​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern, java.lang.String columnNamePattern)
      Get a description of a catalog's stored procedure parameters and result columns.
      java.sql.ResultSet getProcedures​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern)
      Get a description of stored procedures available in a catalog.
      java.sql.ResultSet getProceduresForODBC​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern)
      Get a description of stored procedures available in a catalog.
      java.lang.String getProcedureTerm()
      What's the database vendor's preferred term for "procedure"?
      java.sql.ResultSet getPseudoColumns​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern)
      See DatabaseMetaData javadoc.
      private java.util.Properties getQueryDescriptions​(boolean net)
      Return all queries found in either metadata.properties or metadata_net.properties.
      private java.lang.String getQueryFromDescription​(java.lang.String queryName, boolean net)
      Given a queryName, find closest match in queryDescriptions.
      int getResultSetHoldability()
      JDBC 3.0 Retrieves the default holdability of this ResultSet object.
      java.sql.RowIdLifetime getRowIdLifetime()  
      java.sql.ResultSet getSchemas()
      Get the schema names available in this database.
      java.sql.ResultSet getSchemas​(java.lang.String catalog, java.lang.String schemaPattern)
      JDBC 4.0
      java.lang.String getSchemaTerm()
      What's the database vendor's preferred term for "schema"?
      java.lang.String getSearchStringEscape()
      This is the string that can be used to escape '_' or '%' in the string pattern style catalog search parameters.
      protected java.sql.ResultSet getSimpleQuery​(java.lang.String nameKey)
      Execute a query in metadata.properties, or an SPS in the SYS schema.
      private java.sql.ResultSet getSimpleQuery​(java.lang.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).
      java.lang.String getSQLKeywords()
      Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
      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.
      java.lang.String getStringFunctions()
      Get a comma separated list of JDBC escaped string functions.
      java.sql.ResultSet getSuperTables​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typeNamePattern)
      JDBC 3.0 Retrieves a description of the table hierarchies defined in a particular schema in this database.
      java.sql.ResultSet getSuperTypes​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typeNamePattern)
      JDBC 3.0 Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
      java.lang.String getSystemFunctions()
      Get a comma separated list of JDBC escaped system functions.
      java.sql.ResultSet getTablePrivileges​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern)
      Get a description of the access rights for each table available in a catalog.
      java.sql.ResultSet getTables​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String[] types)
      Get a description of tables available in a catalog.
      java.sql.ResultSet getTableTypes()
      Get the table types available in this database.
      java.lang.String getTimeDateFunctions()
      Get a comma separated list of JDBC escaped time date functions.
      java.sql.ResultSet getTypeInfo()
      Get a description of all the standard SQL types supported by this database.
      java.sql.ResultSet getTypeInfoForODBC()
      Get a description of all the standard SQL types supported by this database.
      private java.sql.ResultSet getTypeInfoMinion​(java.lang.String queryName)
      Get a description of the standard SQL types supported by this database.
      java.sql.ResultSet getUDTs​(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String typeNamePattern, int[] types)
      JDBC 2.0 Get a description of the user-defined types defined in a particular schema.
      java.lang.String getURL()
      What's the url for this database?
      java.lang.String getUserName()
      What's our user name as known to the database?
      java.sql.ResultSet getVersionColumns​(java.lang.String catalog, java.lang.String schema, java.lang.String table)
      Get a description of a table's columns that are automatically updated when any value in a row is updated.
      java.sql.ResultSet getVersionColumnsForODBC​(java.lang.String catalog, java.lang.String schema, java.lang.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 isCatalogAtStart()
      Does a catalog appear at the start of a qualified table name?
      boolean isReadOnly()
      Is the database in read-only mode?
      boolean isWrapperFor​(java.lang.Class<?> iface)
      Returns whether or not this instance implements the specified interface.
      private void loadQueryDescriptions()
      Loads the query descriptions from metadata.properties and metadata_net.properties into queryDescriptions and queryDescriptions_net.
      boolean locatorsUpdateCopy()
      JDBC 3.0 Indicates whether updates made to a LOB are made on a copy or directly to the LOB.
      private boolean notInSoftUpgradeMode()
      check if the dictionary is at the same version as the engine.
      boolean nullPlusNonNullIsNull()
      Are concatenations between NULL and non-NULL values NULL?
      boolean nullsAreSortedAtEnd()
      Are NULL values sorted at the end regardless of sort order?
      boolean nullsAreSortedAtStart()
      Are NULL values sorted at the start regardless of sort order?
      boolean nullsAreSortedHigh()
      Are NULL values sorted high?
      boolean nullsAreSortedLow()
      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 PBloadQueryDescriptions()
      Read the query descriptions from metadata.properties and metadata_net.properties.
      private java.sql.PreparedStatement prepareSPS​(java.lang.String spsName, java.lang.String spsText, boolean net)  
      java.lang.Object run()
      Performs a privileged action.
      boolean storesLowerCaseIdentifiers()
      Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?
      boolean storesLowerCaseQuotedIdentifiers()
      Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?
      boolean storesMixedCaseIdentifiers()
      Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?
      boolean storesMixedCaseQuotedIdentifiers()
      Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?
      boolean storesUpperCaseIdentifiers()
      Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?
      boolean storesUpperCaseQuotedIdentifiers()
      Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?
      boolean supportsAlterTableWithAddColumn()
      Is "ALTER TABLE" with add column supported?
      boolean supportsAlterTableWithDropColumn()
      Is "ALTER TABLE" with drop column supported?
      boolean supportsANSI92EntryLevelSQL()
      Is the ANSI92 entry level SQL grammar supported?
      boolean supportsANSI92FullSQL()
      Is the ANSI92 full SQL grammar supported?
      boolean supportsANSI92IntermediateSQL()
      Is the ANSI92 intermediate SQL grammar supported?
      boolean supportsBatchUpdates()
      JDBC 2.0 Return true if the driver supports batch updates, else return false.
      boolean supportsCatalogsInDataManipulation()
      Can a catalog name be used in a data manipulation statement?
      boolean supportsCatalogsInIndexDefinitions()
      Can a catalog name be used in an index definition statement?
      boolean supportsCatalogsInPrivilegeDefinitions()
      Can a catalog name be used in a privilege definition statement?
      boolean supportsCatalogsInProcedureCalls()
      Can a catalog name be used in a procedure call statement?
      boolean supportsCatalogsInTableDefinitions()
      Can a catalog name be used in a table definition statement?
      boolean supportsColumnAliasing()
      Is column aliasing supported?
      boolean supportsConvert()
      Is the CONVERT function between SQL types supported?
      boolean supportsConvert​(int fromType, int toType)
      Is CONVERT between the given SQL types supported?
      boolean supportsCoreSQLGrammar()
      Is the ODBC Core SQL grammar supported?
      boolean supportsCorrelatedSubqueries()
      Are correlated subqueries supported?
      boolean supportsDataDefinitionAndDataManipulationTransactions()
      Are both data definition and data manipulation statements within a transaction supported?
      boolean supportsDataManipulationTransactionsOnly()
      Are only data manipulation statements within a transaction supported?
      boolean supportsDifferentTableCorrelationNames()
      If table correlation names are supported, are they restricted to be different from the names of the tables?
      boolean supportsExpressionsInOrderBy()
      Are expressions in "ORDER BY" lists supported?
      boolean supportsExtendedSQLGrammar()
      Is the ODBC Extended SQL grammar supported?
      boolean supportsFullOuterJoins()
      Are full nested outer joins supported?
      boolean supportsGetGeneratedKeys()
      JDBC 3.0 Retrieves whether auto-generated keys can be retrieved after a statement has been executed.
      boolean supportsGroupBy()
      Is some form of "GROUP BY" clause supported?
      boolean supportsGroupByBeyondSelect()
      Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?
      boolean supportsGroupByUnrelated()
      Can a "GROUP BY" clause use columns not in the SELECT?
      boolean supportsIntegrityEnhancementFacility()
      Is the SQL Integrity Enhancement Facility supported?
      boolean supportsLikeEscapeClause()
      Is the escape character in "LIKE" clauses supported?
      boolean supportsLimitedOuterJoins()
      Is there limited support for outer joins?
      boolean supportsMinimumSQLGrammar()
      Is the ODBC Minimum SQL grammar supported?
      boolean supportsMixedCaseIdentifiers()
      Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case?
      boolean supportsMixedCaseQuotedIdentifiers()
      Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case?
      boolean supportsMultipleOpenResults()
      JDBC 3.0 Retrieves whether it is possible to have multiple ResultSet objects returned from a CallableStatement object simultaneously.
      boolean supportsMultipleResultSets()
      Are multiple ResultSets from a single execute supported?
      boolean supportsMultipleTransactions()
      Can we have multiple transactions open at once (on different connections)?
      boolean supportsNamedParameters()
      JDBC 3.0 Retrieves whether this database supports named parameters to callable statements.
      boolean supportsNonNullableColumns()
      Can columns be defined as non-nullable?
      boolean supportsOpenCursorsAcrossCommit()
      Can cursors remain open across commits?
      boolean supportsOpenCursorsAcrossRollback()
      Can cursors remain open across rollbacks?
      boolean supportsOpenStatementsAcrossCommit()
      Can statements remain open across commits?
      boolean supportsOpenStatementsAcrossRollback()
      Can statements remain open across rollbacks?
      boolean supportsOrderByUnrelated()
      Can an "ORDER BY" clause use columns not in the SELECT?
      boolean supportsOuterJoins()
      Is some form of outer join supported?
      boolean supportsPositionedDelete()
      Is positioned DELETE supported?
      boolean supportsPositionedUpdate()
      Is positioned UPDATE supported?
      boolean supportsRefCursors()
      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 supportsSavepoints()
      JDBC 3.0 Retrieves whether this database supports savepoints.
      boolean supportsSchemasInDataManipulation()
      Can a schema name be used in a data manipulation statement?
      boolean supportsSchemasInIndexDefinitions()
      Can a schema name be used in an index definition statement?
      boolean supportsSchemasInPrivilegeDefinitions()
      Can a schema name be used in a privilege definition statement?
      boolean supportsSchemasInProcedureCalls()
      Can a schema name be used in a procedure call statement?
      boolean supportsSchemasInTableDefinitions()
      Can a schema name be used in a table definition statement?
      boolean supportsSelectForUpdate()
      Is SELECT for UPDATE supported?
      boolean supportsStatementPooling()
      JDBC 3.0 Retrieves whether this database supports statement pooling.
      boolean supportsStoredFunctionsUsingCallSyntax()  
      boolean supportsStoredProcedures()
      Are stored procedure calls using the stored procedure escape syntax supported?
      boolean supportsSubqueriesInComparisons()
      Are subqueries in comparison expressions supported?
      boolean supportsSubqueriesInExists()
      Are subqueries in 'exists' expressions supported?
      boolean supportsSubqueriesInIns()
      Are subqueries in 'in' statements supported?
      boolean supportsSubqueriesInQuantifieds()
      Are subqueries in quantified expressions supported?
      boolean supportsTableCorrelationNames()
      Are table correlation names supported?
      boolean supportsTransactionIsolationLevel​(int level)
      Does the database support the given transaction isolation level?
      boolean supportsTransactions()
      Are transactions supported?
      boolean supportsUnion()
      Is SQL UNION supported?
      boolean supportsUnionAll()
      Is SQL UNION ALL supported?
      protected static java.lang.String swapNull​(java.lang.String s)  
      <T> T unwrap​(java.lang.Class<T> iface)
      Returns this 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 usesLocalFilePerTable()
      Does the database use a file for each table?
      boolean usesLocalFiles()
      Does the database store tables in a local file?
      • 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 Detail

      • url

        private final java.lang.String url
      • queryDescriptions

        private static java.util.Properties queryDescriptions
        Cached query descriptions from metadata.properties.
      • queryDescriptions_net

        private static java.util.Properties queryDescriptions_net
        Cached query descriptions from metadata_net.properties.
    • Constructor Detail

      • EmbedDatabaseMetaData

        public EmbedDatabaseMetaData​(EmbedConnection connection,
                                     java.lang.String url)
                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException - on error
    • Method Detail

      • getQueryDescriptions

        private java.util.Properties getQueryDescriptions​(boolean net)
        Return all queries found in either metadata.properties or metadata_net.properties.
        Parameters:
        net - if true, 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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • getURL

        public final java.lang.String getURL()
        What's the url for this database?
        Specified by:
        getURL in interface java.sql.DatabaseMetaData
        Returns:
        the url or null if it can't be generated
      • getUserName

        public java.lang.String getUserName()
        What's our user name as known to the database?
        Specified by:
        getUserName in interface java.sql.DatabaseMetaData
        Returns:
        our database user name
      • isReadOnly

        public boolean isReadOnly()
        Is the database in read-only mode?
        Specified by:
        isReadOnly in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • nullsAreSortedHigh

        public boolean nullsAreSortedHigh()
        Are NULL values sorted high?
        Specified by:
        nullsAreSortedHigh in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • nullsAreSortedLow

        public boolean nullsAreSortedLow()
        Are NULL values sorted low?
        Specified by:
        nullsAreSortedLow in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • nullsAreSortedAtStart

        public boolean nullsAreSortedAtStart()
        Are NULL values sorted at the start regardless of sort order?
        Specified by:
        nullsAreSortedAtStart in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • nullsAreSortedAtEnd

        public boolean nullsAreSortedAtEnd()
        Are NULL values sorted at the end regardless of sort order?
        Specified by:
        nullsAreSortedAtEnd in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • getDatabaseProductName

        public java.lang.String getDatabaseProductName()
        What's the name of this database product?
        Specified by:
        getDatabaseProductName in interface java.sql.DatabaseMetaData
        Returns:
        database product name
      • getDatabaseProductVersion

        public java.lang.String getDatabaseProductVersion()
        What's the version of this database product?
        Specified by:
        getDatabaseProductVersion in interface java.sql.DatabaseMetaData
        Returns:
        database version
      • getDriverName

        public java.lang.String getDriverName()
        What's the name of this JDBC driver?
        Specified by:
        getDriverName in interface java.sql.DatabaseMetaData
        Returns:
        JDBC driver name
      • getDriverVersion

        public java.lang.String getDriverVersion()
        What's the version of this JDBC driver?
        Specified by:
        getDriverVersion in interface java.sql.DatabaseMetaData
        Returns:
        JDBC driver version
      • getDriverMajorVersion

        public int getDriverMajorVersion()
        What's this JDBC driver's major version number?
        Specified by:
        getDriverMajorVersion in interface java.sql.DatabaseMetaData
        Returns:
        JDBC driver major version
      • getDriverMinorVersion

        public int getDriverMinorVersion()
        What's this JDBC driver's minor version number?
        Specified by:
        getDriverMinorVersion in interface java.sql.DatabaseMetaData
        Returns:
        JDBC driver minor version number
      • usesLocalFiles

        public boolean usesLocalFiles()
        Does the database store tables in a local file?
        Specified by:
        usesLocalFiles in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • usesLocalFilePerTable

        public boolean usesLocalFilePerTable()
        Does the database use a file for each table?
        Specified by:
        usesLocalFilePerTable in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • getIdentifierQuoteString

        public java.lang.String 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 interface java.sql.DatabaseMetaData
        Returns:
        the quoting string
      • getSQLKeywords

        public java.lang.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 interface java.sql.DatabaseMetaData
        Returns:
        the list
      • getNumericFunctions

        public java.lang.String 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 interface java.sql.DatabaseMetaData
        Returns:
        the list
      • getStringFunctions

        public java.lang.String 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 interface java.sql.DatabaseMetaData
        Returns:
        the list
      • getSystemFunctions

        public java.lang.String 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 interface java.sql.DatabaseMetaData
        Returns:
        the list
      • getTimeDateFunctions

        public java.lang.String 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 interface java.sql.DatabaseMetaData
        Returns:
        the list
      • getSearchStringEscape

        public java.lang.String 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 line

        The '_' character represents any single character.

        The '%' character represents any sequence of zero or more characters.

        Specified by:
        getSearchStringEscape in interface java.sql.DatabaseMetaData
        Returns:
        the string used to escape wildcard characters
      • getExtraNameCharacters

        public java.lang.String 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 interface java.sql.DatabaseMetaData
        Returns:
        the string containing the extra characters
      • supportsAlterTableWithAddColumn

        public boolean supportsAlterTableWithAddColumn()
        Is "ALTER TABLE" with add column supported?
        Specified by:
        supportsAlterTableWithAddColumn in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsAlterTableWithDropColumn

        public boolean supportsAlterTableWithDropColumn()
        Is "ALTER TABLE" with drop column supported?
        Specified by:
        supportsAlterTableWithDropColumn in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsConvert

        public boolean supportsConvert()
        Is the CONVERT function between SQL types supported?
        Specified by:
        supportsConvert in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsConvert

        public boolean supportsConvert​(int fromType,
                                       int toType)
        Is CONVERT between the given SQL types supported?
        Specified by:
        supportsConvert in interface java.sql.DatabaseMetaData
        Parameters:
        fromType - the type to convert from
        toType - the type to convert to
        Returns:
        true if so
        See Also:
        Types
      • supportsTableCorrelationNames

        public boolean supportsTableCorrelationNames()
        Are table correlation names supported? A JDBC-Compliant driver always returns true.
        Specified by:
        supportsTableCorrelationNames in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsExpressionsInOrderBy

        public boolean supportsExpressionsInOrderBy()
        Are expressions in "ORDER BY" lists supported?
        Specified by:
        supportsExpressionsInOrderBy in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsOrderByUnrelated

        public boolean supportsOrderByUnrelated()
        Can an "ORDER BY" clause use columns not in the SELECT?
        Specified by:
        supportsOrderByUnrelated in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsGroupBy

        public boolean supportsGroupBy()
        Is some form of "GROUP BY" clause supported?
        Specified by:
        supportsGroupBy in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsGroupByUnrelated

        public boolean supportsGroupByUnrelated()
        Can a "GROUP BY" clause use columns not in the SELECT?
        Specified by:
        supportsGroupByUnrelated in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsMultipleResultSets

        public boolean supportsMultipleResultSets()
        Are multiple ResultSets from a single execute supported?
        Specified by:
        supportsMultipleResultSets in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsMultipleTransactions

        public boolean supportsMultipleTransactions()
        Can we have multiple transactions open at once (on different connections)?
        Specified by:
        supportsMultipleTransactions in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCoreSQLGrammar

        public boolean supportsCoreSQLGrammar()
        Is the ODBC Core SQL grammar supported?
        Specified by:
        supportsCoreSQLGrammar in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsExtendedSQLGrammar

        public boolean supportsExtendedSQLGrammar()
        Is the ODBC Extended SQL grammar supported?
        Specified by:
        supportsExtendedSQLGrammar in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsANSI92IntermediateSQL

        public boolean supportsANSI92IntermediateSQL()
        Is the ANSI92 intermediate SQL grammar supported?
        Specified by:
        supportsANSI92IntermediateSQL in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsANSI92FullSQL

        public boolean supportsANSI92FullSQL()
        Is the ANSI92 full SQL grammar supported?
        Specified by:
        supportsANSI92FullSQL in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsIntegrityEnhancementFacility

        public boolean supportsIntegrityEnhancementFacility()
        Is the SQL Integrity Enhancement Facility supported?
        Specified by:
        supportsIntegrityEnhancementFacility in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsOuterJoins

        public boolean supportsOuterJoins()
        Is some form of outer join supported?
        Specified by:
        supportsOuterJoins in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsFullOuterJoins

        public boolean supportsFullOuterJoins()
        Are full nested outer joins supported?
        Specified by:
        supportsFullOuterJoins in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • getSchemaTerm

        public java.lang.String getSchemaTerm()
        What's the database vendor's preferred term for "schema"?
        Specified by:
        getSchemaTerm in interface java.sql.DatabaseMetaData
        Returns:
        the vendor term
      • getProcedureTerm

        public java.lang.String getProcedureTerm()
        What's the database vendor's preferred term for "procedure"?
        Specified by:
        getProcedureTerm in interface java.sql.DatabaseMetaData
        Returns:
        the vendor term
      • getCatalogTerm

        public java.lang.String getCatalogTerm()
        What's the database vendor's preferred term for "catalog"?
        Specified by:
        getCatalogTerm in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if it appears at the start
      • getCatalogSeparator

        public java.lang.String getCatalogSeparator()
        What's the separator between catalog and table name?
        Specified by:
        getCatalogSeparator in interface java.sql.DatabaseMetaData
        Returns:
        the separator string
      • supportsSchemasInDataManipulation

        public boolean supportsSchemasInDataManipulation()
        Can a schema name be used in a data manipulation statement?
        Specified by:
        supportsSchemasInDataManipulation in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsSchemasInProcedureCalls

        public boolean supportsSchemasInProcedureCalls()
        Can a schema name be used in a procedure call statement?
        Specified by:
        supportsSchemasInProcedureCalls in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsSchemasInTableDefinitions

        public boolean supportsSchemasInTableDefinitions()
        Can a schema name be used in a table definition statement?
        Specified by:
        supportsSchemasInTableDefinitions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsSchemasInIndexDefinitions

        public boolean supportsSchemasInIndexDefinitions()
        Can a schema name be used in an index definition statement?
        Specified by:
        supportsSchemasInIndexDefinitions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsSchemasInPrivilegeDefinitions

        public boolean supportsSchemasInPrivilegeDefinitions()
        Can a schema name be used in a privilege definition statement?
        Specified by:
        supportsSchemasInPrivilegeDefinitions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCatalogsInDataManipulation

        public boolean supportsCatalogsInDataManipulation()
        Can a catalog name be used in a data manipulation statement?
        Specified by:
        supportsCatalogsInDataManipulation in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCatalogsInProcedureCalls

        public boolean supportsCatalogsInProcedureCalls()
        Can a catalog name be used in a procedure call statement?
        Specified by:
        supportsCatalogsInProcedureCalls in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCatalogsInTableDefinitions

        public boolean supportsCatalogsInTableDefinitions()
        Can a catalog name be used in a table definition statement?
        Specified by:
        supportsCatalogsInTableDefinitions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCatalogsInIndexDefinitions

        public boolean supportsCatalogsInIndexDefinitions()
        Can a catalog name be used in an index definition statement?
        Specified by:
        supportsCatalogsInIndexDefinitions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCatalogsInPrivilegeDefinitions

        public boolean supportsCatalogsInPrivilegeDefinitions()
        Can a catalog name be used in a privilege definition statement?
        Specified by:
        supportsCatalogsInPrivilegeDefinitions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsPositionedDelete

        public boolean supportsPositionedDelete()
        Is positioned DELETE supported?
        Specified by:
        supportsPositionedDelete in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsPositionedUpdate

        public boolean supportsPositionedUpdate()
        Is positioned UPDATE supported?
        Specified by:
        supportsPositionedUpdate in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsSelectForUpdate

        public boolean supportsSelectForUpdate()
        Is SELECT for UPDATE supported?
        Specified by:
        supportsSelectForUpdate in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsStoredProcedures

        public boolean supportsStoredProcedures()
        Are stored procedure calls using the stored procedure escape syntax supported?
        Specified by:
        supportsStoredProcedures in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsCorrelatedSubqueries

        public boolean supportsCorrelatedSubqueries()
        Are correlated subqueries supported? A JDBC-Compliant driver always returns true.
        Specified by:
        supportsCorrelatedSubqueries in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsUnion

        public boolean supportsUnion()
        Is SQL UNION supported?
        Specified by:
        supportsUnion in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsUnionAll

        public boolean supportsUnionAll()
        Is SQL UNION ALL supported?
        Specified by:
        supportsUnionAll in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsOpenCursorsAcrossCommit

        public boolean supportsOpenCursorsAcrossCommit()
        Can cursors remain open across commits?
        Specified by:
        supportsOpenCursorsAcrossCommit in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        max literal length
      • getMaxCharLiteralLength

        public int getMaxCharLiteralLength()
        What's the max length for a character literal?
        Specified by:
        getMaxCharLiteralLength in interface java.sql.DatabaseMetaData
        Returns:
        max literal length
      • getMaxColumnNameLength

        public int getMaxColumnNameLength()
        What's the limit on column name length?
        Specified by:
        getMaxColumnNameLength in interface java.sql.DatabaseMetaData
        Returns:
        max literal length
      • getMaxColumnsInGroupBy

        public int getMaxColumnsInGroupBy()
        What's the maximum number of columns in a "GROUP BY" clause?
        Specified by:
        getMaxColumnsInGroupBy in interface java.sql.DatabaseMetaData
        Returns:
        max number of columns
      • getMaxColumnsInIndex

        public int getMaxColumnsInIndex()
        What's the maximum number of columns allowed in an index?
        Specified by:
        getMaxColumnsInIndex in interface java.sql.DatabaseMetaData
        Returns:
        max columns
      • getMaxColumnsInOrderBy

        public int getMaxColumnsInOrderBy()
        What's the maximum number of columns in an "ORDER BY" clause?
        Specified by:
        getMaxColumnsInOrderBy in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        max columns
      • getMaxColumnsInTable

        public int getMaxColumnsInTable()
        What's the maximum number of columns in a table?
        Specified by:
        getMaxColumnsInTable in interface java.sql.DatabaseMetaData
        Returns:
        max columns
      • getMaxConnections

        public int getMaxConnections()
        How many active connections can we have at a time to this database?
        Specified by:
        getMaxConnections in interface java.sql.DatabaseMetaData
        Returns:
        max connections
      • getMaxCursorNameLength

        public int getMaxCursorNameLength()
        What's the maximum cursor name length?
        Specified by:
        getMaxCursorNameLength in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        max index length in bytes
      • getMaxSchemaNameLength

        public int getMaxSchemaNameLength()
        What's the maximum length allowed for a schema name?
        Specified by:
        getMaxSchemaNameLength in interface java.sql.DatabaseMetaData
        Returns:
        max name length in bytes
      • getMaxProcedureNameLength

        public int getMaxProcedureNameLength()
        What's the maximum length of a procedure name?
        Specified by:
        getMaxProcedureNameLength in interface java.sql.DatabaseMetaData
        Returns:
        max name length in bytes
      • getMaxCatalogNameLength

        public int getMaxCatalogNameLength()
        What's the maximum length of a catalog name?
        Specified by:
        getMaxCatalogNameLength in interface java.sql.DatabaseMetaData
        Returns:
        max name length in bytes
      • getMaxRowSize

        public int getMaxRowSize()
        What's the maximum length of a single row?
        Specified by:
        getMaxRowSize in interface java.sql.DatabaseMetaData
        Returns:
        max row size in bytes
      • doesMaxRowSizeIncludeBlobs

        public boolean doesMaxRowSizeIncludeBlobs()
        Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
        Specified by:
        doesMaxRowSizeIncludeBlobs in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • getMaxStatementLength

        public int getMaxStatementLength()
        What's the maximum length of a SQL statement?
        Specified by:
        getMaxStatementLength in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        the maximum
      • getMaxTableNameLength

        public int getMaxTableNameLength()
        What's the maximum length of a table name?
        Specified by:
        getMaxTableNameLength in interface java.sql.DatabaseMetaData
        Returns:
        max name length in bytes
      • getMaxTablesInSelect

        public int getMaxTablesInSelect()
        What's the maximum number of tables in a SELECT?
        Specified by:
        getMaxTablesInSelect in interface java.sql.DatabaseMetaData
        Returns:
        the maximum
      • getMaxUserNameLength

        public int getMaxUserNameLength()
        What's the maximum length of a user name?
        Specified by:
        getMaxUserNameLength in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        the default isolation level
        See Also:
        Connection
      • supportsTransactions

        public boolean supportsTransactions()
        Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.
        Specified by:
        supportsTransactions in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Parameters:
        level - the values are defined in java.sql.Connection
        Returns:
        true if so
        See Also:
        Connection
      • supportsDataDefinitionAndDataManipulationTransactions

        public boolean supportsDataDefinitionAndDataManipulationTransactions()
        Are both data definition and data manipulation statements within a transaction supported?
        Specified by:
        supportsDataDefinitionAndDataManipulationTransactions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • supportsDataManipulationTransactionsOnly

        public boolean supportsDataManipulationTransactionsOnly()
        Are only data manipulation statements within a transaction supported?
        Specified by:
        supportsDataManipulationTransactionsOnly in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • dataDefinitionIgnoredInTransactions

        public boolean dataDefinitionIgnoredInTransactions()
        Is a data definition statement within a transaction ignored?
        Specified by:
        dataDefinitionIgnoredInTransactions in interface java.sql.DatabaseMetaData
        Returns:
        true if so
      • getProcedures

        public java.sql.ResultSet getProcedures​(java.lang.String catalog,
                                                java.lang.String schemaPattern,
                                                java.lang.String procedureNamePattern)
                                         throws java.sql.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:

        1. PROCEDURE_CAT String => procedure catalog (may be null)
        2. PROCEDURE_SCHEM String => procedure schema (may be null)
        3. PROCEDURE_NAME String => procedure name
        4. reserved for future use
        5. reserved for future use
        6. reserved for future use
        7. REMARKS String => explanatory comment on the procedure
        8. PROCEDURE_TYPE short => kind of procedure:
          • procedureResultUnknown - May return a result
          • procedureNoResult - Does not return a result
          • procedureReturnsResult - Returns a result
        9. SPECIFIC_NAME String => The name which uniquely identifies this procedure within its schema (since JDBC 4.0)
        Specified by:
        getProcedures in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name pattern; "" retrieves those without a schema
        procedureNamePattern - a procedure name pattern
        Returns:
        ResultSet - each row is a procedure description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getSearchStringEscape()
      • getProceduresForODBC

        public java.sql.ResultSet getProceduresForODBC​(java.lang.String catalog,
                                                       java.lang.String schemaPattern,
                                                       java.lang.String procedureNamePattern)
                                                throws java.sql.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:
        java.sql.SQLException
      • getFunctions

        public java.sql.ResultSet getFunctions​(java.lang.String catalog,
                                               java.lang.String schemaPattern,
                                               java.lang.String functionNamePattern)
                                        throws java.sql.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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - limit the search to functions in this catalog (not used)
        schemaPattern - limit the search to functions in schemas matching this pattern
        functionNamePattern - limit the search to functions matching this pattern
        Returns:
        a ResultSet with metadata information
        Throws:
        java.sql.SQLException - if any of the underlying jdbc methods fail
      • doGetProcs

        private java.sql.ResultSet doGetProcs​(java.lang.String catalog,
                                              java.lang.String schemaPattern,
                                              java.lang.String procedureNamePattern,
                                              java.lang.String queryName)
                                       throws java.sql.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:
        java.sql.SQLException
      • getProcedureColumns

        public java.sql.ResultSet getProcedureColumns​(java.lang.String catalog,
                                                      java.lang.String schemaPattern,
                                                      java.lang.String procedureNamePattern,
                                                      java.lang.String columnNamePattern)
                                               throws java.sql.SQLException
        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:

        1. PROCEDURE_CAT String => procedure catalog (may be null)
        2. PROCEDURE_SCHEM String => procedure schema (may be null)
        3. PROCEDURE_NAME String => procedure name
        4. COLUMN_NAME String => column/parameter name
        5. 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
        6. DATA_TYPE int => SQL type from java.sql.Types
        7. TYPE_NAME String => SQL type name
        8. PRECISION int => precision
        9. LENGTH int => length in bytes of data
        10. SCALE short => scale
        11. RADIX short => radix
        12. NULLABLE short => can it contain NULL?
          • procedureNoNulls - does not allow NULL values
          • procedureNullable - allows NULL values
          • procedureNullableUnknown - nullability unknown
        13. REMARKS String => comment describing parameter/column
        14. COLUMN_DEF String
        15. SQL_DATA_TYPE int
        16. SQL_DATETIME_SUB int
        17. CHAR_OCTET_LENGTH int
        18. ORDINAL_POSITION int
        19. IS_NULLABLE String
        20. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name pattern; "" retrieves those without a schema
        procedureNamePattern - a procedure name pattern
        columnNamePattern - a column name pattern
        Returns:
        ResultSet - each row is a stored procedure parameter or column description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getSearchStringEscape()
      • getProcedureColumnsForODBC

        public java.sql.ResultSet getProcedureColumnsForODBC​(java.lang.String catalog,
                                                             java.lang.String schemaPattern,
                                                             java.lang.String procedureNamePattern,
                                                             java.lang.String columnNamePattern)
                                                      throws java.sql.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:
        java.sql.SQLException
      • getFunctionColumns

        public java.sql.ResultSet getFunctionColumns​(java.lang.String catalog,
                                                     java.lang.String schemaPattern,
                                                     java.lang.String functionNamePattern,
                                                     java.lang.String parameterNamePattern)
                                              throws java.sql.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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - limit the search to functions in this catalog (not used)
        schemaPattern - limit the search to functions in schemas matching this pattern
        functionNamePattern - limit the search to functions matching this pattern
        parameterNamePattern - limit the search parameters matching this pattern
        Returns:
        a ResultSet with metadata information
        Throws:
        java.sql.SQLException - if a database error occurs
      • doGetProcCols

        private java.sql.ResultSet doGetProcCols​(java.lang.String catalog,
                                                 java.lang.String schemaPattern,
                                                 java.lang.String procedureNamePattern,
                                                 java.lang.String columnNamePattern,
                                                 java.lang.String queryName)
                                          throws java.sql.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:
        java.sql.SQLException
      • getTables

        public java.sql.ResultSet getTables​(java.lang.String catalog,
                                            java.lang.String schemaPattern,
                                            java.lang.String tableNamePattern,
                                            java.lang.String[] types)
                                     throws java.sql.SQLException
        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:

        1. TABLE_CAT String => table catalog (may be null)
        2. TABLE_SCHEM String => table schema (may be null)
        3. TABLE_NAME String => table name
        4. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
        5. REMARKS String => explanatory comment on the table
        6. TYPE_CAT String => the types catalog (may be null)
        7. TYPE_SCHEM String => the types schema (may be null)
        8. TYPE_NAME String => type name (may be null)
        9. SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
        10. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name pattern; "" retrieves those without a schema
        tableNamePattern - a table name pattern
        types - a list of table types to include; null returns all types
        Returns:
        ResultSet - each row is a table description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getSearchStringEscape()
      • getSchemas

        public java.sql.ResultSet getSchemas()
                                      throws java.sql.SQLException
        Get the schema names available in this database. The results are ordered by schema name.

        The schema columns are:

        1. TABLE_SCHEM String => schema name
        2. TABLE_CATALOG String => catalog name (may be null)
        Specified by:
        getSchemas in interface java.sql.DatabaseMetaData
        Returns:
        ResultSet - each row is a schema description
        Throws:
        java.sql.SQLException - thrown on failure.
      • getCatalogs

        public java.sql.ResultSet getCatalogs()
                                       throws java.sql.SQLException
        Get the catalog names available in this database. The results are ordered by catalog name.

        The catalog column is:

        1. TABLE_CAT String => catalog name
        Specified by:
        getCatalogs in interface java.sql.DatabaseMetaData
        Returns:
        ResultSet - each row has a single String column that is a catalog name
        Throws:
        java.sql.SQLException - thrown on failure.
      • getTableTypes

        public java.sql.ResultSet getTableTypes()
                                         throws java.sql.SQLException
        Get the table types available in this database. The results are ordered by table type.

        The table type is:

        1. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
        Specified by:
        getTableTypes in interface java.sql.DatabaseMetaData
        Returns:
        ResultSet - each row has a single String column that is a table type
        Throws:
        java.sql.SQLException - thrown on failure.
      • getColumns

        public java.sql.ResultSet getColumns​(java.lang.String catalog,
                                             java.lang.String schemaPattern,
                                             java.lang.String tableNamePattern,
                                             java.lang.String columnNamePattern)
                                      throws java.sql.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:

        1. TABLE_CAT String => table catalog (may be null)
        2. TABLE_SCHEM String => table schema (may be null)
        3. TABLE_NAME String => table name
        4. COLUMN_NAME String => column name
        5. DATA_TYPE int => SQL type from java.sql.Types
        6. TYPE_NAME String => Data source dependent type name
        7. 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.
        8. BUFFER_LENGTH is not used.
        9. DECIMAL_DIGITS int => the number of fractional digits
        10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
        11. NULLABLE int => is NULL allowed?
          • columnNoNulls - might not allow NULL values
          • columnNullable - definitely allows NULL values
          • columnNullableUnknown - nullability unknown
        12. REMARKS String => comment describing column (may be null)
        13. COLUMN_DEF String => default value (may be null)
        14. SQL_DATA_TYPE int => unused
        15. SQL_DATETIME_SUB int => unused
        16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
        17. ORDINAL_POSITION int => index of column in table (starting at 1)
        18. 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.
        19. SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)
        20. SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)
        21. SCOPE_TABLE String => table name that this the scope of a reference attribure (null if the DATA_TYPE isn't REF)
        22. 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)
        23. 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
        24. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name pattern; "" retrieves those without a schema
        tableNamePattern - a table name pattern
        columnNamePattern - a column name pattern
        Returns:
        ResultSet - each row is a column description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getSearchStringEscape()
      • getColumnsForODBC

        public java.sql.ResultSet getColumnsForODBC​(java.lang.String catalog,
                                                    java.lang.String schemaPattern,
                                                    java.lang.String tableNamePattern,
                                                    java.lang.String columnNamePattern)
                                             throws java.sql.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:
        java.sql.SQLException
      • doGetCols

        private java.sql.ResultSet doGetCols​(java.lang.String catalog,
                                             java.lang.String schemaPattern,
                                             java.lang.String tableNamePattern,
                                             java.lang.String columnNamePattern,
                                             java.lang.String queryName)
                                      throws java.sql.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:
        java.sql.SQLException
      • getColumnPrivileges

        public java.sql.ResultSet getColumnPrivileges​(java.lang.String catalog,
                                                      java.lang.String schema,
                                                      java.lang.String table,
                                                      java.lang.String columnNamePattern)
                                               throws java.sql.SQLException
        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:

        1. TABLE_CAT String => table catalog (may be null)
        2. TABLE_SCHEM String => table schema (may be null)
        3. TABLE_NAME String => table name
        4. COLUMN_NAME String => column name
        5. GRANTOR => grantor of access (may be null)
        6. GRANTEE String => grantee of access
        7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
        8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
        Specified by:
        getColumnPrivileges in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schema - a schema name; "" retrieves those without a schema
        table - a table name
        columnNamePattern - a column name pattern
        Returns:
        ResultSet - each row is a column privilege description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getSearchStringEscape()
      • getTablePrivileges

        public java.sql.ResultSet getTablePrivileges​(java.lang.String catalog,
                                                     java.lang.String schemaPattern,
                                                     java.lang.String tableNamePattern)
                                              throws java.sql.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:

        1. TABLE_CAT String => table catalog (may be null)
        2. TABLE_SCHEM String => table schema (may be null)
        3. TABLE_NAME String => table name
        4. GRANTOR => grantor of access (may be null)
        5. GRANTEE String => grantee of access
        6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
        7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
        Specified by:
        getTablePrivileges in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name pattern; "" retrieves those without a schema
        tableNamePattern - a table name pattern
        Returns:
        ResultSet - each row is a table privilege description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getSearchStringEscape()
      • getBestRowIdentifier

        public java.sql.ResultSet getBestRowIdentifier​(java.lang.String catalogPattern,
                                                       java.lang.String schemaPattern,
                                                       java.lang.String table,
                                                       int scope,
                                                       boolean nullable)
                                                throws java.sql.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:

        1. 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
        2. COLUMN_NAME String => column name
        3. DATA_TYPE int => SQL data type from java.sql.Types
        4. TYPE_NAME String => Data source dependent type name
        5. COLUMN_SIZE int => precision
        6. BUFFER_LENGTH int => not used
        7. DECIMAL_DIGITS short => scale
        8. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalogPattern - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name; "" retrieves those without a schema
        table - a table name
        scope - the scope of interest; use same values as SCOPE
        nullable - include columns that are nullable?
        Returns:
        ResultSet - each row is a column description
        Throws:
        java.sql.SQLException - thrown on failure.
      • getBestRowIdentifierForODBC

        public java.sql.ResultSet getBestRowIdentifierForODBC​(java.lang.String catalogPattern,
                                                              java.lang.String schemaPattern,
                                                              java.lang.String table,
                                                              int scope,
                                                              boolean nullable)
                                                       throws java.sql.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:
        java.sql.SQLException
      • doGetBestRowId

        private java.sql.ResultSet doGetBestRowId​(java.lang.String catalogPattern,
                                                  java.lang.String schemaPattern,
                                                  java.lang.String table,
                                                  int scope,
                                                  boolean nullable,
                                                  java.lang.String queryPrefix)
                                           throws java.sql.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:
        java.sql.SQLException
      • getVersionColumns

        public java.sql.ResultSet getVersionColumns​(java.lang.String catalog,
                                                    java.lang.String schema,
                                                    java.lang.String table)
                                             throws java.sql.SQLException
        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:

        1. SCOPE short => is not used
        2. COLUMN_NAME String => column name
        3. DATA_TYPE int => SQL data type from java.sql.Types
        4. TYPE_NAME String => Data source dependent type name
        5. COLUMN_SIZE int => precision
        6. BUFFER_LENGTH int => length of column value in bytes
        7. DECIMAL_DIGITS short => scale
        8. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schema - a schema name; "" retrieves those without a schema
        table - a table name
        Returns:
        ResultSet - each row is a column description
        Throws:
        java.sql.SQLException - thrown on failure.
      • getVersionColumnsForODBC

        public java.sql.ResultSet getVersionColumnsForODBC​(java.lang.String catalog,
                                                           java.lang.String schema,
                                                           java.lang.String table)
                                                    throws java.sql.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:
        java.sql.SQLException
      • doGetVersionCols

        private java.sql.ResultSet doGetVersionCols​(java.lang.String catalog,
                                                    java.lang.String schema,
                                                    java.lang.String table,
                                                    java.lang.String queryName)
                                             throws java.sql.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:
        java.sql.SQLException
      • notInSoftUpgradeMode

        private boolean notInSoftUpgradeMode()
                                      throws java.sql.SQLException
        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:
        java.sql.SQLException
      • getPrimaryKeys

        public java.sql.ResultSet getPrimaryKeys​(java.lang.String catalog,
                                                 java.lang.String schema,
                                                 java.lang.String table)
                                          throws java.sql.SQLException
        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:

        1. TABLE_CAT String => table catalog (may be null)
        2. TABLE_SCHEM String => table schema (may be null)
        3. TABLE_NAME String => table name
        4. COLUMN_NAME String => column name
        5. KEY_SEQ short => sequence number within primary key
        6. PK_NAME String => primary key name (may be null)
        Specified by:
        getPrimaryKeys in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schema - a schema name pattern; "" retrieves those without a schema
        table - a table name
        Returns:
        ResultSet - each row is a primary key column description
        Throws:
        java.sql.SQLException - thrown on failure.
      • getImportedKeys

        public java.sql.ResultSet getImportedKeys​(java.lang.String catalog,
                                                  java.lang.String schema,
                                                  java.lang.String table)
                                           throws java.sql.SQLException
        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:

        1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
        2. PKTABLE_SCHEM String => primary key table schema being imported (may be null)
        3. PKTABLE_NAME String => primary key table name being imported
        4. PKCOLUMN_NAME String => primary key column name being imported
        5. FKTABLE_CAT String => foreign key table catalog (may be null)
        6. FKTABLE_SCHEM String => foreign key table schema (may be null)
        7. FKTABLE_NAME String => foreign key table name
        8. FKCOLUMN_NAME String => foreign key column name
        9. KEY_SEQ short => sequence number within foreign key
        10. 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)
        11. 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
        12. FK_NAME String => foreign key name (may be null)
        13. PK_NAME String => primary key name (may be null)
        14. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schema - a schema name pattern; "" retrieves those without a schema
        table - a table name
        Returns:
        ResultSet - each row is a primary key column description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getExportedKeys(java.lang.String, java.lang.String, java.lang.String)
      • getExportedKeys

        public java.sql.ResultSet getExportedKeys​(java.lang.String catalog,
                                                  java.lang.String schema,
                                                  java.lang.String table)
                                           throws java.sql.SQLException
        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:

        1. PKTABLE_CAT String => primary key table catalog (may be null)
        2. PKTABLE_SCHEM String => primary key table schema (may be null)
        3. PKTABLE_NAME String => primary key table name
        4. PKCOLUMN_NAME String => primary key column name
        5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
        6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
        7. FKTABLE_NAME String => foreign key table name being exported
        8. FKCOLUMN_NAME String => foreign key column name being exported
        9. KEY_SEQ short => sequence number within foreign key
        10. 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)
        11. 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
        12. FK_NAME String => foreign key name (may be null)
        13. PK_NAME String => primary key name (may be null)
        14. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schema - a schema name pattern; "" retrieves those without a schema
        table - a table name
        Returns:
        ResultSet - each row is a foreign key column description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getImportedKeys(java.lang.String, java.lang.String, java.lang.String)
      • getCrossReference

        public java.sql.ResultSet getCrossReference​(java.lang.String primaryCatalog,
                                                    java.lang.String primarySchema,
                                                    java.lang.String primaryTable,
                                                    java.lang.String foreignCatalog,
                                                    java.lang.String foreignSchema,
                                                    java.lang.String foreignTable)
                                             throws java.sql.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:

        1. PKTABLE_CAT String => primary key table catalog (may be null)
        2. PKTABLE_SCHEM String => primary key table schema (may be null)
        3. PKTABLE_NAME String => primary key table name
        4. PKCOLUMN_NAME String => primary key column name
        5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
        6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
        7. FKTABLE_NAME String => foreign key table name being exported
        8. FKCOLUMN_NAME String => foreign key column name being exported
        9. KEY_SEQ short => sequence number within foreign key
        10. 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)
        11. 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
        12. FK_NAME String => foreign key name (may be null)
        13. PK_NAME String => primary key name (may be null)
        14. 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 interface java.sql.DatabaseMetaData
        Parameters:
        primaryCatalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        primarySchema - a schema name pattern; "" retrieves those without a schema
        primaryTable - the table name that exports the key
        foreignCatalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        foreignSchema - a schema name pattern; "" retrieves those without a schema
        foreignTable - the table name that imports the key
        Returns:
        ResultSet - each row is a foreign key column description
        Throws:
        java.sql.SQLException - thrown on failure.
        See Also:
        getImportedKeys(java.lang.String, java.lang.String, java.lang.String)
      • getCrossReferenceForODBC

        public java.sql.ResultSet getCrossReferenceForODBC​(java.lang.String primaryCatalog,
                                                           java.lang.String primarySchema,
                                                           java.lang.String primaryTable,
                                                           java.lang.String foreignCatalog,
                                                           java.lang.String foreignSchema,
                                                           java.lang.String foreignTable)
                                                    throws java.sql.SQLException
        In contrast to the JDBC version of getCrossReference, this method allows null values for table names.
        Throws:
        java.sql.SQLException
      • getTypeInfo

        public java.sql.ResultSet getTypeInfo()
                                       throws java.sql.SQLException
        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:

        1. TYPE_NAME String => Type name
        2. DATA_TYPE int => SQL data type from java.sql.Types
        3. PRECISION int => maximum precision
        4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
        5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
        6. CREATE_PARAMS String => parameters used in creating the type (may be null)
        7. NULLABLE short => can you use NULL for this type?
          • typeNoNulls - does not allow NULL values
          • typeNullable - allows NULL values
          • typeNullableUnknown - nullability unknown
        8. CASE_SENSITIVE boolean=> is it case sensitive?
        9. 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 ..
        10. UNSIGNED_ATTRIBUTE boolean => is it unsigned?
        11. FIXED_PREC_SCALE boolean => can it be a money value?
        12. AUTO_INCREMENT boolean => can it be used for an auto-increment value?
        13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
        14. MINIMUM_SCALE short => minimum scale supported
        15. MAXIMUM_SCALE short => maximum scale supported
        16. SQL_DATA_TYPE int => unused
        17. SQL_DATETIME_SUB int => unused
        18. NUM_PREC_RADIX int => usually 2 or 10
        Specified by:
        getTypeInfo in interface java.sql.DatabaseMetaData
        Returns:
        ResultSet - each row is a SQL type description
        Throws:
        java.sql.SQLException - thrown on failure.
      • getTypeInfoForODBC

        public java.sql.ResultSet getTypeInfoForODBC()
                                              throws java.sql.SQLException
        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:
        java.sql.SQLException
      • getTypeInfoMinion

        private java.sql.ResultSet getTypeInfoMinion​(java.lang.String queryName)
                                              throws java.sql.SQLException
        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:
        java.sql.SQLException
      • getIndexInfo

        public java.sql.ResultSet getIndexInfo​(java.lang.String catalog,
                                               java.lang.String schema,
                                               java.lang.String table,
                                               boolean unique,
                                               boolean approximate)
                                        throws java.sql.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:

        1. TABLE_CAT String => table catalog (may be null)
        2. TABLE_SCHEM String => table schema (may be null)
        3. TABLE_NAME String => table name
        4. NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
        5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
        6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
        7. 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
        8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
        9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
        10. 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
        11. 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.
        12. 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.
        13. FILTER_CONDITION String => Filter condition, if any. (may be null)
        Specified by:
        getIndexInfo in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schema - a schema name pattern; "" retrieves those without a schema
        table - a table name
        unique - when true, return only indices for unique values; when false, return indices regardless of whether unique or not
        approximate - 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:
        java.sql.SQLException - thrown on failure.
      • getIndexInfoForODBC

        public java.sql.ResultSet getIndexInfoForODBC​(java.lang.String catalog,
                                                      java.lang.String schema,
                                                      java.lang.String table,
                                                      boolean unique,
                                                      boolean approximate)
                                               throws java.sql.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:
        java.sql.SQLException
      • doGetIndexInfo

        private java.sql.ResultSet doGetIndexInfo​(java.lang.String catalog,
                                                  java.lang.String schema,
                                                  java.lang.String table,
                                                  boolean unique,
                                                  boolean approximate,
                                                  java.lang.String queryName)
                                           throws java.sql.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:
        java.sql.SQLException
      • supportsResultSetType

        public boolean supportsResultSetType​(int type)
        JDBC 2.0 Does the database support the given result set type?
        Specified by:
        supportsResultSetType in interface java.sql.DatabaseMetaData
        Parameters:
        type - defined in java.sql.ResultSet
        Returns:
        true if so
        See Also:
        Connection
      • 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 interface java.sql.DatabaseMetaData
        Parameters:
        type - defined in java.sql.ResultSet
        concurrency - type defined in java.sql.ResultSet
        Returns:
        true if so
        See Also:
        Connection
      • ownUpdatesAreVisible

        public boolean ownUpdatesAreVisible​(int type)
        JDBC 2.0 Determine whether a result set's updates are visible.
        Specified by:
        ownUpdatesAreVisible in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
      • getUDTs

        public java.sql.ResultSet getUDTs​(java.lang.String catalog,
                                          java.lang.String schemaPattern,
                                          java.lang.String typeNamePattern,
                                          int[] types)
                                   throws java.sql.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:

        1. TYPE_CAT String => the type's catalog (may be null)
        2. TYPE_SCHEM String => type's schema (may be null)
        3. TYPE_NAME String => type name
        4. CLASS_NAME String => Java class name
        5. DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
        6. REMARKS String => explanatory comment on the type
        7. 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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - a schema name pattern; "" retrieves those without a schema
        typeNamePattern - a type name pattern; may be a fully qualified name
        types - 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:
        java.sql.SQLException - if a database-access error occurs.
      • getConnection

        public java.sql.Connection getConnection()
        JDBC 2.0 Return the connection that produced this metadata object.
        Specified by:
        getConnection in interface java.sql.DatabaseMetaData
      • supportsStatementPooling

        public boolean supportsStatementPooling()
        JDBC 3.0 Retrieves whether this database supports statement pooling.
        Specified by:
        supportsStatementPooling in interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        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 interface java.sql.DatabaseMetaData
        Returns:
        the type of SQLSTATEs, one of: sqlStateXOpen or sqlStateSQL99
      • locatorsUpdateCopy

        public boolean locatorsUpdateCopy()
                                   throws java.sql.SQLException
        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 interface java.sql.DatabaseMetaData
        Returns:
        true if updates are made to a copy of the LOB; false if updates are made directly to the LOB
        Throws:
        java.sql.SQLException - Feature not implemented for now.
      • getSuperTypes

        public java.sql.ResultSet getSuperTypes​(java.lang.String catalog,
                                                java.lang.String schemaPattern,
                                                java.lang.String typeNamePattern)
                                         throws java.sql.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 interface java.sql.DatabaseMetaData
        Parameters:
        catalog - - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - - a schema name pattern; "" retrieves those without a schema
        typeNamePattern - - 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:
        java.sql.SQLException - Feature not implemented for now.
      • getSuperTables

        public java.sql.ResultSet getSuperTables​(java.lang.String catalog,
                                                 java.lang.String schemaPattern,
                                                 java.lang.String typeNamePattern)
                                          throws java.sql.SQLException
        JDBC 3.0 Retrieves a description of the table hierarchies defined in a particular schema in this database.
        Specified by:
        getSuperTables in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
        schemaPattern - - a schema name pattern; "" retrieves those without a schema
        typeNamePattern - - a UDT name pattern; may be a fully-qualified name
        Returns:
        a ResultSet object in which each row is a type description
        Throws:
        java.sql.SQLException - if a database access error occurs
      • getAttributes

        public java.sql.ResultSet getAttributes​(java.lang.String catalog,
                                                java.lang.String schemaPattern,
                                                java.lang.String typeNamePattern,
                                                java.lang.String attributeNamePattern)
                                         throws java.sql.SQLException
        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 interface java.sql.DatabaseMetaData
        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 search
        schemaPattern - - a schema name pattern; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
        typeNamePattern - - a type name pattern; must match the type name as it is stored in the database
        attributeNamePattern - - 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:
        java.sql.SQLException - if a database access error occurs.
      • getClientInfoProperties

        public java.sql.ResultSet getClientInfoProperties()
                                                   throws java.sql.SQLException
        JDBC 4.0

        Returns a list of the client info properties supported by the driver. The result set contains the following columns:

        1. NAME String=> The name of the client info property.
        2. MAX_LEN int=> The maximum length of the value for the property.
        3. DEFAULT_VALUE String=> The default value of the property.
        4. DESCRIPTION String=> A description of the property.

        The ResultSet is sorted by the NAME column.

        Specified by:
        getClientInfoProperties in interface java.sql.DatabaseMetaData
        Returns:
        A ResultSet object; each row is a supported client info property
        Throws:
        java.sql.SQLException - if an error occurs
      • getSchemas

        public java.sql.ResultSet getSchemas​(java.lang.String catalog,
                                             java.lang.String schemaPattern)
                                      throws java.sql.SQLException
        JDBC 4.0

        Get the schema names available in this database. The results are ordered by schema name.

        The schema columns are:

        1. TABLE_SCHEM String => schema name
        2. TABLE_CATALOG String => catalog name (may be null)
        Specified by:
        getSchemas in interface java.sql.DatabaseMetaData
        Parameters:
        catalog - catalog name used to narrow down the search; "" means no catalog, null means any catalog
        schemaPattern - 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:
        java.sql.SQLException - if a database error occurs
      • getRowIdLifetime

        public java.sql.RowIdLifetime getRowIdLifetime()
                                                throws java.sql.SQLException
        Specified by:
        getRowIdLifetime in interface java.sql.DatabaseMetaData
        Throws:
        java.sql.SQLException
      • supportsStoredFunctionsUsingCallSyntax

        public boolean supportsStoredFunctionsUsingCallSyntax()
                                                       throws java.sql.SQLException
        Specified by:
        supportsStoredFunctionsUsingCallSyntax in interface java.sql.DatabaseMetaData
        Throws:
        java.sql.SQLException
      • autoCommitFailureClosesAllResultSets

        public boolean autoCommitFailureClosesAllResultSets()
                                                     throws java.sql.SQLException
        Returns whether or not all open ResultSets on a Connection are closed if an error occurs when auto-commit in enabled.
        Specified by:
        autoCommitFailureClosesAllResultSets in interface java.sql.DatabaseMetaData
        Returns:
        true, since the embedded driver will close the open ResultSets
        Throws:
        java.sql.SQLException
      • isWrapperFor

        public final boolean isWrapperFor​(java.lang.Class<?> iface)
        Returns whether or not this instance implements the specified interface.
        Specified by:
        isWrapperFor in interface java.sql.Wrapper
        Parameters:
        iface - the interface to check for
        Returns:
        true if this implements the interface
      • unwrap

        public final <T> T unwrap​(java.lang.Class<T> iface)
                           throws java.sql.SQLException
        Returns this if this class implements the interface.
        Specified by:
        unwrap in interface java.sql.Wrapper
        Parameters:
        iface - the interface
        Returns:
        an object that implements the interface
        Throws:
        java.sql.SQLException - if no object is found that implements the interface
      • generatedKeyAlwaysReturned

        public boolean generatedKeyAlwaysReturned()
        See DatabaseMetaData javadoc
        Specified by:
        generatedKeyAlwaysReturned in interface java.sql.DatabaseMetaData
      • getPseudoColumns

        public java.sql.ResultSet getPseudoColumns​(java.lang.String catalog,
                                                   java.lang.String schemaPattern,
                                                   java.lang.String tableNamePattern,
                                                   java.lang.String columnNamePattern)
                                            throws java.sql.SQLException
        See DatabaseMetaData javadoc. Empty ResultSet because Derby does not support pseudo columns.
        Specified by:
        getPseudoColumns in interface java.sql.DatabaseMetaData
        Throws:
        java.sql.SQLException
      • getClientCachedMetaData

        public java.sql.ResultSet getClientCachedMetaData()
                                                   throws java.sql.SQLException
        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:
        java.sql.SQLException - if a database error occurs
      • getSimpleQuery

        private java.sql.ResultSet getSimpleQuery​(java.lang.String nameKey,
                                                  boolean net)
                                           throws java.sql.SQLException
        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 query
        net - if true, execute a query in metadata_net.properties; otherwise, execute a query in metadata.properties
        Returns:
        a ResultSet value
        Throws:
        java.sql.SQLException - if a database error occurs
      • getSimpleQuery

        protected java.sql.ResultSet getSimpleQuery​(java.lang.String nameKey)
                                             throws java.sql.SQLException
        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:
        java.sql.SQLException - if a database error occurs
      • getPreparedQueryUsingSystemTables

        private java.sql.PreparedStatement getPreparedQueryUsingSystemTables​(java.lang.String nameKey,
                                                                             boolean net)
                                                                      throws java.sql.SQLException
        Get a stored prepared statement from the system tables.
        Parameters:
        nameKey - the name of the query
        net - if true, find query in SYSIBM schema; otherwise, find query in SYS schema
        Returns:
        a PreparedStatement value
        Throws:
        java.sql.SQLException - if a database error occurs
      • getPreparedQuery

        private java.sql.PreparedStatement getPreparedQuery​(java.lang.String queryName,
                                                            boolean net)
                                                     throws java.sql.SQLException
        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 statement
        net - if true, use metadata_net.properties instead of metadata.properties
        Returns:
        PreparedStatement
        Throws:
        java.sql.SQLException - if a database error occurs
      • getPreparedQuery

        protected java.sql.PreparedStatement getPreparedQuery​(java.lang.String queryName)
                                                       throws java.sql.SQLException
        Get a prepared query from system tables or metadata.properties.
        Parameters:
        queryName - name of the query
        Returns:
        a PreparedStatement value
        Throws:
        java.sql.SQLException - if a database error occurs
      • getQueryFromDescription

        private java.lang.String getQueryFromDescription​(java.lang.String queryName,
                                                         boolean net)
                                                  throws StandardException
        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 query
        net - if true, get the query from metadata_net.properties instead of metadata.properties
        Returns:
        the query text
        Throws:
        StandardException - if an error occurs
      • prepareSPS

        private java.sql.PreparedStatement prepareSPS​(java.lang.String spsName,
                                                      java.lang.String spsText,
                                                      boolean net)
                                               throws StandardException,
                                                      java.sql.SQLException
        Throws:
        StandardException
        java.sql.SQLException
      • swapNull

        protected static final java.lang.String swapNull​(java.lang.String s)
      • getLanguageConnectionContext

        private LanguageConnectionContext 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 into queryDescriptions and queryDescriptions_net.
      • run

        public final java.lang.Object run()
        Performs a privileged action. Reads the query descriptions.
        Specified by:
        run in interface java.security.PrivilegedAction<java.lang.Object>
        Returns:
        null