: Class DatabaseMetaData

Overview

Package

Class

Tree

Deprecated

Index

Help

1.50.39

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

interbase.interclient
Class DatabaseMetaData

java.lang.Object
  |
  +--interbase.interclient.DatabaseMetaData

public final class DatabaseMetaData
extends Object
implements DatabaseMetaData

Provides information about the database or connection, as well as database capabilities.

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

Since:: JDBC 1, with extended behavior in JDBC 2

Field Summary
`static int`	`bestRowNotPseudo` BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.
`static int`	`bestRowPseudo` BEST ROW PSEUDO_COLUMN - is a pseudo column.
`static int`	`bestRowSession` BEST ROW SCOPE - valid for remainder of current session.
`static int`	`bestRowTemporary` BEST ROW SCOPE - very temporary, while using row.
`static int`	`bestRowTransaction` BEST ROW SCOPE - valid for remainder of current transaction.
`static int`	`bestRowUnknown` BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.
`static int`	`columnNoNulls` COLUMN NULLABLE - might not allow NULL values.
`static int`	`columnNullable` COLUMN NULLABLE - definitely allows NULL values.
`static int`	`columnNullableUnknown` COLUMN NULLABLE - nullability unknown.
`static int`	`importedKeyCascade` IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change imported key to agree with primary key update; for delete, delete rows that import a deleted key.
`static int`	`importedKeyInitiallyDeferred` IMPORT KEY DEFERRABILITY - see SQL92 for definition
`static int`	`importedKeyInitiallyImmediate` IMPORT KEY DEFERRABILITY - see SQL92 for definition
`static int`	`importedKeyNoAction` IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.
`static int`	`importedKeyNotDeferrable` IMPORT KEY DEFERRABILITY - see SQL92 for definition
`static int`	`importedKeyRestrict` IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.
`static int`	`importedKeySetDefault` IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to default values if its primary key has been updated or deleted.
`static int`	`importedKeySetNull` IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to NULL if its primary key has been updated or deleted.
`static int`	`procedureColumnIn` COLUMN_TYPE - IN parameter.
`static int`	`procedureColumnInOut` COLUMN_TYPE - INOUT parameter.
`static int`	`procedureColumnOut` COLUMN_TYPE - OUT parameter.
`static int`	`procedureColumnResult` COLUMN_TYPE - result column in ResultSet.
`static int`	`procedureColumnReturn` COLUMN_TYPE - procedure return value.
`static int`	`procedureColumnUnknown` COLUMN_TYPE - nobody knows.
`static int`	`procedureNoNulls` TYPE NULLABLE - does not allow NULL values.
`static int`	`procedureNoResult` PROCEDURE_TYPE - Does not return a result.
`static int`	`procedureNullable` TYPE NULLABLE - allows NULL values.
`static int`	`procedureNullableUnknown` TYPE NULLABLE - nullability unknown.
`static int`	`procedureResultUnknown` PROCEDURE_TYPE - May return a result.
`static int`	`procedureReturnsResult` PROCEDURE_TYPE - Returns a result.
`static short`	`tableIndexClustered` INDEX INFO TYPE - this identifies a clustered index
`static short`	`tableIndexHashed` INDEX INFO TYPE - this identifies a hashed index
`static short`	`tableIndexOther` INDEX INFO TYPE - this identifies some other form of index
`static short`	`tableIndexStatistic` INDEX INFO TYPE - this identifies table statistics that are returned in conjuction with a table's index descriptions
`static int`	`typeNoNulls` TYPE NULLABLE - does not allow NULL values.
`static int`	`typeNullable` TYPE NULLABLE - allows NULL values.
`static int`	`typeNullableUnknown` TYPE NULLABLE - nullability unknown.
`static int`	`typePredBasic` TYPE INFO SEARCHABLE - Supported except for WHERE ..
`static int`	`typePredChar` TYPE INFO SEARCHABLE - Only supported with WHERE ..
`static int`	`typePredNone` TYPE INFO SEARCHABLE - No support.
`static int`	`typeSearchable` TYPE INFO SEARCHABLE - Supported for all WHERE ...
`static int`	`versionColumnNotPseudo` VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.
`static int`	`versionColumnPseudo` VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.
`static int`	`versionColumnUnknown` VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

