LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XDatabaseMetaData Interface Referencepublished

provides comprehensive information about the database as a whole. More...

import"XDatabaseMetaData.idl";

Inheritance diagram for XDatabaseMetaData:
XInterface XDatabaseMetaData2

Public Member Functions

boolean allProceduresAreCallable () raises (SQLException)
 Can all the procedures returned by getProcedures be called by the current user? More...
 
boolean allTablesAreSelectable () raises (SQLException)
 Can all the tables returned by getTable be SELECTed by the current user? More...
 
string getURL () raises (SQLException)
 returns the URL for the database connection More...
 
string getUserName () raises (SQLException)
 returns the user name from this database connection. More...
 
boolean isReadOnly () raises (SQLException)
 checks if the database in read-only mode. More...
 
boolean nullsAreSortedHigh () raises (SQLException)
 Are NULL values sorted high? More...
 
boolean nullsAreSortedLow () raises (SQLException)
 Are NULL values sorted low? More...
 
boolean nullsAreSortedAtStart () raises (SQLException)
 Are NULL values sorted at the start regardless of sort order? More...
 
boolean nullsAreSortedAtEnd () raises (SQLException)
 Are NULL values sorted at the end, regardless of sort order? More...
 
string getDatabaseProductName () raises (SQLException)
 returns the name of the database product. More...
 
string getDatabaseProductVersion () raises (SQLException)
 returns the version of the database product. More...
 
string getDriverName () raises (SQLException)
 returns the name of the SDBC driver. More...
 
string getDriverVersion () raises (SQLException)
 returns the version number of the SDBC driver. More...
 
long getDriverMajorVersion ()
 returns the SDBC driver major version number. More...
 
long getDriverMinorVersion ()
 returns the SDBC driver minor version number. More...
 
boolean usesLocalFiles () raises (SQLException)
 use the database local files to save the tables. More...
 
boolean usesLocalFilePerTable () raises (SQLException)
 use the database one local file to save for each table. More...
 
boolean supportsMixedCaseIdentifiers () raises (SQLException)
 use the database "mixed case unquoted SQL identifiers" case sensitive. More...
 
boolean storesUpperCaseIdentifiers () raises (SQLException)
 Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case? More...
 
boolean storesLowerCaseIdentifiers () raises (SQLException)
 Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case? More...
 
boolean storesMixedCaseIdentifiers () raises (SQLException)
 Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case? More...
 
boolean supportsMixedCaseQuotedIdentifiers () raises (SQLException)
 Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? More...
 
boolean storesUpperCaseQuotedIdentifiers () raises (SQLException)
 Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case? More...
 
boolean storesLowerCaseQuotedIdentifiers () raises (SQLException)
 Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case? More...
 
boolean storesMixedCaseQuotedIdentifiers () raises (SQLException)
 Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case? More...
 
string getIdentifierQuoteString () raises (SQLException)
 What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting is not supported. More...
 
string getSQLKeywords () raises (SQLException)
 gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords. More...
 
string getNumericFunctions () raises (SQLException)
 gets a comma-separated list of math functions. More...
 
string getStringFunctions () raises (SQLException)
 gets a comma-separated list of string functions. More...
 
string getSystemFunctions () raises (SQLException)
 gets a comma-separated list of system functions. More...
 
string getTimeDateFunctions () raises (SQLException)
 gets a comma-separated list of time and date functions. More...
 
string getSearchStringEscape () raises (SQLException)
 gets the string that can be used to escape wildcard characters. More...
 
string getExtraNameCharacters () raises (SQLException)
 gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). More...
 
boolean supportsAlterTableWithAddColumn () raises (SQLException)
 support the Database "ALTER TABLE" with add column? More...
 
boolean supportsAlterTableWithDropColumn () raises (SQLException)
 support the Database "ALTER TABLE" with drop column? More...
 
boolean supportsColumnAliasing () raises (SQLException)
 support the Database column aliasing? More...
 
boolean nullPlusNonNullIsNull () raises (SQLException)
 are concatenations between NULL and non-NULL values NULL? More...
 
boolean supportsTypeConversion () raises (SQLException)
 TRUE , if the Database supports the CONVERT function between SQL types, otherwise FALSE. More...
 
boolean supportsConvert ([in]long fromType, [in]long toType) raises (SQLException)
 TRUE , if the Database supports the CONVERT between the given SQL types otherwise FALSE. More...
 
boolean supportsTableCorrelationNames () raises (SQLException)
 Are table correlation names supported? More...
 
boolean supportsDifferentTableCorrelationNames () raises (SQLException)
 If table correlation names are supported, are they restricted to be different from the names of the tables? More...
 
boolean supportsExpressionsInOrderBy () raises (SQLException)
 Are expressions in "ORDER BY" lists supported? More...
 
boolean supportsOrderByUnrelated () raises (SQLException)
 Can an "ORDER BY" clause use columns not in the SELECT statement? More...
 
boolean supportsGroupBy () raises (SQLException)
 Is some form of "GROUP BY" clause supported? More...
 
boolean supportsGroupByUnrelated () raises (SQLException)
 Can a "GROUP BY" clause use columns not in the SELECT? More...
 
boolean supportsGroupByBeyondSelect () raises (SQLException)
 Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT? More...
 
boolean supportsLikeEscapeClause () raises (SQLException)
 Is the escape character in "LIKE" clauses supported? More...
 
boolean supportsMultipleResultSets () raises (SQLException)
 Are multiple XResultSets from a single execute supported? More...
 
boolean supportsMultipleTransactions () raises (SQLException)
 Can we have multiple transactions open at once (on different connections)? More...
 
boolean supportsNonNullableColumns () raises (SQLException)
 Can columns be defined as non-nullable? More...
 
boolean supportsMinimumSQLGrammar () raises (SQLException)
 TRUE, if the database supports ODBC Minimum SQL grammar, otherwise FALSE. More...
 
boolean supportsCoreSQLGrammar () raises (SQLException)
 TRUE, if the database supports ODBC Core SQL grammar, otherwise FALSE. More...
 
boolean supportsExtendedSQLGrammar () raises (SQLException)
 TRUE, if the database supports ODBC Extended SQL grammar, otherwise FALSE. More...
 
boolean supportsANSI92EntryLevelSQL () raises (SQLException)
 
boolean supportsANSI92IntermediateSQL () raises (SQLException)
 
