LibreOffice LibreOffice 25.2 SDK API Reference

Public Types | Included Services | Public Attributes | List of all members
JDBCConnectionProperties Service Reference

represents the properties for a JDBC connection (session) with a specific database. More...

`import"JDBCConnectionProperties.idl";`

Inheritance diagram for JDBCConnectionProperties:

## Public Types
typedef sequence< ::com::sun::star::beans::NamedValue > | SystemProperties
| specifies a set of properties to pass to `java.lang.System.setProperty` before loading the system's JDBC driver. More...
typedef sequence< any > | TypeInfoSettings
| specifies how the type info returned by com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() will be modified. More...

## Included Services
service | com::sun::star::sdbc::ConnectionProperties

## Public Attributes
string | JavaDriverClass
| which JDBC driver class should be loaded to create the connection. More...
string | JavaDriverClassPath
| an optional class path to locate the com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClass More...
boolean | IsAutoRetrievingEnabled
| specifies if retrieving of auto generated values should be enabled or not. More...
string | AutoRetrievingStatement
| specifies the statement which should be executed when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface. More...
Public Attributes inherited from ConnectionProperties
string | user
| the username More...
string | password
| the password More...

## Detailed Description

represents the properties for a JDBC connection (session) with a specific database.

These properties can be used when calling the method com::sun::star::sdbc::XDriver::connect() or com::sun::star::sdbc::XDriverManager::getConnectionWithInfo().

The properties for a connection contain additional information about how to connect to a database and how to control the behavior of the resulting connection should be.

See also
  com::sun::star::sdbc::XDriver
  com::sun::star::sdbc::XDriverManager
  com::sun::star::sdbc::ConnectionProperties

## Member Typedef Documentation

## ◆ SystemProperties

sequence< ::com::sun::star::beans::NamedValue > SystemProperties
| optional property

specifies a set of properties to pass to `java.lang.System.setProperty` before loading the system's JDBC driver.

## ◆ TypeInfoSettings

sequence< any > TypeInfoSettings
| optional property

specifies how the type info returned by com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() will be modified.

The sequence contains an even amount of string values. Each pair describes what should be searched for and what should be replaced if found.
The syntax is:

- COLUMN(2) = -5
- COLUMN(6) = PRECISION

COLUMN(X) defines the column which will be compared and the column which will be replaced. In the example above column 2 will be compared with the value -5. If this is true than column 6 will now return the value PRECISION.

## Exported Interfaces

## ◆ com::sun::star::sdbc::ConnectionProperties

service com::sun::star::sdbc::ConnectionProperties

## Member Data Documentation

## ◆ AutoRetrievingStatement

string AutoRetrievingStatement
| optional property

specifies the statement which should be executed when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.

## ◆ IsAutoRetrievingEnabled

boolean IsAutoRetrievingEnabled
| optional property

specifies if retrieving of auto generated values should be enabled or not.

If `TRUE` than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.

## ◆ JavaDriverClass

string JavaDriverClass
| optional property

which JDBC driver class should be loaded to create the connection.

See also
  com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClassPath

## ◆ JavaDriverClassPath

string JavaDriverClassPath
| optional property

an optional class path to locate the com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClass

The class path is a list of zero or more internal (see the com::sun::star::uri::ExternalUriReferenceTranslator service) URI references, where any space characters (`U+0020`) are ignored (and, in particular, separate adjacent URI references). Any “vnd.sun.star.expand” URL references in the list are expanded using the com::sun::star::util::theMacroExpander singleton.

Since
  OOo 2.3

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

- com/sun/star/sdbc/JDBCConnectionProperties.idl