LibreOffice
LibreOffice 24.2 SDK API Reference
|
extends the XDatabaseMetaData interface to allow retrieval of additional information. More...
import"XDatabaseMetaData2.idl";
Public Member Functions | |
sequence< ::com::sun::star::beans::PropertyValue > | getConnectionInfo () |
complements XDatabaseMetaData::getURL by returning the settings which, upon construction of the connection, have been used besides the connection URL. More... | |
Public Member Functions inherited from XDatabaseMetaData | |
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... | |
extends the XDatabaseMetaData interface to allow retrieval of additional information.
sequence< ::com::sun::star::beans::PropertyValue > getConnectionInfo | ( | ) |
complements XDatabaseMetaData::getURL by returning the settings which, upon construction of the connection, have been used besides the connection URL.