boolean supportsANSI92FullSQL () raises (SQLException)
 
boolean supportsIntegrityEnhancementFacility () raises (SQLException)
 returns TRUE, if the Database supports SQL Integrity Enhancement Facility, otherwise FALSE. More...
 
boolean supportsOuterJoins () raises (SQLException)
 
boolean supportsFullOuterJoins () raises (SQLException)
 
boolean supportsLimitedOuterJoins () raises (SQLException)
 
string getSchemaTerm () raises (SQLException)
 return the database vendor's preferred term for "schema" More...
 
string getProcedureTerm () raises (SQLException)
 return the database vendor's preferred term for "procedure" More...
 
string getCatalogTerm () raises (SQLException)
 return the database vendor's preferred term for "catalog" More...
 
boolean isCatalogAtStart () raises (SQLException)
 Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end) More...
 
string getCatalogSeparator () raises (SQLException)
 return the separator between catalog and table name More...
 
boolean supportsSchemasInDataManipulation () raises (SQLException)
 Can a schema name be used in a data manipulation statement? More...
 
boolean supportsSchemasInProcedureCalls () raises (SQLException)
 Can a schema name be used in a procedure call statement? More...
 
boolean supportsSchemasInTableDefinitions () raises (SQLException)
 Can a schema name be used in a table definition statement? More...
 
boolean supportsSchemasInIndexDefinitions () raises (SQLException)
 Can a schema name be used in an index definition statement? More...
 
boolean supportsSchemasInPrivilegeDefinitions () raises (SQLException)
 Can a schema name be used in a privilege definition statement? More...
 
boolean supportsCatalogsInDataManipulation () raises (SQLException)
 Can a catalog name be used in a data manipulation statement? More...
 
boolean supportsCatalogsInProcedureCalls () raises (SQLException)
 Can a catalog name be used in a procedure call statement? More...
 
boolean supportsCatalogsInTableDefinitions () raises (SQLException)
 Can a catalog name be used in a table definition statement? More...
 
boolean supportsCatalogsInIndexDefinitions () raises (SQLException)
 Can a catalog name be used in an index definition statement? More...
 
boolean supportsCatalogsInPrivilegeDefinitions () raises (SQLException)
 Can a catalog name be used in a privilege definition statement? More...
 
boolean supportsPositionedDelete () raises (SQLException)
 Is positioned DELETE supported? More...
 
boolean supportsPositionedUpdate () raises (SQLException)
 Is positioned UPDATE supported? More...
 
boolean supportsSelectForUpdate () raises (SQLException)
 Is SELECT for UPDATE supported? More...
 
boolean supportsStoredProcedures () raises (SQLException)
 Are stored procedure calls using the stored procedure escape syntax supported? More...
 
boolean supportsSubqueriesInComparisons () raises (SQLException)
 Are subqueries in comparison expressions supported? More...
 
boolean supportsSubqueriesInExists () raises (SQLException)
 Are subqueries in "exists" expressions supported? More...
 
boolean supportsSubqueriesInIns () raises (SQLException)
 Are subqueries in "in" statements supported? More...
 
boolean supportsSubqueriesInQuantifieds () raises (SQLException)
 Are subqueries in quantified expressions supported? More...
 
boolean supportsCorrelatedSubqueries () raises (SQLException)
 Are correlated subqueries supported? More...
 
boolean supportsUnion () raises (SQLException)
 Is SQL UNION supported? More...
 
boolean supportsUnionAll () raises (SQLException)
 Is SQL UNION ALL supported? More...
 
boolean supportsOpenCursorsAcrossCommit () raises (SQLException)
 Can cursors remain open across commits? More...
 
boolean supportsOpenCursorsAcrossRollback () raises (SQLException)
 Can cursors remain open across rollbacks? More...
 
boolean supportsOpenStatementsAcrossCommit () raises (SQLException)
 Can statements remain open across commits? More...
 
boolean supportsOpenStatementsAcrossRollback () raises (SQLException)
 Can statements remain open across rollbacks? More...
 
long getMaxBinaryLiteralLength () raises (SQLException)
 return the maximal number of hex characters in an inline binary literal More...
 
long getMaxCharLiteralLength () raises (SQLException)
 return the max length for a character literal More...
 
long getMaxColumnNameLength () raises (SQLException)
 return the limit on column name length More...
 
long getMaxColumnsInGroupBy () raises (SQLException)
 return the maximum number of columns in a "GROUP BY" clause More...
 
long getMaxColumnsInIndex () raises (SQLException)
 return the maximum number of columns allowed in an index More...
 
long getMaxColumnsInOrderBy () raises (SQLException)
 return the maximum number of columns in an "ORDER BY" clause More...
 
long getMaxColumnsInSelect () raises (SQLException)
 return the maximum number of columns in a "SELECT" list More...
 
long getMaxColumnsInTable () raises (SQLException)
 return the maximum number of columns in a table More...
 
long getMaxConnections () raises (SQLException)
 return the number of active connections at a time to this database. More...
 
long getMaxCursorNameLength () raises (SQLException)
 return the maximum cursor name length More...
 
long getMaxIndexLength () raises (SQLException)
 return the maximum length of an index (in bytes) More...
 
long getMaxSchemaNameLength () raises (SQLException)
 return the maximum length allowed for a schema name More...
 
long getMaxProcedureNameLength () raises (SQLException)
 return the maximum length of a procedure name More...
 
long getMaxCatalogNameLength () raises (SQLException)
 return the maximum length of a catalog name More...
 
long getMaxRowSize () raises (SQLException)
 return the maximum length of a single row. More...
 
boolean doesMaxRowSizeIncludeBlobs () raises (SQLException)
 Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs? More...
 
long getMaxStatementLength () raises (SQLException)
 return the maximum length of a SQL statement More...
 
long getMaxStatements () raises (SQLException)
 return the maximal number of open active statements at one time to this database More...
 
long getMaxTableNameLength () raises (SQLException)
 return the maximum length of a table name More...
 
long getMaxTablesInSelect () raises (SQLException)
 return the maximum number of tables in a SELECT statement More...
 
long getMaxUserNameLength () raises (SQLException)
 return the maximum length of a user name More...
 
long getDefaultTransactionIsolation () raises (SQLException)
 return the database default transaction isolation level. More...
 
