Java Client API 1.4 (November 2023)
 
Loading...
Searching...
No Matches
com.dbSpaces.jdb.DatabaseMetaData Class Reference

Inherits com.dbSpaces.jdb.Base.

Collaboration diagram for com.dbSpaces.jdb.DatabaseMetaData:

Public Member Functions

boolean allProceduresAreCallable ()
 
boolean allTablesAreSelectable ()
 
boolean autoCommitFailureClosesAllResultSets ()
 
boolean dataDefinitionCausesTransactionCommit ()
 
boolean dataDefinitionIgnoredInTransactions ()
 
boolean deletesAreDetected (int type)
 
boolean doesMaxRowSizeIncludeBlobs ()
 
ResultSet getBestRowIdentifier (String catalog, String schema, String table, int scope, boolean nullable) throws DatabaseException
 
ResultSet getCatalogs () throws DatabaseException
 
String getCatalogSeparator ()
 
String getCatalogTerm ()
 
ResultSet getColumnPrivileges (String catalogName, String schemaName, String tableName, String columnNamePattern) throws DatabaseException
 
ResultSet getColumns (String catalogName, String schemaPattern, String tableNamePattern, String columnNamePattern) throws DatabaseException
 
ResultSet getCrossReference (String primaryCatalogName, String primarySchemaName, String primaryTableName, String foreignCatalogName, String foreignSchemaName, String foreignTableName) throws DatabaseException
 
String getDatabaseProductName () throws DatabaseException
 
String getDatabaseProductVersion () throws DatabaseException
 
int getDatabaseMajorVersion () throws DatabaseException
 
int getDatabaseMinorVersion () throws DatabaseException
 
int getDefaultTransactionIsolation ()
 
ResultSet getExportedKeys (String catalogName, String schemaName, String tableName) throws DatabaseException
 
ResultSet getImportedKeys (String catalogName, String schemaName, String tableName) throws DatabaseException
 
String getIdentifierQuoteString ()
 
ResultSet getIndexInfo (String catalogName, String schemaName, String tableName, boolean unique, boolean approximate) throws DatabaseException
 
int getMaxBinaryLiteralLength ()
 
int getMaxCatalogNameLength ()
 
int getMaxCharLiteralLength ()
 
int getMaxColumnNameLength ()
 
int getMaxColumnsInGroupBy ()
 
int getMaxColumnsInIndex ()
 
int getMaxColumnsInOrderBy ()
 
int getMaxColumnsInSelect ()
 
int getMaxColumnsInTable ()
 
int getMaxConnections () throws DatabaseException
 
int getMaxCursors () throws DatabaseException
 
int getMaxCursorNameLength ()
 
int getMaxIndexLength ()
 
int getMaxProcedureNameLength ()
 
int getMaxRowSize ()
 
int getMaxSchemaNameLength ()
 
int getMaxStatementLength ()
 
int getMaxTableNameLength ()
 
int getMaxTablesInSelect ()
 
int getMaxUserNameLength ()
 
String getNumericFunctions ()
 
ResultSet getPrimaryKeys (String catalogName, String schemaName, String tableName) throws DatabaseException
 
