LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
Connection Service Referencepublished

represents a connection (session) with a specific database. More...

import"Connection.idl";

Inheritance diagram for Connection:
XComponent XConnection XWarningsSupplier XInterface XCloseable XInterface XInterface Connection DatabaseAccessConnection

Exported Interfaces

interface com::sun::star::lang::XComponent
 controls the closing of a connection. More...
 
interface XConnection
 the main interface for interaction with a connection to a database. More...
 
interface XWarningsSupplier
 controls the chaining of warnings, which may occur on every call to the connected database. More...
 

Additional Inherited Members

- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. 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...
 
- Public Member Functions inherited from XConnection
XStatement createStatement () raises (SQLException)
 creates a new com::sun::star::sdbc::Statement object for sending SQL statements to the database. More...
 
XPreparedStatement prepareStatement ([in]string sql) raises (SQLException)
 creates a com::sun::star::sdbc::PreparedStatement object for sending parameterized SQL statements to the database. More...
 
XPreparedStatement prepareCall ([in]string sql) raises (SQLException)
 creates a com::sun::star::sdbc::CallableStatement object for calling database stored procedures. More...
 
string nativeSQL ([in]string sql) raises (SQLException)
 converts the given SQL statement into the system's native SQL grammar. More...
 
void setAutoCommit ([in] boolean autoCommit) raises (SQLException)
 sets this connection's auto-commit mode. More...
 
boolean getAutoCommit () raises (SQLException)
 gets the current auto-commit state. More...
 
void commit () raises (SQLException)
 makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. More...
 
void rollback () raises (SQLException)
 drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection. More...
 
boolean isClosed () raises (SQLException)
 tests to see if a connection is closed. More...
 
XDatabaseMetaData getMetaData () raises (SQLException)
 gets the metadata regarding this connection's database. More...
 
void setReadOnly ([in]boolean readOnly) raises (SQLException)
 puts this connection in read-only mode as a hint to enable database optimizations. More...
 
boolean isReadOnly () raises (SQLException)
 tests to see if the connection is in read-only mode. More...
 
void setCatalog ([in]string catalog) raises (SQLException)
 sets a catalog name in order to select a subspace of this Connection's database in which to work. More...
 
string getCatalog () raises (SQLException)
 returns the Connection's current catalog name. More...
 
void setTransactionIsolation ([in]long level) raises (SQLException)
 attempts to change the transaction isolation level to the one given. More...
 
long getTransactionIsolation () raises (SQLException)
 gets this Connection's current transaction isolation level. More...
 
com::sun::star::container::XNameAccess getTypeMap () raises (SQLException)
 gets the type map object associated with this connection. More...
 
void setTypeMap ([in]com::sun::star::container::XNameAccess typeMap) raises (SQLException)
 installs the given type map as the type map for this connection. More...
 
- Public Member Functions inherited from XCloseable
void close () raises (SQLException)
 releases all resources connected to an object. More...
 
- Public Member Functions inherited from XWarningsSupplier
any getWarnings () raises (SQLException)
 returns the first warning reported by calls on an object that supports the usage of warnings. More...
 
void clearWarnings () raises (SQLException)
 clears all warnings reported for the object implementing the interface. More...
 

Detailed Description

represents a connection (session) with a specific database.

Within the context of a Connection, SQL statements are executed and results are returned.

A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, and the capabilities of this connection. This information is obtained with the com::sun::star::sdbc::XConnection::getMetaData() method.

Note: By default the Connection automatically commits changes after executing each statement. If auto commit has been disabled, an explicit commit must be done or database changes will not be saved.

See also
com::sun::star::sdbc::XStatement
com::sun::star::sdbc::XResultSet
com::sun::star::sdbc::XDatabaseMetaData
Developers Guide
Database - Connection Service

Exported Interfaces

controls the closing of a connection.

interface XConnection

the main interface for interaction with a connection to a database.

interface XWarningsSupplier

controls the chaining of warnings, which may occur on every call to the connected database.

Chained warnings from previous calls will be cleared before processing a new call.


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