Method Summary
`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`	`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)` Determine whether or not a visible row delete can be detected by calling ResultSet.rowDeleted().
`boolean`	`doesMaxRowSizeIncludeBlobs()` Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs.
`ResultSet`	`getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)` Get a description of a table's optimal set of columns that uniquely identifies a row.
`int`	`getCacheBuffers()` Get the actual number of cache page buffers being used for this connection.
`ResultSet`	`getCatalogs()` Get the catalog names available in this database.
`String`	`getCatalogSeparator()` What's the separator between catalog and table name.
`String`	`getCatalogTerm()` What's the database vendor's preferred term for "catalog".
`ResultSet`	`getColumnPrivileges(String catalog, String schema, String table, String columnNamePattern)` Get a description of the access rights for a table's columns.
`ResultSet`	`getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)` Get a description of table columns available in a catalog.
`Connection`	`getConnection()` Return the connection that produced this metadata object.
`ResultSet`	`getCrossReference(String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)` Get a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table.
`int`	`getDatabaseMajorVersion()` Get the major version for the InterBase product.
`String`	`getDatabaseProductName()` What's the name of this database product.
`String`	`getDatabaseProductVersion()` What's the version of this database product.
`int`	`getDefaultTransactionIsolation()` What's the database's default transaction isolation level.
`Date`	`getDriverExpirationDate()` Get the expiration date for InterClient.
`int`	`getDriverJDBCNetProtocolVersion()` Get the JDBC/Net protocol used by InterClient.
`int`	`getDriverMajorVersion()` What's this JDBC driver's major version number.
`int`	`getDriverMinorVersion()` What's this JDBC driver's minor version number.
`String`	`getDriverName()` What's the name of this JDBC driver.
`String`	`getDriverVersion()` What's the version of this JDBC driver.
`ResultSet`	`getExportedKeys(String catalog, String schema, String table)` Get a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).
`String`	`getExtraNameCharacters()` Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
`String`	`getIdentifierQuoteString()` What's the string used to quote SQL identifiers.
`ResultSet`	`getImportedKeys(String catalog, String schema, String table)` Get a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).
`ResultSet`	`getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)` Get a description of a table's indices and statistics.
`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).
`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.
`String`	`getNumericFunctions()` Get a comma separated list of math functions.
`int`	`getODSMajorVersion()` Get the On Disk Structure (ODS) major version for the database.
`int`	`getODSMinorVersion()` Get the On Disk Structure (ODS) minor version for the database.
`int`	`getPageAllocation()` Get the number of pages allocated for this database at the time of connection.
`int`	`getPageSize()` Get the page size for this database.
`ResultSet`	`getPrimaryKeys(String catalog, String schema, String table)` Get a description of a table's primary key columns.
`ResultSet`	`getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)` Get a description of a catalog's stored procedure parameters and result columns.
`ResultSet`	`getProcedures(String catalog, String schemaPattern, String procedureNamePattern)` Get a description of stored procedures available in a catalog.
`String`	`getProcedureTerm()` What's the database vendor's preferred term for "procedure".
`ResultSet`	`getSchemas()` Get the schema names available in this database.
`String`	`getSchemaTerm()` What's the database vendor's preferred term for "schema".
`String`	`getSearchStringEscape()` This is the string that can be used to escape the wildcard characters '_' or '%' in the string pattern style catalog search parameters.
`Date`	`getServerExpirationDate()` Get the expiration date for the server side JDBC middleware server (InterServer).
`int`	`getServerJDBCNetProtocolVersion()` Get the JDBC/Net protocol used by InterServer.
`int`	`getServerMajorVersion()` What's the major version number for InterServer.
`int`	`getServerMinorVersion()` What's the minor version number for InterServer.
`String`	`getServerName()` What's the name of the server side JDBC middleware server.
`int`	`getServerPort()` Get the JDBC/Net middleware server (InterServer) port.
`String`	`getServerVersion()` What's the version of the server side JDBC middleware server (InterServer).
`String`	`getSQLKeywords()` Get a comma separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
`String`	`getStringFunctions()` Get a comma separated list of string functions.
`boolean`	`getSweepInterval()` Get the sweep interval for automatic housekeeping.
`String`	`getSystemFunctions()` Get a comma separated list of system functions.
`ResultSet`	`getTablePrivileges(String catalog, String schemaPattern, String tableNamePattern)` Get a description of the access rights for each table available in a catalog.
`ResultSet`	`getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)` Get a description of tables available in a catalog.
`ResultSet`	`getTableTypes()` Get the table types available in this database.
`String`	`getTimeDateFunctions()` Get a comma separated list of time and date functions.
`ResultSet`	`getTypeInfo()` Get a description of all the standard SQL types supported by this database.
`String`	`getUDFs()` Return a list of the User-Defined Functions on this database.
`ResultSet`	`getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)` Get a description of the user-defined types defined in a particular schema.
`String`	`getURL()` What's the url for this database.
`String`	`getUserName()` What's our user name as known to the database.
`ResultSet`	`getVersionColumns(String catalog, String schema, String table)` Get a description of a table's columns that are automatically updated when any value in a row is updated.
`boolean`	`insertsAreDetected(int type)` 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`	`isSpaceReservedForVersioning()` Is space being reserved on each newly created database page for anticipated record versions.
`boolean`	`isSynchronous()` Are disk writes synchronous for this connection.
`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)` Determine whether deletes made by others are visible.
`boolean`	`othersInsertsAreVisible(int type)` Determine whether inserts made by others are visible.
`boolean`	`othersUpdatesAreVisible(int type)` Determine whether updates made by others are visible.
`boolean`	`ownDeletesAreVisible(int type)` Determine whether a result set's own deletes visible.
`boolean`	`ownInsertsAreVisible(int type)` Determine whether a result set's own inserts visible.
`boolean`	`ownUpdatesAreVisible(int type)` Determine whether a result set's own updates visible.
`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()` 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`	`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`	`supportsMultipleResultSets()` Are multiple ResultSets from a single execute supported.
`boolean`	`supportsMultipleTransactions()` Can we have multiple transactions open at once (on different connections).
`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`	`supportsResultSetConcurrency(int type, int concurrency)` Does the database support the concurrency type in combination with the given result set type.
`boolean`	`supportsResultSetType(int type)` Does the database support the given result set type.
`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`	`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.
`boolean`	`updatesAreDetected(int type)` 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

Field Detail

procedureResultUnknown

public static final int procedureResultUnknown

PROCEDURE_TYPE - May return a result.

Since:: JDBC 1

procedureNoResult

public static final int procedureNoResult

PROCEDURE_TYPE - Does not return a result.

Since:: JDBC 1

procedureReturnsResult

public static final int procedureReturnsResult

PROCEDURE_TYPE - Returns a result.

Since:: JDBC 1

procedureColumnUnknown

public static final int procedureColumnUnknown

COLUMN_TYPE - nobody knows.

Since:: JDBC 1

procedureColumnIn

public static final int procedureColumnIn

COLUMN_TYPE - IN parameter.

Since:: JDBC 1

procedureColumnInOut

public static final int procedureColumnInOut

COLUMN_TYPE - INOUT parameter.

Since:: JDBC 1

procedureColumnOut

public static final int procedureColumnOut

COLUMN_TYPE - OUT parameter.

Since:: JDBC 1

procedureColumnReturn

public static final int procedureColumnReturn

COLUMN_TYPE - procedure return value.

Since:: JDBC 1

procedureColumnResult

public static final int procedureColumnResult

COLUMN_TYPE - result column in ResultSet.

Since:: JDBC 1

procedureNoNulls

public static final int procedureNoNulls

TYPE NULLABLE - does not allow NULL values.

Since:: JDBC 1

procedureNullable

public static final int procedureNullable

TYPE NULLABLE - allows NULL values.

Since:: JDBC 1

procedureNullableUnknown

public static final int procedureNullableUnknown

TYPE NULLABLE - nullability unknown.

Since:: JDBC 1

columnNoNulls

public static final int columnNoNulls

COLUMN NULLABLE - might not allow NULL values.

Since:: JDBC 1

columnNullable

public static final int columnNullable

COLUMN NULLABLE - definitely allows NULL values.

Since:: JDBC 1

columnNullableUnknown

public static final int columnNullableUnknown

COLUMN NULLABLE - nullability unknown.

Since:: JDBC 1

bestRowTemporary

public static final int bestRowTemporary

BEST ROW SCOPE - very temporary, while using row.

Since:: JDBC 1

bestRowTransaction

public static final int bestRowTransaction

BEST ROW SCOPE - valid for remainder of current transaction.

Since:: JDBC 1

bestRowSession

public static final int bestRowSession

BEST ROW SCOPE - valid for remainder of current session.

Since:: JDBC 1

bestRowUnknown

public static final int bestRowUnknown

BEST ROW PSEUDO_COLUMN - may or may not be pseudo column.

Since:: JDBC 1

bestRowNotPseudo

public static final int bestRowNotPseudo

BEST ROW PSEUDO_COLUMN - is NOT a pseudo column.

Since:: JDBC 1

bestRowPseudo

public static final int bestRowPseudo

BEST ROW PSEUDO_COLUMN - is a pseudo column.

Since:: JDBC 1

versionColumnUnknown

public static final int versionColumnUnknown

VERSION COLUMNS PSEUDO_COLUMN - may or may not be pseudo column.

Since:: JDBC 1

versionColumnNotPseudo

public static final int versionColumnNotPseudo

VERSION COLUMNS PSEUDO_COLUMN - is NOT a pseudo column.

Since:: JDBC 1

versionColumnPseudo

public static final int versionColumnPseudo

VERSION COLUMNS PSEUDO_COLUMN - is a pseudo column.

Since:: JDBC 1

importedKeyCascade

public static final int importedKeyCascade

IMPORT KEY UPDATE_RULE and DELETE_RULE - for update, change imported key to agree with primary key update; for delete, delete rows that import a deleted key.

Since:: JDBC 1

importedKeyRestrict

public static final int importedKeyRestrict

IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.

Since:: JDBC 1

importedKeySetNull

public static final int importedKeySetNull

IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to NULL if its primary key has been updated or deleted.

Since:: JDBC 1

importedKeyNoAction

public static final int importedKeyNoAction

IMPORT KEY UPDATE_RULE and DELETE_RULE - do not allow update or delete of primary key if it has been imported.

Since:: JDBC 1

importedKeySetDefault

public static final int importedKeySetDefault

IMPORT KEY UPDATE_RULE and DELETE_RULE - change imported key to default values if its primary key has been updated or deleted.

Since:: JDBC 1

importedKeyInitiallyDeferred

public static final int importedKeyInitiallyDeferred

IMPORT KEY DEFERRABILITY - see SQL92 for definition

Since:: JDBC 1

importedKeyInitiallyImmediate

public static final int importedKeyInitiallyImmediate

IMPORT KEY DEFERRABILITY - see SQL92 for definition

Since:: JDBC 1

importedKeyNotDeferrable

public static final int importedKeyNotDeferrable

IMPORT KEY DEFERRABILITY - see SQL92 for definition

Since:: JDBC 1

typeNoNulls

public static final int typeNoNulls

TYPE NULLABLE - does not allow NULL values.

Since:: JDBC 1

typeNullable

public static final int typeNullable

TYPE NULLABLE - allows NULL values.

Since:: JDBC 1

typeNullableUnknown

public static final int typeNullableUnknown

TYPE NULLABLE - nullability unknown.

Since:: JDBC 1

typePredNone

public static final int typePredNone

TYPE INFO SEARCHABLE - No support.

Since:: JDBC 1

typePredChar

public static final int typePredChar

TYPE INFO SEARCHABLE - Only supported with WHERE .. LIKE.

Since:: JDBC 1

typePredBasic

public static final int typePredBasic

TYPE INFO SEARCHABLE - Supported except for WHERE .. LIKE.

Since:: JDBC 1

typeSearchable

public static final int typeSearchable

TYPE INFO SEARCHABLE - Supported for all WHERE ...

Since:: JDBC 1

tableIndexStatistic

public static final short tableIndexStatistic

INDEX INFO TYPE - this identifies table statistics that are returned in conjuction with a table's index descriptions

Since:: JDBC 1

tableIndexClustered

public static final short tableIndexClustered

INDEX INFO TYPE - this identifies a clustered index

Since:: JDBC 1

tableIndexHashed

public static final short tableIndexHashed

INDEX INFO TYPE - this identifies a hashed index

Since:: JDBC 1

tableIndexOther

public static final short tableIndexOther

INDEX INFO TYPE - this identifies some other form of index

Since:: JDBC 1

Method Detail

allProceduresAreCallable

public boolean allProceduresAreCallable()
                                 throws SQLException

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

InterClient note: This is always true for sysdba.

Specified by:: allProceduresAreCallable in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

allTablesAreSelectable

public boolean allTablesAreSelectable()
                               throws SQLException

Can all the tables returned by getTable be SELECTed by the current user.

InterClient note: This is always true for sysdba.

Specified by:: allTablesAreSelectable in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getURL

public String getURL()
              throws SQLException

What's the url for this database.

InterClient note: For InterBase this is something like "jdbc:interbase://host_name//databases/employee.gdb" or "jdbc:interbase://host_name/d:/databases/employee.gdb" for a database on server host_name. InterServer and InterBase may reside on separate tiers; If the interserver process is running on a server named interserver_host and the database resides on a server named database_host, then the url is something like

 jdbc:interbase://interserver_host/database_host:/databases/employee.gdb

Specified by:: getURL in interface DatabaseMetaData
Returns:: the url or null if it can't be generated
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getUserName

public String getUserName()
                   throws SQLException

What's our user name as known to the database.

Specified by:: getUserName in interface DatabaseMetaData
Returns:: our database user name
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Is the database in read-only mode.

Specified by:: isReadOnly in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

nullsAreSortedHigh

public boolean nullsAreSortedHigh()
                           throws SQLException

Are NULL values sorted high.

InterClient note: Returns false for InterBase.

Specified by:: nullsAreSortedHigh in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

nullsAreSortedLow

public boolean nullsAreSortedLow()
                          throws SQLException

Are NULL values sorted low.

InterClient note: Returns true for InterBase.

Specified by:: nullsAreSortedLow in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

nullsAreSortedAtStart

public boolean nullsAreSortedAtStart()
                              throws SQLException

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

InterClient note: Returns false for InterBase.

Specified by:: nullsAreSortedAtStart in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

nullsAreSortedAtEnd

public boolean nullsAreSortedAtEnd()
                            throws SQLException

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

InterClient note: Returns false for InterBase.

Specified by:: nullsAreSortedAtEnd in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDatabaseProductName

public String getDatabaseProductName()
                              throws SQLException

What's the name of this database product.

InterClient note: Returns "InterBase" usually, but may be locale dependent.

Specified by:: getDatabaseProductName in interface DatabaseMetaData
Returns:: database product name
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDatabaseProductVersion

public String getDatabaseProductVersion()
                                 throws SQLException

What's the version of this database product.

InterClient note: Returns something like "SO-V4.0B" for an InterBase 4.0B server on Solaris.

Specified by:: getDatabaseProductVersion in interface DatabaseMetaData
Returns:: database version
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDriverName

public String getDriverName()
                     throws SQLException

What's the name of this JDBC driver.

InterClient note: Returns "InterClient"

Specified by:: getDriverName in interface DatabaseMetaData
Returns:: JDBC driver name
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getServerName()

getDriverVersion

public String getDriverVersion()
                        throws SQLException

What's the version of this JDBC driver.

InterClient note: This returns something like "1.50.36 Beta" for beta versions, and something like "1.50.37" for product versions, where 1 is the major version, 50 is the minor version, and 37 is the build number.

Specified by:: getDriverVersion in interface DatabaseMetaData
Returns:: JDBC driver version
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getServerVersion()

getDriverMajorVersion

public int getDriverMajorVersion()

What's this JDBC driver's major version number.

Specified by:: getDriverMajorVersion in interface DatabaseMetaData
Returns:: JDBC driver major version
Since:: JDBC 1
See Also:: Driver.getMajorVersion(), getServerMajorVersion()

getDriverMinorVersion

public int getDriverMinorVersion()

What's this JDBC driver's minor version number.

Specified by:: getDriverMinorVersion in interface DatabaseMetaData
Returns:: JDBC driver minor version number.
Since:: JDBC 1
See Also:: Driver.getMinorVersion(), getServerMinorVersion()

usesLocalFiles

public boolean usesLocalFiles()
                       throws SQLException

Does the database store tables in a local file.

InterClient note: Returns true for InterBase. InterBase databases are stored in .gdb files.

Specified by:: usesLocalFiles in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

usesLocalFilePerTable

public boolean usesLocalFilePerTable()
                              throws SQLException

Does the database use a file for each table.

InterClient note: Returns false for InterBase.

Specified by:: usesLocalFilePerTable in interface DatabaseMetaData
Returns:: true if the database uses a local file for each table
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsMixedCaseIdentifiers

public boolean supportsMixedCaseIdentifiers()
                                     throws SQLException

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

Compliance note: must return false.

InterClient note: Returns false for InterBase.

Specified by:: supportsMixedCaseIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

storesUpperCaseIdentifiers

public boolean storesUpperCaseIdentifiers()
                                   throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: storesUpperCaseIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

storesLowerCaseIdentifiers

public boolean storesLowerCaseIdentifiers()
                                   throws SQLException

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

InterClient note: Returns false for InterBase.

Specified by:: storesLowerCaseIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

storesMixedCaseIdentifiers

public boolean storesMixedCaseIdentifiers()
                                   throws SQLException

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

InterClient note: Returns false for InterBase.

Specified by:: storesMixedCaseIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsMixedCaseQuotedIdentifiers

public boolean supportsMixedCaseQuotedIdentifiers()
                                           throws SQLException

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

Compliance note: must return true.

InterClient note: Returns false for InterBase. InterBase 5 does not support quoted SQL identifiers.

Specified by:: supportsMixedCaseQuotedIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

storesUpperCaseQuotedIdentifiers

public boolean storesUpperCaseQuotedIdentifiers()
                                         throws SQLException

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

InterClient note: Returns false for InterBase. InterBase 5 does not support quoted SQL identifiers.

Specified by:: storesUpperCaseQuotedIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

storesLowerCaseQuotedIdentifiers

public boolean storesLowerCaseQuotedIdentifiers()
                                         throws SQLException

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

InterClient note: Returns false for InterBase. InterBase 5 does not support quoted SQL identifiers.

Specified by:: storesLowerCaseQuotedIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

storesMixedCaseQuotedIdentifiers

public boolean storesMixedCaseQuotedIdentifiers()
                                         throws SQLException

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

InterClient note: Returns false for InterBase. InterBase 5 does not support quoted SQL identifiers.

Specified by:: storesMixedCaseQuotedIdentifiers in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getIdentifierQuoteString

public String getIdentifierQuoteString()
                                throws SQLException

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

Compliance note: must return the double quote character.

InterClient note: Returns " " for InterBase 4 and 5. InterBase 4 and 5 do not support quoted SQL identifiers.

Specified by:: getIdentifierQuoteString in interface DatabaseMetaData
Returns:: the quoting string
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getSQLKeywords

public String getSQLKeywords()
                      throws SQLException

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

Specified by:: getSQLKeywords in interface DatabaseMetaData
Returns:: the list
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getNumericFunctions

public String getNumericFunctions()
                           throws SQLException

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

InterClient note: Returns "" for InterBase. InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Specified by:: getNumericFunctions in interface DatabaseMetaData
Returns:: the list
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getUDFs()

getStringFunctions

public String getStringFunctions()
                          throws SQLException

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

InterClient note: Returns "" for InterBase. InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Specified by:: getStringFunctions in interface DatabaseMetaData
Returns:: the list
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getUDFs()

getSystemFunctions

public String getSystemFunctions()
                          throws SQLException

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

InterClient note: Returns "" for InterBase. InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Specified by:: getSystemFunctions in interface DatabaseMetaData
Returns:: the list
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getUDFs()

getTimeDateFunctions

public String getTimeDateFunctions()
                            throws SQLException

Get a comma separated list of time and date functions.

InterClient note: Returns "" for InterBase. InterBase supports user-defined functions (UDFs) rather than relying on built-in functions.

Specified by:: getTimeDateFunctions in interface DatabaseMetaData
Returns:: the list
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getUDFs()

getSearchStringEscape

public String getSearchStringEscape()
                             throws SQLException

This is the string that can be used to escape the wildcard characters '_' 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.

InterClient note: Returns "\" for InterBase.

Specified by:: getSearchStringEscape in interface DatabaseMetaData
Returns:: the string used to escape wildcard characters
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getExtraNameCharacters

public String getExtraNameCharacters()
                              throws SQLException

Get all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

InterClient note: Returns "$" for InterBase.

Specified by:: getExtraNameCharacters in interface DatabaseMetaData
Returns:: the string containing the extra characters
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsAlterTableWithAddColumn

public boolean supportsAlterTableWithAddColumn()
                                        throws SQLException

Is "ALTER TABLE" with add column supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsAlterTableWithAddColumn in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsAlterTableWithDropColumn

public boolean supportsAlterTableWithDropColumn()
                                         throws SQLException

Is "ALTER TABLE" with drop column supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsAlterTableWithDropColumn in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsColumnAliasing

public boolean supportsColumnAliasing()
                               throws SQLException

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.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsColumnAliasing in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

nullPlusNonNullIsNull

public boolean nullPlusNonNullIsNull()
                              throws SQLException

Are concatenations between NULL and non-NULL values NULL.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: nullPlusNonNullIsNull in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsConvert

public boolean supportsConvert()
                        throws SQLException

Is the CONVERT function between SQL types supported.

InterClient note: Returns false for InterBase. InterBase supports this function using the CAST operator.

Specified by:: supportsConvert in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsConvert

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

Is CONVERT between the given SQL types supported.

InterClient note: Returns false for InterBase. InterBase supports this function using the CAST operator.

Specified by:: supportsConvert in interface DatabaseMetaData
Parameters:: fromType - the type to convert from; toType - the type to convert to
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: java.sql.Types

supportsTableCorrelationNames

public boolean supportsTableCorrelationNames()
                                      throws SQLException

Are table correlation names supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsTableCorrelationNames in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsDifferentTableCorrelationNames

public boolean supportsDifferentTableCorrelationNames()
                                               throws SQLException

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

InterClient note: Returns false for InterBase.

Specified by:: supportsDifferentTableCorrelationNames in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsExpressionsInOrderBy

public boolean supportsExpressionsInOrderBy()
                                     throws SQLException

Are expressions in "ORDER BY" lists supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsExpressionsInOrderBy in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsOrderByUnrelated

public boolean supportsOrderByUnrelated()
                                 throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: supportsOrderByUnrelated in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsGroupBy

public boolean supportsGroupBy()
                        throws SQLException

Is some form of "GROUP BY" clause supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsGroupBy in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsGroupByUnrelated

public boolean supportsGroupByUnrelated()
                                 throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: supportsGroupByUnrelated in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsGroupByBeyondSelect

public boolean supportsGroupByBeyondSelect()
                                    throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: supportsGroupByBeyondSelect in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsLikeEscapeClause

public boolean supportsLikeEscapeClause()
                                 throws SQLException

Is the escape character in "LIKE" clauses supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsLikeEscapeClause in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsMultipleResultSets

public boolean supportsMultipleResultSets()
                                   throws SQLException

Are multiple ResultSets from a single execute supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsMultipleResultSets in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsMultipleTransactions

public boolean supportsMultipleTransactions()
                                     throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: supportsMultipleTransactions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsNonNullableColumns

public boolean supportsNonNullableColumns()
                                   throws SQLException

Can columns be defined as non-nullable.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsNonNullableColumns in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsMinimumSQLGrammar

public boolean supportsMinimumSQLGrammar()
                                  throws SQLException

Is the ODBC Minimum SQL grammar supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsMinimumSQLGrammar in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCoreSQLGrammar

public boolean supportsCoreSQLGrammar()
                               throws SQLException

Is the ODBC Core SQL grammar supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsCoreSQLGrammar in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsExtendedSQLGrammar

public boolean supportsExtendedSQLGrammar()
                                   throws SQLException

Is the ODBC Extended SQL grammar supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsExtendedSQLGrammar in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsANSI92EntryLevelSQL

public boolean supportsANSI92EntryLevelSQL()
                                    throws SQLException

Is the ANSI92 entry level SQL grammar supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsANSI92EntryLevelSQL in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsANSI92IntermediateSQL

public boolean supportsANSI92IntermediateSQL()
                                      throws SQLException

Is the ANSI92 intermediate SQL grammar supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsANSI92IntermediateSQL in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsANSI92FullSQL

public boolean supportsANSI92FullSQL()
                              throws SQLException

Is the ANSI92 full SQL grammar supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsANSI92FullSQL in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsIntegrityEnhancementFacility

public boolean supportsIntegrityEnhancementFacility()
                                             throws SQLException

Is the SQL Integrity Enhancement Facility supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsIntegrityEnhancementFacility in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsOuterJoins

public boolean supportsOuterJoins()
                           throws SQLException

Is some form of outer join supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsOuterJoins in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsFullOuterJoins

public boolean supportsFullOuterJoins()
                               throws SQLException

Are full nested outer joins supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsFullOuterJoins in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsLimitedOuterJoins

public boolean supportsLimitedOuterJoins()
                                  throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: supportsLimitedOuterJoins in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getSchemaTerm

public String getSchemaTerm()
                     throws SQLException

What's the database vendor's preferred term for "schema".

InterClient note: Throws a DriverNotCapableException. InterBase does not support schemas.

Specified by:: getSchemaTerm in interface DatabaseMetaData
Returns:: the vendor term
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getProcedureTerm

public String getProcedureTerm()
                        throws SQLException

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

InterClient note: Returns "PROCEDURE" for InterBase.

Specified by:: getProcedureTerm in interface DatabaseMetaData
Returns:: the vendor term
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getCatalogTerm

public String getCatalogTerm()
                      throws SQLException

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

InterClient note: Throws a DriverNotCapableException. InterBase does not support catalogs.

Specified by:: getCatalogTerm in interface DatabaseMetaData
Returns:: the vendor term
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

isCatalogAtStart

public boolean isCatalogAtStart()
                         throws SQLException

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

InterClient note: Throws a DriverNotCapableException. InterBase does not support catalogs.

Specified by:: isCatalogAtStart in interface DatabaseMetaData
Returns:: true if it appears at the start
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getCatalogSeparator

public String getCatalogSeparator()
                           throws SQLException

What's the separator between catalog and table name.

InterClient note: Always returns "". InterBase does not support catalogs.

Specified by:: getCatalogSeparator in interface DatabaseMetaData
Returns:: the separator string
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

supportsSchemasInDataManipulation

public boolean supportsSchemasInDataManipulation()
                                          throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support schemas.

Specified by:: supportsSchemasInDataManipulation in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSchemasInProcedureCalls

public boolean supportsSchemasInProcedureCalls()
                                        throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support schemas.

Specified by:: supportsSchemasInProcedureCalls in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSchemasInTableDefinitions

public boolean supportsSchemasInTableDefinitions()
                                          throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support schemas.

Specified by:: supportsSchemasInTableDefinitions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSchemasInIndexDefinitions

public boolean supportsSchemasInIndexDefinitions()
                                          throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support schemas.

Specified by:: supportsSchemasInIndexDefinitions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSchemasInPrivilegeDefinitions

public boolean supportsSchemasInPrivilegeDefinitions()
                                              throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support schemas.

Specified by:: supportsSchemasInPrivilegeDefinitions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCatalogsInDataManipulation

public boolean supportsCatalogsInDataManipulation()
                                           throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support catalogs.

Specified by:: supportsCatalogsInDataManipulation in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCatalogsInProcedureCalls

public boolean supportsCatalogsInProcedureCalls()
                                         throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support catalogs.

Specified by:: supportsCatalogsInProcedureCalls in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCatalogsInTableDefinitions

public boolean supportsCatalogsInTableDefinitions()
                                           throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support catalogs.

Specified by:: supportsCatalogsInTableDefinitions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCatalogsInIndexDefinitions

public boolean supportsCatalogsInIndexDefinitions()
                                           throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support catalogs.

Specified by:: supportsCatalogsInIndexDefinitions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCatalogsInPrivilegeDefinitions

public boolean supportsCatalogsInPrivilegeDefinitions()
                                               throws SQLException

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

InterClient note: Returns false for InterBase. InterBase does not support catalogs.

Specified by:: supportsCatalogsInPrivilegeDefinitions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsPositionedDelete

public boolean supportsPositionedDelete()
                                 throws SQLException

Is positioned DELETE supported.

InterClient note: Returns true for InterBase/InterClient.

Specified by:: supportsPositionedDelete in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsPositionedUpdate

public boolean supportsPositionedUpdate()
                                 throws SQLException

Is positioned UPDATE supported.

InterClient note: Returns true for InterBase/InterClient.

Specified by:: supportsPositionedUpdate in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSelectForUpdate

public boolean supportsSelectForUpdate()
                                throws SQLException

Is SELECT for UPDATE supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsSelectForUpdate in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsStoredProcedures

public boolean supportsStoredProcedures()
                                 throws SQLException

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

InterClient note: Returns false for InterBase.

Specified by:: supportsStoredProcedures in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSubqueriesInComparisons

public boolean supportsSubqueriesInComparisons()
                                        throws SQLException

Are subqueries in comparison expressions supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsSubqueriesInComparisons in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSubqueriesInExists

public boolean supportsSubqueriesInExists()
                                   throws SQLException

Are subqueries in 'exists' expressions supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsSubqueriesInExists in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSubqueriesInIns

public boolean supportsSubqueriesInIns()
                                throws SQLException

Are subqueries in 'in' statements supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsSubqueriesInIns in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsSubqueriesInQuantifieds

public boolean supportsSubqueriesInQuantifieds()
                                        throws SQLException

Are subqueries in quantified expressions supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsSubqueriesInQuantifieds in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsCorrelatedSubqueries

public boolean supportsCorrelatedSubqueries()
                                     throws SQLException

Are correlated subqueries supported.

Compliance note: must return true.

InterClient note: Returns true for InterBase.

Specified by:: supportsCorrelatedSubqueries in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsUnion

public boolean supportsUnion()
                      throws SQLException

Is SQL UNION supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsUnion in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsUnionAll

public boolean supportsUnionAll()
                         throws SQLException

Is SQL UNION ALL supported.

InterClient note: Returns true for InterBase.

Specified by:: supportsUnionAll in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsOpenCursorsAcrossCommit

public boolean supportsOpenCursorsAcrossCommit()
                                        throws SQLException

Can cursors remain open across commits.

InterClient note: Returns false for InterBase.

Specified by:: supportsOpenCursorsAcrossCommit in interface DatabaseMetaData
Returns:: true if cursors always remain open; false if they might not remain open
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsOpenCursorsAcrossRollback

public boolean supportsOpenCursorsAcrossRollback()
                                          throws SQLException

Can cursors remain open across rollbacks.

InterClient note: Returns false for InterBase.

Specified by:: supportsOpenCursorsAcrossRollback in interface DatabaseMetaData
Returns:: true if cursors always remain open; false if they might not remain open
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsOpenStatementsAcrossCommit

public boolean supportsOpenStatementsAcrossCommit()
                                           throws SQLException

Can statements remain open across commits.

InterClient note: Returns true for InterBase.

Specified by:: supportsOpenStatementsAcrossCommit in interface DatabaseMetaData
Returns:: true if statements always remain open; false if they might not remain open
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsOpenStatementsAcrossRollback

public boolean supportsOpenStatementsAcrossRollback()
                                             throws SQLException

Can statements remain open across rollbacks.

InterClient note: Returns true for InterBase.

Specified by:: supportsOpenStatementsAcrossRollback in interface DatabaseMetaData
Returns:: true if statements always remain open; false if they might not remain open
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxBinaryLiteralLength

public int getMaxBinaryLiteralLength()
                              throws SQLException

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

InterClient note: Throws a DriverNotCapableException. InterBase does not support binary literals.

Specified by:: getMaxBinaryLiteralLength in interface DatabaseMetaData
Returns:: max literal length
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getMaxCharLiteralLength

public int getMaxCharLiteralLength()
                            throws SQLException

What's the max length for a character literal.

InterClient note: Returns 1,024 (1K) for InterBase.

Specified by:: getMaxCharLiteralLength in interface DatabaseMetaData
Returns:: max literal length
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxColumnNameLength

public int getMaxColumnNameLength()
                           throws SQLException

What's the limit on column name length.

InterClient note: Returns 31 for InterBase.

Specified by:: getMaxColumnNameLength in interface DatabaseMetaData
Returns:: max literal length
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxColumnsInGroupBy

public int getMaxColumnsInGroupBy()
                           throws SQLException

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

InterClient note: Returns 16 for InterBase.

Specified by:: getMaxColumnsInGroupBy in interface DatabaseMetaData
Returns:: max number of columns
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxColumnsInIndex

public int getMaxColumnsInIndex()
                         throws SQLException

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

InterClient note: Returns 16 for InterBase.

Specified by:: getMaxColumnsInIndex in interface DatabaseMetaData
Returns:: max columns
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxColumnsInOrderBy

public int getMaxColumnsInOrderBy()
                           throws SQLException

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

InterClient note: Returns 16 for InterBase.

Specified by:: getMaxColumnsInOrderBy in interface DatabaseMetaData
Returns:: max columns
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxColumnsInSelect

public int getMaxColumnsInSelect()
                          throws SQLException

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

InterClient note: Returns 32,767 for InterBase.

Specified by:: getMaxColumnsInSelect in interface DatabaseMetaData
Returns:: max columns
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxColumnsInTable

public int getMaxColumnsInTable()
                         throws SQLException

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

InterClient note: Returns 32,767 for InterBase.

Specified by:: getMaxColumnsInTable in interface DatabaseMetaData
Returns:: max columns
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxConnections

public int getMaxConnections()
                      throws SQLException

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

InterClient note: Returns 0 (unlimited) for InterBase. This depends mostly on the OS configuration (kernel, RAM, etc...). Practical limits are around 150 using NT-V4.2.

Specified by:: getMaxConnections in interface DatabaseMetaData
Returns:: max connections
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxCursorNameLength

public int getMaxCursorNameLength()
                           throws SQLException

What's the maximum cursor name length.

InterClient note: Return 31 for InterBase.

Specified by:: getMaxCursorNameLength in interface DatabaseMetaData
Returns:: max cursor name length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxIndexLength

public int getMaxIndexLength()
                      throws SQLException

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

InterClient note: Returns 198 bytes for InterBase.

Specified by:: getMaxIndexLength in interface DatabaseMetaData
Returns:: max index length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxSchemaNameLength

public int getMaxSchemaNameLength()
                           throws SQLException

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

InterClient note: Throws a DriverNotCapableException. InterBase does not support schemas.

Specified by:: getMaxSchemaNameLength in interface DatabaseMetaData
Returns:: max name length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getMaxProcedureNameLength

public int getMaxProcedureNameLength()
                              throws SQLException

What's the maximum length of a procedure name.

InterClient note: Returns 27 for InterBase.

Specified by:: getMaxProcedureNameLength in interface DatabaseMetaData
Returns:: max name length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxCatalogNameLength

public int getMaxCatalogNameLength()
                            throws SQLException

What's the maximum length of a catalog name.

InterClient note: Throws a DriverNotCapableException. InterBase does not support catalogs.

Specified by:: getMaxCatalogNameLength in interface DatabaseMetaData
Returns:: max name length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getMaxRowSize

public int getMaxRowSize()
                  throws SQLException

What's the maximum length of a single row.

InterClient note: Returns 32,664 bytes for InterBase.

Specified by:: getMaxRowSize in interface DatabaseMetaData
Returns:: max row size in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

doesMaxRowSizeIncludeBlobs

public boolean doesMaxRowSizeIncludeBlobs()
                                   throws SQLException

Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs.

InterClient note: Returns false for InterBase. There's virtually no limit to the size of a blob, other than the practical limit the OS imposes on the size of a single file (eg. 2 gig on 32-bit unixes).

Specified by:: doesMaxRowSizeIncludeBlobs in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxStatementLength

public int getMaxStatementLength()
                          throws SQLException

What's the maximum length of a SQL statement.

InterClient note: Returns 640 bytes for InterBase.

Specified by:: getMaxStatementLength in interface DatabaseMetaData
Returns:: max length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxStatements

public int getMaxStatements()
                     throws SQLException

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

InterClient note: Returns 0 (unlimited) for InterBase.

Specified by:: getMaxStatements in interface DatabaseMetaData
Returns:: the maximum
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxTableNameLength

public int getMaxTableNameLength()
                          throws SQLException

What's the maximum length of a table name.

InterClient note: Returns 31 for InterBase.

Specified by:: getMaxTableNameLength in interface DatabaseMetaData
Returns:: max name length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxTablesInSelect

public int getMaxTablesInSelect()
                         throws SQLException

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

InterClient note: Returns 16 for InterBase.

Specified by:: getMaxTablesInSelect in interface DatabaseMetaData
Returns:: the maximum
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getMaxUserNameLength

public int getMaxUserNameLength()
                         throws SQLException

What's the maximum length of a user name.

InterClient note: Returns 31 for InterBase.

Specified by:: getMaxUserNameLength in interface DatabaseMetaData
Returns:: max name length in bytes
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getDefaultTransactionIsolation

public int getDefaultTransactionIsolation()
                                   throws SQLException

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

InterClient note: Returns Connection.TRANSACTION_SERIALIZABLE for InterBase.

Specified by:: getDefaultTransactionIsolation in interface DatabaseMetaData
Returns:: the default isolation level
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: Connection

supportsTransactions

public boolean supportsTransactions()
                             throws SQLException

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

InterClient note: Returns true for InterBase.

Specified by:: supportsTransactions in interface DatabaseMetaData
Returns:: true if transactions are supported
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsTransactionIsolationLevel

public boolean supportsTransactionIsolationLevel(int level)
                                          throws SQLException

Does the database support the given transaction isolation level.

InterClient note: InterBase supports the JDBC isolation levels TRANSACTION_REPEATABLE_READ, TRANSACTION_READ_COMMITTED, and TRANSACTION_SERIALIZABLE.

In addition, InterBase's native isolation modes will be supported as extensions to the JDBC api

TRANSACTION_READ_COMMITTED_REC_VERSION (aka TRANSACTION_READ_COMMITTED)
TRANSACTION_READ_COMMITTED_NO_REC_VERSION
TRANSACTION_SNAPSHOT (aka TRANSACTION_SERIALIZABLE)
TRANSACTION_SNAPSHOT_TABLE_STABILITY

Specified by:: supportsTransactionIsolationLevel in interface DatabaseMetaData
Parameters:: level - the values are defined in interbase.interclient.Connection
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: Connection

supportsDataDefinitionAndDataManipulationTransactions

public boolean supportsDataDefinitionAndDataManipulationTransactions()
                                                              throws SQLException

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

InterClient note: Returns true for InterBase, but DDL forces an implicit commit.

Specified by:: supportsDataDefinitionAndDataManipulationTransactions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: dataDefinitionCausesTransactionCommit()

supportsDataManipulationTransactionsOnly

public boolean supportsDataManipulationTransactionsOnly()
                                                 throws SQLException

Are only data manipulation statements within a transaction supported.

InterClient note: Returns false for InterBase.

Specified by:: supportsDataManipulationTransactionsOnly in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

dataDefinitionCausesTransactionCommit

public boolean dataDefinitionCausesTransactionCommit()
                                              throws SQLException

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

InterClient note: Returns true for InterClient. InterClient does not follow the ISQL transaction model. Under the ISQL transaction model, in a mixed DDL/DML transaction, the DDL is autocommitted even if you're not in autocommit mode, but the DML is not autocommitted. So if a rollback occurs, only the DML is rollbacked, hence a mixed DDL/DML transaction is not atomic. Under the InterClient transaction model for a mixed DDL/DML transaction, any DDL forces the entire transaction to commit implicitly, this includes all DML up to and including the DDL atomically.

Specified by:: dataDefinitionCausesTransactionCommit in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

dataDefinitionIgnoredInTransactions

public boolean dataDefinitionIgnoredInTransactions()
                                            throws SQLException

Is a data definition statement within a transaction ignored.

InterClient note: Returns false for InterBase.

Specified by:: dataDefinitionIgnoredInTransactions in interface DatabaseMetaData
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getProcedures

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

Get a description of stored procedures available in a catalog.

Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.

Each procedure description has the the following columns:

PROCEDURE_CAT String => procedure catalog (may be null)
PROCEDURE_SCHEM String => procedure schema (may be null)
PROCEDURE_NAME String => procedure name
reserved for future use
reserved for future use
reserved for future use
REMARKS String => explanatory comment on the procedure
PROCEDURE_TYPE short => kind of procedure:
- procedureResultUnknown - May return a result
- procedureNoResult - Does not return a result
- procedureReturnsResult - Returns a result

InterClient note: InterClient provides an additional 9th column as PROCEDURE_OWNER. A SQLException is thrown if a catalog or schema pattern is given.

Specified by:: getProcedures in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getSearchStringEscape()

getProcedureColumns

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

Get a description of a catalog's stored procedure parameters and result columns.

Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description or column description with the following fields:

PROCEDURE_CAT String => procedure catalog (may be null)
PROCEDURE_SCHEM String => procedure schema (may be null)
PROCEDURE_NAME String => procedure name
COLUMN_NAME String => column/parameter name
COLUMN_TYPE Short => kind of column/parameter:
- procedureColumnUnknown - nobody knows
- procedureColumnIn - IN parameter
- procedureColumnInOut - INOUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value
- procedureColumnResult - result column in ResultSet
DATA_TYPE short => SQL type from java.sql.Types
TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
PRECISION int => precision
LENGTH int => length in bytes of data
SCALE short => scale
RADIX short => radix
NULLABLE short => can it contain NULL?
- procedureNoNulls - does not allow NULL values
- procedureNullable - allows NULL values
- procedureNullableUnknown - nullability unknown
REMARKS String => comment describing parameter/column

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

InterClient note: A SQLException is thrown if a catalog or schema pattern is given.

Specified by:: getProcedureColumns in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getSearchStringEscape()

getTables

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

Get a description of tables available in a catalog.

Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.

Each table description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
REMARKS String => explanatory comment on the table

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

InterClient note: InterClient provides an additional 6th column as TABLE_OWNER. A SQLException is thrown if a catalog or schema pattern is given.

Specified by:: getTables in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getSearchStringEscape()

getSchemas

public ResultSet getSchemas()
                     throws SQLException

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

The schema column is:

TABLE_SCHEM String => schema name

InterClient note: Throws a DriverNotCapableException. InterBase does not support schemas.

Specified by:: getSchemas in interface DatabaseMetaData
Returns:: ResultSet - each row has a single String column that is a schema name
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getCatalogs

public ResultSet getCatalogs()
                      throws SQLException

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

The catalog column is:

TABLE_CAT String => catalog name

InterClient note: Throws a DriverNotCapableException. InterBase does not support catalogs.

Specified by:: getCatalogs in interface DatabaseMetaData
Returns:: ResultSet - each row has a single String column that is a catalog name
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1, not supported

getTableTypes

public ResultSet getTableTypes()
                        throws SQLException

Get the table types available in this database. The results are ordered by table type.

The table type is:

TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Specified by:: getTableTypes in interface DatabaseMetaData
Returns:: ResultSet - each row has a single String column that is a table type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getColumns

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

Get a description of table columns available in a catalog.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.

Each column description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
COLUMN_NAME String => column name
DATA_TYPE short => SQL type from java.sql.Types
TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
COLUMN_SIZE int => column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
BUFFER_LENGTH is not used.
DECIMAL_DIGITS int => the number of fractional digits
NUM_PREC_RADIX int => Radix (typically either 10 or 2)
NULLABLE int => is NULL allowed?
- columnNoNulls - might not allow NULL values
- columnNullable - definitely allows NULL values
- columnNullableUnknown - nullability unknown
REMARKS String => comment describing column (may be null)
COLUMN_DEF String => default value (may be null)
SQL_DATA_TYPE int => unused
SQL_DATETIME_SUB int => unused
CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
ORDINAL_POSITION int => index of column in table (starting at 1)
IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.

InterClient note: A SQLException is thrown if a catalog or schema pattern is given.

Specified by:: getColumns in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getSearchStringEscape()

getColumnPrivileges

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

Get a description of the access rights for a table's columns.

Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.

Each privilige description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
COLUMN_NAME String => column name
GRANTOR => grantor of access (may be null)
GRANTEE String => grantee of access
PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getColumnPrivileges in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getSearchStringEscape()

getTablePrivileges

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

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

Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.

Each privilige description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
GRANTOR => grantor of access (may be null)
GRANTEE String => grantee of access
PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

InterClient note: A SQLException is thrown if a catalog or schema pattern is given.

Specified by:: getTablePrivileges in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getSearchStringEscape()

getBestRowIdentifier

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

Get a description of a table's optimal set of columns that uniquely identifies a row. They are ordered by SCOPE.

Each column description has the following columns:

SCOPE short => actual scope of result
- bestRowTemporary - very temporary, while using row
- bestRowTransaction - valid for remainder of current transaction
- bestRowSession - valid for remainder of current session
COLUMN_NAME String => column name
DATA_TYPE short => SQL data type from java.sql.Types
TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
COLUMN_SIZE int => precision
BUFFER_LENGTH int => not used
DECIMAL_DIGITS short => scale
PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
- bestRowUnknown - may or may not be pseudo column
- bestRowNotPseudo - is NOT a pseudo column
- bestRowPseudo - is a pseudo column

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getBestRowIdentifier in interface 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; 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:: SQLException - if a database access error occurs.
Since:: JDBC 1

getVersionColumns

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

Get a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.

Each column description has the following columns:

SCOPE short => is not used
COLUMN_NAME String => column name
DATA_TYPE short => SQL data type from java.sql.Types
TYPE_NAME String => Data source dependent type name
COLUMN_SIZE int => precision
BUFFER_LENGTH int => length of column value in bytes
DECIMAL_DIGITS short => scale
PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
- versionColumnUnknown - may or may not be pseudo column
- versionColumnNotPseudo - is NOT a pseudo column
- versionColumnPseudo - is a pseudo column

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getVersionColumns in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 1

getPrimaryKeys

public ResultSet getPrimaryKeys(String catalog,
                                String schema,
                                String table)
                         throws 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:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
COLUMN_NAME String => column name
KEY_SEQ short => sequence number within primary key
PK_NAME String => primary key name (may be null)

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getPrimaryKeys in interface 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 primary key column description
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getImportedKeys

public ResultSet getImportedKeys(String catalog,
                                 String schema,
                                 String table)
                          throws 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:

PKTABLE_CAT String => primary key table catalog being imported (may be null)
PKTABLE_SCHEM String => primary key table schema being imported (may be null)
PKTABLE_NAME String => primary key table name being imported
PKCOLUMN_NAME String => primary key column name being imported
FKTABLE_CAT String => foreign key table catalog (may be null)
FKTABLE_SCHEM String => foreign key table schema (may be null)
FKTABLE_NAME String => foreign key table name
FKCOLUMN_NAME String => foreign key column name
KEY_SEQ short => sequence number within foreign key
UPDATE_RULE short => What happens to foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
DELETE_RULE short => What happens to the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
FK_NAME String => foreign key name (may be null)
PK_NAME String => primary key name (may be null)
DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getImportedKeys in interface 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 primary key column description
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getExportedKeys(java.lang.String, java.lang.String, java.lang.String)

getExportedKeys

public ResultSet getExportedKeys(String catalog,
                                 String schema,
                                 String table)
                          throws 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:

PKTABLE_CAT String => primary key table catalog (may be null)
PKTABLE_SCHEM String => primary key table schema (may be null)
PKTABLE_NAME String => primary key table name
PKCOLUMN_NAME String => primary key column name
FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
FKTABLE_NAME String => foreign key table name being exported
FKCOLUMN_NAME String => foreign key column name being exported
KEY_SEQ short => sequence number within foreign key
UPDATE_RULE short => What happens to foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
DELETE_RULE short => What happens to the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
FK_NAME String => foreign key name (may be null)
PK_NAME String => primary key name (may be null)
DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getExportedKeys in interface 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 foreign key column description
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

getCrossReference

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

Get a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table. Viz. describe how one table imports another's key. This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

PKTABLE_CAT String => primary key table catalog (may be null)
PKTABLE_SCHEM String => primary key table schema (may be null)
PKTABLE_NAME String => primary key table name
PKCOLUMN_NAME String => primary key column name
FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
FKTABLE_NAME String => foreign key table name being exported
FKCOLUMN_NAME String => foreign key column name being exported
KEY_SEQ short => sequence number within foreign key
UPDATE_RULE short => What happens to foreign key when primary is updated:
- importedNoAction - do not allow update of primary key if it has been imported
- importedKeyCascade - change imported key to agree with primary key update
- importedKeySetNull - change imported key to NULL if its primary key has been updated
- importedKeySetDefault - change imported key to default values if its primary key has been updated
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
DELETE_RULE short => What happens to the foreign key when primary is deleted.
- importedKeyNoAction - do not allow delete of primary key if it has been imported
- importedKeyCascade - delete rows that import a deleted key
- importedKeySetNull - change imported key to NULL if its primary key has been deleted
- importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
- importedKeySetDefault - change imported key to default if its primary key has been deleted
FK_NAME String => foreign key name (may be null)
PK_NAME String => primary key name (may be null)
DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
- importedKeyInitiallyDeferred - see SQL92 for definition
- importedKeyInitiallyImmediate - see SQL92 for definition
- importedKeyNotDeferrable - see SQL92 for definition

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getCrossReference in interface DatabaseMetaData
Parameters:: primaryCatalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria; primarySchema - a schema name; "" 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; "" retrieves those without a schema; foreignTable - the table name that imports the key
Returns:: ResultSet - each row is a foreign key column description
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1
See Also:: getImportedKeys(java.lang.String, java.lang.String, java.lang.String)

getTypeInfo

public ResultSet getTypeInfo()
                      throws 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:

TYPE_NAME String => Type name
DATA_TYPE short => SQL data type from java.sql.Types
PRECISION int => maximum precision
LITERAL_PREFIX String => prefix used to quote a literal (may be null)
LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
CREATE_PARAMS String => parameters used in creating the type (may be null)
NULLABLE short => can you use NULL for this type?
- typeNoNulls - does not allow NULL values
- typeNullable - allows NULL values
- typeNullableUnknown - nullability unknown
CASE_SENSITIVE boolean=> is it case sensitive?
SEARCHABLE short => can you use "WHERE" based on this type:
- typePredNone - No support
- typePredChar - Only supported with WHERE .. LIKE
- typePredBasic - Supported except for WHERE .. LIKE
- typeSearchable - Supported for all WHERE ..
UNSIGNED_ATTRIBUTE boolean => is it unsigned?
FIXED_PREC_SCALE boolean => can it be a money value?
AUTO_INCREMENT boolean => can it be used for an auto-increment value?
LOCAL_TYPE_NAME String => localized version of type name (may be null)
MINIMUM_SCALE short => minimum scale supported
MAXIMUM_SCALE short => maximum scale supported
SQL_DATA_TYPE int => unused
SQL_DATETIME_SUB int => unused
NUM_PREC_RADIX int => usually 2 or 10

Specified by:: getTypeInfo in interface DatabaseMetaData
Returns:: ResultSet - each row is a SQL type description
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 1

getIndexInfo

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

Get a description of a table's indices and statistics. They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

Each index column description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
TYPE short => index type:
- tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
- tableIndexClustered - this is a clustered index
- tableIndexHashed - this is a hashed index
- tableIndexOther - this is some other style of index
ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
FILTER_CONDITION String => Filter condition, if any. (may be null)

InterClient note: A SQLException is thrown if a catalog or schema is given.

Specified by:: getIndexInfo in interface 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; 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:: SQLException - if a database access error occurs.
Since:: JDBC 1

supportsResultSetType

public boolean supportsResultSetType(int type)
                              throws SQLException

Does the database support the given result set type.

Specified by:: supportsResultSetType in interface DatabaseMetaData
Parameters:: type - defined in java.sql.ResultSet
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported
See Also:: Connection

supportsResultSetConcurrency

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

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

Specified by:: supportsResultSetConcurrency in interface DatabaseMetaData
Parameters:: type - defined in java.sql.ResultSet; concurrency - type defined in java.sql.ResultSet
Returns:: true if so
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported
See Also:: Connection

ownUpdatesAreVisible

public boolean ownUpdatesAreVisible(int type)
                             throws SQLException

Determine whether a result set's own updates visible.

Specified by:: ownUpdatesAreVisible in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are visible for the result set type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

ownDeletesAreVisible

public boolean ownDeletesAreVisible(int type)
                             throws SQLException

Determine whether a result set's own deletes visible.

Specified by:: ownDeletesAreVisible in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are visible for the result set type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

ownInsertsAreVisible

public boolean ownInsertsAreVisible(int type)
                             throws SQLException

Determine whether a result set's own inserts visible.

Specified by:: ownInsertsAreVisible in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are visible for the result set type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

othersUpdatesAreVisible

public boolean othersUpdatesAreVisible(int type)
                                throws SQLException

Determine whether updates made by others are visible.

Specified by:: othersUpdatesAreVisible in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are visible for the result set type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

othersDeletesAreVisible

public boolean othersDeletesAreVisible(int type)
                                throws SQLException

Determine whether deletes made by others are visible.

Specified by:: othersDeletesAreVisible in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are visible for the result set type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

othersInsertsAreVisible

public boolean othersInsertsAreVisible(int type)
                                throws SQLException

Determine whether inserts made by others are visible.

Specified by:: othersInsertsAreVisible in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are visible for the result set type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

updatesAreDetected

public boolean updatesAreDetected(int type)
                           throws SQLException

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

Specified by:: updatesAreDetected in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are detected by the resultset type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

deletesAreDetected

public boolean deletesAreDetected(int type)
                           throws SQLException

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 DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are detected by the resultset type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

insertsAreDetected

public boolean insertsAreDetected(int type)
                           throws SQLException

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

Specified by:: insertsAreDetected in interface DatabaseMetaData
Parameters:: result - set type, i.e. ResultSet.TYPE_XXX
Returns:: true if changes are detected by the resultset type
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

supportsBatchUpdates

public boolean supportsBatchUpdates()
                             throws SQLException

Return true if the driver supports batch updates, else return false.

Specified by:: supportsBatchUpdates in interface DatabaseMetaData
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

getUDTs

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

Get a description of the user-defined types defined in a particular schema. Schema specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully qualified name. In this case, the catalog and schemaPattern parameters are ignored.

Each type description has the following columns:

TYPE_CAT String => the type's catalog (may be null)
TYPE_SCHEM String => type's schema (may be null)
TYPE_NAME String => type name
CLASS_NAME String => Java class name
DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
REMARKS String => explanatory comment on the type

Note: If the driver does not support UDTs then an empty result set is returned.

Specified by:: getUDTs in interface 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:: SQLException - if a database access error occurs.
Since:: JDBC 2, not yet supported

getConnection

public Connection getConnection()
                         throws SQLException

Return the connection that produced this metadata object.

Specified by:: getConnection in interface DatabaseMetaData
Throws:: SQLException - if a database access error occurs.
Since:: JDBC 2, since 1.50

getUDFs

public String getUDFs()
               throws SQLException

Return a list of the User-Defined Functions on this database.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

getServerName

public String getServerName()
                     throws SQLException

What's the name of the server side JDBC middleware server.

Returns:: "InterServer".
Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for 2.0
See Also:: getDriverName()

getServerVersion

public String getServerVersion()
                        throws SQLException

What's the version of the server side JDBC middleware server (InterServer).

Returns:: InterServer version.
Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for 2.0
See Also:: getDriverVersion()

getServerMajorVersion

public int getServerMajorVersion()
                          throws SQLException

What's the major version number for InterServer.

Returns:: InterServer major version.
Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for 2.0
See Also:: getDriverMajorVersion(), Server.getMajorVersion()

getServerMinorVersion

public int getServerMinorVersion()
                          throws SQLException

What's the minor version number for InterServer.

Returns:: InterServer minor version.
Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for 2.0
See Also:: getDriverMinorVersion(), Server.getMinorVersion()

getServerJDBCNetProtocolVersion

public int getServerJDBCNetProtocolVersion()
                                    throws SQLException

Get the JDBC/Net protocol used by InterServer.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for 2.0
See Also:: getDriverJDBCNetProtocolVersion(), Server.getJDBCNetProtocolVersion()

getDriverJDBCNetProtocolVersion

public int getDriverJDBCNetProtocolVersion()

Get the JDBC/Net protocol used by InterClient.

Since:: Extension, proposed for 2.0
See Also:: getServerJDBCNetProtocolVersion(), Driver.getJDBCNetProtocolVersion()

getServerExpirationDate

public Date getServerExpirationDate()
                             throws SQLException

Get the expiration date for the server side JDBC middleware server (InterServer).

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for 2.0
See Also:: getDriverExpirationDate(), Server.getExpirationDate()

getDriverExpirationDate

public Date getDriverExpirationDate()

Get the expiration date for InterClient.

Since:: Extension, proposed for 2.0
See Also:: getServerExpirationDate(), Driver.getExpirationDate()

getServerPort

public int getServerPort()
                  throws SQLException

Get the JDBC/Net middleware server (InterServer) port.

Throws:: SQLException - if a server access error occurs.
Since:: Extension, proposed for 2.0
See Also:: Server.getPort()

getDatabaseMajorVersion

public int getDatabaseMajorVersion()
                            throws SQLException

Get the major version for the InterBase product.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

getODSMajorVersion

public int getODSMajorVersion()
                       throws SQLException

Get the On Disk Structure (ODS) major version for the database.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

getODSMinorVersion

public int getODSMinorVersion()
                       throws SQLException

Get the On Disk Structure (ODS) minor version for the database.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

getPageSize

public int getPageSize()
                throws SQLException

Get the page size for this database.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

getPageAllocation

public int getPageAllocation()
                      throws SQLException

Get the number of pages allocated for this database at the time of connection.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

getSweepInterval

public boolean getSweepInterval()
                         throws SQLException

Get the sweep interval for automatic housekeeping.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported

isSpaceReservedForVersioning

public boolean isSpaceReservedForVersioning()
                                     throws SQLException

Is space being reserved on each newly created database page for anticipated record versions.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported
See Also:: ConnectionProperties.reserveNoSpaceForVersioning(boolean)

isSynchronous

public boolean isSynchronous()
                      throws SQLException

Are disk writes synchronous for this connection.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported
See Also:: ConnectionProperties.allowAsynchronousDiskWrites(boolean)

getCacheBuffers

public int getCacheBuffers()
                    throws SQLException

Get the actual number of cache page buffers being used for this connection.

Throws:: SQLException - if a database access error occurs.
Since:: Extension, proposed for future release, not yet supported
See Also:: ConnectionProperties.setCacheBuffers(int), Server.getCacheBuffers(java.lang.String), Server.getDefaultCacheBuffers()

Overview

Package

Class

Tree

Deprecated

Index

Help

1.50.39

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Send comments or suggestions to icsupport@interbase.com

interbase.interclient Class DatabaseMetaData

procedureResultUnknown

procedureNoResult

procedureReturnsResult

procedureColumnUnknown

procedureColumnIn

procedureColumnInOut

procedureColumnOut

procedureColumnReturn

procedureColumnResult

procedureNoNulls

procedureNullable

procedureNullableUnknown

columnNoNulls

columnNullable

columnNullableUnknown

bestRowTemporary

bestRowTransaction

bestRowSession

bestRowUnknown

bestRowNotPseudo

bestRowPseudo

versionColumnUnknown

versionColumnNotPseudo

versionColumnPseudo

importedKeyCascade

importedKeyRestrict

importedKeySetNull

importedKeyNoAction

importedKeySetDefault

importedKeyInitiallyDeferred

importedKeyInitiallyImmediate

importedKeyNotDeferrable

typeNoNulls

typeNullable

typeNullableUnknown

typePredNone

typePredChar

typePredBasic

typeSearchable

tableIndexStatistic

tableIndexClustered

tableIndexHashed

tableIndexOther

allProceduresAreCallable

allTablesAreSelectable

getURL

getUserName

isReadOnly

nullsAreSortedHigh

nullsAreSortedLow

nullsAreSortedAtStart

nullsAreSortedAtEnd

getDatabaseProductName

getDatabaseProductVersion

getDriverName

getDriverVersion

getDriverMajorVersion

getDriverMinorVersion

usesLocalFiles

usesLocalFilePerTable

supportsMixedCaseIdentifiers

storesUpperCaseIdentifiers

storesLowerCaseIdentifiers

storesMixedCaseIdentifiers

supportsMixedCaseQuotedIdentifiers

storesUpperCaseQuotedIdentifiers

storesLowerCaseQuotedIdentifiers

storesMixedCaseQuotedIdentifiers

getIdentifierQuoteString

getSQLKeywords

getNumericFunctions

getStringFunctions

getSystemFunctions

getTimeDateFunctions

getSearchStringEscape

getExtraNameCharacters

supportsAlterTableWithAddColumn

supportsAlterTableWithDropColumn

supportsColumnAliasing

interbase.interclient
Class DatabaseMetaData