LibreOffice LibreOffice 25.2 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
20
21 module com { module sun { module star { module sdbc {
22
23 published interface XResultSet;
24 published interface XConnection;
25
62published interface XDatabaseMetaData: com::sun::star::uno::XInterface
63{
64
75 boolean allProceduresAreCallable() raises (SQLException);
76
84 boolean allTablesAreSelectable() raises (SQLException);
85
88 string getURL() raises (SQLException);
89
92 string getUserName() raises (SQLException);
93
100 boolean isReadOnly() raises (SQLException);
101
108 boolean nullsAreSortedHigh() raises (SQLException);
109
116 boolean nullsAreSortedLow() raises (SQLException);
117
124 boolean nullsAreSortedAtStart() raises (SQLException);
125
132 boolean nullsAreSortedAtEnd() raises (SQLException);
133
136 string getDatabaseProductName() raises (SQLException);
137
140 string getDatabaseProductVersion() raises (SQLException);
141
144 string getDriverName() raises (SQLException);
145
148 string getDriverVersion() raises (SQLException);
149
152 long getDriverMajorVersion();
153
156 long getDriverMinorVersion();
157
164 boolean usesLocalFiles() raises (SQLException);
165
172 boolean usesLocalFilePerTable() raises (SQLException);
173
180 boolean supportsMixedCaseIdentifiers() raises (SQLException);
181
189 boolean storesUpperCaseIdentifiers() raises (SQLException);
190
198 boolean storesLowerCaseIdentifiers() raises (SQLException);
199
207 boolean storesMixedCaseIdentifiers() raises (SQLException);
208
216 boolean supportsMixedCaseQuotedIdentifiers() raises (SQLException);
217
225 boolean storesUpperCaseQuotedIdentifiers() raises (SQLException);
226
234 boolean storesLowerCaseQuotedIdentifiers() raises (SQLException);
235
243 boolean storesMixedCaseQuotedIdentifiers() raises (SQLException);
244
252 string getIdentifierQuoteString() raises (SQLException);
253
261 string getSQLKeywords() raises (SQLException);
262
271 string getNumericFunctions() raises (SQLException);
272
281 string getStringFunctions() raises (SQLException);
282
291 string getSystemFunctions() raises (SQLException);
292
299 string getTimeDateFunctions() raises (SQLException);
300
318 string getSearchStringEscape() raises (SQLException);
319
327 string getExtraNameCharacters() raises (SQLException);
328
335 boolean supportsAlterTableWithAddColumn() raises (SQLException);
336
343 boolean supportsAlterTableWithDropColumn() raises (SQLException);
344
357 boolean supportsColumnAliasing() raises (SQLException);
358
365 boolean nullPlusNonNullIsNull() raises (SQLException);
366
375 boolean supportsTypeConversion() raises (SQLException);
376
385 boolean supportsConvert([in]long fromType, [in]long toType)
386 raises (SQLException);
387
394 boolean supportsTableCorrelationNames() raises (SQLException);
395
403 boolean supportsDifferentTableCorrelationNames()
404 raises (SQLException);
405
412 boolean supportsExpressionsInOrderBy() raises (SQLException);
413
420 boolean supportsOrderByUnrelated() raises (SQLException);
421
428 boolean supportsGroupBy() raises (SQLException);
429
436 boolean supportsGroupByUnrelated() raises (SQLException);
437
445 boolean supportsGroupByBeyondSelect() raises (SQLException);
446
453 boolean supportsLikeEscapeClause() raises (SQLException);
454
461 boolean supportsMultipleResultSets() raises (SQLException);
462
470 boolean supportsMultipleTransactions() raises (SQLException);
471
478 boolean supportsNonNullableColumns() raises (SQLException);
479
487 boolean supportsMinimumSQLGrammar() raises (SQLException);
488
496 boolean supportsCoreSQLGrammar() raises (SQLException);
497
506 boolean supportsExtendedSQLGrammar() raises (SQLException);
507
514 boolean supportsANSI92EntryLevelSQL() raises (SQLException);
515
522 boolean supportsANSI92IntermediateSQL() raises (SQLException);
523
530 boolean supportsANSI92FullSQL() raises (SQLException);
531
538 boolean supportsIntegrityEnhancementFacility() raises (SQLException);
539
546 boolean supportsOuterJoins() raises (SQLException);
547
554 boolean supportsFullOuterJoins() raises (SQLException);
555
563 boolean supportsLimitedOuterJoins() raises (SQLException);
564
571 string getSchemaTerm() raises (SQLException);
572
579 string getProcedureTerm() raises (SQLException);
580
587 string getCatalogTerm() raises (SQLException);
588
596 boolean isCatalogAtStart() raises (SQLException);
597
604 string getCatalogSeparator() raises (SQLException);
605
612 boolean supportsSchemasInDataManipulation() raises (SQLException);
613
620 boolean supportsSchemasInProcedureCalls() raises (SQLException);
621
628 boolean supportsSchemasInTableDefinitions() raises (SQLException);
629
636 boolean supportsSchemasInIndexDefinitions() raises (SQLException);
637
644 boolean supportsSchemasInPrivilegeDefinitions()
645 raises (SQLException);
646
653 boolean supportsCatalogsInDataManipulation() raises (SQLException);
654
661 boolean supportsCatalogsInProcedureCalls() raises (SQLException);
662
669 boolean supportsCatalogsInTableDefinitions() raises (SQLException);
670
677 boolean supportsCatalogsInIndexDefinitions() raises (SQLException);
678
685 boolean supportsCatalogsInPrivilegeDefinitions()
686 raises (SQLException);
687
694 boolean supportsPositionedDelete() raises (SQLException);
695
702 boolean supportsPositionedUpdate() raises (SQLException);
703
710 boolean supportsSelectForUpdate() raises (SQLException);
711
719 boolean supportsStoredProcedures() raises (SQLException);
720
727 boolean supportsSubqueriesInComparisons() raises (SQLException);
728
735 boolean supportsSubqueriesInExists() raises (SQLException);
736
743 boolean supportsSubqueriesInIns() raises (SQLException);
744
751 boolean supportsSubqueriesInQuantifieds() raises (SQLException);
752
759 boolean supportsCorrelatedSubqueries() raises (SQLException);
760
767 boolean supportsUnion() raises (SQLException);
768
775 boolean supportsUnionAll() raises (SQLException);
776
783 boolean supportsOpenCursorsAcrossCommit() raises (SQLException);
784
791 boolean supportsOpenCursorsAcrossRollback() raises (SQLException);
792
799 boolean supportsOpenStatementsAcrossCommit() raises (SQLException);
800
807 boolean supportsOpenStatementsAcrossRollback()
808 raises (SQLException);
809
816 long getMaxBinaryLiteralLength() raises (SQLException);
817
824 long getMaxCharLiteralLength() raises (SQLException);
825
832 long getMaxColumnNameLength() raises (SQLException);
833
840 long getMaxColumnsInGroupBy() raises (SQLException);
841
848 long getMaxColumnsInIndex() raises (SQLException);
849
856 long getMaxColumnsInOrderBy() raises (SQLException);
857
864 long getMaxColumnsInSelect() raises (SQLException);
865
872 long getMaxColumnsInTable() raises (SQLException);
873
880 long getMaxConnections() raises (SQLException);
881
888 long getMaxCursorNameLength() raises (SQLException);
889
896 long getMaxIndexLength() raises (SQLException);
897
904 long getMaxSchemaNameLength() raises (SQLException);
905
912 long getMaxProcedureNameLength() raises (SQLException);
913
920 long getMaxCatalogNameLength() raises (SQLException);
921
928 long getMaxRowSize() raises (SQLException);
929
937 boolean doesMaxRowSizeIncludeBlobs() raises (SQLException);
938
945 long getMaxStatementLength() raises (SQLException);
946
953 long getMaxStatements() raises (SQLException);
954
961 long getMaxTableNameLength() raises (SQLException);
962
969 long getMaxTablesInSelect() raises (SQLException);
970
977 long getMaxUserNameLength() raises (SQLException);
978
988 long getDefaultTransactionIsolation() raises (SQLException);
989
1000 boolean supportsTransactions() raises (SQLException);
1001
1009 boolean supportsTransactionIsolationLevel([in]long level)
1010 raises (SQLException);
1011
1026 boolean supportsDataDefinitionAndDataManipulationTransactions()
1027 raises (SQLException);
1028
1036 boolean supportsDataManipulationTransactionsOnly()
1037 raises (SQLException);
1038
1046 boolean dataDefinitionCausesTransactionCommit()
1047 raises (SQLException);
1048
1055 boolean dataDefinitionIgnoredInTransactions()
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
1281 XResultSet getSchemas() raises (SQLException);
1282
1299 XResultSet getCatalogs() raises (SQLException);
1300
1319 XResultSet getTableTypes() raises (SQLException);
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
2037 XResultSet getCrossReference(
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
2135 XResultSet getTypeInfo() raises (SQLException);
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
2366 boolean supportsBatchUpdates() raises (SQLException);
2367
2419 XResultSet getUDTs([in]any catalog, [in]string schemaPattern,
2420 [in]string typeNamePattern, [in]sequence<long> types)
2421 raises (SQLException);
2422
2429 XConnection getConnection() raises (SQLException);
2430};
2431
2432
2433}; }; }; };
2434
2435/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition: SQLException.idl:41
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:50
com::sun::star::sdbc::XDatabaseMetaData
provides comprehensive information about the database as a whole.
Definition: XDatabaseMetaData.idl:63
com::sun::star::sdbc::XDatabaseMetaData::allProceduresAreCallable
boolean allProceduresAreCallable()
Can all the procedures returned by getProcedures be called by the current user?
com::sun::star::sdbc::XResultSet
provides the navigation on a table of data.
Definition: XResultSet.idl:38
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20