boolean supportsTransactions () raises (SQLException)
 support the Database transactions? If not, invoking the method com::sun::star::sdbc::XConnection::commit() is a noop and the isolation level is TransactionIsolation_NONE. More...
 
boolean supportsTransactionIsolationLevel ([in]long level) raises (SQLException)
 Does this database support the given transaction isolation level? More...
 
boolean supportsDataDefinitionAndDataManipulationTransactions () raises (SQLException)
 support the Database both data definition and data manipulation statements within a transaction? More...
 
boolean supportsDataManipulationTransactionsOnly () raises (SQLException)
 are only data manipulation statements within a transaction supported? More...
 
boolean dataDefinitionCausesTransactionCommit () raises (SQLException)
 does a data definition statement within a transaction force the transaction to commit? More...
 
boolean dataDefinitionIgnoredInTransactions () raises (SQLException)
 is a data definition statement within a transaction ignored? More...
 
XResultSet getProcedures ([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern) raises (SQLException)
 Gets a description of the stored procedures available in a catalog. More...
 
XResultSet getProcedureColumns ([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern, [in]string columnNamePattern) raises (SQLException)
 gets a description of a catalog's stored procedure parameters and result columns. More...
 
XResultSet getTables ([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]sequence< string > types) raises (SQLException)
 gets a description of tables available in a catalog. More...
 
XResultSet getSchemas () raises (SQLException)
 Gets the schema names available in this database. More...
 
XResultSet getCatalogs () raises (SQLException)
 gets the catalog names available in this database. More...
 
XResultSet getTableTypes () raises (SQLException)
 gets the table types available in this database. More...
 
XResultSet getColumns ([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]string columnNamePattern) raises (SQLException)
 gets a description of table columns available in the specified catalog. More...
 
XResultSet getColumnPrivileges ([in]any catalog, [in]string schema, [in]string table, [in]string columnNamePattern) raises (SQLException)
 gets a description of the access rights for a table's columns. More...
 
XResultSet getTablePrivileges ([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern) raises (SQLException)
 gets a description of the access rights for each table available in a catalog. More...
 
XResultSet getBestRowIdentifier ([in]any catalog, [in]string schema, [in]string table, [in]long scope, [in] boolean nullable) raises (SQLException)
 gets a description of a table's optimal set of columns that uniquely identifies a row. More...
 
XResultSet getVersionColumns ([in]any catalog, [in]string schema, [in]string table) raises (SQLException)
 gets a description of a table's columns that are automatically updated when any value in a row is updated. More...
 
XResultSet getPrimaryKeys ([in]any catalog, [in]string schema, [in]string table) raises (SQLException)
 gets a description of a table's primary key columns. More...
 
XResultSet getImportedKeys ([in]any catalog, [in]string schema, [in]string table) raises (SQLException)
 gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table). More...
 
XResultSet getExportedKeys ([in]any catalog, [in]string schema, [in]string table) raises (SQLException)
 gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table). More...
 
XResultSet getCrossReference ([in]any primaryCatalog, [in]string primarySchema, [in]string primaryTable, [in]any foreignCatalog, [in]string foreignSchema, [in]string foreignTable) raises (SQLException)
 gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.) This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.). More...
 
XResultSet getTypeInfo () raises (SQLException)
 gets a description of all the standard SQL types supported by this database. More...
 
XResultSet getIndexInfo ([in]any catalog, [in]string schema, [in]string table, [in]boolean unique, [in]boolean approximate) raises (SQLException)
 gets a description of a table's indices and statistics. More...
 
boolean supportsResultSetType ([in]long setType) raises (SQLException)
 Does the database support the given result set type? More...
 
boolean supportsResultSetConcurrency ([in]long setType, [in]long concurrency) raises (SQLException)
 Does the database support the concurrency type in combination with the given result set type? More...
 
boolean ownUpdatesAreVisible ([in]long setType) raises (SQLException)
 indicates whether a result set's own updates are visible. More...
 
boolean ownDeletesAreVisible ([in]long setType) raises (SQLException)
 indicates whether a result set's own deletes are visible. More...
 
boolean ownInsertsAreVisible ([in]long setType) raises (SQLException)
 indicates whether a result set's own inserts are visible. More...
 
boolean othersUpdatesAreVisible ([in]long setType) raises (SQLException)
 indicates whether updates made by others are visible. More...
 
boolean othersDeletesAreVisible ([in]long setType) raises (SQLException)
 indicates whether deletes made by others are visible. More...
 
boolean othersInsertsAreVisible ([in]long setType) raises (SQLException)
 indicates whether inserts made by others are visible. More...
 
boolean updatesAreDetected ([in]long setType) raises (SQLException)
 indicates whether or not a visible row update can be detected by calling the method XResultSet.rowUpdated. More...
 
boolean deletesAreDetected ([in]long setType) raises (SQLException)
 indicates whether or not a visible row delete can be detected by calling com::sun::star::sdbc::XResultSet::rowDeleted(). More...
 
boolean insertsAreDetected ([in]long setType) raises (SQLException)
 indicates whether or not a visible row insert can be detected by calling com::sun::star::sdbc::XResultSet::rowInserted(). More...
 
boolean supportsBatchUpdates () raises (SQLException)
 indicates whether the driver supports batch updates. More...
 
XResultSet getUDTs ([in]any catalog, [in]string schemaPattern, [in]string typeNamePattern, [in]sequence< long > types) raises (SQLException)
 Gets a description of the user-defined types defined in a particular schema. More...
 
XConnection getConnection () raises (SQLException)
 retrieves the connection that produced this metadata object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides comprehensive information about the database as a whole.

Many of the methods here return lists of information in the form of com::sun::star::sdbc::XResultSet objects. You can use the normal com::sun::star::sdbc::XRow (or com::sun::star::sdb::XColumn) methods such as com::sun::star::sdbc::XRow::getString() and com::sun::star::sdbc::XRow::getInt() to retrieve the data from these XResultSets. If a given form of metadata is not available, these methods should throw a com::sun::star::sdbc::SQLException. After calling one of the getXXX() methods, one can check whether that value is NULL with the method com::sun::star::sdbc::XRow::wasNull(). In the text only "(may be `NULL`)" is mentioned for this case.

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 VOID, that argument's criteria will be dropped from the search.

