LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XDriverManager Interface Referencepublished

is the basic interface for managing a set of SDBC drivers. More...

import"XDriverManager.idl";

Inheritance diagram for XDriverManager:
XInterface XDatabaseEnvironment XConnectionPool XDriverManager2 DatabaseEnvironment ConnectionPool DriverManager

Public Member Functions

XConnection getConnection ([in]string url) raises (SQLException)
 attempts to establish a connection to the given database URL. More...
 
XConnection getConnectionWithInfo ([in]string url, [in]sequence< com::sun::star::beans::PropertyValue > info) raises (SQLException)
 attempts to establish a connection to the given database URL. More...
 
void setLoginTimeout ([in]long seconds)
 sets the maximum time in seconds that a driver will wait while attempting to connect to a database. More...
 
long getLoginTimeout ()
 gets the maximum time in seconds that a driver can wait when attempting to login to a database. 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

is the basic interface for managing a set of SDBC drivers.

When the method com::sun::star::sdbc::XDriverManager::getConnection() is called, the DriverManager will attempt to locate a suitable driver.

See also
com::sun::star::sdbc::XDriver
com::sun::star::sdbc::XConnection

Member Function Documentation

◆ getConnection()

XConnection getConnection ( [in] string  url)
raises (SQLException
)

attempts to establish a connection to the given database URL.

The DriverManager attempts to select an appropriate driver from the set of registered JDBC/SDBC drivers.

Parameters
urla database url of the form sdbc:subprotocol:subname
Returns
the Connection object
Exceptions
SQLExceptionif a database access error occurs.

◆ getConnectionWithInfo()

XConnection getConnectionWithInfo ( [in] string  url,
[in] sequence< com::sun::star::beans::PropertyValue info 
)
raises (SQLException
)

attempts to establish a connection to the given database URL.

The DriverManager attempts to select an appropriate driver from the set of registered JDBC/SDBC drivers.

Parameters
urla database url of the form sdbc:subprotocol:subname
infoa list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included
See also
com::sun::star::sdbc::ConnectionProperties
Returns
the Connection object
Exceptions
SQLExceptionif a database access error occurs.

◆ getLoginTimeout()

long getLoginTimeout ( )

gets the maximum time in seconds that a driver can wait when attempting to login to a database.

Returns
the driver login time limit in seconds
Exceptions
SQLExceptionif a database access error occurs.

◆ setLoginTimeout()

void setLoginTimeout ( [in] long  seconds)

sets the maximum time in seconds that a driver will wait while attempting to connect to a database.

Parameters
secondsthe login time limit in seconds
Exceptions
SQLExceptionif a database access error occurs.

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