ResultSet getProcedureColumns (String catalogName, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws DatabaseException
 
ResultSet getProcedurePrivileges (String catalogName, String schemaPattern, String procedureNamePattern) throws DatabaseException
 
ResultSet getProcedures (String catalogName, String schemaPattern, String procedureNamePattern) throws DatabaseException
 
String getProcedureTerm ()
 
ResultSet getSchemas () throws DatabaseException
 
ResultSet getSchemas (String catalogName, String schemaPattern) throws DatabaseException
 
String getSchemaTerm ()
 
String getSearchStringEscape ()
 
String getSQLKeywords ()
 
int getSQLStateType ()
 
String getStringFunctions ()
 
String getSystemFunctions ()
 
ResultSet getTablePrivileges (String catalogName, String schemaPattern, String tableNamePattern) throws DatabaseException
 
ResultSet getTables (String catalogName, String schemaPattern, String tableNamePattern, String types[]) throws DatabaseException
 
ResultSet getTableTypes () throws DatabaseException
 
String getTimeDateFunctions ()
 
ResultSet getTypeInfo () throws DatabaseException
 
ResultSet getUDTypeInfo (String catalog, String schemaPattern, String typeNamePattern) throws DatabaseException
 
ResultSet getVersionColumns (String catalogName, String schemaName, String tableName) throws DatabaseException
 
boolean insertsAreDetected (int type)
 
boolean isCatalogAtStart ()
 
boolean isReadOnly ()
 
boolean nullsAreSortedHigh ()
 
boolean nullsAreSortedLow ()
 
boolean nullsAreSortedAtStart ()
 
boolean nullsAreSortedAtEnd ()
 
boolean nullPlusNonNullIsNull ()
 
boolean othersDeletesAreVisible (int type) throws DatabaseException
 
boolean othersInsertsAreVisible (int type)
 
boolean othersUpdatesAreVisible (int type)
 
boolean ownDeletesAreVisible (int type)
 
boolean ownInsertsAreVisible (int type)
 
boolean ownUpdatesAreVisible (int type)
 
boolean storesLowerCaseIdentifiers ()
 
boolean storesLowerCaseQuotedIdentifiers ()
 
boolean storesMixedCaseIdentifiers ()
 
boolean storesMixedCaseQuotedIdentifiers ()
 
boolean storesUpperCaseIdentifiers ()
 
boolean storesUpperCaseQuotedIdentifiers ()
 
boolean supportsAlterTableWithAddColumn ()
 
boolean supportsAlterTableWithDropColumn ()
 
boolean supportsANSI92EntryLevelSQL ()
 
boolean supportsANSI92FullSQL ()
 
boolean supportsANSI92IntermediateSQL ()
 
boolean supportsBatchUpdates ()
 
boolean supportsCatalogsInDataManipulation ()
 
boolean supportsCatalogsInIndexDefinitions ()
 
boolean supportsCatalogsInPrivilegeDefinitions ()
 
boolean supportsCatalogsInProcedureCalls ()
 
boolean supportsCatalogsInTableDefinitions ()
 
boolean supportsColumnAliasing ()
 
boolean supportsConvert ()
 
boolean supportsConvert (int fromType, int toType)
 
boolean supportsCoreSQLGrammar ()
 
boolean supportsCorrelatedSubqueries ()
 
boolean supportsDataDefinitionAndDataManipulationTransactions ()
 
boolean supportsDataManipulationTransactionsOnly ()
 
boolean supportsDifferentTableCorrelationNames ()
 
boolean supportsExpressionsInOrderBy ()
 
boolean supportsExtendedSQLGrammar ()
 
boolean supportsFullOuterJoins ()
 
boolean supportsGetGeneratedKeys ()
 
boolean supportsGroupBy ()
 
boolean supportsGroupByBeyondSelect ()
 
boolean supportsGroupByUnrelated ()
 
boolean supportsIntegrityEnhancementFacility ()
 
boolean supportsLikeEscapeClause ()
 
boolean supportsLimitedOuterJoins ()
 
boolean supportsMinimumSQLGrammar ()
 
boolean supportsMixedCaseIdentifiers ()
 
boolean supportsMixedCaseQuotedIdentifiers ()
 
boolean supportsMultipleOpenResults ()
 
boolean supportsMultipleResultSets ()
 
boolean supportsMultipleTransactions ()
 
boolean supportsNamedParameters ()
 
boolean supportsNonNullableColumns ()
 
boolean supportsOpenCursorsAcrossCommit ()
 
boolean supportsOpenCursorsAcrossRollback ()
 
boolean supportsOpenStatementsAcrossCommit ()
 
boolean supportsOpenStatementsAcrossRollback ()
 
boolean supportsOrderByUnrelated ()
 
boolean supportsOuterJoins ()
 
boolean supportsPositionedDelete ()
 
boolean supportsPositionedUpdate ()
 
boolean supportsResultSetConcurrency (int type, int concurrency)
 
boolean supportsResultSetHoldability (int holdability)
 
boolean supportsResultSetType (int type)
 
boolean supportsSavepoints ()
 
boolean supportsSchemasInDataManipulation ()
 
boolean supportsSchemasInIndexDefinitions ()
 
boolean supportsSchemasInPrivilegeDefinitions ()
 
boolean supportsSchemasInProcedureCalls ()
 
boolean supportsSchemasInTableDefinitions ()
 
boolean supportsSelectForUpdate ()
 
boolean supportsStatementPooling ()
 
boolean supportsStoredFunctionsUsingCallSyntax ()
 
boolean supportsStoredProcedures ()
 
boolean supportsSubqueriesInComparisons ()
 
boolean supportsSubqueriesInExists ()
 
boolean supportsSubqueriesInIns ()
 
boolean supportsSubqueriesInQuantifieds ()
 
boolean supportsTableCorrelationNames ()
 
boolean supportsTransactionIsolationLevel (int level) throws DatabaseException
 
boolean supportsTransactions ()
 
boolean supportsUnion ()
 
boolean supportsUnionAll ()
 
boolean updatesAreDetected (int type)
 

Detailed Description

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 DatabaseException.

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 DatabaseException will be thrown if a database error occurs and exceptions are enabled. If exceptions are not enabled the following error methods can be used to get information about the error;

  • GetErrorStatus()
  • GetErrorCode()
  • GetErrorMessage()
Since
Version 1.0

Member Function Documentation

◆ allProceduresAreCallable()

boolean com.dbSpaces.jdb.DatabaseMetaData.allProceduresAreCallable ( )

Can all the procedures returned by getProcedures be called by the current user?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ allTablesAreSelectable()

boolean com.dbSpaces.jdb.DatabaseMetaData.allTablesAreSelectable ( )

Can all the tables returned by getTables() be SELECTed by the current user?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ autoCommitFailureClosesAllResultSets()

boolean com.dbSpaces.jdb.DatabaseMetaData.autoCommitFailureClosesAllResultSets ( )

Retrieves whether a DatabaseException while autoCommit is true inidcates that all open ResultSets are closed, even ones that are holdable. When a DatabaseException occurs while autocommit is true, it is vendor specific whether the driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.

Returns
true if so; false otherwise.
Since
Version 1.0

◆ dataDefinitionCausesTransactionCommit()

boolean com.dbSpaces.jdb.DatabaseMetaData.dataDefinitionCausesTransactionCommit ( )

Does a data definition statement within a transaction force the transaction to commit?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ dataDefinitionIgnoredInTransactions()

boolean com.dbSpaces.jdb.DatabaseMetaData.dataDefinitionIgnoredInTransactions ( )

Is a data definition statement within a transaction ignored?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ deletesAreDetected()

boolean com.dbSpaces.jdb.DatabaseMetaData.deletesAreDetected ( int  type)

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.

Parameters
typeThe result set type, i.e. ResultSet.TYPE_XXX
Returns
true if changes are detected by the resultset type; false if otherwise.
Since
Version 1.0

◆ doesMaxRowSizeIncludeBlobs()

boolean com.dbSpaces.jdb.DatabaseMetaData.doesMaxRowSizeIncludeBlobs ( )

Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ getBestRowIdentifier()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getBestRowIdentifier ( String  catalog,
String  schema,
String  table,
int  scope,
boolean  nullable 
) throws DatabaseException

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 short => SQL data type
  4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  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
Parameters
catalogA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaA schema name; "" retrieves those without a schema
tableA table name
scopeThe scope of interest; use same values as SCOPE
nullableinclude columns that are nullable?
Returns
ResultSet Each row is a column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getCatalogs()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getCatalogs ( ) throws DatabaseException

Returns a list of valid catalogs.

Returns
ResultSet
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getCatalogSeparator()

String com.dbSpaces.jdb.DatabaseMetaData.getCatalogSeparator ( )

What's the separator between catalog and table name?

Returns
the separator string
Since
Version 1.0

◆ getCatalogTerm()

String com.dbSpaces.jdb.DatabaseMetaData.getCatalogTerm ( )

What's the database vendor's preferred term for "catalog"?

Returns
the catalog term
Since
Version 1.0

◆ getColumnPrivileges()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getColumnPrivileges ( String  catalogName,
String  schemaName,
String  tableName,
String  columnNamePattern 
) throws DatabaseException

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 privilege 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
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaNameA schema name; "" retrieves those without a schema
tableNameA table name
columnNamePatternA column name pattern
Returns
The ResultSet; each row is a column privilege description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getColumns()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getColumns ( String  catalogName,
String  schemaPattern,
String  tableNamePattern,
String  columnNamePattern 
) throws DatabaseException

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 short => SQL type
  6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  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.
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatternA schema name pattern; "" retrieves those without a schema
tableNamePatternA table name pattern
columnNamePatternA column name pattern
Returns
The ResultSet; each row is a column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getCrossReference()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getCrossReference ( String  primaryCatalogName,
String  primarySchemaName,
String  primaryTableName,
String  foreignCatalogName,
String  foreignSchemaName,
String  foreignTableName 
) throws DatabaseException

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
  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
    • 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
Parameters
primaryCatalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
primarySchemaNameA schema name; "" retrieves those without a schema
primaryTableNameThe table name that exports the key
foreignCatalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
foreignSchemaNameA schema name; "" retrieves those without a schema
foreignTableNameThe table name that imports the key
Returns
The ResultSet; each row is a foreign key column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getImportedKeys
Since
Version 1.0
Here is the call graph for this function:

◆ getDatabaseMajorVersion()

int com.dbSpaces.jdb.DatabaseMetaData.getDatabaseMajorVersion ( ) throws DatabaseException

Return the database major version.

Returns
the major version number.
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0

◆ getDatabaseMinorVersion()

int com.dbSpaces.jdb.DatabaseMetaData.getDatabaseMinorVersion ( ) throws DatabaseException

Return the database minor version.

Returns
the minor version number.
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0

◆ getDatabaseProductName()

String com.dbSpaces.jdb.DatabaseMetaData.getDatabaseProductName ( ) throws DatabaseException

What's the name of this database product?

Returns
database product name
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getDatabaseProductVersion()

String com.dbSpaces.jdb.DatabaseMetaData.getDatabaseProductVersion ( ) throws DatabaseException

What's the version of this database product?

Returns
database version
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getDefaultTransactionIsolation()

int com.dbSpaces.jdb.DatabaseMetaData.getDefaultTransactionIsolation ( )

What's the database's default transaction isolation level? The values are defined in Connection.

Returns
the default isolation level
See also
Connection
Since
Version 1.0

◆ getExportedKeys()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getExportedKeys ( String  catalogName,
String  schemaName,
String  tableName 
) throws DatabaseException

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
  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
    • 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
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaNameA schema name; "" retrieves those without a schema
tableNameA table name
Returns
The ResultSet; each row is a foreign key column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getImportedKeys
Since
Version 1.0
Here is the call graph for this function:

◆ getIdentifierQuoteString()

String com.dbSpaces.jdb.DatabaseMetaData.getIdentifierQuoteString ( )

What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting isn't supported.

Returns
the quoting string
Since
Version 1.0

◆ getImportedKeys()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getImportedKeys ( String  catalogName,
String  schemaName,
String  tableName 
) throws DatabaseException

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
  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
    • 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
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaNameA schema name; "" retrieves those without a schema
tableNameA table name
Returns
The ResultSet; each row is a primary key column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getExportedKeys
Since
Version 1.0
Here is the call graph for this function:

◆ getIndexInfo()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getIndexInfo ( String  catalogName,
String  schemaName,
String  tableName,
boolean  unique,
boolean  approximate 
) throws DatabaseException

Get a description of a table's indices and statisticallStmt. 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)
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaNameA schema name; "" retrieves those without a schema
tableNameA table name
uniqueWhen true, return only indices for unique values; when false, return indices regardless of whether unique or not
approximateWhen true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate
Returns
The ResultSet; each row is an index column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getMaxBinaryLiteralLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxBinaryLiteralLength ( )

How many hex characters can you have in an inline binary literal?

Returns
max literal length
Since
Version 1.0

◆ getMaxCatalogNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxCatalogNameLength ( )

What's the maximum length of a catalog name?

Returns
max name length in bytes
Since
Version 1.0

◆ getMaxCharLiteralLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxCharLiteralLength ( )

What's the max length for a character literal?

Returns
max literal length
Since
Version 1.0

◆ getMaxColumnNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxColumnNameLength ( )

What's the limit on column name length?

Returns
max literal length
Since
Version 1.0

◆ getMaxColumnsInGroupBy()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxColumnsInGroupBy ( )

What's the maximum number of columns in a "GROUP BY" clause?

Returns
max number of columns
Since
Version 1.0

◆ getMaxColumnsInIndex()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxColumnsInIndex ( )

What's the maximum number of columns allowed in an index?

Returns
max columns
Since
Version 1.0

◆ getMaxColumnsInOrderBy()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxColumnsInOrderBy ( )

What's the maximum number of columns in an "ORDER BY" clause?

Returns
max columns
Since
Version 1.0

◆ getMaxColumnsInSelect()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxColumnsInSelect ( )

What's the maximum number of columns in a "SELECT" list?

Returns
max columns
Since
Version 1.0

◆ getMaxColumnsInTable()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxColumnsInTable ( )

What's the maximum number of columns in a table?

Returns
max columns
Since
Version 1.0

◆ getMaxConnections()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxConnections ( ) throws DatabaseException

How many active connections can we have at a time to this database?

Returns
max connections
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0

◆ getMaxCursorNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxCursorNameLength ( )

What's the maximum cursor name length?

Returns
max cursor name length in bytes
Since
Version 1.0

◆ getMaxCursors()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxCursors ( ) throws DatabaseException

How many active statements can we have open at one time to this database?

Returns
the maximum
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0

◆ getMaxIndexLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxIndexLength ( )

What's the maximum length of an index (in bytes)?

Returns
max index length in bytes
Since
Version 1.0

◆ getMaxProcedureNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxProcedureNameLength ( )

What's the maximum length of a procedure name?

Returns
max name length in bytes
Since
Version 1.0

◆ getMaxRowSize()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxRowSize ( )

What's the maximum length of a single row?

Returns
max row size in bytes

◆ getMaxSchemaNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxSchemaNameLength ( )

What's the maximum length allowed for a schema name?

Returns
max name length in bytes
Since
Version 1.0

◆ getMaxStatementLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxStatementLength ( )

What's the maximum length of a SQL statement?

Returns
max length in bytes
Since
Version 1.0

◆ getMaxTableNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxTableNameLength ( )

What's the maximum length of a table name?

Returns
max name length in bytes

◆ getMaxTablesInSelect()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxTablesInSelect ( )

What's the maximum number of tables in a SELECT?

Returns
the maximum
Since
Version 1.0

◆ getMaxUserNameLength()

int com.dbSpaces.jdb.DatabaseMetaData.getMaxUserNameLength ( )

What's the maximum length of a user name?

Returns
max name length in bytes.
Since
Version 1.0

◆ getNumericFunctions()

String com.dbSpaces.jdb.DatabaseMetaData.getNumericFunctions ( )

Get a comma separated list of math functions. These are the X/Open CLI math function names used in the function escape clause.

Returns
the list.
Since
Version 1.0

◆ getPrimaryKeys()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getPrimaryKeys ( String  catalogName,
String  schemaName,
String  tableName 
) throws DatabaseException

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)
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaNameA schema name; "" retrieves those without a schema
tableNameA table name
Returns
The ResultSet; each row is a primary key column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getProcedureColumns()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getProcedureColumns ( String  catalogName,
String  schemaPattern,
String  procedureNamePattern,
String  columnNamePattern 
) throws DatabaseException

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 short => SQL type
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  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

Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.

Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatternA schema name pattern; "" retrieves those without a schema
procedureNamePatternA procedure name pattern
columnNamePatternA column name pattern
Returns
The ResultSet; each row is a stored procedure parameter or column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getProcedurePrivileges()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getProcedurePrivileges ( String  catalogName,
String  schemaPattern,
String  procedureNamePattern 
) throws DatabaseException