A com::sun::star::sdbc::SQLException will be thrown if a driver does not support a metadata method. In the case of methods that return an XResultSet, either an XResultSet (which may be empty) is returned or a SQLException is thrown.

Developers Guide
Database - XDatabaseMetaData Interface
Database - Database Design - Retrieving Information about a Database

Member Function Documentation

boolean allProceduresAreCallable ( )
raises (SQLException
)

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

Returns
TRUE if the user is allowed to call all procedures returned by getProcedures otherwise FALSE.
Exceptions
SQLExceptionif a database access error occurs.
boolean allTablesAreSelectable ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean dataDefinitionCausesTransactionCommit ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean dataDefinitionIgnoredInTransactions ( )
raises (SQLException
)

is a data definition statement within a transaction ignored?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean deletesAreDetected ( [in] long  setType)
raises (SQLException
)

indicates whether or not a visible row delete can be detected by calling com::sun::star::sdbc::XResultSet::rowDeleted().

If deletesAreDetected() returns FALSE, then deleted rows are removed from the result set.

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean doesMaxRowSizeIncludeBlobs ( )
raises (SQLException
)

Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getBestRowIdentifier ( [in] any  catalog,
[in] string  schema,
[in] string  table,
[in] long  scope,
[in] boolean  nullable 
)
raises (SQLException
)

gets a description of a table's optimal set of columns that uniquely identifies a row.

They are ordered by SCOPE.

Each column description has the following columns:

  1. SCOPE short => actual scope of result
    • TEMPORARY - very temporary, while using row
    • TRANSACTION - valid for remainder of current transaction
    • SESSION - valid for remainder of current session
  2. COLUMN_NAME string => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME string => Data source dependent type name, for a UDT the type name is fully qualified
  5. COLUMN_SIZE long => precision
  6. BUFFER_LENGTH long => not used
  7. DECIMAL_DIGITS short => scale
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • UNKNOWN - may or may not be pseudo column
    • NOT_PSEUDO - is NOT a pseudo column
    • PSEUDO - is a pseudo column
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name; "" retrieves those without a schema
tablea table name
scopethe scope of interest; use same values as SCOPE
nullableinclude columns that are nullable?
Returns
each row is a column description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getCatalogs ( )
raises (SQLException
)

gets the catalog names available in this database.

The results are ordered by catalog name.

The catalog column is:

  1. TABLE_CAT string => catalog name
Returns
each row has a single String column that is a catalog name
Exceptions
SQLExceptionif a database access error occurs.
string getCatalogSeparator ( )
raises (SQLException
)

return the separator between catalog and table name

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getCatalogTerm ( )
raises (SQLException
)

return the database vendor's preferred term for "catalog"

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getColumnPrivileges ( [in] any  catalog,
[in] string  schema,
[in] string  table,
[in] string  columnNamePattern 
)
raises (SQLException
)

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

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

Each privilege description has the following columns:

  1. TABLE_CAT string => table catalog (may be NULL)
  2. TABLE_SCHEM string => table schema (may be NULL)
  3. TABLE_NAME string => table name
  4. COLUMN_NAME string => column name
  5. GRANTOR => granter of access (may be NULL)
  6. GRANTEE string => grantee of access
  7. PRIVILEGE string => name of access (SELECT, INSERT, UPDATE, REFERENCES, ...)
  8. IS_GRANTABLE string => "YES" if grantee is permitted to grant to others; "NO" if not; NULL if unknown
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name ; "" retrieves those without a schema
tablea table name
columnNamePatterna column name pattern
Returns
each row is a column privilege description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getColumns ( [in] any  catalog,
[in] string  schemaPattern,
[in] string  tableNamePattern,
[in] string  columnNamePattern 
)
raises (SQLException
)

gets a description of table columns available in the specified catalog.

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

Each column description has the following columns:

  1. TABLE_CAT string => table catalog (may be NULL)
  2. TABLE_SCHEM string => table schema (may be NULL)
  3. TABLE_NAME string => table name
  4. COLUMN_NAME string => column name
  5. DATA_TYPE short => SQL type from java.sql.Types
  6. TYPE_NAME string => Data source dependent type name, for a UDT the type name is fully qualified
  7. COLUMN_SIZE long => column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS long => the number of fractional digits
  10. NUM_PREC_RADIX long => Radix (typically either 10 or 2)
  11. NULLABLE long => is NULL allowed?
    • NO_NULLS - might not allow NULL values
    • NULLABLE - definitely allows NULL values
    • NULLABLE_UNKNOWN - nullability unknown
  12. REMARKS string => comment describing column (may be NULL)
  13. COLUMN_DEF string => default value (may be NULL)
  14. SQL_DATA_TYPE long => unused
  15. SQL_DATETIME_SUB long => unused
  16. CHAR_OCTET_LENGTH long => for char types the maximum number of bytes in the column
  17. ORDINAL_POSITION int => index of column in table (starting at 1)
  18. IS_NULLABLE string => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
tableNamePatterna table name pattern
columnNamePatterna column name pattern
Returns
each row is a column description
Exceptions
SQLExceptionif a database access error occurs.
XConnection getConnection ( )
raises (SQLException
)

retrieves the connection that produced this metadata object.

Returns
the Connection object
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getCrossReference ( [in] any  primaryCatalog,
[in] string  primarySchema,
[in] string  primaryTable,
[in] any  foreignCatalog,
[in] string  foreignSchema,
[in] string  foreignTable 
)
raises (SQLException
)

gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.) This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.).

They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT string => primary key table catalog (may be NULL)
  2. PKTABLE_SCHEM string => primary key table schema (may be NULL)
  3. PKTABLE_NAME string => primary key table name
  4. PKCOLUMN_NAME string => primary key column name
  5. FKTABLE_CAT string => foreign key table catalog (may be NULL) being exported (may be NULL)
  6. FKTABLE_SCHEM string => foreign key table schema (may be NULL) being exported (may be NULL)
  7. FKTABLE_NAME string => foreign key table name being exported
  8. FKCOLUMN_NAME string => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • NO_ACTION - do not allow update of primary key if it has been imported
    • CASCADE - change imported key to agree with primary key update
    • SET_NULL - change imported key to NULL if its primary key has been updated
    • SET_DEFAULT - change imported key to default values if its primary key has been updated
    • RESTRICT - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • NO_ACTION - do not allow delete of primary key if it has been imported
    • CASCADE - delete rows that import a deleted key
    • SET_NULL - change imported key to NULL if its primary key has been deleted
    • RESTRICT - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • SET_DEFAULT - change imported key to default if its primary key has been deleted
  12. FK_NAME string => foreign key name (may be NULL)
  13. PK_NAME string => primary key name (may be NULL)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • INITIALLY_DEFERRED - see SQL92 for definition
    • INITIALLY_IMMEDIATE - see SQL92 for definition
    • NONE - see SQL92 for definition
