JDBCRepositoryBuilder (Carbonado 1.2.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazon.carbonado.repo.jdbc
Class JDBCRepositoryBuilder

java.lang.Object
  com.amazon.carbonado.spi.AbstractRepositoryBuilder
      com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder

All Implemented Interfaces:: RepositoryBuilder

public class JDBCRepositoryBuilder
extends AbstractRepositoryBuilder
extends AbstractRepositoryBuilder

Builds a repository instance backed by a JDBC accessible database. JDBCRepository is not independent of the underlying database schema, and so it requires matching tables and columns in the database. It will not alter or create tables. Use the Alias annotation to control precisely which tables and columns must be matched up.

Note: The current JDBC repository implementation makes certain assumptions about the database it is accessing. It must support transactions and multiple statements per connection. If it doesn't support savepoints, then nested transactions are faked -- rollback of inner transaction will appear to do nothing.

The following extra capabilities are supported:

Author:: Brian S O'Neill, bcastill, Adam D Bradley

Constructor Summary
`JDBCRepositoryBuilder()`

Method Summary
`Repository`	`build(AtomicReference<Repository> rootRef)` Builds a repository instance.
`void`	`errorCheck(Collection<String> messages)` This method is called by assertReady, and subclasses must override to perform custom checks.
`String`	`getCatalog()` Returns the optional catalog to search for metadata.
`DataSource`	`getDataSource()` Returns the source of JDBC connections, which defaults to a non-pooling source if driver class, driver URL, username, and password are all supplied.
`boolean`	`getDataSourceCloseOnShutdown()` Returns true if DataSource is closed when the repository is closed or shutdown.
`boolean`	`getDataSourceLogging()` Returns true if debug logging is enabled.
`Integer`	`getDefaultFetchSize()` Returns the default fetch size when running queries, or null if driver default is used instead.
`String`	`getDriverClassName()` Returns the driver class name, which may be null if a DataSource was provided.
`String`	`getDriverURL()` Returns the connection URL, which may be null if a DataSource was provided.
`String`	`getName()` Returns the name of the repository.
`String`	`getPassword()` Returns the optional password to use with DataSource.
`String`	`getSchema()` Returns the optional schema to search for metadata.
`String`	`getSequenceSelectStatement()` Returns the native sequence select statement, which is null if the default is chosen.
`String`	`getUserName()` Returns the optional username to use with DataSource.
`boolean`	`isForceStoredSequence()` Returns true if native sequences should not be used.
`boolean`	`isMaster()` Returns true if repository should assume the role of master, which is true by default.
`void`	`setAutoVersioningEnabled(boolean enabled, String className)` By default, JDBCRepository assumes that `version numbers` are initialized and incremented by triggers installed on the database.
`void`	`setCatalog(String catalog)` Optionally set the catalog to search for metadata.
`void`	`setDataSource(DataSource dataSource)` Set the source of JDBC connections, overriding any configuration supported by these methods: `setDriverClassName(java.lang.String)` `setDriverURL(java.lang.String)` `setUserName(java.lang.String)` `setPassword(java.lang.String)`
`void`	`setDataSourceCloseOnShutdown(boolean b)` Pass true to cause the DataSource to be closed when the repository is closed or shutdown.
`void`	`setDataSourceLogging(boolean b)` Pass true to enable debug logging.
`void`	`setDefaultFetchSize(Integer size)` Set the default fetch size when running queries.
`void`	`setDriverClassName(String driverClassName)` Set the JDBC driver class name, which is required if a DataSource was not provided.
`void`	`setDriverURL(String url)` Set the JDBC connection URL, which is required if a DataSource was not provided.
`void`	`setForceStoredSequence(boolean forceStoredSequence)` By default, native sequences are used if supported.
`void`	`setMaster(boolean b)` Set to false if repository should not assume the role of master.
`void`	`setName(String name)` Set name for the repository, which is required.
`void`	`setPassword(String password)` Optionally set the password to use with DataSource.
`void`	`setPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled)` By default, JDBCRepository makes sure that every declared primary key in the database table for a Storable lines up with a declared PrimaryKey or AlternateKey.
`void`	`setSchema(String schema)` Optionally set the schema to search for metadata.
`void`	`setSequenceSelectStatement(String sequenceSelectStatement)` Override the default native sequence select statement with a printf.
`void`	`setSuppressReload(boolean suppress, String className)` By default, JDBCRepository reloads Storables after every insert or update.
`void`	`setUserName(String username)` Optionally set the username to use with DataSource.

Methods inherited from class com.amazon.carbonado.spi.AbstractRepositoryBuilder
`addTriggerFactory, assertReady, build, getTriggerFactories, removeTriggerFactory`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

JDBCRepositoryBuilder

public JDBCRepositoryBuilder()

Method Detail