Get a description of the access rights for each procedure available in a catalog. Note that a procedure privilege applies to one or more parameters in the procedure. It would be wrong to assume that this priviledge applies to all parameters (this may be true for some systems but is not true for all.)

Only privileges matching the schema and procedure name criteria are returned. They are ordered by PROC_SCHEM, PROC_NAME, and PRIVILEGE.

Each privilige description has the following columns:

  1. PROC_CAT String => procedure catalog (may be null)
  2. PROC_SCHEM String => procedure schema (may be null)
  3. PROC_NAME String => procedure name
  4. GRANTOR => grantor of access (may be null)
  5. GRANTEE String => grantee of access
  6. PRIVILEGE String => name of access (EXECUTE, ...)
  7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatternA schema name pattern; "" retrieves those without a schema
procedureNamePatternA procedure name pattern
Returns
The ResultSet; each row is a procedure privilege description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getProcedures()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getProcedures ( String  catalogName,
String  schemaPattern,
String  procedureNamePattern 
) throws DatabaseException

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
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatternA schema name pattern; "" retrieves those without a schema
procedureNamePatternA procedure name pattern
Returns
The ResultSet; each row is a procedure description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getProcedureTerm()

String com.dbSpaces.jdb.DatabaseMetaData.getProcedureTerm ( )