Parameters
primaryCataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
primarySchemaa schema name; "" retrieves those without a schema
primaryTablethe table name that exports the key
foreignCataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
foreignSchemaa schema name; "" retrieves those without a schema
foreignTablethe table name that imports the key
Returns
each row is a foreign key column description
Exceptions
SQLExceptionif a database access error occurs.
string getDatabaseProductName ( )
raises (SQLException
)

returns the name of the database product.

string getDatabaseProductVersion ( )
raises (SQLException
)

returns the version of the database product.

long getDefaultTransactionIsolation ( )
raises (SQLException
)

return the database default transaction isolation level.

The values are defined in com::sun::star::sdbc::TransactionIsolation.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
See also
com::sun::star::sdbc::XConnection
long getDriverMajorVersion ( )

returns the SDBC driver major version number.

long getDriverMinorVersion ( )

returns the SDBC driver minor version number.

string getDriverName ( )
raises (SQLException
)

returns the name of the SDBC driver.

string getDriverVersion ( )
raises (SQLException
)

returns the version number of the SDBC driver.

XResultSet getExportedKeys ( [in] any  catalog,
[in] string  schema,
[in] string  table 
)
raises (SQLException
)

gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).

They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT string => primary key table catalog (may be NULL)
  2. PKTABLE_SCHEM string => primary key table schema (may be NULL)
  3. PKTABLE_NAME string => primary key table name
  4. PKCOLUMN_NAME string => primary key column name
  5. FKTABLE_CAT string => foreign key table catalog (may be NULL) being exported (may be NULL)
  6. FKTABLE_SCHEM string => foreign key table schema (may be NULL) being exported (may be NULL)
  7. FKTABLE_NAME string => foreign key table name being exported
  8. FKCOLUMN_NAME string => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • NO_ACTION - do not allow update of primary key if it has been imported
    • CASCADE - change imported key to agree with primary key update
    • SET_NULL - change imported key to NULL if its primary key has been updated
    • SET_DEFAULT - change imported key to default values if its primary key has been updated
    • RESTRICT - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • NO_ACTION - do not allow delete of primary key if it has been imported
    • CASCADE - delete rows that import a deleted key
    • SET_NULL - change imported key to NULL if its primary key has been deleted
    • RESTRICT - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • SET_DEFAULT - change imported key to default if its primary key has been deleted
  12. FK_NAME string => foreign key name (may be NULL)
  13. PK_NAME string => primary key name (may be NULL)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • INITIALLY_DEFERRED - see SQL92 for definition
    • INITIALLY_IMMEDIATE - see SQL92 for definition
    • NONE - see SQL92 for definition
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name; "" retrieves those without a schema
tablea table name
Returns
each row is a foreign key column description
Exceptions
SQLExceptionif a database access error occurs.
string getExtraNameCharacters ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getIdentifierQuoteString ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getImportedKeys ( [in] any  catalog,
[in] string  schema,
[in] string  table 
)
raises (SQLException
)

gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).

They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.

Each primary key column description has the following columns:

  1. PKTABLE_CAT string => primary key table catalog being imported (may be NULL)
  2. PKTABLE_SCHEM string => primary key table schema being imported (may be NULL)
  3. PKTABLE_NAME string => primary key table name being imported
  4. PKCOLUMN_NAME string => primary key column name being imported
  5. FKTABLE_CAT string => foreign key table catalog (may be NULL)
  6. FKTABLE_SCHEM string => foreign key table schema (may be NULL)
  7. FKTABLE_NAME string => foreign key table name
  8. FKCOLUMN_NAME string => foreign key column name
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME string => foreign key name (may be NULL)
  13. PK_NAME string => primary key name (may be NULL)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name; "" retrieves those without a schema
tablea table name
Returns
each row is a primary key column description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getIndexInfo ( [in] any  catalog,
[in] string  schema,
[in] string  table,
[in] boolean  unique,
[in] boolean  approximate 
)
raises (SQLException
)

gets a description of a table's indices and statistics.

They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

Each index column description has the following columns:

  1. TABLE_CAT string => table catalog (may be NULL)
  2. TABLE_SCHEM string => table schema (may be NULL)
  3. TABLE_NAME string => table name
  4. NON_UNIQUE boolean => Can index values be non-unique? FALSE when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER string => index catalog (may be NULL); NULL when TYPE is tableIndexStatistic
  6. INDEX_NAME string => index name; NULL when TYPE is tableIndexStatistic
  7. TYPE short => index type:
    • 0 - this identifies table statistics that are returned in conjunction with a table's index descriptions
    • CLUSTERED - this is a clustered index
    • HASHED - this is a hashed index
    • OTHER - this is some other style of index
  8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
  9. COLUMN_NAME string => column name; NULL when TYPE is tableIndexStatistic
  10. ASC_OR_DESC string => column sort sequence, "A" => ascending, "D" => descending, may be NULL if sort sequence is not supported; NULL when TYPE is tableIndexStatistic
  11. CARDINALITY long => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
  12. PAGES long => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
  13. FILTER_CONDITION string => Filter condition, if any. (may be NULL)
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name; "" retrieves those without a schema
tablethe table name that exports the key
uniquewhen TRUE, return only indices for unique values; when FALSE, return indices regardless of whether unique or not
approximatewhen TRUE, result is allowed to reflect approximate or out of data values; when FALSE, results are requested to be accurate
Returns
each row is an index column description
Exceptions
SQLExceptionif a database access error occurs.
long getMaxBinaryLiteralLength ( )
raises (SQLException
)

return the maximal number of hex characters in an inline binary literal

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxCatalogNameLength ( )
raises (SQLException
)

return the maximum length of a catalog name

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxCharLiteralLength ( )
raises (SQLException
)

return the max length for a character literal

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxColumnNameLength ( )
raises (SQLException
)

