ODB-class {ODB}

Class "ODB"

Description

A connection to an Open Document Base (.odb) embedded HSQL database.

This class extends JDBCConnection, and objects from it can be accessed via the DBI interface. Objects from this class also store file paths used for other ODB manipulation (such as queries or comments, stored in the embedded content.xml file rather than the HSQL database).

Objects from the Class

Objects can be created by calls to the odb.open function, and saved into the original .odb file by odb.close.

Several objects can but should not refer to the same .odb file: as they deal with distinct copies of this file, updates in one connection will not propagate to others. Moreover, when one of these connections will be closed, it will override changes in the .odb file made by formerly closed connections.

Slots

jc:

Inherited from "JDBCConnection"

identifier.quote:

Inherited from "JDBCConnection"

directory:

Single character value, the path to the temp directory storing the database files.

odbFile:

Single character value, the path to the .odb file handled.

odbVersion:

Single character value, HSQLDB version of the .odb file.

jarFile:

Single character value, the path to the HSQLDB .jar library used.

jarVersion:

Single character value, HSQLDB version of the .jar library.

Extends

• Class "JDBCConnection", directly.

• Class "DBIConnection", by class "JDBCConnection", distance 2.

• Class "DBIObject", by class "JDBCConnection", distance 3.

Methods

show

signature(object = "ODB")

See also inherited methods.

Note

Functions from the DBI package can be used directly on the object, if you prefer to manage SQL transactions yourself. Notice however that common issues (charset, factors and column names) are handled by odb.read and odb.write, which can deal with any SQL query.

Author(s)

Sylvain Mareschal

See Also

odb.open

See ODB-package for a complete example.