What's the database vendor preferred term for "procedure"?

Returns
the procedure term
Since
Version 1.0

◆ getSchemas() [1/2]

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getSchemas ( ) throws DatabaseException

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

The schema column is:

  1. TABLE_SCHEM String => schema name
Returns
The ResultSet; each row has a single String column that is a schema name
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getSchemas() [2/2]

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getSchemas ( String  catalogName,
String  schemaPattern 
) throws DatabaseException

Retrieves the schema names available in this database. The results are ordered by TABLE_CATALOG and TABLE_SCHEM.

The schema columns are:

  1. TABLE_SCHEM String => schema name
  2. TABLE_CATALOG String => catalog name (may be null)
Parameters
catalogNameA catalog name; must match the catalog name as it is stored in the database;"" retrieves those without a catalog; null means catalog name should not be used to narrow down the search.
schemaPatternA schema name; must match the schema name as it is stored in the database; null means schema name should not be used to narrow down the search.
Returns
The ResultSet; each row is a schema description.
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getSchemaTerm()

String com.dbSpaces.jdb.DatabaseMetaData.getSchemaTerm ( )

What's the database preferred term for "schema"?

Returns
the schema term
Since
Version 1.0

◆ getSearchStringEscape()

String com.dbSpaces.jdb.DatabaseMetaData.getSearchStringEscape ( )