return the limit on column name length

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxColumnsInGroupBy ( )
raises (SQLException
)

return the maximum number of columns in a "GROUP BY" clause

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxColumnsInIndex ( )
raises (SQLException
)

return the maximum number of columns allowed in an index

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxColumnsInOrderBy ( )
raises (SQLException
)

return the maximum number of columns in an "ORDER BY" clause

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxColumnsInSelect ( )
raises (SQLException
)

return the maximum number of columns in a "SELECT" list

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxColumnsInTable ( )
raises (SQLException
)

return the maximum number of columns in a table

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxConnections ( )
raises (SQLException
)

return the number of active connections at a time to this database.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxCursorNameLength ( )
raises (SQLException
)

return the maximum cursor name length

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxIndexLength ( )
raises (SQLException
)

return the maximum length of an index (in bytes)

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxProcedureNameLength ( )
raises (SQLException
)

return the maximum length of a procedure name

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxRowSize ( )
raises (SQLException
)

return the maximum length of a single row.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxSchemaNameLength ( )
raises (SQLException
)

return the maximum length allowed for a schema name

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxStatementLength ( )
raises (SQLException
)

return the maximum length of a SQL statement

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxStatements ( )
raises (SQLException
)

return the maximal number of open active statements at one time to this database

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxTableNameLength ( )
raises (SQLException
)

return the maximum length of a table name

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxTablesInSelect ( )
raises (SQLException
)

return the maximum number of tables in a SELECT statement

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
long getMaxUserNameLength ( )
raises (SQLException
)

return the maximum length of a user name

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getNumericFunctions ( )
raises (SQLException
)

gets a comma-separated list of math functions.

These are the X/Open CLI math function names used in the SDBC function escape clause.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getPrimaryKeys ( [in] any  catalog,
[in] string  schema,
[in] string  table 
)
raises (SQLException
)

gets a description of a table's primary key columns.

They are ordered by COLUMN_NAME.

Each primary key column description has the following columns:

  1. TABLE_CAT string => table catalog (may be NULL)
  2. TABLE_SCHEM string => table schema (may be NULL)
  3. TABLE_NAME string => table name
  4. COLUMN_NAME string => column name
  5. KEY_SEQ short => sequence number within primary key
  6. PK_NAME string => primary key name (may be NULL)
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name; "" retrieves those without a schema
tablea table name
Returns
each row is a primary key column description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getProcedureColumns ( [in] any  catalog,
[in] string  schemaPattern,
[in] string  procedureNamePattern,
[in] string  columnNamePattern 
)
raises (SQLException
)

gets 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 XResultSet is a parameter description or column description with the following fields:

  1. PROCEDURE_CAT string => procedure catalog (may be NULL)
  2. PROCEDURE_SCHEM string => procedure schema (may be NULL)
  3. PROCEDURE_NAME string => procedure name
  4. COLUMN_NAME string => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
    • UNKNOWN - nobody knows
    • IN - IN parameter
    • INOUT - INOUT parameter
    • OUT - OUT parameter
    • RETURN - procedure return value
    • RESULT - result column in XResultSet
  6. DATA_TYPE short => SQL type from java.sql.Types
  7. TYPE_NAME string => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION long => precision
  9. LENGTH long => length in bytes of data
  10. SCALE short => scale
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL?
    • NO_NULLS - does not allow NULL values
    • NULLABLE - allows NULL values
    • NULLABLE_UNKNOWN - nullability unknown
  13. REMARKS string => comment describing parameter/column

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

Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
procedureNamePatterna procedure name pattern
columnNamePatterna column name pattern
Returns
each row describes a stored procedure parameter or column
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getProcedures ( [in] any  catalog,
[in] string  schemaPattern,
[in] string  procedureNamePattern 
)
raises (SQLException
)

Gets a description of the 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 following columns:

  1. PROCEDURE_CAT string => procedure catalog (may be NULL)
  2. PROCEDURE_SCHEM string => procedure schema (may be NULL)
  3. PROCEDURE_NAME string => procedure name
  4. reserved for future use
  5. reserved for future use
  6. reserved for future use
  7. REMARKS string => explanatory comment on the procedure
  8. PROCEDURE_TYPE short => kind of procedure:
    • UNKNOWN - May return a result
    • NO - Does not return a result
    • RETURN - Returns a result
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
procedureNamePatterna procedure name pattern
Returns
each row is a procedure description
Exceptions
SQLExceptionif a database access error occurs.
string getProcedureTerm ( )
raises (SQLException
)

return the database vendor's preferred term for "procedure"

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getSchemas ( )
raises (SQLException
)

Gets the schema names available in this database.

The results are ordered by schema name.

The schema column is:

  1. TABLE_SCHEM string => schema name
Returns
each row has a single String column that is a schema name
Exceptions
SQLExceptionif a database access error occurs.
string getSchemaTerm ( )
raises (SQLException
)

return the database vendor's preferred term for "schema"

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getSearchStringEscape ( )
raises (SQLException
)

gets the string that can be used to escape wildcard characters.

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

The "_" character represents any single character.

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getSQLKeywords ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getStringFunctions ( )
raises (SQLException
)

gets a comma-separated list of string functions.

These are the X/Open CLI string function names used in the SDBC function escape clause.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
string getSystemFunctions ( )
raises (SQLException
)

gets a comma-separated list of system functions.

These are the X/Open CLI system function names used in the SDBC function escape clause.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getTablePrivileges ( [in] any  catalog,
[in] string  schemaPattern,
[in] string  tableNamePattern 
)
raises (SQLException
)

gets 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 privilege 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 privilege description has the following columns:

  1. TABLE_CAT string => table catalog (may be NULL)
  2. TABLE_SCHEM string => table schema (may be NULL)
  3. TABLE_NAME string => table name
  4. GRANTOR => granter of access (may be NULL)
  5. GRANTEE string => grantee of access
  6. PRIVILEGE string => name of access (SELECT, INSERT, UPDATE, REFERENCES, ...)
  7. IS_GRANTABLE string => "YES" if grantee is permitted to grant to others; "NO" if not; NULL if unknown
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
tableNamePatterna table name pattern
Returns
each row is a table privilege description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getTables ( [in] any  catalog,
[in] string  schemaPattern,
[in] string  tableNamePattern,
[in] sequence< string >  types 
)
raises (SQLException
)

