interface XDriver in module com::sun::star::sdbc::

(Global Index)

Syntax

interface XDriver : com::sun::star::uno::XInterface ;

Description

is the interface that every driver class must implement.

Each driver should supply a service that implements the Driver interface.

The DriverManager will try to load as many drivers as it can find, and then for any given connection request, it will ask each driver in turn to try to connect to the target URL.

It is strongly recommended that each Driver object should be small and standalone so that the Driver object can be loaded and queried without bringing in vast quantities of supporting code.

See also

XDriverManager

See also

XConnection

Method Summary

connect attempts to make a database connection to the given URL. The driver should return NULL if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn.

acceptsURL returns true if the driver thinks that it can open a connection to the given URL. Typically drivers will return true if they understand the subprotocol specified in the URL and false if they do not.

getPropertyInfo gets information about the possible properties for this driver.

getMajorVersion gets the driver's major version number. Initially this should be 1.

getMinorVersion gets the driver's minor version number. Initially this should be 0.

Known Services Which Export this Interface

com::sun::star::sdbc::Driver

Method Details



connect

Syntax

com::sun::star::sdbc::XConnection connect (
string url,
sequence< com::sun::star::beans::PropertyValue > info )
raises ( com::sun::star::sdbc::SQLException );

Description

attempts to make a database connection to the given URL. The driver should return NULL if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn.

The driver should raise a SQLException if it is the right driver to connect to the given URL, but has trouble connecting to the database.

The info argument can be used to pass arbitrary string tag/value pairs as connection arguments. Normally at least "user" and "password" properties should be included in the Properties. For a JDBC driver also the java class must be supplied. The property is named JavaDriverClass. Possible property value names are when supported by the driver:

  • user - the username
  • password - the password
  • Timeout - after which time a timeout should happen
  • Silent - should the connection be silent
  • UseCatalog - should the driver should support a catalog
  • Charset - which charset should be used to fetch data
  • ParameterNameSubstitution - should the parameter '?' in prepared statement be substituated with an distinct name

Parameter url

is the URL of the database to which to connect.

Parameter info

a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included.

Returns

a Connection object that represents a connection to the URL

Throws

SQLException if a database access error occurs

acceptsURL

Syntax

boolean acceptsURL (
string url )
raises ( com::sun::star::sdbc::SQLException );

Description

returns true if the driver thinks that it can open a connection to the given URL. Typically drivers will return true if they understand the subprotocol specified in the URL and false if they do not.

Parameter url

is the URL of the database to which to connect.

Returns

true if this driver can connect to the given URL.

Throws

SQLException if a database access error occurs.

getPropertyInfo

Syntax

sequence< com::sun::star::sdbc::DriverPropertyInfo > getPropertyInfo (
string url,
sequence< com::sun::star::beans::PropertyValue > info )
raises ( com::sun::star::sdbc::SQLException );

Description

gets information about the possible properties for this driver.

The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database. Note that depending on the values the human has supplied so far, additional values may become necessary, so it may be necessary to iterate though several calls to getPropertyInfo.

Parameter url

is the URL of the database to which to connect.

Parameter info

is a proposed list of tag/value pairs that will be sent on connect open.

Returns

an array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.

Throws

SQLException if a database access error occurs.

getMajorVersion

Syntax

long getMajorVersion ();

Description

gets the driver's major version number. Initially this should be 1.

Returns

this driver's major version number

getMinorVersion

Syntax

long getMinorVersion ();

Description

gets the driver's minor version number. Initially this should be 0.

Returns

this driver's minor version number.
Top of Page