This is the string that can be used to escape '_' or '' in the string pattern style catalog search parameters.

The '_' character represents any single character.

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

Returns
the string used to escape wildcard characters
Since
Version 1.0

◆ getSQLKeywords()

String com.dbSpaces.jdb.DatabaseMetaData.getSQLKeywords ( )

Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.

Returns
the list
Since
Version 1.0

◆ getSQLStateType()

int com.dbSpaces.jdb.DatabaseMetaData.getSQLStateType ( )

Indicates whether the SQLSTATE returned by DatabaseException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL:2003.

Returns
the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL
Since
Version 1.0

◆ getStringFunctions()

String com.dbSpaces.jdb.DatabaseMetaData.getStringFunctions ( )

Get a comma separated list of string functions. These are the X/Open CLI string function names used in the function escape clause.

Returns
the list
Since
Version 1.0

◆ getSystemFunctions()

String com.dbSpaces.jdb.DatabaseMetaData.getSystemFunctions ( )

Get a comma separated list of system functions. These are the X/Open CLI system function names used in the function escape clause.

Returns
the list
Since
Version 1.0

◆ getTablePrivileges()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getTablePrivileges ( String  catalogName,
String  schemaPattern,
String  tableNamePattern 
) throws DatabaseException

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
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatternA schema name pattern; "" retrieves those without a schema
tableNamePatternA table name pattern
Returns
The ResultSet; each row is a table privilege description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getTables()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getTables ( String  catalogName,
String  schemaPattern,
String  tableNamePattern,
String  types[] 
) throws DatabaseException

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

Note: Some databases may not return information for all tables.

Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatternA schema name pattern; "" retrieves those without a schema
tableNamePatternA table name pattern
typesA list of table types to include; null returns all types
Returns
The ResultSet; each row is a table description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
#getSearchStringEscape
Since
Version 1.0
Here is the call graph for this function:

◆ getTableTypes()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getTableTypes ( ) throws DatabaseException

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".
Returns
The ResultSet; each row has a single column that is a table type.
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getTimeDateFunctions()

String com.dbSpaces.jdb.DatabaseMetaData.getTimeDateFunctions ( )

Get a comma separated list of time and date functions.