gets a description of tables available in a catalog.

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

Each table description has the following columns:

  1. TABLE_CAT string => table catalog (may be NULL)
  2. TABLE_SCHEM string => table schema (may be NULL)
  3. TABLE_NAME string => table name
  4. TABLE_TYPE string => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
  5. REMARKS string => explanatory comment on the table

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

Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
tableNamePatterna table name pattern
typesa list of table types to include
Returns
each row is a table description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getTableTypes ( )
raises (SQLException
)

gets the table types available in this database.

The results are ordered by table type.

The table type is:

  1. TABLE_TYPE string => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
Returns
each row has a single String column that is a table type
Exceptions
SQLExceptionif a database access error occurs.
string getTimeDateFunctions ( )
raises (SQLException
)

gets a comma-separated list of time and date functions.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getTypeInfo ( )
raises (SQLException
)

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

Each type description has the following columns:

  1. TYPE_NAME string => Type name
  2. DATA_TYPE short => SQL data type from java.sql.Types
  3. PRECISION long => maximum precision
  4. LITERAL_PREFIX string => prefix used to quote a literal (may be NULL)
  5. LITERAL_SUFFIX string => suffix used to quote a literal (may be NULL)
  6. CREATE_PARAMS string => parameters used in creating the type (may be NULL)
  7. NULLABLE short => can you use NULL for this type?
    • NO_NULLS - does not allow NULL values
    • NULLABLE - allows NULL values
    • NULLABLE_UNKNOWN - nullability unknown
  8. CASE_SENSITIVE boolean=> is it case sensitive?
  9. SEARCHABLE short => can you use "WHERE" based on this type:
    • NONE - No support
    • CHAR - Only supported with WHERE .. LIKE
    • BASIC - Supported except for WHERE .. LIKE
    • FULL - Supported for all WHERE ..
  10. UNSIGNED_ATTRIBUTE boolean => is it unsigned?
  11. FIXED_PREC_SCALE boolean => can it be a money value?
  12. AUTO_INCREMENT boolean => can it be used for an auto-increment value?
  13. LOCAL_TYPE_NAME string => localized version of type name (may be NULL)
  14. MINIMUM_SCALE short => minimum scale supported
  15. MAXIMUM_SCALE short => maximum scale supported
  16. SQL_DATA_TYPE long => unused
  17. SQL_DATETIME_SUB long => unused
  18. NUM_PREC_RADIX long => usually 2 or 10
Returns
each row is a SQL type description
Exceptions
SQLExceptionif a database access error occurs.
XResultSet getUDTs ( [in] any  catalog,
[in] string  schemaPattern,
[in] string  typeNamePattern,
[in] sequence< long >  types 
)
raises (SQLException
)

Gets a description of the user-defined types defined in a particular schema.

Schema-specific UDTs may have type OBJECT, STRUCT, or DISTINCT.

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

Each type description has the following columns:

  1. TYPE_CAT string => the type's catalog (may be NULL)
  2. TYPE_SCHEM string => type's schema (may be NULL)
  3. TYPE_NAME string => type name
  4. CLASS_NAME string => Java class name or service name
  5. DATA_TYPE string => type value. One of OBJECT, STRUCT, or DISTINCT
  6. REMARKS string => explanatory comment on the type

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

Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
typeNamePatterna type name pattern; may be a fully-qualified name
typesa list of user-named types to include (OBJECT, STRUCT, or DISTINCT)
Returns
each row is a type description
Exceptions
SQLExceptionif a database access error occurs.
string getURL ( )
raises (SQLException
)

returns the URL for the database connection

string getUserName ( )
raises (SQLException
)

returns the user name from this database connection.

XResultSet getVersionColumns ( [in] any  catalog,
[in] string  schema,
[in] string  table 
)
raises (SQLException
)

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

They are unordered.

Each column description has the following columns:

  1. SCOPE short => is not used
  2. COLUMN_NAME string => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME string => Data source dependent type name
  5. COLUMN_SIZE long => precision
  6. BUFFER_LENGTH long => length of column value in bytes
  7. DECIMAL_DIGITS short => scale
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • UNKNOWN - may or may not be pseudo column
    • NOT_PSEUDO - is NOT a pseudo column
    • PSEUDO - is a pseudo column
Parameters
cataloga catalog name; "" retrieves those without a catalog; VOID means drop catalog name from the selection criteria
schemaa schema name; "" retrieves those without a schema
tablea table name
Returns
each row is a column description
Exceptions
SQLExceptionif a database access error occurs.
boolean insertsAreDetected ( [in] long  setType)
raises (SQLException
)

indicates whether or not a visible row insert can be detected by calling com::sun::star::sdbc::XResultSet::rowInserted().

()

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isCatalogAtStart ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isReadOnly ( )
raises (SQLException
)

checks if the database in read-only mode.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean nullPlusNonNullIsNull ( )
raises (SQLException
)

are concatenations between NULL and non-NULL values NULL?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean nullsAreSortedAtEnd ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean nullsAreSortedAtStart ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean nullsAreSortedHigh ( )
raises (SQLException
)

Are NULL values sorted high?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean nullsAreSortedLow ( )
raises (SQLException
)

Are NULL values sorted low?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean othersDeletesAreVisible ( [in] long  setType)
raises (SQLException
)

indicates whether deletes made by others are visible.

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean othersInsertsAreVisible ( [in] long  setType)
raises (SQLException
)

indicates whether inserts made by others are visible.

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean othersUpdatesAreVisible ( [in] long  setType)
raises (SQLException
)

indicates whether updates made by others are visible.

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean ownDeletesAreVisible ( [in] long  setType)
raises (SQLException
)

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

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean ownInsertsAreVisible ( [in] long  setType)
raises (SQLException
)

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

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean ownUpdatesAreVisible ( [in] long  setType)
raises (SQLException
)

indicates whether a result set's own updates are visible.

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean storesLowerCaseIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean storesLowerCaseQuotedIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean storesMixedCaseIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean storesMixedCaseQuotedIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean storesUpperCaseIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean storesUpperCaseQuotedIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsAlterTableWithAddColumn ( )
raises (SQLException
)

support the Database "ALTER TABLE" with add column?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsAlterTableWithDropColumn ( )
raises (SQLException
)

