diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc/XDatabaseMetaData.idl')
| -rw-r--r-- | offapi/com/sun/star/sdbc/XDatabaseMetaData.idl | 973 |
1 files changed, 852 insertions, 121 deletions
diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl index cd8f7687983e..cdfac633cbd2 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseMetaData.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: jsc $ $Date: 2001-11-28 15:32:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,19 +80,30 @@ interface XConnection; <p>Many of the methods here return lists of information in - the form of <code>XResultSet</code> objects. - You can use the normal XResultSet methods such as getString and getInt + the form of + <type scope="com::sun::star::sdbc">XResultSet</type> + objects. + You can use the normal <type scope="com::sun::star::sdbc">XResultSet</type> + methods such as + <member scope="com::sun::star::sdbc">XResultSet::getString()</member> + and + <member scope="com::sun::star::sdbc">XResultSet::getInt()</member> to retrieve the data from these XResultSets. If a given form of - metadata is not available, these methods should throw a SQLException. + metadata is not available, these methods should throw a + <type scope="com::sun::star::sdbc">SQLException</type> + . </p> - <p>Some of these methods take arguments that are String patterns. These - arguments all have names such as fooPattern. Within a pattern String, "%" + <p>Some of these methods take arguments that are String patterns. These + arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern - are returned. If a search pattern argument is set to a null ref, + are returned. If a search pattern argument is set to a <NULL/> ref, that argument's criteria will be dropped from the search. </p> - <p>A <code>SQLException</code> will be thrown if a driver does not support + <p> + A + <type scope="com::sun::star::sdbc">SQLException</type> + will be thrown if a driver does not support a meta data method. In the case of methods that return an XResultSet, either an XResultSet (which may be empty) is returned or a SQLException is thrown.</p> @@ -104,7 +115,14 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can all the procedures returned by getProcedures be called by the current user? -<!-- JRH:/MI: These questions are unclear, see "@return\<TRUE/>..." examples in this document for a better solution. --> + @return + <TRUE/> + if the user is allowed to call all procedures returned by getProcedures + otherwise + <FALSE/> + . + @throws SQLException + if a database access error occurs. */ boolean allProceduresAreCallable() raises (SQLException); //------------------------------------------------------------------------- @@ -112,6 +130,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::allTablesAreSelectable /** 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. */ boolean allTablesAreSelectable() raises (SQLException); //------------------------------------------------------------------------- @@ -130,30 +152,50 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isReadOnly /** checks if the database in read-only mode. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isReadOnly() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedHigh /** Are NULL values sorted high? -<!-- JRH: meaning sorted to start of file? -->*/ + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + */ boolean nullsAreSortedHigh() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedLow /** Are NULL values sorted low? -<!-- JRH: meaning to end of file? -->*/ + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + */ boolean nullsAreSortedLow() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtStart /** Are NULL values sorted at the start regardless of sort order? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullsAreSortedAtStart() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtEnd /** Are NULL values sorted at the end, regardless of sort order? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullsAreSortedAtEnd() raises (SQLException); //------------------------------------------------------------------------- @@ -196,18 +238,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFiles /** use the database local files to save the tables. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean usesLocalFiles() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFilePerTable /** use the database one local file to save for each table. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean usesLocalFilePerTable() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseIdentifiers /** use the database 'mixed case unquoted SQL identifiers' case sensitive. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMixedCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -215,6 +269,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseIdentifiers /** 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. */ boolean storesUpperCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -222,6 +280,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseIdentifiers /** 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. */ boolean storesLowerCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -229,6 +291,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseIdentifiers /** 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. */ boolean storesMixedCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -236,6 +302,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseQuotedIdentifiers /** 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. */ boolean supportsMixedCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -243,6 +313,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseQuotedIdentifiers /** 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. */ boolean storesUpperCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -250,6 +324,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseQuotedIdentifiers /** 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. */ boolean storesLowerCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -257,6 +335,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseQuotedIdentifiers /** 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. */ boolean storesMixedCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -264,6 +346,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getIdentifierQuoteString /** 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. */ string getIdentifierQuoteString() raises (SQLException); //------------------------------------------------------------------------- @@ -271,36 +357,56 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSQLKeywords /** 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. */ string getSQLKeywords() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getNumericFunctions - /** gets a comma-separated list of math functions. These are the + /** 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. */ string getNumericFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getStringFunctions - /** gets a comma-separated list of string functions. These are the + /** 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. */ string getStringFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSystemFunctions - /** gets a comma-separated list of system functions. These are the + /** 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. */ string getSystemFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTimeDateFunctions /** gets a comma-separated list of time and date functions. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getTimeDateFunctions() raises (SQLException); //------------------------------------------------------------------------- @@ -311,11 +417,17 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface the string pattern style catalog search parameters. - <p>The '_' character represents any single character. + <p> + The '_' character represents any single character. </p> - <p>The '%' character represents any sequence of zero or + <p> + The '%' character represents any sequence of zero or more characters. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSearchStringEscape() raises (SQLException); //------------------------------------------------------------------------- @@ -323,18 +435,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExtraNameCharacters /** 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. */ string getExtraNameCharacters() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithAddColumn /** support the Database "ALTER TABLE" with add column? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsAlterTableWithAddColumn() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithDropColumn /** support the Database "ALTER TABLE" with drop column? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsAlterTableWithDropColumn() raises (SQLException); //------------------------------------------------------------------------- @@ -343,31 +467,52 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** support the Database column aliasing? - <p>The SQL AS clause can be used to provide names for + <p> + The SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsColumnAliasing() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullPlusNonNullIsNull /** are concatenations between NULL and non-NULL values NULL? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullPlusNonNullIsNull() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTypeConversion - /** @returns - <TRUE/>, if the Database supports the CONVERT function between SQL types, - otherwise <FALSE/>. + /** <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. */ boolean supportsTypeConversion() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsConvert - /** @returns - <TRUE/>, if the Database supports the CONVERT between the given SQL types - otherwise <FALSE/>. + /** <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. */ boolean supportsConvert([in]long fromType, [in]long toType) raises (SQLException); @@ -375,6 +520,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTableCorrelationNames /** Are table correlation names supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTableCorrelationNames() raises (SQLException); //------------------------------------------------------------------------- @@ -382,6 +531,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDifferentTableCorrelationNames /** 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. */ boolean supportsDifferentTableCorrelationNames() raises (SQLException); @@ -389,24 +542,40 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExpressionsInOrderBy /** Are expressions in "ORDER BY" lists supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsExpressionsInOrderBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOrderByUnrelated /** Can an "ORDER BY" clause use columns not in the SELECT statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOrderByUnrelated() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupBy /** Is some form of "GROUP BY" clause supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByUnrelated /** Can a "GROUP BY" clause use columns not in the SELECT? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupByUnrelated() raises (SQLException); //------------------------------------------------------------------------- @@ -414,18 +583,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByBeyondSelect /** 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. */ boolean supportsGroupByBeyondSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLikeEscapeClause /** Is the escape character in "LIKE" clauses supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsLikeEscapeClause() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleResultSets /** Are multiple XResultSets from a single execute supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMultipleResultSets() raises (SQLException); //------------------------------------------------------------------------- @@ -433,36 +614,54 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleTransactions /** Can we have multiple transactions open at once (on different connections)? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMultipleTransactions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsNonNullableColumns /** Can columns be defined as non-nullable? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsNonNullableColumns() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMinimumSQLGrammar - /** @returns - <TRUE/>, if the database supports ODBC Minimum SQL grammar, + /** <TRUE/>, if the database supports ODBC Minimum SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMinimumSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCoreSQLGrammar - /** @returns - <TRUE/>, if the database supports ODBC Core SQL grammar, + /** <TRUE/>, if the database supports ODBC Core SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCoreSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExtendedSQLGrammar - /** @returns + /** <TRUE/>, if the database supports ODBC Extended SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsExtendedSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- @@ -471,6 +670,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 entry level SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92EntryLevelSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -479,6 +680,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 intermediate SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92IntermediateSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -487,6 +690,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 full SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92FullSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -495,6 +700,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** returns <TRUE/>, if the Database supports SQL Integrity Enhancement Facility, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsIntegrityEnhancementFacility() raises (SQLException); //------------------------------------------------------------------------- @@ -503,6 +710,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if some form of outer join is supported, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsOuterJoins() raises (SQLException); //------------------------------------------------------------------------- @@ -511,6 +720,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if full nested outer joins are supported, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsFullOuterJoins() raises (SQLException); //------------------------------------------------------------------------- @@ -518,26 +729,40 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLimitedOuterJoins /** @returns <TRUE/>, if there is limited support for outer joins. - (This will be true if supportFullOuterJoins is true.) + (This will be <TRUE/> if supportFullOuterJoins is <TRUE/>.) <FALSE/> is returned otherwise. + @throws SQLException + if a database access error occurs. */ boolean supportsLimitedOuterJoins() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSchemaTerm /** return the database vendor's preferred term for "schema" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSchemaTerm() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getProcedureTerm /** return the database vendor's preferred term for "procedure" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getProcedureTerm() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogTerm /** return the database vendor's preferred term for "catalog" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getCatalogTerm() raises (SQLException); //------------------------------------------------------------------------- @@ -545,42 +770,70 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isCatalogAtStart /** 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. */ boolean isCatalogAtStart() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogSeparator /** return the separator between catalog and table name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getCatalogSeparator() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInDataManipulation /** Can a schema name be used in a data manipulation statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInDataManipulation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInProcedureCalls /** Can a schema name be used in a procedure call statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInProcedureCalls() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInTableDefinitions /** Can a schema name be used in a table definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInTableDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInIndexDefinitions /** Can a schema name be used in an index definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInIndexDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInPrivilegeDefinitions /** Can a schema name be used in a privilege definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInPrivilegeDefinitions() raises (SQLException); @@ -588,30 +841,50 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInDataManipulation /** Can a catalog name be used in a data manipulation statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInDataManipulation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInProcedureCalls /** Can a catalog name be used in a procedure call statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInProcedureCalls() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInTableDefinitions /** Can a catalog name be used in a table definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInTableDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInIndexDefinitions /** Can a catalog name be used in an index definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInIndexDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInPrivilegeDefinitions /** Can a catalog name be used in a privilege definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInPrivilegeDefinitions() raises (SQLException); @@ -619,18 +892,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedDelete /** Is positioned DELETE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsPositionedDelete() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedUpdate /** Is positioned UPDATE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsPositionedUpdate() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSelectForUpdate /** Is SELECT for UPDATE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSelectForUpdate() raises (SQLException); //------------------------------------------------------------------------- @@ -638,72 +923,120 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsStoredProcedures /** Are stored procedure calls using the stored procedure escape syntax supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsStoredProcedures() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInComparisons /** Are subqueries in comparison expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInComparisons() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInExists /** Are subqueries in 'exists' expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInExists() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInIns /** Are subqueries in 'in' statements supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInIns() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInQuantifieds /** Are subqueries in quantified expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInQuantifieds() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCorrelatedSubqueries /** Are correlated subqueries supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCorrelatedSubqueries() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnion /** Is SQL UNION supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsUnion() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnionAll /** Is SQL UNION ALL supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsUnionAll() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossCommit /** Can cursors remain open across commits? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenCursorsAcrossCommit() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossRollback /** Can cursors remain open across rollbacks? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenCursorsAcrossRollback() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossCommit /** Can statements remain open across commits? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenStatementsAcrossCommit() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossRollback /** Can statements remain open across rollbacks? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenStatementsAcrossRollback() raises (SQLException); @@ -711,90 +1044,150 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxBinaryLiteralLength /** return the maximal number of hex characters in an inline binary literal + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxBinaryLiteralLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCharLiteralLength /** return the max length for a character literal + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCharLiteralLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnNameLength /** return the limit on column name length + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInGroupBy /** return the maximum number of columns in a "GROUP BY" clause + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInGroupBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInIndex /** return the maximum number of columns allowed in an index + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInIndex() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInOrderBy /** return the maximum number of columns in an "ORDER BY" clause + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInOrderBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInSelect /** return the maximum number of columns in a "SELECT" list + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInTable /** return the maximum number of columns in a table + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInTable() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxConnections /** return the number of active connections at a time to this database. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxConnections() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCursorNameLength /** return the maximum cursor name length + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCursorNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxIndexLength /** return the maximum length of an index (in bytes) + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxIndexLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxSchemaNameLength /** return the maximum length allowed for a schema name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxSchemaNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxProcedureNameLength /** return the maximum length of a procedure name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxProcedureNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCatalogNameLength /** return the maximum length of a catalog name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCatalogNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxRowSize /** return the maximum length of a single row. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxRowSize() raises (SQLException); //------------------------------------------------------------------------- @@ -802,57 +1195,97 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::doesMaxRowSizeIncludeBlobs /** Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean doesMaxRowSizeIncludeBlobs() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatementLength /** return the maximum length of a SQL statement + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxStatementLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatements /** 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. */ long getMaxStatements() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTableNameLength /** return the maximum length of a table name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxTableNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTablesInSelect /** return the maximum number of tables in a SELECT statement + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxTablesInSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxUserNameLength /** return the maximum length of a user name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxUserNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDefaultTransactionIsolation /** return the database default transaction isolation level. - The values are defined in <type scope="com::sun::star::sdbc">TransactionIsolation</type>.@see com::sun::star::sdbc::XConnection + The values are defined in + <type scope="com::sun::star::sdbc">TransactionIsolation</type>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + @see com::sun::star::sdbc::XConnection */ long getDefaultTransactionIsolation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactions /** support the Database transactions? - If not, invoking the method <code>commit</code> is a noop and the + If not, invoking the method + <member scope="com::Sun::star::sdbc">XConnection::commit()</member> + is a noop and the isolation level is TransactionIsolation_NONE. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTransactions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel /** Does this database support the given transaction isolation level? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. @see com::sun::star::sdbc::Connection */ boolean supportsTransactionIsolationLevel([in]long level) @@ -862,6 +1295,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataDefinitionAndDataManipulationTransactions /** 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. <!-- JRH: Unclear on the intent of these many support questions. If asking, it should state, "Does the Database support both ....? If declaring, it should state something like the following: @@ -877,6 +1314,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataManipulationTransactionsOnly /** are only data manipulation statements within a transaction supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsDataManipulationTransactionsOnly() raises (SQLException); @@ -885,6 +1326,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionCausesTransactionCommit /** 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. */ boolean dataDefinitionCausesTransactionCommit() raises (SQLException); @@ -892,6 +1337,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionIgnoredInTransactions /** is a data definition statement within a transaction ignored? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean dataDefinitionIgnoredInTransactions() raises (SQLException); @@ -902,18 +1351,20 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface catalog. - <p>Only procedure descriptions matching the schema and - procedure name criteria are returned. They are ordered by + <p> + Only procedure descriptions matching the schema and + procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME. </p> - <p>Each procedure description has the the following columns: + <p> + Each procedure description has the the following columns: </p> <ol> <li> - <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be <NULL/>) </li> <li> - <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be <NULL/>) </li> <li> <b>PROCEDURE_NAME</b> string =&gt; procedure name @@ -939,6 +1390,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param procedureNamePattern + a procedure name pattern + @returns + each row is a procedure description + @throws SQLException + if a database access error occurs. */ XResultSet getProcedures([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern) raises (SQLException); @@ -949,8 +1410,9 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface and result columns. - <p>Only descriptions matching the schema, procedure and - parameter name criteria are returned. They are ordered by + <p> + 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. @@ -960,10 +1422,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be <NULL/>) </li> <li> - <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be <NULL/>) </li> <li> <b>PROCEDURE_NAME</b> string =&gt; procedure name @@ -1027,6 +1489,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param procedureNamePattern + a procedure name pattern + @param columnNamePattern + a column name pattern + @returns + each row describes a stored procedure parameter or column + @throws SQLException + if a database access error occurs. */ XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern, @@ -1039,23 +1513,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <p>Only table descriptions matching the catalog, schema, table - name, and type criteria are returned. They are ordered by + name, and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM, and TABLE_NAME. </p> <p>Each table description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> - <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". </li> @@ -1067,6 +1541,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>Note:</b> Some databases may not return information for all tables. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @param 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. */ XResultSet getTables([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]sequence<string> types) @@ -1085,6 +1571,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>TABLE_SCHEM</b> string =&gt; schema name </li> </ol> + @returns + each row has a single String column that is a schema name + @throws SQLException + if a database access error occurs. */ XResultSet getSchemas() raises (SQLException); //------------------------------------------------------------------------- @@ -1101,12 +1591,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>TABLE_CAT</b> string =&gt; catalog name </li> </ol> + @returns + each row has a single String column that is a catalog name + @throws SQLException + if a database access error occurs. */ XResultSet getCatalogs() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTableTypes - /** gets the table types available in this database. The results + /** gets the table types available in this database. The results are ordered by table type. @@ -1114,11 +1608,15 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". </li> </ol> + @returns + each row has a single String column that is a table type + @throws SQLException + if a database access error occurs. */ XResultSet getTableTypes() raises (SQLException); //------------------------------------------------------------------------- @@ -1129,17 +1627,17 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <p>Only column descriptions matching the catalog, schema, table - and column name criteria are returned. They are ordered by + and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION. </p> <p>Each column description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1155,7 +1653,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface for a UDT the type name is fully qualified </li> <li> - <b>COLUMN_SIZE</b> long =&gt; column size. For char or date + <b>COLUMN_SIZE</b> long =&gt; column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision. </li> @@ -1180,10 +1678,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>REMARKS</b> string =&gt; comment describing column (may be null) + <b>REMARKS</b> string =&gt; comment describing column (may be <NULL/>) </li> <li> - <b>COLUMN_DEF</b> string =&gt; default value (may be null) + <b>COLUMN_DEF</b> string =&gt; default value (may be <NULL/>) </li> <li> <b>SQL_DATA_TYPE</b> long =&gt; unused @@ -1202,9 +1700,21 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <li> <b>IS_NULLABLE</b> string =&gt; "NO" means column definitely does not allow NULL values; "YES" means the column might - allow NULL values. An empty string means nobody knows. + allow NULL values. An empty string means nobody knows. </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @param columnNamePattern + a column name pattern + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getColumns([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]string columnNamePattern) @@ -1215,17 +1725,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a description of the access rights for a table's columns. - <p>Only privileges matching the column name criteria are - returned. They are ordered by COLUMN_NAME and PRIVILEGE. + <p> + Only privileges matching the column name criteria are + returned. They are ordered by COLUMN_NAME and PRIVILEGE. </p> <p>Each privilige description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1234,7 +1745,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>COLUMN_NAME</b> string =&gt; column name </li> <li> - <b>GRANTOR</b> =&gt; grantor of access (may be null) + <b>GRANTOR</b> =&gt; grantor of access (may be <NULL/>) </li> <li> <b>GRANTEE</b> string =&gt; grantee of access @@ -1245,9 +1756,21 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted - to grant to others; "NO" if not; null if unknown + to grant to others; "NO" if not; <NULL/> if unknown </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name ; "" retrieves those without a schema + @param table + a table name + @param columnNamePattern + a column name pattern + @returns + each row is a column privilege description + @throws SQLException + if a database access error occurs. */ XResultSet getColumnPrivileges([in]any catalog, [in]string schema, [in]string table, [in]string columnNamePattern) raises (SQLException); @@ -1257,28 +1780,28 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** 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.) + this priviledge applies to all columns (this may be <TRUE/> for + some systems but is not <TRUE/> for all.) <p>Only privileges matching the schema and table name - criteria are returned. They are ordered by TABLE_SCHEM, + criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE. </p> <p>Each privilige description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> - <b>GRANTOR</b> =&gt; grantor of access (may be null) + <b>GRANTOR</b> =&gt; grantor of access (may be <NULL/>) </li> <li> <b>GRANTEE</b> string =&gt; grantee of access @@ -1289,9 +1812,19 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted - to grant to others; "NO" if not; null if unknown + to grant to others; "NO" if not; <NULL/> if unknown </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @returns + each row is a table privilege description + @throws SQLException + if a database access error occurs. */ XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern) raises (SQLException); @@ -1348,6 +1881,20 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @param scope + the scope of interest; use same values as SCOPE + @param nullable + include columns that are nullable? + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getBestRowIdentifier([in]any catalog, [in]string schema, [in]string table, [in]long scope, [in] boolean nullable) @@ -1356,7 +1903,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns /** gets a description of a table's columns that are automatically - updated when any value in a row is updated. They are + updated when any value in a row is updated. They are unordered. @@ -1397,13 +1944,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getVersionColumns([in]any catalog, [in]string schema, [in]string table) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getPrimaryKeys - /** gets a description of a table's primary key columns. They + /** gets a description of a table's primary key columns. They are ordered by COLUMN_NAME. @@ -1411,10 +1968,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1426,9 +1983,19 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>KEY_SEQ</b> short =&gt; sequence number within primary key </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a primary key column description + @throws SQLException + if a database access error occurs. */ XResultSet getPrimaryKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1437,7 +2004,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::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, + imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ. @@ -1446,11 +2013,11 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <ol> <li> <b>PKTABLE_CAT</b> string =&gt; primary key table catalog - being imported (may be null) + being imported (may be <NULL/>) </li> <li> <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema - being imported (may be null) + being imported (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1461,10 +2028,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface being imported </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1517,10 +2084,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1535,6 +2102,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a primary key column description + @throws SQLException + if a database access error occurs. */ XResultSet getImportedKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1543,7 +2120,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::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, + table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. @@ -1551,10 +2128,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be <NULL/>) </li> <li> - <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1563,12 +2140,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string =&gt; primary key column name </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) - being exported (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) - being exported (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1623,10 +2200,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1641,6 +2218,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a foreign key column description + @throws SQLException + if a database access error occurs. */ XResultSet getExportedKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1651,7 +2238,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface 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 + (most tables only import a foreign key from a table once.). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. @@ -1660,10 +2247,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be <NULL/>) </li> <li> - <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1672,12 +2259,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string =&gt; primary key column name </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) - being exported (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) - being exported (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1732,10 +2319,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1750,6 +2337,22 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param primaryCatalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param primarySchema + a schema name; "" retrieves those without a schema + @param primaryTable + the table name that exports the key + @param foreignCatalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param foreignSchema + a schema name; "" retrieves those without a schema + @param 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. */ XResultSet getCrossReference( [in]any primaryCatalog, [in]string primarySchema, @@ -1779,15 +2382,15 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LITERAL_PREFIX</b> string =&gt; prefix used to quote a literal - (may be null) + (may be <NULL/>) </li> <li> <b>LITERAL_SUFFIX</b> string =&gt; suffix used to quote a literal - (may be null) + (may be <NULL/>) </li> <li> <b>CREATE_PARAMS</b> string =&gt; parameters used in creating - the type (may be null) + the type (may be <NULL/>) </li> <li> <b>NULLABLE</b> short =&gt; can you use NULL for this type? @@ -1828,7 +2431,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LOCAL_TYPE_NAME</b> string =&gt; localized version of type name - (may be null) + (may be <NULL/>) </li> <li> <b>MINIMUM_SCALE</b> short =&gt; minimum scale supported @@ -1846,6 +2449,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>NUM_PREC_RADIX</b> long =&gt; usually 2 or 10 </li> </ol> + @returns + each row is a SQL type description + @throws SQLException + if a database access error occurs. */ XResultSet getTypeInfo() raises (SQLException); //------------------------------------------------------------------------- @@ -1859,24 +2466,24 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> <b>NON_UNIQUE</b> boolean =&gt; Can index values be non-unique? - false when TYPE is tableIndexStatistic + <FALSE/> when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be null); - null when TYPE is tableIndexStatistic + <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be <NULL/>); + <NULL/> when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_NAME</b> string =&gt; index name; null when TYPE is + <b>INDEX_NAME</b> string =&gt; index name; <NULL/> when TYPE is tableIndexStatistic </li> <li> @@ -1898,13 +2505,13 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface within index; zero when TYPE is tableIndexStatistic </li> <li> - <b>COLUMN_NAME</b> string =&gt; column name; null when TYPE is + <b>COLUMN_NAME</b> string =&gt; column name; <NULL/> when TYPE is tableIndexStatistic </li> <li> <b>ASC_OR_DESC</b> string =&gt; column sort sequence, "A" =&gt; ascending, - "D" =&gt; descending, may be null if sort sequence is not supported; - null when TYPE is tableIndexStatistic + "D" =&gt; descending, may be <NULL/> if sort sequence is not supported; + <NULL/> when TYPE is tableIndexStatistic </li> <li> <b>CARDINALITY</b> long =&gt; When TYPE is tableIndexStatistic, then @@ -1918,9 +2525,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>FILTER_CONDITION</b> string =&gt; Filter condition, if any. - (may be null) + (may be <NULL/>) </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + the table name that exports the key + @param unique + when <TRUE/>, return only indices for unique values; when <FALSE/>, return indices regardless of whether unique or not + @param 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. */ XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table, [in]boolean unique, [in]boolean approximate) @@ -1929,6 +2550,13 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetType /** Does the database support the given result set type? + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsResultSetType([in]long setType) raises (SQLException); //------------------------------------------------------------------------- @@ -1936,6 +2564,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetConcurrency /** Does the database support the concurrency type in combination with the given result set type? + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @param concurrency + defined in + <type scop="com::sun::star::sdbc">ResultSetConcurrency</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsResultSetConcurrency([in]long setType, [in]long concurrency) @@ -1944,88 +2582,159 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownUpdatesAreVisible /** indicates whether a result set's own updates are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownUpdatesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownDeletesAreVisible /** indicates whether a result set's own deletes are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownDeletesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownInsertsAreVisible /** indicates whether a result set's own inserts are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownInsertsAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersUpdatesAreVisible /** indicates whether updates made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersUpdatesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersDeletesAreVisible /** indicates whether deletes made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersDeletesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersInsertsAreVisible /** indicates whether inserts made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersInsertsAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::updatesAreDetected /** indicates whether or not a visible row update can be detected by - calling the method <code>XResultSet.rowUpdated</code>. + calling the method + <code>XResultSet.rowUpdated</code>. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean updatesAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::deletesAreDetected /** indicates whether or not a visible row delete can be detected by - calling XResultSet.rowDeleted(). If deletesAreDetected() + calling + <member scope="com::sun::star::sdbc">XResultSet::rowDeleted()</member> + . If deletesAreDetected() returns <FALSE/>, then deleted rows are removed from the result set. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean deletesAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::insertsAreDetected /** indicates whether or not a visible row insert can be detected - by calling XResultSet.rowInserted(). + by calling + <member scope="com::sun::star::sdbc">XResultSet::rowInserted().</member> + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean insertsAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsBatchUpdates /** indicates whether the driver supports batch updates. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsBatchUpdates() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getUDTs /** Gets a description of the user-defined types defined in a particular - schema. Schema-specific UDTs may have type OBJECT, STRUCT, + schema. Schema-specific UDTs may have type OBJECT, STRUCT, or DISTINCT. <p>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 + 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. </p> <p>Each type description has the following columns: </p> <ol> <li> - <b>TYPE_CAT</b> string =&gt; the type's catalog (may be null) + <b>TYPE_CAT</b> string =&gt; the type's catalog (may be <NULL/>) </li> <li> - <b>TYPE_SCHEM</b> string =&gt; type's schema (may be null) + <b>TYPE_SCHEM</b> string =&gt; type's schema (may be <NULL/>) </li> <li> <b>TYPE_NAME</b> string =&gt; type name @@ -2045,6 +2754,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>Note:</b> If the driver does not support UDTs, an empty result set is returned. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param typeNamePattern + a type name pattern; may be a fully-qualified name + @param 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. */ XResultSet getUDTs([in]any catalog, [in]string schemaPattern, [in]string typeNamePattern, [in]sequence<long> types) @@ -2053,6 +2774,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getConnection /** retrieves the connection that produced this metadata object. + @returns + the Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -2063,6 +2788,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.9.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.9 2001/11/28 15:32:14 jsc + remove double closed comment + Revision 1.8 2001/11/02 12:47:42 mi needs <TRUE/> instead of <TRUE> etc. @@ -2076,7 +2807,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface remove interfaceheader with uik and remove [const] in method definitions Revision 1.4 2000/12/14 12:53:39 mi - <true></true> -> <TRUE/> and same with FALSE + <<TRUE/>></<TRUE/>> -> <TRUE/> and same with FALSE Revision 1.3 2000/11/08 12:43:35 mi moved from api |