Returns
the list
Since
Version 1.0

◆ getTypeInfo()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getTypeInfo ( ) throws DatabaseException

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 SQL type.

Each type description has the following columns:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE short => SQL data type
  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
Returns
The ResultSet; each row is a SQL type description.
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ getUDTypeInfo()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getUDTypeInfo ( String  catalog,
String  schemaPattern,
String  typeNamePattern 
) throws DatabaseException

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.

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_NAME String => Type name
  2. DATA_TYPE short => 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
Parameters
cataloga catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
typeNamePatterna type name pattern; may be a fully qualified name
Returns
ResultSet - each row is a type description
Exceptions
SQLExceptionif a database-access error occurs.
Here is the call graph for this function:

◆ getVersionColumns()

ResultSet com.dbSpaces.jdb.DatabaseMetaData.getVersionColumns ( String  catalogName,
String  schemaName,
String  tableName 
) throws DatabaseException

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 short => SQL data type
  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
Parameters
catalogNameA catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaNameA schema name; "" retrieves those without a schema
tableNameA table name
Returns
The ResultSet; each row is a column description
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
Since
Version 1.0
Here is the call graph for this function:

◆ insertsAreDetected()

boolean com.dbSpaces.jdb.DatabaseMetaData.insertsAreDetected ( int  type)

Determine whether or not a visible row insert can be detected by calling ResultSet.rowInserted().

Parameters
typeThe result set type, i.e. ResultSet.TYPE_XXX
Returns
true if changes are detected by the resultset type; false if otherwise.
Since
Version 1.0

◆ isCatalogAtStart()

boolean com.dbSpaces.jdb.DatabaseMetaData.isCatalogAtStart ( )

Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end)

Returns
true if it appears at the start; false if otherwise.
Since
Version 1.0

◆ isReadOnly()

boolean com.dbSpaces.jdb.DatabaseMetaData.isReadOnly ( )

Is the database in read-only mode?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ nullPlusNonNullIsNull()

boolean com.dbSpaces.jdb.DatabaseMetaData.nullPlusNonNullIsNull ( )

Are concatenations between NULL and non-NULL values NULL?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ nullsAreSortedAtEnd()

boolean com.dbSpaces.jdb.DatabaseMetaData.nullsAreSortedAtEnd ( )

Are NULL values sorted at the end regardless of sort order?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ nullsAreSortedAtStart()

boolean com.dbSpaces.jdb.DatabaseMetaData.nullsAreSortedAtStart ( )

Are NULL values sorted at the start regardless of sort order?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ nullsAreSortedHigh()

boolean com.dbSpaces.jdb.DatabaseMetaData.nullsAreSortedHigh ( )

Are NULL values sorted high?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ nullsAreSortedLow()

boolean com.dbSpaces.jdb.DatabaseMetaData.nullsAreSortedLow ( )

Are NULL values sorted low?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ othersDeletesAreVisible()

boolean com.dbSpaces.jdb.DatabaseMetaData.othersDeletesAreVisible ( int  type) throws DatabaseException

Retrieves whether deletes made by others are visible.

Parameters
typeThe ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns
true if deletes made by others are visible for the given result set type; false if otherwise.
Since
Version 1.0

◆ othersInsertsAreVisible()

boolean com.dbSpaces.jdb.DatabaseMetaData.othersInsertsAreVisible ( int  type)

Retrieves whether inserts made by others are visible.

Parameters
typeThe ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns
true if inserts made by others are visible for the given result set type; false if otherwise.
Since
Version 1.0

◆ othersUpdatesAreVisible()

boolean com.dbSpaces.jdb.DatabaseMetaData.othersUpdatesAreVisible ( int  type)

Determine whether changes made by others are visible.

Parameters
typeThe result set type, i.e. ResultSet.TYPE_XXX
Returns
true if changes are visible for the result set type; false if otherwise.
Since
Version 1.0

◆ ownDeletesAreVisible()

boolean com.dbSpaces.jdb.DatabaseMetaData.ownDeletesAreVisible ( int  type)

Retrieves whether a result set's own deletes are visible.

Parameters
typeThe ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns
true if deletes are visible for the given result set type; false if otherwise.
Since
Version 1.0

◆ ownInsertsAreVisible()

boolean com.dbSpaces.jdb.DatabaseMetaData.ownInsertsAreVisible ( int  type)

Retrieves whether a result set's own inserts are visible.

Parameters
typeThe ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns
true if inserts are visible for the given result set type; false if otherwise.
Since
Version 1.0

◆ ownUpdatesAreVisible()

boolean com.dbSpaces.jdb.DatabaseMetaData.ownUpdatesAreVisible ( int  type)

Retrieves whether for the given type of ResultSet object, the result set's own updates are visible.

Parameters
typeThe ResultSet type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
Returns
true if updates are visible for the given result set type; false if otherwise.
Since
Version 1.0