support the Database "ALTER TABLE" with drop column?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsANSI92EntryLevelSQL ( )
raises (SQLException
)
Returns
TRUE, if the database supports ANSI92 entry level SQL grammar, otherwise FALSE.
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsANSI92FullSQL ( )
raises (SQLException
)
Returns
TRUE, if the database supports ANSI92 full SQL grammar, otherwise FALSE.
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsANSI92IntermediateSQL ( )
raises (SQLException
)
Returns
TRUE, if the database supports ANSI92 intermediate SQL grammar, otherwise FALSE.
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsBatchUpdates ( )
raises (SQLException
)

indicates whether the driver supports batch updates.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCatalogsInDataManipulation ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCatalogsInIndexDefinitions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCatalogsInPrivilegeDefinitions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCatalogsInProcedureCalls ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCatalogsInTableDefinitions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsColumnAliasing ( )
raises (SQLException
)

support the Database column aliasing?

The SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsConvert ( [in] long  fromType,
[in] long  toType 
)
raises (SQLException
)

TRUE , if the Database supports the CONVERT between the given SQL types otherwise FALSE.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCoreSQLGrammar ( )
raises (SQLException
)

TRUE, if the database supports ODBC Core SQL grammar, otherwise FALSE.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsCorrelatedSubqueries ( )
raises (SQLException
)

Are correlated subqueries supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsDataDefinitionAndDataManipulationTransactions ( )
raises (SQLException
)

support the Database both data definition and data manipulation statements within a transaction?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsDataManipulationTransactionsOnly ( )
raises (SQLException
)

are only data manipulation statements within a transaction supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsDifferentTableCorrelationNames ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsExpressionsInOrderBy ( )
raises (SQLException
)

Are expressions in "ORDER BY" lists supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsExtendedSQLGrammar ( )
raises (SQLException
)

TRUE, if the database supports ODBC Extended SQL grammar, otherwise FALSE.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsFullOuterJoins ( )
raises (SQLException
)
Returns
TRUE, if full nested outer joins are supported, otherwise FALSE.
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsGroupBy ( )
raises (SQLException
)

Is some form of "GROUP BY" clause supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsGroupByBeyondSelect ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsGroupByUnrelated ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsIntegrityEnhancementFacility ( )
raises (SQLException
)

returns TRUE, if the Database supports SQL Integrity Enhancement Facility, otherwise FALSE.

Exceptions
SQLExceptionif a database access error occurs.
boolean supportsLikeEscapeClause ( )
raises (SQLException
)

Is the escape character in "LIKE" clauses supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsLimitedOuterJoins ( )
raises (SQLException
)
Returns
TRUE, if there is limited support for outer joins. (This will be TRUE if supportFullOuterJoins is TRUE.) FALSE is returned otherwise.
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsMinimumSQLGrammar ( )
raises (SQLException
)

TRUE, if the database supports ODBC Minimum SQL grammar, otherwise FALSE.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsMixedCaseIdentifiers ( )
raises (SQLException
)

use the database "mixed case unquoted SQL identifiers" case sensitive.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsMixedCaseQuotedIdentifiers ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsMultipleResultSets ( )
raises (SQLException
)

Are multiple XResultSets from a single execute supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsMultipleTransactions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsNonNullableColumns ( )
raises (SQLException
)

Can columns be defined as non-nullable?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsOpenCursorsAcrossCommit ( )
raises (SQLException
)

Can cursors remain open across commits?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsOpenCursorsAcrossRollback ( )
raises (SQLException
)

Can cursors remain open across rollbacks?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsOpenStatementsAcrossCommit ( )
raises (SQLException
)

Can statements remain open across commits?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsOpenStatementsAcrossRollback ( )
raises (SQLException
)

Can statements remain open across rollbacks?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsOrderByUnrelated ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsOuterJoins ( )
raises (SQLException
)
Returns
TRUE, if some form of outer join is supported, otherwise FALSE.
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsPositionedDelete ( )
raises (SQLException
)

Is positioned DELETE supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsPositionedUpdate ( )
raises (SQLException
)

Is positioned UPDATE supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsResultSetConcurrency ( [in] long  setType,
[in] long  concurrency 
)
raises (SQLException
)

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

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
concurrencydefined in com::sun::star::sdbc::ResultSetConcurrency
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsResultSetType ( [in] long  setType)
raises (SQLException
)

Does the database support the given result set type?

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSchemasInDataManipulation ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSchemasInIndexDefinitions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSchemasInPrivilegeDefinitions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSchemasInProcedureCalls ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSchemasInTableDefinitions ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSelectForUpdate ( )
raises (SQLException
)

Is SELECT for UPDATE supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsStoredProcedures ( )
raises (SQLException
)

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

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSubqueriesInComparisons ( )
raises (SQLException
)

Are subqueries in comparison expressions supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSubqueriesInExists ( )
raises (SQLException
)

Are subqueries in "exists" expressions supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSubqueriesInIns ( )
raises (SQLException
)

Are subqueries in "in" statements supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsSubqueriesInQuantifieds ( )
raises (SQLException
)

Are subqueries in quantified expressions supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsTableCorrelationNames ( )
raises (SQLException
)

Are table correlation names supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsTransactionIsolationLevel ( [in] long  level)
raises (SQLException
)

Does this database support the given transaction isolation level?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
See also
com::sun::star::sdbc::Connection
boolean supportsTransactions ( )
raises (SQLException
)

support the Database transactions? If not, invoking the method com::sun::star::sdbc::XConnection::commit() is a noop and the isolation level is TransactionIsolation_NONE.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsTypeConversion ( )
raises (SQLException
)

TRUE , if the Database supports the CONVERT function between SQL types, otherwise FALSE.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsUnion ( )
raises (SQLException
)

Is SQL UNION supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean supportsUnionAll ( )
raises (SQLException
)

Is SQL UNION ALL supported?

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean updatesAreDetected ( [in] long  setType)
raises (SQLException
)

indicates whether or not a visible row update can be detected by calling the method XResultSet.rowUpdated.

Parameters
setTypedefined in com::sun::star::sdbc::ResultSetType
Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean usesLocalFilePerTable ( )
raises (SQLException
)

use the database one local file to save for each table.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean usesLocalFiles ( )
raises (SQLException
)

use the database local files to save the tables.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.

The documentation for this interface was generated from the following file: