Package oracle.soda.rdbms

Class OracleRDBMSClient

java.lang.Object

oracle.soda.rdbms.OracleRDBMSClient

All Implemented Interfaces:

OracleClient

public class OracleRDBMSClient
extends Object
implements OracleClient

Oracle RDBMS implementation of OracleClient.

Entry point to the SODA API. Provides a way to get an OracleDatabase object, from which document collections can be created and opened.

This class is thread-safe. Other API classes (implementing OracleDatabase, OracleCollection, OracleDocument, etc) are not thread-safe and should not be shared between different threads.

Constructor Summary

Constructors

Constructor	Description
OracleRDBMSClient()
OracleRDBMSClient(Properties props)	The following properties are currently supported:

Method Summary

Modifier and Type	Method	Description
OracleRDBMSMetadataBuilder	createMetadataBuilder()	Creates an OracleRDBMSMetadataBuilder initialized with default collection metadata settings.
OracleDatabase	getDatabase(Connection connection)	Gets the document collections database.
OracleDatabase	getDatabase(Connection connection, boolean avoidTxnManagement)	Gets the document collections database.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OracleRDBMSClient

public OracleRDBMSClient()

OracleRDBMSClient

public OracleRDBMSClient(Properties props)

The following properties are currently supported:

oracle.soda.sharedMetadataCache - if set to true, the shared cache of collection metadata will be turned on. oracle.soda.localMetadataCache - if set to true, the local cache of collection metadata will be turned on.

Parameters:

props - Properties object, populated with 0 or more of the supported properties and their values.

Method Detail

getDatabase

public OracleDatabase getDatabase(Connection connection)
                           throws OracleException

Gets the document collections database.

The same JDBC connection should not be used to back more than one OracleDatabase

Specified by:

getDatabase in interface OracleClient

Parameters:

connection - JDBC connection.The passed in JDBC connection must be an instance of oracle.jdbc.OracleConnection

Returns:

document collections database

Throws:

OracleException - if there's an error getting the database

getDatabase

public OracleDatabase getDatabase(Connection connection,
                                  boolean avoidTxnManagement)
                           throws OracleException

Gets the document collections database. This method serves the same purpose as getDatabase(Connection), except it also provides the avoidTxnManagement flag. If this flag is set to true SODA will report an error for any operation that requires transaction management. This is useful when running distributed transactions, to ensure that SODA's local transaction management does not interfere with global transaction decisions. Note: unless you're performing distributed transactions, you should not use this method. Instead, use getDatabase(Connection).

The same JDBC connection should not be used to back more than one OracleDatabase

Specified by:

getDatabase in interface OracleClient

Parameters:

connection - JDBC connection.The passed in JDBC connection must be an instance of oracle.jdbc.OracleConnection

avoidTxnManagement - flag specifying whether to avoid transaction management. If set to true, an error will be thrown if a SODA operation requires transaction management. If set to false, it has no effect.

Returns:

document collections database

Throws:

OracleException - if there's an error getting the database

createMetadataBuilder

public OracleRDBMSMetadataBuilder createMetadataBuilder()

Creates an OracleRDBMSMetadataBuilder initialized with default collection metadata settings.

Returns:

a collection metadata builder

See Also:

OracleDatabaseAdmin.createCollection(String, oracle.soda.OracleDocument)