◆ storesLowerCaseIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.storesLowerCaseIdentifiers ( )

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ storesLowerCaseQuotedIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.storesLowerCaseQuotedIdentifiers ( )

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ storesMixedCaseIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.storesMixedCaseIdentifiers ( )

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ storesMixedCaseQuotedIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.storesMixedCaseQuotedIdentifiers ( )

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ storesUpperCaseIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.storesUpperCaseIdentifiers ( )

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ storesUpperCaseQuotedIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.storesUpperCaseQuotedIdentifiers ( )

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsAlterTableWithAddColumn()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsAlterTableWithAddColumn ( )

Is "ALTER TABLE" with add column supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsAlterTableWithDropColumn()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsAlterTableWithDropColumn ( )

Is "ALTER TABLE" with drop column supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsANSI92EntryLevelSQL()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsANSI92EntryLevelSQL ( )

Is the ANSI92 entry level SQL grammar supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsANSI92FullSQL()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsANSI92FullSQL ( )

Is the ANSI92 full SQL grammar supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsANSI92IntermediateSQL()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsANSI92IntermediateSQL ( )

Is the ANSI92 intermediate SQL grammar supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsBatchUpdates()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsBatchUpdates ( )

Does the database support batch updates.

Returns
true if batch updates are supported; false if otherwise.
Since
Version 1.0

◆ supportsCatalogsInDataManipulation()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCatalogsInDataManipulation ( )

Can a catalog name be used in a data manipulation statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsCatalogsInIndexDefinitions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCatalogsInIndexDefinitions ( )

Can a catalog name be used in an index definition statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsCatalogsInPrivilegeDefinitions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCatalogsInPrivilegeDefinitions ( )

Can a catalog name be used in a privilege definition statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsCatalogsInProcedureCalls()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCatalogsInProcedureCalls ( )

Can a catalog name be used in a procedure call statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsCatalogsInTableDefinitions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCatalogsInTableDefinitions ( )

Can a catalog name be used in a table definition statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsColumnAliasing()

boolean com.dbSpaces.jdb.DatabaseMetaData.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.

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsConvert() [1/2]

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsConvert ( )

Is the CONVERT function between SQL types supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsConvert() [2/2]

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsConvert ( int  fromType,
int  toType 
)

Is CONVERT between the given SQL types supported?

Parameters
fromTypeThe type to convert from.
toTypeThe type to convert to.
Returns
true if so; false if otherwise.
See also
Types

◆ supportsCoreSQLGrammar()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCoreSQLGrammar ( )

Is the Core SQL grammar supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsCorrelatedSubqueries()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsCorrelatedSubqueries ( )

Are correlated subqueries supported?

Returns
true if so; false if otherwise.

◆ supportsDataDefinitionAndDataManipulationTransactions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsDataDefinitionAndDataManipulationTransactions ( )

Are both data definition and data manipulation statements within a transaction supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsDataManipulationTransactionsOnly()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsDataManipulationTransactionsOnly ( )

Are only data manipulation statements within a transaction supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsDifferentTableCorrelationNames()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsDifferentTableCorrelationNames ( )

If table correlation names are supported, are they restricted to be different from the names of the tables?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsExpressionsInOrderBy()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsExpressionsInOrderBy ( )

Are expressions in "ORDER BY" lists supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsExtendedSQLGrammar()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsExtendedSQLGrammar ( )

Is Extended SQL grammar supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsFullOuterJoins()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsFullOuterJoins ( )

Are full nested outer joins supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsGetGeneratedKeys()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsGetGeneratedKeys ( )

Retrieves whether auto-generated keys can be retrieved after a statement has been executed.

Returns
true if auto-generated keys can be retrieved after a statement has executed; false if otherwise.
Since
Version 1.0

◆ supportsGroupBy()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsGroupBy ( )

Is some form of "GROUP BY" clause supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsGroupByBeyondSelect()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsGroupByBeyondSelect ( )

Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsGroupByUnrelated()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsGroupByUnrelated ( )

Can a "GROUP BY" clause use columns not in the SELECT?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsIntegrityEnhancementFacility()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsIntegrityEnhancementFacility ( )

Is the SQL Integrity Enhancement Facility supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsLikeEscapeClause()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsLikeEscapeClause ( )

Is the escape character in "LIKE" clauses supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsLimitedOuterJoins()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsLimitedOuterJoins ( )

Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsMinimumSQLGrammar()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsMinimumSQLGrammar ( )

Is the Minimum SQL grammar supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsMixedCaseIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsMixedCaseIdentifiers ( )

Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsMixedCaseQuotedIdentifiers()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsMixedCaseQuotedIdentifiers ( )

Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsMultipleOpenResults()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsMultipleOpenResults ( )

Retrieves whether it is possible to have multiple ResultSet objects returned from a Statment object simultaneously.

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsMultipleResultSets()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsMultipleResultSets ( )

Are multiple ResultSets from a single execute supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsMultipleTransactions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsMultipleTransactions ( )

Can we have multiple transactions open at once (on different connections)?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsNamedParameters()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsNamedParameters ( )

Does dynamic SQL statements support named parameters?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsNonNullableColumns()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsNonNullableColumns ( )

