LibreOffice
LibreOffice 25.2 SDK API Reference
Public Member Functions | List of all members
XDatabaseMetaData3 Interface Reference

extends the XDatabaseMetaData interface to allow retrieval of additional information. More...

import"XDatabaseMetaData3.idl";

Inheritance diagram for XDatabaseMetaData3:
XDatabaseMetaData2 XDatabaseMetaData XInterface

Public Member Functions

boolean autoCommitFailureClosesAllResultSets () raises (SQLException)
 Retrieves whether a. More...
 
boolean generatedKeyAlwaysReturned () raises (SQLException)
 Retrieves whether a generated key will always be returned if the column name(s) or index(es) specified for the auto generated key column(s) are valid and the statement succeeds. More...
 
XResultSet getAttributes ([in]string catalog, [in]string schemaPattern, [in]string typeNamePattern, [in]string attributeNamePattern) raises (SQLException)
 Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog. More...
 
XResultSet getClientInfoProperties () raises (SQLException)
 Retrieves a list of the client info properties that the driver supports. More...
 
long getDatabaseMajorVersion ()
 Retrieves the major version number of the underlying database. More...
 
long getDatabaseMinorVersion ()
 Retrieves the minor version number of the underlying database. More...
 
XResultSet getFunctions ([in]string catalog, [in]string schemaPattern, [in]string functionNamePattern) raises (SQLException)
 Retrieves a description of the system and user functions available in the given catalog. More...
 
XResultSet getFunctionColumns ([in]string catalog, [in]string schemaPattern, [in]string functionNamePattern, [in]string columnNamePattern) raises (SQLException)
 
