LibreOffice
LibreOffice 24.8 SDK API Reference
 
Loading...
Searching...
No Matches
XDatabaseMetaData.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21 module com { module sun { module star { module sdbc {
22
23 published interface XResultSet;
24 published interface XConnection;
25
63{
64
76
85
88 string getURL() raises (SQLException);
89
92 string getUserName() raises (SQLException);
93
100 boolean isReadOnly() raises (SQLException);
101
109
116 boolean nullsAreSortedLow() raises (SQLException);
117
125
133
137
141
144 string getDriverName() raises (SQLException);
145
149
153
157
164 boolean usesLocalFiles() raises (SQLException);
165
173
181
190
199
208
217
226
235
244
253
261 string getSQLKeywords() raises (SQLException);
262
272
282
292
300
319
328
336
344
358
366
376
385 boolean supportsConvert([in]long fromType, [in]long toType)
386 raises (SQLException);
387
395
404 raises (SQLException);
405
413
421
428 boolean supportsGroupBy() raises (SQLException);
429
437
446
454
462
471
479
488
497
507
515
523
531
539
547
555
564
571 string getSchemaTerm() raises (SQLException);
572
580
587 string getCatalogTerm() raises (SQLException);
588
596 boolean isCatalogAtStart() raises (SQLException);
597
605
613
621
629
637
645 raises (SQLException);
646
654
662
670
678
686 raises (SQLException);
687
695
703
711
720
728
736
744
752
760
767 boolean supportsUnion() raises (SQLException);
768
775 boolean supportsUnionAll() raises (SQLException);
776
784
792
800
808 raises (SQLException);
809
817
825
833
841
849
857
865
873
881
889
897
905
913
921
929
938
946
954
962
970
978
989
1001
1010 raises (SQLException);
1011
1027 raises (SQLException);
1028
1037 raises (SQLException);
1038
1047 raises (SQLException);
1048
1056 raises (SQLException);
1057
1112 XResultSet getProcedures([in]any catalog, [in]string schemaPattern,
1113 [in]string procedureNamePattern) raises (SQLException);
1114
1211 XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern,
1212 [in]string procedureNamePattern,
1213 [in]string columnNamePattern)
1214 raises (SQLException);
1215
1261 XResultSet getTables([in]any catalog, [in]string schemaPattern,
1262 [in]string tableNamePattern, [in]sequence<string> types)
1263 raises (SQLException);
1264
1282
1300
1320
1415 XResultSet getColumns([in]any catalog, [in]string schemaPattern,
1416 [in]string tableNamePattern, [in]string columnNamePattern)
1417 raises (SQLException);
1418
1469 XResultSet getColumnPrivileges([in]any catalog, [in]string schema,
1470 [in]string table, [in]string columnNamePattern) raises (SQLException);
1471
1521 XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern,
1522 [in]string tableNamePattern) raises (SQLException);
1523
1589 XResultSet getBestRowIdentifier([in]any catalog, [in]string schema,
1590 [in]string table, [in]long scope, [in] boolean nullable)
1591 raises (SQLException);
1592
1646 XResultSet getVersionColumns([in]any catalog, [in]string schema,
1647 [in]string table) raises (SQLException);
1648
1686 XResultSet getPrimaryKeys([in]any catalog, [in]string schema,
1687 [in]string table) raises (SQLException);
1688
1800 XResultSet getImportedKeys([in]any catalog, [in]string schema,
1801 [in]string table) raises (SQLException);
1802
1914 XResultSet getExportedKeys([in]any catalog, [in]string schema,
1915 [in]string table) raises (SQLException);
1916
2038 [in]any primaryCatalog, [in]string primarySchema,
2039 [in]string primaryTable,
2040 [in]any foreignCatalog, [in]string foreignSchema,
2041 [in]string foreignTable) raises (SQLException);
2042
2136
2222 XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table,
2223 [in]boolean unique, [in]boolean approximate)
2224 raises (SQLException);
2225
2235 boolean supportsResultSetType([in]long setType) raises (SQLException);
2236
2250 boolean supportsResultSetConcurrency([in]long setType,
2251 [in]long concurrency)
2252 raises (SQLException);
2253
2263 boolean ownUpdatesAreVisible([in]long setType) raises (SQLException);
2264
2274 boolean ownDeletesAreVisible([in]long setType) raises (SQLException);
2275
2285 boolean ownInsertsAreVisible([in]long setType) raises (SQLException);
2286
2296 boolean othersUpdatesAreVisible([in]long setType) raises (SQLException);
2297
2307 boolean othersDeletesAreVisible([in]long setType) raises (SQLException);
2308
2318 boolean othersInsertsAreVisible([in]long setType) raises (SQLException);
2319
2331 boolean updatesAreDetected([in]long setType) raises (SQLException);
2332
2345 boolean deletesAreDetected([in]long setType) raises (SQLException);
2346
2358 boolean insertsAreDetected([in]long setType) raises (SQLException);
2359
2367
2419 XResultSet getUDTs([in]any catalog, [in]string schemaPattern,
2420 [in]string typeNamePattern, [in]sequence<long> types)
2421 raises (SQLException);
2422
2430};
2431
2432
2433}; }; }; };
2434
2435/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is an exception that provides information on a database access error.
Definition SQLException.idl:41
represents a connection (session) with a specific database.
Definition XConnection.idl:50
provides comprehensive information about the database as a whole.
Definition XDatabaseMetaData.idl:63
boolean supportsAlterTableWithDropColumn()
support the Database "ALTER TABLE" with drop column?
boolean supportsTransactionIsolationLevel([in]long level)
Does this database support the given transaction isolation level?
string getCatalogSeparator()
return the separator between catalog and table name
long getMaxIndexLength()
return the maximum length of an index (in bytes)
boolean supportsTypeConversion()
TRUE , if the Database supports the CONVERT function between SQL types, otherwise FALSE.
boolean nullPlusNonNullIsNull()
are concatenations between NULL and non-NULL values NULL?
boolean supportsAlterTableWithAddColumn()
support the Database "ALTER TABLE" with add column?
string getDatabaseProductName()
returns the name of the database product.
boolean supportsSubqueriesInQuantifieds()
Are subqueries in quantified expressions supported?
boolean supportsSelectForUpdate()
Is SELECT for UPDATE supported?
string getDriverVersion()
returns the version number of the SDBC driver.
XResultSet getCrossReference([in]any primaryCatalog, [in]string primarySchema, [in]string primaryTable, [in]any foreignCatalog, [in]string foreignSchema, [in]string foreignTable)
gets a description of the foreign key columns in the foreign key table that reference the primary key...
boolean supportsSchemasInDataManipulation()
Can a schema name be used in a data manipulation statement?
boolean storesMixedCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mix...
string getNumericFunctions()
gets a comma-separated list of math functions.
long getMaxTablesInSelect()
return the maximum number of tables in a SELECT statement
string getSystemFunctions()
gets a comma-separated list of system functions.
boolean supportsNonNullableColumns()
Can columns be defined as non-nullable?
XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern, [in]string columnNamePattern)
gets a description of a catalog's stored procedure parameters and result columns.
boolean supportsCoreSQLGrammar()
TRUE, if the database supports ODBC Core SQL grammar, otherwise FALSE.
string getProcedureTerm()
return the database vendor's preferred term for "procedure"
boolean storesUpperCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper...
XResultSet getExportedKeys([in]any catalog, [in]string schema, [in]string table)
gets a description of the foreign key columns that reference a table's primary key columns (the forei...
boolean nullsAreSortedLow()
Are NULL values sorted low?
boolean supportsStoredProcedures()
Are stored procedure calls using the stored procedure escape syntax supported?
XResultSet getImportedKeys([in]any catalog, [in]string schema, [in]string table)
gets a description of the primary key columns that are referenced by a table's foreign key columns (t...
long getDriverMinorVersion()
returns the SDBC driver minor version number.
long getMaxSchemaNameLength()
return the maximum length allowed for a schema name
long getMaxColumnsInSelect()
return the maximum number of columns in a "SELECT" list
long getMaxRowSize()
return the maximum length of a single row.
long getMaxColumnsInIndex()
return the maximum number of columns allowed in an index
boolean supportsMultipleTransactions()
Can we have multiple transactions open at once (on different connections)?
boolean othersInsertsAreVisible([in]long setType)
indicates whether inserts made by others are visible.
boolean supportsTableCorrelationNames()
Are table correlation names supported?
boolean supportsSchemasInTableDefinitions()
Can a schema name be used in a table definition statement?
boolean supportsBatchUpdates()
indicates whether the driver supports batch updates.
boolean supportsCorrelatedSubqueries()
Are correlated subqueries supported?
string getStringFunctions()
gets a comma-separated list of string functions.
string getIdentifierQuoteString()
What's the string used to quote SQL identifiers?
boolean supportsDataManipulationTransactionsOnly()
are only data manipulation statements within a transaction supported?
boolean supportsMixedCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store the...
XConnection getConnection()
retrieves the connection that produced this metadata object.
long getMaxCharLiteralLength()
return the max length for a character literal
boolean isCatalogAtStart()
Does a catalog appear at the start of a qualified table name?
XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern)
gets a description of the access rights for each table available in a catalog.
long getMaxTableNameLength()
return the maximum length of a table name
long getMaxProcedureNameLength()
return the maximum length of a procedure name
boolean usesLocalFiles()
use the database local files to save the tables.
boolean supportsExpressionsInOrderBy()
Are expressions in "ORDER BY" lists supported?
boolean supportsMixedCaseIdentifiers()
use the database "mixed case unquoted SQL identifiers" case sensitive.
XResultSet getVersionColumns([in]any catalog, [in]string schema, [in]string table)
gets a description of a table's columns that are automatically updated when any value in a row is upd...
boolean othersDeletesAreVisible([in]long setType)
indicates whether deletes made by others are visible.
long getMaxStatements()
return the maximal number of open active statements at one time to this database
boolean supportsGroupBy()
Is some form of "GROUP BY" clause supported?
boolean storesMixedCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed...
boolean ownDeletesAreVisible([in]long setType)
indicates whether a result set's own deletes are visible.
boolean allProceduresAreCallable()
Can all the procedures returned by getProcedures be called by the current user?
boolean supportsTransactions()
support the Database transactions?
boolean supportsSchemasInProcedureCalls()
Can a schema name be used in a procedure call statement?
boolean othersUpdatesAreVisible([in]long setType)
indicates whether updates made by others are visible.
long getMaxCursorNameLength()
return the maximum cursor name length
boolean dataDefinitionIgnoredInTransactions()
is a data definition statement within a transaction ignored?
boolean updatesAreDetected([in]long setType)
indicates whether or not a visible row update can be detected by calling the method XResultSet....
boolean allTablesAreSelectable()
Can all the tables returned by getTable be SELECTed by the current user?
long getMaxConnections()
return the number of active connections at a time to this database.
boolean supportsOpenCursorsAcrossRollback()
Can cursors remain open across rollbacks?
boolean supportsResultSetConcurrency([in]long setType, [in]long concurrency)
Does the database support the concurrency type in combination with the given result set type?
boolean supportsOpenStatementsAcrossRollback()
Can statements remain open across rollbacks?
boolean ownInsertsAreVisible([in]long setType)
indicates whether a result set's own inserts are visible.
XResultSet getTableTypes()
gets the table types available in this database.
boolean supportsOpenCursorsAcrossCommit()
Can cursors remain open across commits?
boolean deletesAreDetected([in]long setType)
indicates whether or not a visible row delete can be detected by calling com::sun::star::sdbc::XResul...
XResultSet getProcedures([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern)
Gets a description of the stored procedures available in a catalog.
boolean supportsSubqueriesInIns()
Are subqueries in "in" statements supported?
boolean supportsCatalogsInPrivilegeDefinitions()
Can a catalog name be used in a privilege definition statement?
boolean supportsSubqueriesInComparisons()
Are subqueries in comparison expressions supported?
XResultSet getColumnPrivileges([in]any catalog, [in]string schema, [in]string table, [in]string columnNamePattern)
gets a description of the access rights for a table's columns.
boolean supportsSchemasInIndexDefinitions()
Can a schema name be used in an index definition statement?
boolean nullsAreSortedAtEnd()
Are NULL values sorted at the end, regardless of sort order?
boolean supportsIntegrityEnhancementFacility()
returns TRUE, if the Database supports SQL Integrity Enhancement Facility, otherwise FALSE.
long getMaxBinaryLiteralLength()
return the maximal number of hex characters in an inline binary literal
long getDefaultTransactionIsolation()
return the database default transaction isolation level.
boolean supportsSubqueriesInExists()
Are subqueries in "exists" expressions supported?
XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table, [in]boolean unique, [in]boolean approximate)
gets a description of a table's indices and statistics.
boolean storesLowerCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in low...
boolean nullsAreSortedHigh()
Are NULL values sorted high?
string getSearchStringEscape()
gets the string that can be used to escape wildcard characters.
XResultSet getSchemas()
Gets the schema names available in this database.
long getMaxStatementLength()
return the maximum length of a SQL statement
boolean storesUpperCaseIdentifiers()
Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upp...
boolean supportsUnionAll()
Is SQL UNION ALL supported?
boolean storesLowerCaseQuotedIdentifiers()
Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower...
boolean supportsGroupByBeyondSelect()
Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SE...
boolean usesLocalFilePerTable()
use the database one local file to save for each table.
long getMaxColumnsInTable()
return the maximum number of columns in a table
XResultSet getBestRowIdentifier([in]any catalog, [in]string schema, [in]string table, [in]long scope, [in] boolean nullable)
gets a description of a table's optimal set of columns that uniquely identifies a row.
boolean insertsAreDetected([in]long setType)
indicates whether or not a visible row insert can be detected by calling com::sun::star::sdbc::XResul...
boolean supportsOpenStatementsAcrossCommit()
Can statements remain open across commits?
long getMaxColumnNameLength()
return the limit on column name length
long getDriverMajorVersion()
returns the SDBC driver major version number.
boolean supportsDataDefinitionAndDataManipulationTransactions()
support the Database both data definition and data manipulation statements within a transaction?
boolean supportsCatalogsInTableDefinitions()
Can a catalog name be used in a table definition statement?
boolean supportsResultSetType([in]long setType)
Does the database support the given result set type?
boolean supportsMultipleResultSets()
Are multiple XResultSets from a single execute supported?
long getMaxColumnsInOrderBy()
return the maximum number of columns in an "ORDER BY" clause
XResultSet getPrimaryKeys([in]any catalog, [in]string schema, [in]string table)
gets a description of a table's primary key columns.
string getCatalogTerm()
return the database vendor's preferred term for "catalog"
boolean supportsCatalogsInProcedureCalls()
Can a catalog name be used in a procedure call statement?
string getDatabaseProductVersion()
returns the version of the database product.
boolean supportsCatalogsInDataManipulation()
Can a catalog name be used in a data manipulation statement?
boolean ownUpdatesAreVisible([in]long setType)
indicates whether a result set's own updates are visible.
boolean supportsGroupByUnrelated()
Can a "GROUP BY" clause use columns not in the SELECT?
XResultSet getUDTs([in]any catalog, [in]string schemaPattern, [in]string typeNamePattern, [in]sequence< long > types)
Gets a description of the user-defined types defined in a particular schema.
string getExtraNameCharacters()
gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z,...
string getSQLKeywords()
gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
string getTimeDateFunctions()
gets a comma-separated list of time and date functions.
string getDriverName()
returns the name of the SDBC driver.
boolean isReadOnly()
checks if the database in read-only mode.
boolean supportsMinimumSQLGrammar()
TRUE, if the database supports ODBC Minimum SQL grammar, otherwise FALSE.
boolean supportsDifferentTableCorrelationNames()
If table correlation names are supported, are they restricted to be different from the names of the t...
boolean dataDefinitionCausesTransactionCommit()
does a data definition statement within a transaction force the transaction to commit?
boolean supportsSchemasInPrivilegeDefinitions()
Can a schema name be used in a privilege definition statement?
long getMaxUserNameLength()
return the maximum length of a user name
long getMaxCatalogNameLength()
return the maximum length of a catalog name
boolean doesMaxRowSizeIncludeBlobs()
Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
string getUserName()
returns the user name from this database connection.
boolean supportsOrderByUnrelated()
Can an "ORDER BY" clause use columns not in the SELECT statement?
string getURL()
returns the URL for the database connection
XResultSet getTypeInfo()
gets a description of all the standard SQL types supported by this database.
XResultSet getColumns([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]string columnNamePattern)
gets a description of table columns available in the specified catalog.
boolean supportsPositionedUpdate()
Is positioned UPDATE supported?
XResultSet getTables([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]sequence< string > types)
gets a description of tables available in a catalog.
boolean supportsColumnAliasing()
support the Database column aliasing?
long getMaxColumnsInGroupBy()
return the maximum number of columns in a "GROUP BY" clause
boolean supportsLikeEscapeClause()
Is the escape character in "LIKE" clauses supported?
string getSchemaTerm()
return the database vendor's preferred term for "schema"
XResultSet getCatalogs()
gets the catalog names available in this database.
boolean supportsUnion()
Is SQL UNION supported?
boolean nullsAreSortedAtStart()
Are NULL values sorted at the start regardless of sort order?
boolean supportsPositionedDelete()
Is positioned DELETE supported?
boolean supportsConvert([in]long fromType, [in]long toType)
TRUE , if the Database supports the CONVERT between the given SQL types otherwise FALSE.
boolean supportsCatalogsInIndexDefinitions()
Can a catalog name be used in an index definition statement?
provides the navigation on a table of data.
Definition XResultSet.idl:38
base interface of all UNO interfaces
Definition XInterface.idl:46
Table specific interfaces (for text and spreadsheet).
Definition modules.idl:358
Definition Ambiguous.idl:20