Can columns be defined as non-nullable?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsOpenCursorsAcrossCommit()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsOpenCursorsAcrossCommit ( )

Can cursors remain open across commits?

Returns
true if cursors always remain open; false if otherwise.
Since
Version 1.0

◆ supportsOpenCursorsAcrossRollback()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsOpenCursorsAcrossRollback ( )

Can cursors remain open across rollbacks?

Returns
true if cursors always remain open; false if otherwise.
Since
Version 1.0

◆ supportsOpenStatementsAcrossCommit()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsOpenStatementsAcrossCommit ( )

Can statements remain open across commits?

Returns
true if statements always remain open; false if otherwise.
Since
Version 1.0

◆ supportsOpenStatementsAcrossRollback()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsOpenStatementsAcrossRollback ( )

Can statements remain open across rollbacks?

Returns
true if statements always remain open; false if they might not remain open.
Since
Version 1.0

◆ supportsOrderByUnrelated()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsOrderByUnrelated ( )

Can an "ORDER BY" clause use columns not in the SELECT?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsOuterJoins()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsOuterJoins ( )

Is some form of outer join supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsPositionedDelete()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsPositionedDelete ( )

Is positioned DELETE supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsPositionedUpdate()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsPositionedUpdate ( )

Is positioned UPDATE supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsResultSetConcurrency()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsResultSetConcurrency ( int  type,
int  concurrency 
)

Does the database support the concurrency type in combination with the given result set type?

Parameters
typedefined in ResultSet
concurrencytype defined in ResultSet
Returns
true if so; false if otherwise.
See also
Connection
Since
Version 1.0

◆ supportsResultSetHoldability()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsResultSetHoldability ( int  holdability)

Retrieves whether this database supports the given result set holdability.

Parameters
holdabilityOne of the following constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns
true if so; false if otherwise.
Exceptions
DatabaseException(if exceptions are enabled) when a database error occurs.
See also
Connection
Since
Version 1.0

◆ supportsResultSetType()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsResultSetType ( int  type)

Does the database support the given result set type?

Parameters
typeDefined in ResultSet
Returns
true if so; false if otherwise.
See also
Connection
Since
Version 1.0

◆ supportsSavepoints()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSavepoints ( )

Does transactions support savepoinsts?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSchemasInDataManipulation()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSchemasInDataManipulation ( )

Can a schema name be used in a data manipulation statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSchemasInIndexDefinitions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSchemasInIndexDefinitions ( )

Can a schema name be used in an index definition statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSchemasInPrivilegeDefinitions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSchemasInPrivilegeDefinitions ( )

Can a schema name be used in a privilege definition statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSchemasInProcedureCalls()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSchemasInProcedureCalls ( )

Can a schema name be used in a procedure call statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSchemasInTableDefinitions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSchemasInTableDefinitions ( )

Can a schema name be used in a table definition statement?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSelectForUpdate()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSelectForUpdate ( )

Is SELECT for UPDATE supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsStatementPooling()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsStatementPooling ( )

Is statement pooling supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsStoredFunctionsUsingCallSyntax()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsStoredFunctionsUsingCallSyntax ( )

Retrieves whether this database supports invoking user-defined or system functions using the stored procedure escape syntax.

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsStoredProcedures()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsStoredProcedures ( )

Are stored procedure calls using the stored procedure escape syntax supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSubqueriesInComparisons()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSubqueriesInComparisons ( )

Are subqueries in comparison expressions supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSubqueriesInExists()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSubqueriesInExists ( )

Are subqueries in 'exists' expressions supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSubqueriesInIns()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSubqueriesInIns ( )

Are subqueries in 'in' statements supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsSubqueriesInQuantifieds()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsSubqueriesInQuantifieds ( )

Are subqueries in quantified expressions supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsTableCorrelationNames()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsTableCorrelationNames ( )

Are table correlation names supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsTransactionIsolationLevel()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsTransactionIsolationLevel ( int  level) throws DatabaseException

Does the database support the given transaction isolation level?

Parameters
levelThe values are defined in Connection
Returns
true if so; false if otherwise.
See also
Connection
Since
Version 1.0

◆ supportsTransactions()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsTransactions ( )

Are transactions supported? If not, commit is a noop and the isolation level is TRANSACTION_NONE.

Returns
true if transactions are supported
Since
Version 1.0

◆ supportsUnion()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsUnion ( )

Is SQL UNION supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ supportsUnionAll()

boolean com.dbSpaces.jdb.DatabaseMetaData.supportsUnionAll ( )

Is SQL UNION ALL supported?

Returns
true if so; false if otherwise.
Since
Version 1.0

◆ updatesAreDetected()

boolean com.dbSpaces.jdb.DatabaseMetaData.updatesAreDetected ( int  type)

Determine whether or not a visible row update can be detected by calling ResultSet.rowUpdated().

Parameters
typeThe result set type, i.e. ResultSet.TYPE_XXX
Returns
true if changes are detected by the resultset type; false if otherwise.
Since
Version 1.0