LibreOffice: com/sun/star/sdbc/XDatabaseMetaData.idl Source File

LibreOffice LibreOffice 7.0 SDK API Reference

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 #ifndef __com_sun_star_sdbc_XDatabaseMetaData_idl__
20 #define __com_sun_star_sdbc_XDatabaseMetaData_idl__
21
22 #include <com/sun/star/uno/XInterface.idl>
23
24 #include <com/sun/star/sdbc/SQLException.idl>
25
26
27 module com { module sun { module star { module sdbc {
28
29 published interface XResultSet;
30 published interface XConnection;
31
68 published interface XDatabaseMetaData: com::sun::star::uno::XInterface
69 {
70
81 boolean allProceduresAreCallable() raises (SQLException);
82
90 boolean allTablesAreSelectable() raises (SQLException);
91
94 string getURL() raises (SQLException);
95
98 string getUserName() raises (SQLException);
99
106 boolean isReadOnly() raises (SQLException);
107
114 boolean nullsAreSortedHigh() raises (SQLException);
115
122 boolean nullsAreSortedLow() raises (SQLException);
123
130 boolean nullsAreSortedAtStart() raises (SQLException);
131
138 boolean nullsAreSortedAtEnd() raises (SQLException);
139
142 string getDatabaseProductName() raises (SQLException);
143
146 string getDatabaseProductVersion() raises (SQLException);
147
150 string getDriverName() raises (SQLException);
151
154 string getDriverVersion() raises (SQLException);
155
158 long getDriverMajorVersion();
159
162 long getDriverMinorVersion();
163
170 boolean usesLocalFiles() raises (SQLException);
171
178 boolean usesLocalFilePerTable() raises (SQLException);
179
186 boolean supportsMixedCaseIdentifiers() raises (SQLException);
187
195 boolean storesUpperCaseIdentifiers() raises (SQLException);
196
204 boolean storesLowerCaseIdentifiers() raises (SQLException);
205
213 boolean storesMixedCaseIdentifiers() raises (SQLException);
214
222 boolean supportsMixedCaseQuotedIdentifiers() raises (SQLException);
223
231 boolean storesUpperCaseQuotedIdentifiers() raises (SQLException);
232
240 boolean storesLowerCaseQuotedIdentifiers() raises (SQLException);
241
249 boolean storesMixedCaseQuotedIdentifiers() raises (SQLException);
250
258 string getIdentifierQuoteString() raises (SQLException);
259
267 string getSQLKeywords() raises (SQLException);
268
277 string getNumericFunctions() raises (SQLException);
278
287 string getStringFunctions() raises (SQLException);
288
297 string getSystemFunctions() raises (SQLException);
298
305 string getTimeDateFunctions() raises (SQLException);
306
324 string getSearchStringEscape() raises (SQLException);
325
333 string getExtraNameCharacters() raises (SQLException);
334
341 boolean supportsAlterTableWithAddColumn() raises (SQLException);
342
349 boolean supportsAlterTableWithDropColumn() raises (SQLException);
350
363 boolean supportsColumnAliasing() raises (SQLException);
364
371 boolean nullPlusNonNullIsNull() raises (SQLException);
372
381 boolean supportsTypeConversion() raises (SQLException);
382
391 boolean supportsConvert([in]long fromType, [in]long toType)
392 raises (SQLException);
393
400 boolean supportsTableCorrelationNames() raises (SQLException);
401
409 boolean supportsDifferentTableCorrelationNames()
410 raises (SQLException);
411
418 boolean supportsExpressionsInOrderBy() raises (SQLException);
419
426 boolean supportsOrderByUnrelated() raises (SQLException);
427
434 boolean supportsGroupBy() raises (SQLException);
435
442 boolean supportsGroupByUnrelated() raises (SQLException);
443
451 boolean supportsGroupByBeyondSelect() raises (SQLException);
452
459 boolean supportsLikeEscapeClause() raises (SQLException);
460
467 boolean supportsMultipleResultSets() raises (SQLException);
468
476 boolean supportsMultipleTransactions() raises (SQLException);
477
484 boolean supportsNonNullableColumns() raises (SQLException);
485
493 boolean supportsMinimumSQLGrammar() raises (SQLException);
494
502 boolean supportsCoreSQLGrammar() raises (SQLException);
503
512 boolean supportsExtendedSQLGrammar() raises (SQLException);
513
520 boolean supportsANSI92EntryLevelSQL() raises (SQLException);
521
528 boolean supportsANSI92IntermediateSQL() raises (SQLException);
529
536 boolean supportsANSI92FullSQL() raises (SQLException);
537
544 boolean supportsIntegrityEnhancementFacility() raises (SQLException);
545
552 boolean supportsOuterJoins() raises (SQLException);
553
560 boolean supportsFullOuterJoins() raises (SQLException);
561
569 boolean supportsLimitedOuterJoins() raises (SQLException);
570
577 string getSchemaTerm() raises (SQLException);
578
585 string getProcedureTerm() raises (SQLException);
586
593 string getCatalogTerm() raises (SQLException);
594
602 boolean isCatalogAtStart() raises (SQLException);
603
610 string getCatalogSeparator() raises (SQLException);
611
618 boolean supportsSchemasInDataManipulation() raises (SQLException);
619
626 boolean supportsSchemasInProcedureCalls() raises (SQLException);
627
634 boolean supportsSchemasInTableDefinitions() raises (SQLException);
635
642 boolean supportsSchemasInIndexDefinitions() raises (SQLException);
643
650 boolean supportsSchemasInPrivilegeDefinitions()
651 raises (SQLException);
652
659 boolean supportsCatalogsInDataManipulation() raises (SQLException);
660
667 boolean supportsCatalogsInProcedureCalls() raises (SQLException);
668
675 boolean supportsCatalogsInTableDefinitions() raises (SQLException);
676
683 boolean supportsCatalogsInIndexDefinitions() raises (SQLException);
684
691 boolean supportsCatalogsInPrivilegeDefinitions()
692 raises (SQLException);
693
700 boolean supportsPositionedDelete() raises (SQLException);
701
708 boolean supportsPositionedUpdate() raises (SQLException);
709
716 boolean supportsSelectForUpdate() raises (SQLException);
717
725 boolean supportsStoredProcedures() raises (SQLException);
726
733 boolean supportsSubqueriesInComparisons() raises (SQLException);
734
741 boolean supportsSubqueriesInExists() raises (SQLException);
742
749 boolean supportsSubqueriesInIns() raises (SQLException);
750
757 boolean supportsSubqueriesInQuantifieds() raises (SQLException);
758
765 boolean supportsCorrelatedSubqueries() raises (SQLException);
766
773 boolean supportsUnion() raises (SQLException);
774
781 boolean supportsUnionAll() raises (SQLException);
782
789 boolean supportsOpenCursorsAcrossCommit() raises (SQLException);
790
797 boolean supportsOpenCursorsAcrossRollback() raises (SQLException);
798
805 boolean supportsOpenStatementsAcrossCommit() raises (SQLException);
806
813 boolean supportsOpenStatementsAcrossRollback()
814 raises (SQLException);
815
822 long getMaxBinaryLiteralLength() raises (SQLException);
823
830 long getMaxCharLiteralLength() raises (SQLException);
831
838 long getMaxColumnNameLength() raises (SQLException);
839
846 long getMaxColumnsInGroupBy() raises (SQLException);
847
854 long getMaxColumnsInIndex() raises (SQLException);
855
862 long getMaxColumnsInOrderBy() raises (SQLException);
863
870 long getMaxColumnsInSelect() raises (SQLException);
871
878 long getMaxColumnsInTable() raises (SQLException);
879
886 long getMaxConnections() raises (SQLException);
887
894 long getMaxCursorNameLength() raises (SQLException);
895
902 long getMaxIndexLength() raises (SQLException);
903
910 long getMaxSchemaNameLength() raises (SQLException);
911
918 long getMaxProcedureNameLength() raises (SQLException);
919
926 long getMaxCatalogNameLength() raises (SQLException);
927
934 long getMaxRowSize() raises (SQLException);
935
943 boolean doesMaxRowSizeIncludeBlobs() raises (SQLException);
944
951 long getMaxStatementLength() raises (SQLException);
952
959 long getMaxStatements() raises (SQLException);
960
967 long getMaxTableNameLength() raises (SQLException);
968
975 long getMaxTablesInSelect() raises (SQLException);
976
983 long getMaxUserNameLength() raises (SQLException);
984
994 long getDefaultTransactionIsolation() raises (SQLException);
995
1006 boolean supportsTransactions() raises (SQLException);
1007
1015 boolean supportsTransactionIsolationLevel([in]long level)
1016 raises (SQLException);
1017
1032 boolean supportsDataDefinitionAndDataManipulationTransactions()
1033 raises (SQLException);
1034
1042 boolean supportsDataManipulationTransactionsOnly()
1043 raises (SQLException);
1044
1052 boolean dataDefinitionCausesTransactionCommit()
1053 raises (SQLException);
1054
1061 boolean dataDefinitionIgnoredInTransactions()
1062 raises (SQLException);
1063
1118 XResultSet getProcedures([in]any catalog, [in]string schemaPattern,
1119 [in]string procedureNamePattern) raises (SQLException);
1120
1217 XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern,
1218 [in]string procedureNamePattern,
1219 [in]string columnNamePattern)
1220 raises (SQLException);
1221
1267 XResultSet getTables([in]any catalog, [in]string schemaPattern,
1268 [in]string tableNamePattern, [in]sequence<string> types)
1269 raises (SQLException);
1270
1287 XResultSet getSchemas() raises (SQLException);
1288
1305 XResultSet getCatalogs() raises (SQLException);
1306
1325 XResultSet getTableTypes() raises (SQLException);
1326
1421 XResultSet getColumns([in]any catalog, [in]string schemaPattern,
1422 [in]string tableNamePattern, [in]string columnNamePattern)
1423 raises (SQLException);
1424
1475 XResultSet getColumnPrivileges([in]any catalog, [in]string schema,
1476 [in]string table, [in]string columnNamePattern) raises (SQLException);
1477
1527 XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern,
1528 [in]string tableNamePattern) raises (SQLException);
1529
1595 XResultSet getBestRowIdentifier([in]any catalog, [in]string schema,
1596 [in]string table, [in]long scope, [in] boolean nullable)
1597 raises (SQLException);
1598
1652 XResultSet getVersionColumns([in]any catalog, [in]string schema,
1653 [in]string table) raises (SQLException);
1654
1692 XResultSet getPrimaryKeys([in]any catalog, [in]string schema,
1693 [in]string table) raises (SQLException);
1694
1806 XResultSet getImportedKeys([in]any catalog, [in]string schema,
1807 [in]string table) raises (SQLException);
1808
1920 XResultSet getExportedKeys([in]any catalog, [in]string schema,
1921 [in]string table) raises (SQLException);
1922
2043 XResultSet getCrossReference(
2044 [in]any primaryCatalog, [in]string primarySchema,
2045 [in]string primaryTable,
2046 [in]any foreignCatalog, [in]string foreignSchema,
2047 [in]string foreignTable) raises (SQLException);
2048
2141 XResultSet getTypeInfo() raises (SQLException);
2142
2228 XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table,
2229 [in]boolean unique, [in]boolean approximate)
2230 raises (SQLException);
2231
2241 boolean supportsResultSetType([in]long setType) raises (SQLException);
2242
2256 boolean supportsResultSetConcurrency([in]long setType,
2257 [in]long concurrency)
2258 raises (SQLException);
2259
2269 boolean ownUpdatesAreVisible([in]long setType) raises (SQLException);
2270
2280 boolean ownDeletesAreVisible([in]long setType) raises (SQLException);
2281
2291 boolean ownInsertsAreVisible([in]long setType) raises (SQLException);
2292
2302 boolean othersUpdatesAreVisible([in]long setType) raises (SQLException);
2303
2313 boolean othersDeletesAreVisible([in]long setType) raises (SQLException);
2314
2324 boolean othersInsertsAreVisible([in]long setType) raises (SQLException);
2325
2337 boolean updatesAreDetected([in]long setType) raises (SQLException);
2338
2351 boolean deletesAreDetected([in]long setType) raises (SQLException);
2352
2364 boolean insertsAreDetected([in]long setType) raises (SQLException);
2365
2372 boolean supportsBatchUpdates() raises (SQLException);
2373
2425 XResultSet getUDTs([in]any catalog, [in]string schemaPattern,
2426 [in]string typeNamePattern, [in]sequence<long> types)
2427 raises (SQLException);
2428
2435 XConnection getConnection() raises (SQLException);
2436 };
2437
2438
2439 }; }; }; };
2440
2441 #endif
2442
2443 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdbc::XResultSet
provides the navigation on a table of data.
Definition: XResultSet.idl:44
XInterface.idl
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:58
com::sun::star::sdbc::XDatabaseMetaData::allProceduresAreCallable
boolean allProceduresAreCallable()
Can all the procedures returned by getProcedures be called by the current user?
SQLException.idl
com::sun::star::sdbc::XDatabaseMetaData
provides comprehensive information about the database as a whole.
Definition: XDatabaseMetaData.idl:69
com
Definition: Ambiguous.idl:22
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition: SQLException.idl:45