/** Retrieves a description of the given catalog's system or user function parameters and return type. More...
 
long getMaxLogicalLobSize () raises (SQLException)
 Retrieves the maximum number of bytes this database allows for the logical size for a. More...
 
XResultSet getPseudoColumns ([in]string catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]string columnNamePattern) raises (SQLException)
 Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema. More...
 
long getResultSetHoldability () raises (SQLException)
 Retrieves this database's default holdability for. More...
 
long getRowIdLifetime () raises (SQLException)
 Indicates whether this data source supports the SQL. More...
 
XResultSet getSchemasFiltered ([in] com::sun::star::beans::Optional< string > catalog, [in] com::sun::star::beans::Optional< string > schemaPattern) raises (SQLException)
 Retrieves the schema names available in this database. More...
 
long getSQLStateType () raises (SQLException)
 Indicates whether the SQLSTATE returned by. More...
 
XResultSet getSuperTables ([in]string catalog, [in]string schemaPattern, [in]string tableNamePattern) raises (SQLException)
 Retrieves a description of the table hierarchies defined in a particular schema in this database. More...
 
XResultSet getSuperTypes ([in]string catalog, [in]string schemaPattern, [in]string typeNamePattern) raises (SQLException)
 Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. More...
 
boolean locatorsUpdateCopy () raises (SQLException)
 Indicates whether updates made to a LOB are made on a copy or directly to the LOB. More...
 
boolean supportsConvertInGeneral () raises (SQLException)
 Retrieves whether this database supports the SQL function CONVERT for the conversion between the data types defined in com::sun::star::sdbc::DataType (see supportsConvert in com::sun::star::sdbc::XDatabaseMetadata to test for support between specific types) More...
 
boolean supportsGetGeneratedKeys () raises (SQLException)
 Retrieves whether auto-generated keys can be retrieved after a statement has been executed. More...
 
boolean supportsMultipleOpenResults () raises (SQLException)
 Retrieves whether it is possible to have multiple. More...
 
boolean supportsNamedParameters () raises (SQLException)
 Retrieves whether this database supports named parameters to callable statements. More...
 
boolean supportsRefCursors () raises (SQLException)
 Retrieves whether this database supports REF CURSOR. More...
 
boolean supportsSavepoints () raises (SQLException)
 Retrieves whether this database supports savepoints. More...
 
boolean supportsSharding () raises (SQLException)
 Retrieves whether this database supports sharding. More...
 
boolean supportsStatementPooling () raises (SQLException)
 Retrieves whether this database supports statement pooling. More...
 
boolean supportsStoredFunctionsUsingCallSyntax () raises (SQLException)
 Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax. More...
 
- Public Member Functions inherited from XDatabaseMetaData2
sequence< ::com::sun::star::beans::PropertyValuegetConnectionInfo ()
 complements XDatabaseMetaData::getURL by returning the settings which, upon construction of the connection, have been used besides the connection URL. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

extends the XDatabaseMetaData interface to allow retrieval of additional information.

Since
LibreOffice 25.2

Member Function Documentation

◆ autoCommitFailureClosesAllResultSets()

boolean autoCommitFailureClosesAllResultSets ( )
raises (SQLException
)

Retrieves whether a.

SQLException

while autoCommit is

true

indicates that all open ResultSets are closed, even ones that are holdable. When a

SQLException

occurs while autocommit is

true

, it is vendor specific whether the JDBC driver responds with a commit operation, a rollback operation, or by doing neither a commit nor a rollback. A potential result of this difference is in whether or not holdable ResultSets are closed.

Returns
true
if so;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ generatedKeyAlwaysReturned()

boolean generatedKeyAlwaysReturned ( )
raises (SQLException
)

Retrieves whether a generated key will always be returned if the column name(s) or index(es) specified for the auto generated key column(s) are valid and the statement succeeds.

The key that is returned may or may not be based on the column(s) for the auto generated key. Consult your JDBC driver documentation for additional details.

Returns
true
if so;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ getAttributes()

XResultSet getAttributes ( [in] string  catalog,
[in] string  schemaPattern,
[in] string  typeNamePattern,
[in] string  attributeNamePattern 
)
raises (SQLException
)

Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.

Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by

TYPE_CAT

,

TYPE_SCHEM

,

TYPE_NAME

and

ORDINAL_POSITION

. This description does not contain inherited attributes.

The

ResultSet

object that is returned has the following columns:

  1. TYPE_CAT String
    =>
    type catalog (may be
    null
    )
  2. TYPE_SCHEM String
    =>
    type schema (may be
    null
    )
  3. TYPE_NAME String
    =>
    type name
  4. ATTR_NAME String
    =>
    attribute name
  5. DATA_TYPE int
    =>
    attribute type SQL type from com::sun::star::sdbc::DataType
  6. ATTR_TYPE_NAME String
    =>
    Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type.
  7. ATTR_SIZE int
    =>
    column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision.
  8. DECIMAL_DIGITS int
    =>
    the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  9. NUM_PREC_RADIX int
    =>
    Radix (typically either 10 or 2)
  10. NULLABLE int
    =>
    whether NULL is allowed
    • attributeNoNulls - might not allow NULL values
    • attributeNullable - definitely allows NULL values
    • attributeNullableUnknown - nullability unknown
  11. REMARKS String
    =>
    comment describing column (may be
    null
    )
  12. ATTR_DEF String
    =>
    default value (may be
    null
    )
  13. SQL_DATA_TYPE int
    =>
    unused
  14. SQL_DATETIME_SUB int
    =>
    unused
  15. CHAR_OCTET_LENGTH int
    =>
    for char types the maximum number of bytes in the column
  16. ORDINAL_POSITION int
    =>
    index of the attribute in the UDT (starting at 1)
  17. IS_NULLABLE String
    =>
    ISO rules are used to determine the nullability for a attribute.
    • YES — if the attribute can include NULLs
    • NO — if the attribute cannot include NULLs
    • empty string — if the nullability for the attribute is unknown
  18. SCOPE_CATALOG String
    =>
    catalog of table that is the scope of a reference attribute (
    null
    if DATA_TYPE isn't REF)
  19. SCOPE_SCHEMA String
    =>
    schema of table that is the scope of a reference attribute (
    null
    if DATA_TYPE isn't REF)
  20. SCOPE_TABLE String
    =>
    table name that is the scope of a reference attribute (
    null
    if the DATA_TYPE isn't REF)
  21. SOURCE_DATA_TYPE short
    =>
    source type of a distinct type or user-generated Ref type, SQL type from com::sun::star::sdbc::DataType (
    null
    if DATA_TYPE isn't DISTINCT or user-generated REF)
Parameters
cataloga catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used to narrow the search
schemaPatterna schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;
null
means that the schema name should not be used to narrow the search
typeNamePatterna type name pattern; must match the type name as it is stored in the database
attributeNamePatternan attribute name pattern; must match the attribute name as it is declared in the database
Returns
a
ResultSet
object in which each row is an attribute description
Exceptions
SQLExceptionif a database access error occurs.

◆ getClientInfoProperties()

XResultSet getClientInfoProperties ( )
raises (SQLException
)

Retrieves a list of the client info properties that the driver supports.

The result set contains the following columns

  1. NAME String
    =>
    The name of the client info property
  2. MAX_LEN int
    =>
    The maximum length of the value for the property
  3. DEFAULT_VALUE String
    =>
    The default value of the property
  4. DESCRIPTION String
    =>
    A description of the property. This will typically contain information as to where this property is stored in the database.

The

ResultSet

is sorted by the NAME column

Returns
A
ResultSet
object; each row is a supported client info property
Exceptions
SQLExceptionif a database access error occurs

◆ getDatabaseMajorVersion()

long getDatabaseMajorVersion ( )

Retrieves the major version number of the underlying database.

Returns
the underlying database's major version
Exceptions
SQLExceptionif a database access error occurs

◆ getDatabaseMinorVersion()

long getDatabaseMinorVersion ( )

Retrieves the minor version number of the underlying database.

Returns
underlying database's minor version
Exceptions
SQLExceptionif a database access error occurs

◆ getFunctionColumns()

XResultSet getFunctionColumns ( [in] string  catalog,
[in] string  schemaPattern,
[in] string  functionNamePattern,
[in] string  columnNamePattern 
)
raises (SQLException
)


/** Retrieves a description of the given catalog's system or user function parameters and return type.

Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by

FUNCTION_CAT

,

FUNCTION_SCHEM

,

FUNCTION_NAME

and

SPECIFIC_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.

Each row in the

ResultSet

is a parameter description, column description or return type description with the following fields:

  1. FUNCTION_CAT String
    =>
    function catalog (may be
    null
    )
  2. FUNCTION_SCHEM String
    =>
    function schema (may be
    null
    )
  3. FUNCTION_NAME String
    =>
    function name. This is the name used to invoke the function
  4. COLUMN_NAME String
    =>
    column/parameter name
  5. COLUMN_TYPE Short
    =>
    kind of column/parameter:
    • functionColumnUnknown - nobody knows
    • functionColumnIn - IN parameter
    • functionColumnInOut - INOUT parameter
    • functionColumnOut - OUT parameter
    • functionReturn - function return value
    • functionColumnResult - Indicates that the parameter or column is a column in the
      ResultSet
  6. DATA_TYPE int
    =>
    SQL type from com::sun::star::sdbc::DataType
  7. TYPE_NAME String
    =>
    SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int
    =>
    precision
  9. LENGTH int
    =>
    length in bytes of data
  10. SCALE short
    =>
    scale - null is returned for data types where SCALE is not applicable.
  11. RADIX short
    =>
    radix
  12. NULLABLE short
    =>
    can it contain NULL.
    • functionNoNulls - does not allow NULL values
    • functionNullable - allows NULL values
    • functionNullableUnknown - nullability unknown
  13. REMARKS String
    =>
    comment describing column/parameter
  14. CHAR_OCTET_LENGTH int
    =>
    the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL
  15. ORDINAL_POSITION int
    =>
    the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1.
  16. IS_NULLABLE String
    =>
    ISO rules are used to determine the nullability for a parameter or column.
    • YES — if the parameter or column can include NULLs
    • NO — if the parameter or column cannot include NULLs
    • empty string — if the nullability for the parameter or column is unknown
  17. SPECIFIC_NAME String
    =>
    the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different from the
    FUNCTION_NAME
    for example with overload functions

The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

Parameters
cataloga catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used to narrow the search
schemaPatterna schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;
null
means that the schema name should not be used to narrow the search
functionNamePatterna procedure name pattern; must match the function name as it is stored in the database
columnNamePatterna parameter name pattern; must match the parameter or column name as it is stored in the database
Returns
ResultSet
- each row describes a user function parameter, column or return type
Exceptions
SQLExceptionif a database access error occurs

◆ getFunctions()

XResultSet getFunctions ( [in] string  catalog,
[in] string  schemaPattern,
[in] string  functionNamePattern 
)
raises (SQLException
)

Retrieves a description of the system and user functions available in the given catalog.

Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered by

FUNCTION_CAT

,

FUNCTION_SCHEM

,

FUNCTION_NAME

and

SPECIFIC_NAME

.

Each function description has the following columns:

  1. FUNCTION_CAT String
    =>
    function catalog (may be
    null
    )
  2. FUNCTION_SCHEM String
    =>
    function schema (may be
    null
    )
  3. FUNCTION_NAME String
    =>
    function name. This is the name used to invoke the function
  4. REMARKS String
    =>
    explanatory comment on the function
  5. FUNCTION_TYPE short
    =>
    kind of function:
    • functionResultUnknown - Cannot determine if a return value or table will be returned
    • functionNoTable- Does not return a table
    • functionReturnsTable - Returns a table
  6. SPECIFIC_NAME String
    =>
    the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different from the
    FUNCTION_NAME
    for example with overload functions

A user may not have permission to execute any of the functions that are returned by

Parameters
cataloga catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used to narrow the search
schemaPatterna schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;
null
means that the schema name should not be used to narrow the search
functionNamePatterna function name pattern; must match the function name as it is stored in the database
Returns
ResultSet
- each row is a function description
Exceptions
SQLExceptionif a database access error occurs

◆ getMaxLogicalLobSize()

long getMaxLogicalLobSize ( )
raises (SQLException
)

Retrieves the maximum number of bytes this database allows for the logical size for a.

LOB

.

The default implementation will return

0
Returns
the maximum number of bytes allowed; a result of zero means that there is no limit or the limit is not known
Exceptions
SQLExceptionif a database access error occurs

◆ getPseudoColumns()

XResultSet getPseudoColumns ( [in] string  catalog,
[in] string  schemaPattern,
[in] string  tableNamePattern,
[in] string  columnNamePattern 
)
raises (SQLException
)

Retrieves a description of the pseudo or hidden columns available in a given table within the specified catalog and schema.

Pseudo or hidden columns may not always be stored within a table and are not visible in a ResultSet unless they are specified in the query's outermost SELECT list. Pseudo or hidden columns may not necessarily be able to be modified. If there are no pseudo or hidden columns, an empty ResultSet is returned.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by

TABLE_CAT

,

TABLE_SCHEM

,

TABLE_NAME

and

COLUMN_NAME

.

Each column description has the following columns:

  1. TABLE_CAT String
    =>
    table catalog (may be
    null
    )
  2. TABLE_SCHEM String
    =>
    table schema (may be
    null
    )
  3. TABLE_NAME String
    =>
    table name
  4. COLUMN_NAME String
    =>
    column name
  5. DATA_TYPE int
    =>
    SQL type from com::sun::star::sdbc::DataType
  6. COLUMN_SIZE int
    =>
    column size.
  7. DECIMAL_DIGITS int
    =>
    the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. NUM_PREC_RADIX int
    =>
    Radix (typically either 10 or 2)
  9. COLUMN_USAGE String
    =>
    The allowed usage for the column. The value returned will correspond to the enum name returned by PseudoColumnUsage.name()
  10. REMARKS String
    =>
    comment describing column (may be
    null
    )
  11. CHAR_OCTET_LENGTH int
    =>
    for char types the maximum number of bytes in the column
  12. IS_NULLABLE String
    =>
    ISO rules are used to determine the nullability for a column.
    • YES — if the column can include NULLs
    • NO — if the column cannot include NULLs
    • empty string — if the nullability for the column is unknown

The COLUMN_SIZE column specifies the column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.

Parameters
cataloga catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog;
null
means that the catalog name should not be used to narrow the search
schemaPatterna schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema;
null
means that the schema name should not be used to narrow the search
tableNamePatterna table name pattern; must match the table name as it is stored in the database
columnNamePatterna column name pattern; must match the column name as it is stored in the database
Returns
ResultSet
- each row is a column description
Exceptions
SQLExceptionif a database access error occurs

◆ getResultSetHoldability()

long getResultSetHoldability ( )
raises (SQLException
)

Retrieves this database's default holdability for.

ResultSet

objects.

Returns
the default holdability; either
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
Exceptions
SQLExceptionif a database access error occurs

◆ getRowIdLifetime()

long getRowIdLifetime ( )
raises (SQLException
)

Indicates whether this data source supports the SQL.

type, and the lifetime for which a RowId object remains valid.

Returns
the status indicating the lifetime of a
RowId
Exceptions
SQLExceptionif a database access error occurs
See also
RowIdLifetime.idl

◆ getSchemasFiltered()

XResultSet getSchemasFiltered ( [in] com::sun::star::beans::Optional< string >  catalog,
[in] com::sun::star::beans::Optional< string >  schemaPattern 
)
raises (SQLException
)

Retrieves the schema names available in this database.

The results are ordered by

TABLE_CATALOG

and

TABLE_SCHEM

.

The schema columns are:

  1. TABLE_SCHEM String
    =>
    schema name
  2. TABLE_CATALOG String
    =>
    catalog name (may be
    null
    )
Parameters
catalogan optional catalog name; if absent (catalog.IsPresent is false), catalog name is not used to narrow down the search. if present, then only the results for which catalog.Value matches the catalog name as it is stored in the database; Note that catalog.IsPresent and catalog.Value == "" retrieves those without a catalog
schemaPatterna optional schema name; if absent means it should not be used to narrow down the search if present, must match the schema name as it is stored in the database
Returns
a
ResultSet
object in which each row is a schema description
Exceptions
SQLExceptionif a database access error occurs

◆ getSQLStateType()

long getSQLStateType ( )
raises (SQLException
)

Indicates whether the SQLSTATE returned by.

SQLException.getSQLState

is X/Open (now known as Open Group) SQL CLI or SQL:2003.

Returns
the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL
Exceptions
SQLExceptionif a database access error occurs

◆ getSuperTables()

XResultSet getSuperTables ( [in] string  catalog,
[in] string  schemaPattern,
[in] string  tableNamePattern 
)
raises (SQLException
)

Retrieves a description of the table hierarchies defined in a particular schema in this database.

Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.

Each type description has the following columns:

  1. TABLE_CAT String
    =>
    the type's catalog (may be
    null
    )
  2. TABLE_SCHEM String
    =>
    type's schema (may be
    null
    )
  3. TABLE_NAME String
    =>
    type name
  4. SUPERTABLE_NAME String
    =>
    the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

Parameters
cataloga catalog name; "" retrieves those without a catalog;
null
means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
tableNamePatterna table name pattern; may be a fully-qualified name
Returns
a
ResultSet
object in which each row is a type description
Exceptions
SQLExceptionif a database access error occurs

◆ getSuperTypes()

XResultSet getSuperTypes ( [in] string  catalog,
[in] string  schemaPattern,
[in] string  typeNamePattern 
)
raises (SQLException
)

Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.

Only the immediate super type/ sub type relationship is modeled.

Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.

If a UDT does not have a direct super type, it is not listed here. A row of the

ResultSet

object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:

  1. TYPE_CAT String
    =>
    the UDT's catalog (may be
    null
    )
  2. TYPE_SCHEM String
    =>
    UDT's schema (may be
    null
    )
  3. TYPE_NAME String
    =>
    type name of the UDT
  4. SUPERTYPE_CAT String
    =>
    the direct super type's catalog (may be
    null
    )
  5. SUPERTYPE_SCHEM String
    =>
    the direct super type's schema (may be
    null
    )
  6. SUPERTYPE_NAME String
    =>
    the direct super type's name

Note: If the driver does not support type hierarchies, an empty result set is returned.

Parameters
cataloga catalog name; "" retrieves those without a catalog;
null
means drop catalog name from the selection criteria
schemaPatterna schema name pattern; "" retrieves those without a schema
typeNamePatterna UDT name pattern; may be a fully-qualified name
Returns
a
ResultSet
object in which a row gives information about the designated UDT
Exceptions
SQLExceptionif a database access error occurs

◆ locatorsUpdateCopy()

boolean locatorsUpdateCopy ( )
raises (SQLException
)

Indicates whether updates made to a LOB are made on a copy or directly to the LOB.

Returns
true
if updates are made to a copy of the LOB;
false
if updates are made directly to the LOB
Exceptions
SQLExceptionif a database access error occurs

◆ supportsConvertInGeneral()

boolean supportsConvertInGeneral ( )
raises (SQLException
)

Retrieves whether this database supports the SQL function CONVERT for the conversion between the data types defined in com::sun::star::sdbc::DataType (see supportsConvert in com::sun::star::sdbc::XDatabaseMetadata to test for support between specific types)

Returns
true if so; false otherwise
Exceptions
SQLExceptionif a database access error occurs.

◆ supportsGetGeneratedKeys()

boolean supportsGetGeneratedKeys ( )
raises (SQLException
)

Retrieves whether auto-generated keys can be retrieved after a statement has been executed.

Returns
true
if auto-generated keys can be retrieved after a statement has executed;
false
otherwise

If

true

is returned, the JDBC driver must support the returning of auto-generated keys for at least SQL INSERT statements

Exceptions
SQLExceptionif a database access error occurs

◆ supportsMultipleOpenResults()

boolean supportsMultipleOpenResults ( )
raises (SQLException
)

Retrieves whether it is possible to have multiple.

ResultSet

objects returned from a

CallableStatement

object simultaneously.

Returns
true
if a
CallableStatement
object can return multiple
ResultSet
objects simultaneously;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ supportsNamedParameters()

boolean supportsNamedParameters ( )
raises (SQLException
)

Retrieves whether this database supports named parameters to callable statements.

Returns
true
if named parameters are supported;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ supportsRefCursors()

boolean supportsRefCursors ( )
raises (SQLException
)

Retrieves whether this database supports REF CURSOR.

The default implementation will return

false
Returns
true
if this database supports REF CURSOR;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ supportsSavepoints()

boolean supportsSavepoints ( )
raises (SQLException
)

Retrieves whether this database supports savepoints.

Returns
true
if savepoints are supported;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ supportsSharding()

boolean supportsSharding ( )
raises (SQLException
)

Retrieves whether this database supports sharding.

The default implementation will return

false
Returns
true
if this database supports sharding;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ supportsStatementPooling()

boolean supportsStatementPooling ( )
raises (SQLException
)

Retrieves whether this database supports statement pooling.

Returns
true
if so;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

◆ supportsStoredFunctionsUsingCallSyntax()

boolean supportsStoredFunctionsUsingCallSyntax ( )
raises (SQLException
)

Retrieves whether this database supports invoking user-defined or vendor functions using the stored procedure escape syntax.

Returns
true
if so;
false
otherwise
Exceptions
SQLExceptionif a database access error occurs

The documentation for this interface was generated from the following file: