Method Summary
|
allProceduresAreCallable |
Can all the procedures returned by getProcedures be called by the
current user?
|
|
allTablesAreSelectable |
Can all the tables returned by getTable be SELECTed by the
current user?
|
|
getURL |
returns the directory and filename of the database.
|
|
getUserName |
returns the user name from this database connection.
|
|
isReadOnly |
checks if the database in read-only mode.
|
|
nullsAreSortedHigh |
Are NULL values sorted high?
|
|
nullsAreSortedLow |
Are NULL values sorted low?
|
|
nullsAreSortedAtStart |
Are NULL values sorted at the start regardless of sort order?
|
|
nullsAreSortedAtEnd |
Are NULL values sorted at the end, regardless of sort order?
|
|
getDatabaseProductName |
returns the name of the database product.
|
|
getDatabaseProductVersion |
returns the version of the database product.
|
|
getDriverName |
returns the name of the SDBC driver.
|
|
getDriverVersion |
returns the version number of the SDBC driver.
|
|
getDriverMajorVersion |
returns the JDBC driver major version number.
|
|
getDriverMinorVersion |
returns the SDBC driver minor version number.
|
|
usesLocalFiles |
use the database local files to save the tables.
|
|
usesLocalFilePerTable |
use the database one local file to save for each table.
|
|
supportsMixedCaseIdentifiers |
use the database 'mixed case unquoted SQL identifiers' case sensitive.
|
|
storesUpperCaseIdentifiers |
Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in upper case?
|
|
storesLowerCaseIdentifiers |
Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in lower case?
|
|
storesMixedCaseIdentifiers |
Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in mixed case?
|
|
supportsMixedCaseQuotedIdentifiers |
Does the database treat mixed case quoted SQL identifiers as
case sensitive and as a result store them in mixed case?
|
|
storesUpperCaseQuotedIdentifiers |
Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in upper case?
|
|
storesLowerCaseQuotedIdentifiers |
Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in lower case?
|
|
storesMixedCaseQuotedIdentifiers |
Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in mixed case?
|
|
getIdentifierQuoteString |
What's the string used to quote SQL identifiers?
This returns a space " " if identifier quoting is not supported.
|
|
getSQLKeywords |
gets a comma-separated list of all a database's SQL keywords
that are NOT also SQL92 keywords.
|
|
getNumericFunctions |
gets a comma-separated list of math functions. These are the
X/Open CLI math function names used in the SDBC function escape
clause.
|
|
getStringFunctions |
gets a comma-separated list of string functions. These are the
X/Open CLI string function names used in the SDBC function escape
clause.
|
|
getSystemFunctions |
gets a comma-separated list of system functions. These are the
X/Open CLI system function names used in the SDBC function escape
clause.
|
|
getTimeDateFunctions |
gets a comma-separated list of time and date functions.
|
|
getSearchStringEscape |
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.
|
|
getExtraNameCharacters |
gets all the "extra" characters that can be used in unquoted
identifier names (those beyond a-z, A-Z, 0-9 and _).
|
|
supportsAlterTableWithAddColumn |
support the Database "ALTER TABLE" with add column?
|
|
supportsAlterTableWithDropColumn |
support the Database "ALTER TABLE" with drop column?
|
|
supportsColumnAliasing |
support the Database column aliasing?
|
|
nullPlusNonNullIsNull |
are concatenations between NULL and non-NULL values NULL?
|
|
supportsTypeConversion |
true
, if the Database supports the CONVERT function between SQL types,
otherwise
false
.
|
|
supportsConvert |
true
, if the Database supports the CONVERT between the given SQL types
otherwise
false
.
|
|
supportsTableCorrelationNames |
Are table correlation names supported?
|
|
supportsDifferentTableCorrelationNames |
If table correlation names are supported, are they restricted
to be different from the names of the tables?
|
|
supportsExpressionsInOrderBy |
Are expressions in "ORDER BY" lists supported?
|
|
supportsOrderByUnrelated |
Can an "ORDER BY" clause use columns not in the SELECT statement?
|
|
supportsGroupBy |
Is some form of "GROUP BY" clause supported?
|
|
supportsGroupByUnrelated |
Can a "GROUP BY" clause use columns not in the SELECT?
|
|
supportsGroupByBeyondSelect |
Can a "GROUP BY" clause add columns not in the SELECT
provided it specifies all the columns in the SELECT?
|
|
supportsLikeEscapeClause |
Is the escape character in "LIKE" clauses supported?
|
|
supportsMultipleResultSets |
Are multiple XResultSets from a single execute supported?
|
|
supportsMultipleTransactions |
Can we have multiple transactions open at once (on different
connections)?
|
|
supportsNonNullableColumns |
Can columns be defined as non-nullable?
|
|
supportsMinimumSQLGrammar |
true
, if the database supports ODBC Minimum SQL grammar,
otherwise false
.
|
|
supportsCoreSQLGrammar |
true
, if the database supports ODBC Core SQL grammar,
otherwise false
.
|
|
supportsExtendedSQLGrammar |
true
, if the database supports ODBC Extended SQL grammar,
otherwise false
.
|
|
supportsANSI92EntryLevelSQL |
|
|
supportsANSI92IntermediateSQL |
|
|
supportsANSI92FullSQL |
|
|
supportsIntegrityEnhancementFacility |
returns
true
, if the Database supports SQL Integrity Enhancement Facility,
otherwise false
.
|
|
supportsOuterJoins |
|
|
supportsFullOuterJoins |
|
|
supportsLimitedOuterJoins |
|
|
getSchemaTerm |
return the database vendor's preferred term for "schema"
|
|
getProcedureTerm |
return the database vendor's preferred term for "procedure"
|
|
getCatalogTerm |
return the database vendor's preferred term for "catalog"
|
|
isCatalogAtStart |
Does a catalog appear at the start of a qualified table name?
(Otherwise it appears at the end)
|
|
getCatalogSeparator |
return the separator between catalog and table name
|
|
supportsSchemasInDataManipulation |
Can a schema name be used in a data manipulation statement?
|
|
supportsSchemasInProcedureCalls |
Can a schema name be used in a procedure call statement?
|
|
supportsSchemasInTableDefinitions |
Can a schema name be used in a table definition statement?
|
|
supportsSchemasInIndexDefinitions |
Can a schema name be used in an index definition statement?
|
|
supportsSchemasInPrivilegeDefinitions |
Can a schema name be used in a privilege definition statement?
|
|
supportsCatalogsInDataManipulation |
Can a catalog name be used in a data manipulation statement?
|
|
supportsCatalogsInProcedureCalls |
Can a catalog name be used in a procedure call statement?
|
|
supportsCatalogsInTableDefinitions |
Can a catalog name be used in a table definition statement?
|
|
supportsCatalogsInIndexDefinitions |
Can a catalog name be used in an index definition statement?
|
|
supportsCatalogsInPrivilegeDefinitions |
Can a catalog name be used in a privilege definition statement?
|
|
supportsPositionedDelete |
Is positioned DELETE supported?
|
|
supportsPositionedUpdate |
Is positioned UPDATE supported?
|
|
supportsSelectForUpdate |
Is SELECT for UPDATE supported?
|
|
supportsStoredProcedures |
Are stored procedure calls using the stored procedure escape
syntax supported?
|
|
supportsSubqueriesInComparisons |
Are subqueries in comparison expressions supported?
|
|
supportsSubqueriesInExists |
Are subqueries in 'exists' expressions supported?
|
|
supportsSubqueriesInIns |
Are subqueries in 'in' statements supported?
|
|
supportsSubqueriesInQuantifieds |
Are subqueries in quantified expressions supported?
|
|
supportsCorrelatedSubqueries |
Are correlated subqueries supported?
|
|
supportsUnion |
Is SQL UNION supported?
|
|
supportsUnionAll |
Is SQL UNION ALL supported?
|
|
supportsOpenCursorsAcrossCommit |
Can cursors remain open across commits?
|
|
supportsOpenCursorsAcrossRollback |
Can cursors remain open across rollbacks?
|
|
supportsOpenStatementsAcrossCommit |
Can statements remain open across commits?
|
|
supportsOpenStatementsAcrossRollback |
Can statements remain open across rollbacks?
|
|
getMaxBinaryLiteralLength |
return the maximal number of hex characters in an inline binary literal
|
|
getMaxCharLiteralLength |
return the max length for a character literal
|
|
getMaxColumnNameLength |
return the limit on column name length
|
|
getMaxColumnsInGroupBy |
return the maximum number of columns in a "GROUP BY" clause
|
|
getMaxColumnsInIndex |
return the maximum number of columns allowed in an index
|
|
getMaxColumnsInOrderBy |
return the maximum number of columns in an "ORDER BY" clause
|
|
getMaxColumnsInSelect |
return the maximum number of columns in a "SELECT" list
|
|
getMaxColumnsInTable |
return the maximum number of columns in a table
|
|
getMaxConnections |
return the number of active connections at a time to this database.
|
|
getMaxCursorNameLength |
return the maximum cursor name length
|
|
getMaxIndexLength |
return the maximum length of an index (in bytes)
|
|
getMaxSchemaNameLength |
return the maximum length allowed for a schema name
|
|
getMaxProcedureNameLength |
return the maximum length of a procedure name
|
|
getMaxCatalogNameLength |
return the maximum length of a catalog name
|
|
getMaxRowSize |
return the maximum length of a single row.
|
|
doesMaxRowSizeIncludeBlobs |
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY
blobs?
|
|
getMaxStatementLength |
return the maximum length of a SQL statement
|
|
getMaxStatements |
return the maximal number of open active statements at one time to this database
|
|
getMaxTableNameLength |
return the maximum length of a table name
|
|
getMaxTablesInSelect |
return the maximum number of tables in a SELECT statement
|
|
getMaxUserNameLength |
return the maximum length of a user name
|
|
getDefaultTransactionIsolation |
return the database default transaction isolation level.
The values are defined in
TransactionIsolation .
|
|
supportsTransactions |
support the Database transactions?
If not, invoking the method
XConnection::commit()
is a noop and the
isolation level is TransactionIsolation_NONE.
|
|
supportsTransactionIsolationLevel |
Does this database support the given transaction isolation level?
|
|
supportsDataDefinitionAndDataManipulationTransactions |
support the Database both data definition and data manipulation statements
within a transaction?
|
|
supportsDataManipulationTransactionsOnly |
are only data manipulation statements within a transaction
supported?
|
|
dataDefinitionCausesTransactionCommit |
does a data definition statement within a transaction force the
transaction to commit?
|
|
dataDefinitionIgnoredInTransactions |
is a data definition statement within a transaction ignored?
|
|
getProcedures |
Gets a description of the stored procedures available in a
catalog.
|
|
getProcedureColumns |
gets a description of a catalog's stored procedure parameters
and result columns.
|
|
getTables |
gets a description of tables available in a catalog.
|
|
getSchemas |
Gets the schema names available in this database. The results
are ordered by schema name.
|
|
getCatalogs |
gets the catalog names available in this database. The results
are ordered by catalog name.
|
|
getTableTypes |
gets the table types available in this database. The results
are ordered by table type.
|
|
getColumns |
gets a description of table columns available in
the specified catalog.
|
|
getColumnPrivileges |
gets a description of the access rights for a table's columns.
|
|
getTablePrivileges |
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 priviledge applies to all columns (this may be true
for
some systems but is not true
for all.)
|
|
getBestRowIdentifier |
gets a description of a table's optimal set of columns that
uniquely identifies a row. They are ordered by SCOPE.
|
|
getVersionColumns |
gets a description of a table's columns that are automatically
updated when any value in a row is updated. They are
unordered.
|
|
getPrimaryKeys |
gets a description of a table's primary key columns. They
are ordered by COLUMN_NAME.
|
|
getImportedKeys |
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.
|
|
getExportedKeys |
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.
|
|
getCrossReference |
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.
|
|
getTypeInfo |
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.
|
|
getIndexInfo |
gets a description of a table's indices and statistics. They are
ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.
|
|
supportsResultSetType |
Does the database support the given result set type?
|
|
supportsResultSetConcurrency |
Does the database support the concurrency type in combination
with the given result set type?
|
|
ownUpdatesAreVisible |
indicates whether a result set's own updates are visible.
|
|
ownDeletesAreVisible |
indicates whether a result set's own deletes are visible.
|
|
ownInsertsAreVisible |
indicates whether a result set's own inserts are visible.
|
|
othersUpdatesAreVisible |
indicates whether updates made by others are visible.
|
|
othersDeletesAreVisible |
indicates whether deletes made by others are visible.
|
|
othersInsertsAreVisible |
indicates whether inserts made by others are visible.
|
|
updatesAreDetected |
indicates whether or not a visible row update can be detected by
calling the method
XResultSet.rowUpdated .
|
|
deletesAreDetected |
indicates whether or not a visible row delete can be detected by
calling
XResultSet::rowDeleted()
. If deletesAreDetected()
returns false
, then deleted rows are removed from the result set.
|
|
insertsAreDetected |
indicates whether or not a visible row insert can be detected
by calling
XResultSet::rowInserted().
|
|
supportsBatchUpdates |
indicates whether the driver supports batch updates.
|
|
getUDTs |
Gets a description of the user-defined types defined in a particular
schema. Schema-specific UDTs may have type OBJECT, STRUCT,
or DISTINCT.
|
|
getConnection |
retrieves the connection that produced this metadata object.
|
|
Method Details
|
|
Syntax
- boolean allProceduresAreCallable
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean allTablesAreSelectable
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can all the tables returned by getTable be SELECTed by the
current user?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getURL
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns the directory and filename of the database.
Syntax
- string getUserName
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns the user name from this database connection.
Syntax
- boolean isReadOnly
();
- raises ( com::sun::star::sdbc::SQLException );
Description
checks if the database in read-only mode.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean nullsAreSortedHigh
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are NULL values sorted high?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean nullsAreSortedLow
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are NULL values sorted low?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean nullsAreSortedAtStart
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are NULL values sorted at the start regardless of sort order?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean nullsAreSortedAtEnd
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are NULL values sorted at the end, regardless of sort order?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getDatabaseProductName
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns the name of the database product.
Syntax
- string getDatabaseProductVersion
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns the version of the database product.
Syntax
- string getDriverName
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns the name of the SDBC driver.
Syntax
- string getDriverVersion
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns the version number of the SDBC driver.
Syntax
- long getDriverMajorVersion
();
Description
returns the JDBC driver major version number.
Syntax
- long getDriverMinorVersion
();
Description
returns the SDBC driver minor version number.
Syntax
- boolean usesLocalFiles
();
- raises ( com::sun::star::sdbc::SQLException );
Description
use the database local files to save the tables.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean usesLocalFilePerTable
();
- raises ( com::sun::star::sdbc::SQLException );
Description
use the database one local file to save for each table.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsMixedCaseIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
use the database 'mixed case unquoted SQL identifiers' case sensitive.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean storesUpperCaseIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in upper case?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean storesLowerCaseIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in lower case?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean storesMixedCaseIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database treat mixed case unquoted SQL identifiers as
case insensitive and store them in mixed case?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsMixedCaseQuotedIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean storesUpperCaseQuotedIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in upper case?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean storesLowerCaseQuotedIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in lower case?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean storesMixedCaseQuotedIdentifiers
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database treat mixed case quoted SQL identifiers as
case insensitive and store them in mixed case?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getIdentifierQuoteString
();
- raises ( com::sun::star::sdbc::SQLException );
Description
What's the string used to quote SQL identifiers?
This returns a space " " if identifier quoting is not supported.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getSQLKeywords
();
- raises ( com::sun::star::sdbc::SQLException );
Description
gets a comma-separated list of all a database's SQL keywords
that are NOT also SQL92 keywords.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getNumericFunctions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- string getStringFunctions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- string getSystemFunctions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- string getTimeDateFunctions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
gets a comma-separated list of time and date functions.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getSearchStringEscape
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- string getExtraNameCharacters
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsAlterTableWithAddColumn
();
- raises ( com::sun::star::sdbc::SQLException );
Description
support the Database "ALTER TABLE" with add column?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsAlterTableWithDropColumn
();
- raises ( com::sun::star::sdbc::SQLException );
Description
support the Database "ALTER TABLE" with drop column?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsColumnAliasing
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean nullPlusNonNullIsNull
();
- raises ( com::sun::star::sdbc::SQLException );
Description
are concatenations between NULL and non-NULL values NULL?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsTypeConversion
();
- raises ( com::sun::star::sdbc::SQLException );
Description
true
, if the Database supports the CONVERT function between SQL types,
otherwise
false
.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsConvert
(
- long fromType,
- long toType )
- raises ( com::sun::star::sdbc::SQLException );
Description
true
, if the Database supports the CONVERT between the given SQL types
otherwise
false
.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsTableCorrelationNames
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are table correlation names supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsDifferentTableCorrelationNames
();
- raises ( com::sun::star::sdbc::SQLException );
Description
If table correlation names are supported, are they restricted
to be different from the names of the tables?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsExpressionsInOrderBy
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are expressions in "ORDER BY" lists supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsOrderByUnrelated
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can an "ORDER BY" clause use columns not in the SELECT statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsGroupBy
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is some form of "GROUP BY" clause supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsGroupByUnrelated
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a "GROUP BY" clause use columns not in the SELECT?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsGroupByBeyondSelect
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a "GROUP BY" clause add columns not in the SELECT
provided it specifies all the columns in the SELECT?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsLikeEscapeClause
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is the escape character in "LIKE" clauses supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsMultipleResultSets
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are multiple XResultSets from a single execute supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsMultipleTransactions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can we have multiple transactions open at once (on different
connections)?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsNonNullableColumns
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can columns be defined as non-nullable?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsMinimumSQLGrammar
();
- raises ( com::sun::star::sdbc::SQLException );
Description
true
, if the database supports ODBC Minimum SQL grammar,
otherwise false
.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCoreSQLGrammar
();
- raises ( com::sun::star::sdbc::SQLException );
Description
true
, if the database supports ODBC Core SQL grammar,
otherwise false
.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsExtendedSQLGrammar
();
- raises ( com::sun::star::sdbc::SQLException );
Description
true
, if the database supports ODBC Extended SQL grammar,
otherwise false
.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsANSI92EntryLevelSQL
();
- raises ( com::sun::star::sdbc::SQLException );
Returns
-
true
, if the database supports ANSI92 entry level SQL grammar,
otherwise false
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsANSI92IntermediateSQL
();
- raises ( com::sun::star::sdbc::SQLException );
Returns
-
true
, if the database supports ANSI92 intermediate SQL grammar,
otherwise false
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsANSI92FullSQL
();
- raises ( com::sun::star::sdbc::SQLException );
Returns
-
true
, if the database supports ANSI92 full SQL grammar,
otherwise false
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsIntegrityEnhancementFacility
();
- raises ( com::sun::star::sdbc::SQLException );
Description
returns
true
, if the Database supports SQL Integrity Enhancement Facility,
otherwise false
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsOuterJoins
();
- raises ( com::sun::star::sdbc::SQLException );
Returns
-
true
, if some form of outer join is supported,
otherwise false
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsFullOuterJoins
();
- raises ( com::sun::star::sdbc::SQLException );
Returns
-
true
, if full nested outer joins are supported,
otherwise false
.
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsLimitedOuterJoins
();
- raises ( com::sun::star::sdbc::SQLException );
Returns
-
true
, if there is limited support for outer joins.
(This will be true
if supportFullOuterJoins is true
.)
false
is returned otherwise.
Throws
- SQLException
if a database access error occurs.
Syntax
- string getSchemaTerm
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the database vendor's preferred term for "schema"
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getProcedureTerm
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the database vendor's preferred term for "procedure"
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getCatalogTerm
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the database vendor's preferred term for "catalog"
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean isCatalogAtStart
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Does a catalog appear at the start of a qualified table name?
(Otherwise it appears at the end)
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- string getCatalogSeparator
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the separator between catalog and table name
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSchemasInDataManipulation
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a schema name be used in a data manipulation statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSchemasInProcedureCalls
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a schema name be used in a procedure call statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSchemasInTableDefinitions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a schema name be used in a table definition statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSchemasInIndexDefinitions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a schema name be used in an index definition statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSchemasInPrivilegeDefinitions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a schema name be used in a privilege definition statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCatalogsInDataManipulation
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a catalog name be used in a data manipulation statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCatalogsInProcedureCalls
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a catalog name be used in a procedure call statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCatalogsInTableDefinitions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a catalog name be used in a table definition statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCatalogsInIndexDefinitions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a catalog name be used in an index definition statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCatalogsInPrivilegeDefinitions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can a catalog name be used in a privilege definition statement?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsPositionedDelete
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is positioned DELETE supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsPositionedUpdate
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is positioned UPDATE supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSelectForUpdate
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is SELECT for UPDATE supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsStoredProcedures
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are stored procedure calls using the stored procedure escape
syntax supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSubqueriesInComparisons
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are subqueries in comparison expressions supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSubqueriesInExists
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are subqueries in 'exists' expressions supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSubqueriesInIns
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are subqueries in 'in' statements supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsSubqueriesInQuantifieds
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are subqueries in quantified expressions supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsCorrelatedSubqueries
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Are correlated subqueries supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsUnion
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is SQL UNION supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsUnionAll
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Is SQL UNION ALL supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsOpenCursorsAcrossCommit
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can cursors remain open across commits?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsOpenCursorsAcrossRollback
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can cursors remain open across rollbacks?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsOpenStatementsAcrossCommit
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can statements remain open across commits?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsOpenStatementsAcrossRollback
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Can statements remain open across rollbacks?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxBinaryLiteralLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximal number of hex characters in an inline binary literal
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxCharLiteralLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the max length for a character literal
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxColumnNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the limit on column name length
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxColumnsInGroupBy
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum number of columns in a "GROUP BY" clause
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxColumnsInIndex
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum number of columns allowed in an index
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxColumnsInOrderBy
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum number of columns in an "ORDER BY" clause
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxColumnsInSelect
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum number of columns in a "SELECT" list
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxColumnsInTable
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum number of columns in a table
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxConnections
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the number of active connections at a time to this database.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxCursorNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum cursor name length
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxIndexLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of an index (in bytes)
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxSchemaNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length allowed for a schema name
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxProcedureNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of a procedure name
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxCatalogNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of a catalog name
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxRowSize
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of a single row.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean doesMaxRowSizeIncludeBlobs
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY
blobs?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxStatementLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of a SQL statement
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxStatements
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximal number of open active statements at one time to this database
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxTableNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of a table name
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxTablesInSelect
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum number of tables in a SELECT statement
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getMaxUserNameLength
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the maximum length of a user name
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- long getDefaultTransactionIsolation
();
- raises ( com::sun::star::sdbc::SQLException );
Description
return the database default transaction isolation level.
The values are defined in
TransactionIsolation .
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
See also
- XConnection
-
Syntax
- boolean supportsTransactions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
support the Database transactions?
If not, invoking the method
XConnection::commit()
is a noop and the
isolation level is TransactionIsolation_NONE.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsTransactionIsolationLevel
(
- long level )
- raises ( com::sun::star::sdbc::SQLException );
Description
Does this database support the given transaction isolation level?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
See also
- Connection
-
Syntax
- boolean supportsDataDefinitionAndDataManipulationTransactions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
support the Database both data definition and data manipulation statements
within a transaction?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsDataManipulationTransactionsOnly
();
- raises ( com::sun::star::sdbc::SQLException );
Description
are only data manipulation statements within a transaction
supported?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean dataDefinitionCausesTransactionCommit
();
- raises ( com::sun::star::sdbc::SQLException );
Description
does a data definition statement within a transaction force the
transaction to commit?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean dataDefinitionIgnoredInTransactions
();
- raises ( com::sun::star::sdbc::SQLException );
Description
is a data definition statement within a transaction ignored?
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getProcedures
(
- any catalog,
- string schemaPattern,
- string procedureNamePattern )
- raises ( com::sun::star::sdbc::SQLException );
Description
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 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:
- UNKNOWN - May return a result
- NO - Does not return a result
- RETURN - Returns a result
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schemaPattern
-
a schema name pattern; "" retrieves those without a schema
Parameter procedureNamePattern
-
a procedure name pattern
Returns
-
each row is a procedure description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getProcedureColumns
(
- any catalog,
- string schemaPattern,
- string procedureNamePattern,
- string columnNamePattern )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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:
- UNKNOWN - nobody knows
- IN - IN parameter
- INOUT - INOUT parameter
- OUT - OUT parameter
- RETURN - procedure return value
- RESULT - result column in XResultSet
-
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 long => precision
-
LENGTH long => length in bytes of data
-
SCALE short => scale
-
RADIX short => radix
-
NULLABLE short => can it contain NULL?
- NO_NULLS - does not allow NULL values
- NULLABLE - allows NULL values
- NULLABLE_UNKNOWN - 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.
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schemaPattern
-
a schema name pattern; "" retrieves those without a schema
Parameter procedureNamePattern
-
a procedure name pattern
Parameter columnNamePattern
-
a column name pattern
Returns
-
each row describes a stored procedure parameter or column
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getTables
(
- any catalog,
- string schemaPattern,
- string tableNamePattern,
- sequence< string > types )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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.
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schemaPattern
-
a schema name pattern; "" retrieves those without a schema
Parameter tableNamePattern
-
a table name pattern
Parameter types
-
a list of table types to include; NULL
returns all types
Returns
-
each row is a table description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getSchemas
();
- raises ( com::sun::star::sdbc::SQLException );
Description
Gets the schema names available in this database. The results
are ordered by schema name.
The schema column is:
-
TABLE_SCHEM string => schema name
Returns
-
each row has a single String column that is a schema name
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getCatalogs
();
- raises ( com::sun::star::sdbc::SQLException );
Description
gets the catalog names available in this database. The results
are ordered by catalog name.
The catalog column is:
-
TABLE_CAT string => catalog name
Returns
-
each row has a single String column that is a catalog name
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getTableTypes
();
- raises ( com::sun::star::sdbc::SQLException );
Description
gets 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".
Returns
-
each row has a single String column that is a table type
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getColumns
(
- any catalog,
- string schemaPattern,
- string tableNamePattern,
- string columnNamePattern )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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 long => 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 long => the number of fractional digits
-
NUM_PREC_RADIX long => Radix (typically either 10 or 2)
-
NULLABLE long => is NULL allowed?
- NO_NULLS - might not allow NULL values
- NULABLE - definitely allows NULL values
- NULLABLE_UNKNOWN - nullability unknown
-
REMARKS string => comment describing column (may be NULL
)
-
COLUMN_DEF string => default value (may be NULL
)
-
SQL_DATA_TYPE long => unused
-
SQL_DATETIME_SUB long => unused
-
CHAR_OCTET_LENGTH long => 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.
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schemaPattern
-
a schema name pattern; "" retrieves those without a schema
Parameter tableNamePattern
-
a table name pattern
Parameter columnNamePattern
-
a column name pattern
Returns
-
each row is a column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getColumnPrivileges
(
- any catalog,
- string schema,
- string table,
- string columnNamePattern )
- raises ( com::sun::star::sdbc::SQLException );
Description
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 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, REFERENCES, ...)
-
IS_GRANTABLE string => "YES" if grantee is permitted
to grant to others; "NO" if not; NULL
if unknown
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name ; "" retrieves those without a schema
Parameter table
-
a table name
Parameter columnNamePattern
-
a column name pattern
Returns
-
each row is a column privilege description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getTablePrivileges
(
- any catalog,
- string schemaPattern,
- string tableNamePattern )
- raises ( com::sun::star::sdbc::SQLException );
Description
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 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, REFERENCES, ...)
-
IS_GRANTABLE string => "YES" if grantee is permitted
to grant to others; "NO" if not; NULL
if unknown
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schemaPattern
-
a schema name pattern; "" retrieves those without a schema
Parameter tableNamePattern
-
a table name pattern
Returns
-
each row is a table privilege description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getBestRowIdentifier
(
- any catalog,
- string schema,
- string table,
- long scope,
- boolean nullable )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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
-
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 long => precision
-
BUFFER_LENGTH long => not used
-
DECIMAL_DIGITS short => scale
-
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
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name; "" retrieves those without a schema
Parameter table
-
a table name
Parameter scope
-
the scope of interest; use same values as SCOPE
Parameter nullable
-
include columns that are nullable?
Returns
-
each row is a column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getVersionColumns
(
- any catalog,
- string schema,
- string table )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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 long => precision
-
BUFFER_LENGTH long => length of column value in bytes
-
DECIMAL_DIGITS short => scale
-
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
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name; "" retrieves those without a schema
Parameter table
-
a table name
Returns
-
each row is a column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getPrimaryKeys
(
- any catalog,
- string schema,
- string table )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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
)
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name; "" retrieves those without a schema
Parameter table
-
a table name
Returns
-
each row is a primary key column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getImportedKeys
(
- any catalog,
- string schema,
- string table )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name; "" retrieves those without a schema
Parameter table
-
a table name
Returns
-
each row is a primary key column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getExportedKeys
(
- any catalog,
- string schema,
- string table )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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:
- 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)
-
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
-
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
- INITIALLY_DEFERRED - see SQL92 for definition
- INITIALLY_IMMEDIATE - see SQL92 for definition
- NONE - see SQL92 for definition
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name; "" retrieves those without a schema
Parameter table
-
a table name
Returns
-
each row is a foreign key column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getCrossReference
(
- any primaryCatalog,
- string primarySchema,
- string primaryTable,
- any foreignCatalog,
- string foreignSchema,
- string foreignTable )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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:
- 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)
-
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
-
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
- INITIALLY_DEFERRED - see SQL92 for definition
- INITIALLY_IMMEDIATE - see SQL92 for definition
- NONE - see SQL92 for definition
Parameter primaryCatalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter primarySchema
-
a schema name; "" retrieves those without a schema
Parameter primaryTable
-
the table name that exports the key
Parameter foreignCatalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter foreignSchema
-
a schema name; "" retrieves those without a schema
Parameter foreignTable
-
the table name that imports the key
Returns
-
each row is a foreign key column description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getTypeInfo
();
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
TYPE_NAME string => Type name
-
DATA_TYPE short => SQL data type from java.sql.Types
-
PRECISION long => 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?
- NO_NULLS - does not allow NULL values
- NULLABLE - allows NULL values
- NULLABLE_UNKNOWN - nullability unknown
-
CASE_SENSITIVE boolean=> is it case sensitive?
-
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 ..
-
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 long => unused
-
SQL_DATETIME_SUB long => unused
-
NUM_PREC_RADIX long => usually 2 or 10
Returns
-
each row is a SQL type description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getIndexInfo
(
- any catalog,
- string schema,
- string table,
- boolean unique,
- boolean approximate )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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:
- 0 - this identifies table statistics that are
returned in conjuction 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
-
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 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.
-
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.
-
FILTER_CONDITION string => Filter condition, if any.
(may be NULL
)
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schema
-
a schema name; "" retrieves those without a schema
Parameter table
-
the table name that exports the key
Parameter unique
-
when true
, return only indices for unique values; when false
, return indices regardless of whether unique or not
Parameter approximate
-
when 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
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsResultSetType
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database support the given result set type?
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsResultSetConcurrency
(
- long setType,
- long concurrency )
- raises ( com::sun::star::sdbc::SQLException );
Description
Does the database support the concurrency type in combination
with the given result set type?
Parameter setType
-
defined in
ResultSetType
Parameter concurrency
-
defined in
ResultSetConcurrency
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean ownUpdatesAreVisible
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether a result set's own updates are visible.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean ownDeletesAreVisible
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether a result set's own deletes are visible.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean ownInsertsAreVisible
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether a result set's own inserts are visible.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean othersUpdatesAreVisible
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether updates made by others are visible.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean othersDeletesAreVisible
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether deletes made by others are visible.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean othersInsertsAreVisible
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether inserts made by others are visible.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean updatesAreDetected
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether or not a visible row update can be detected by
calling the method
XResultSet.rowUpdated .
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean deletesAreDetected
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether or not a visible row delete can be detected by
calling
XResultSet::rowDeleted()
. If deletesAreDetected()
returns false
, then deleted rows are removed from the result set.
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean insertsAreDetected
(
- long setType )
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether or not a visible row insert can be detected
by calling
XResultSet::rowInserted().
Parameter setType
-
defined in
ResultSetType
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- boolean supportsBatchUpdates
();
- raises ( com::sun::star::sdbc::SQLException );
Description
indicates whether the driver supports batch updates.
Returns
-
true
if so
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XResultSet getUDTs
(
- any catalog,
- string schemaPattern,
- string typeNamePattern,
- sequence< long > types )
- raises ( com::sun::star::sdbc::SQLException );
Description
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:
-
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 or service name
-
DATA_TYPE string => type value.
One of OBJECT, STRUCT, or DISTINCT
-
REMARKS string => explanatory comment on the type
Note: If the driver does not support UDTs, an empty
result set is returned.
Parameter catalog
-
a catalog name; "" retrieves those without a catalog; NULL
means drop catalog name from the selection criteria
Parameter schemaPattern
-
a schema name pattern; "" retrieves those without a schema
Parameter typeNamePattern
-
a type name pattern; may be a fully-qualified name
Parameter types
-
a list of user-named types to include (OBJECT, STRUCT, or DISTINCT); NULL
returns all types
Returns
-
each row is a type description
Throws
- SQLException
if a database access error occurs.
Syntax
- com::sun::star::sdbc::XConnection getConnection
();
- raises ( com::sun::star::sdbc::SQLException );
Description
retrieves the connection that produced this metadata object.
Returns
-
the Connection object
Throws
- SQLException
if a database access error occurs.
|
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.