Database (rxjava-jdbc 0.6.2 API)

java.lang.Object
- com.github.davidmoten.rx.jdbc.Database

```
public final class Database
extends Object
```
Main entry point for manipulations of a database using rx-java-jdbc style queries.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Database.Builder
Builds a Database.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Database.Builder` Builds a `Database`.

Field Summary

Fields
Modifier and Type	Field and Description
`static Object`	`NULL_BLOB` Sentinel object used to indicate in parameters of a query that rather than calling `PreparedStatement.setObject(int, Object)` with a null we call `PreparedStatement.setNull(int, int)` with `Types.CLOB`.
`static Object`	`NULL_CLOB` Sentinel object used to indicate in parameters of a query that rather than calling `PreparedStatement.setObject(int, Object)` with a null we call `PreparedStatement.setNull(int, int)` with `Types.CLOB`.
`static Object`	`NULL_NUMBER`

Constructor Summary

Constructors
Constructor and Description
`Database(Connection con)` Constructor.
`Database(ConnectionProvider cp)` Constructor.
`Database(ConnectionProvider cp, rx.functions.Func0<rx.Scheduler> nonTransactionalSchedulerFactory)` Constructor.
`Database(String url, String username, String password)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Database`	`asynchronous()` Returns a Database based on the current Database except all non-transactional queries run `Schedulers.io()`.
`Database`	`asynchronous(rx.functions.Func0<rx.Scheduler> nonTransactionalSchedulerFactory)` Returns a Database based on the current Database except all non-transactional queries run on the scheduler provided by the given factory.
`Database`	`asynchronous(rx.Scheduler nonTransactionalScheduler)` Returns a Database based on the current Database except all non-transactional queries run on the given scheduler.
`rx.Observable<Boolean>`	`beginTransaction()` Starts a transaction.
`rx.Observable<Boolean>`	`beginTransaction(rx.Observable<?> dependency)` Starts a transaction.
`<T> rx.Observable.Operator<T,T>`	`beginTransactionOnNextOperator()` Starts a database transaction for each onNext call.
`static Database.Builder`	`builder()` Returns a new `Database.Builder`.
`Database`	`close()` Close the database in particular closes the `ConnectionProvider` for the database.
`rx.Observable<Boolean>`	`commit(rx.Observable<?>... depends)` Commits a transaction and resets the current query context so that further queries will use the asynchronous version by default.
`<T> rx.Observable.Operator<Boolean,T>`	`commitOnCompleteOperator()` Commits current transaction on the completion of source if and only if the source sequence is non-empty.
`<T> rx.Observable.Operator<Boolean,rx.Observable<T>>`	`commitOnNextListOperator()`
`<T> rx.Observable.Operator<Boolean,T>`	`commitOnNextOperator()` Commits the currently open transaction.
`<T> rx.Observable.Operator<Boolean,T>`	`commitOperator()` Waits for the source to complete before returning the result of db.commit();
`static Database`	`from(Connection con)` Factory method.
`static Database`	`from(ConnectionProvider cp)` Returns a `Database` that obtains `Connection`s on demand from the given `ConnectionProvider`.
`static Database`	`from(String url)` Returns a `Database` based on a jdbc connection string.
`static Database`	`from(String url, String username, String password)` Returns a `Database` based on a jdbc connection string.
`static Database`	`fromContext(String jndiResource)` Returns a `Database` based on connections obtained from a `DataSource` based on looking up the current `Context`
`static Database`	`fromDataSource(DataSource dataSource)` Returns a `Database` based on connections obtained from a `DataSource`
`ConnectionProvider`	`getConnectionProvider()` Returns the `ConnectionProvider`.
`rx.Observable<Boolean>`	`lastTransactionResult()` Returns observable that emits true when last transaction committed or false when last transaction is rolled back.
`com.github.davidmoten.rx.jdbc.QueryContext`	`queryContext()` Returns the thread local current query context (will not return null).
`rx.Observable<Boolean>`	`rollback(rx.Observable<?>... depends)` Rolls back a transaction and resets the current query context so that further queries will use the asynchronous version by default.
`<T> rx.Observable.Operator<Boolean,T>`	`rollbackOnCompleteOperator()` Rolls back current transaction on the completion of source if and only if the source sequence is non-empty.
`<T> rx.Observable.Operator<Boolean,rx.Observable<T>>`	`rollbackOnNextListOperator()`
`rx.Observable.Operator<Boolean,?>`	`rollbackOnNextOperator()` Rolls back the current transaction.
`<T> rx.Observable.Operator<Boolean,T>`	`rollbackOperator()` Waits for the source to complete before returning the result of db.rollback();
`rx.Observable.Operator<Integer,String>`	`run()` Returns an `Observable.Operator` version of `run(Observable)`.
`rx.Observable<Integer>`	`run(InputStream is, Charset charset, String delimiter)` Returns an `Observable` that is the result of running a sequence of update commands (insert/update/delete, ddl) commands read from an `InputStream` with the given `Charset` using the given delimiter as the statement delimiter (for example semicolon).
`rx.Observable<Integer>`	`run(InputStream is, String delimiter)` Returns an `Observable` that is the result of running a sequence of update commands (insert/update/delete, ddl) commands read from an InputStream using the given delimiter as the statement delimiter (for example semicolon).
`rx.Observable<Integer>`	`run(rx.Observable<String> commands)` Returns an `Observable` that is the result of running a sequence of update commands (insert/update/delete, ddl) read from the given `Observable` sequence.
`QuerySelect.Builder`	`select()` Returns a `QuerySelect.Builder` builder and defers specifying sql to the `autoMap` Class parameter.
`QuerySelect.Builder`	`select(String sql)` Returns a `QuerySelect.Builder` builder based on the given select statement sql.
`static Object`	`toSentinelIfNull(byte[] bytes)`
`static Object`	`toSentinelIfNull(String s)`
`QueryUpdate.Builder`	`update(String sql)` Returns a `QueryUpdate.Builder` builder based on the given update/insert/delete/DDL statement sql.

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

- Field Detail
  - NULL_CLOB
```
public static final Object NULL_CLOB
```
    Sentinel object used to indicate in parameters of a query that rather than calling PreparedStatement.setObject(int, Object) with a null we call PreparedStatement.setNull(int, int) with Types.CLOB. This is required by many databases for setting CLOB and BLOB fields to null.
  - NULL_NUMBER
```
public static final Object NULL_NUMBER
```
  - NULL_BLOB
```
public static final Object NULL_BLOB
```
    Sentinel object used to indicate in parameters of a query that rather than calling PreparedStatement.setObject(int, Object) with a null we call PreparedStatement.setNull(int, int) with Types.CLOB. This is required by many databases for setting CLOB and BLOB fields to null.
- Constructor Detail
  - Database
```
public Database(ConnectionProvider cp,
        rx.functions.Func0<rx.Scheduler> nonTransactionalSchedulerFactory)
```
    Constructor.
    
    Parameters:
    cp - provides connections
    nonTransactionalSchedulerFactory - schedules non transactional queries
  - Database
```
public Database(ConnectionProvider cp)
```
    Constructor. Thread pool size defaults to Runtime.getRuntime().availableProcessors()+1. This may be too conservative if the database is on another server. If that is the case then you may want to use a thread pool size equal to the available processors + 1 on the database server.
    
    Parameters:
    cp - provides connections
  - Database
```
public Database(String url,
        String username,
        String password)
```
    Constructor. Uses a ConnectionProviderFromUrl based on the given url.
    
    Parameters:
    url - jdbc url
    username - username for connection
    password - password for connection
  - Database
```
public Database(Connection con)
```
    Constructor. Uses the single connection provided and current thread scheduler (trampoline) to run all queries. The connection will not be closed in reality though the log may indicate it as having received a close call.
    
    Parameters:
    con - the connection
- Method Detail
  - getConnectionProvider
```
public ConnectionProvider getConnectionProvider()
```
    Returns the ConnectionProvider.
    
    Returns:
  - from
```
public static Database from(String url)
```
    Returns a Database based on a jdbc connection string.
    
    Parameters:
    url - jdbc connection url
    
    Returns:
  - from
```
public static Database from(String url,
            String username,
            String password)
```
    Returns a Database based on a jdbc connection string.
    
    Parameters:
    url - jdbc url
    username - username for connection
    password - password for connection
    
    Returns:
    the database object
  - fromContext
```
public static Database fromContext(String jndiResource)
```
    Returns a Database based on connections obtained from a DataSource based on looking up the current Context
    
    Parameters:
    jndiResource -
    
    Returns:
  - fromDataSource
```
public static Database fromDataSource(DataSource dataSource)
```
    Returns a Database based on connections obtained from a DataSource
    
    Parameters:
    jndiResource -
    
    Returns:
  - from
```
public static Database from(ConnectionProvider cp)
```
    Returns a Database that obtains Connections on demand from the given ConnectionProvider. When close() is called, ConnectionProvider.close() is called.
    
    Parameters:
    cp -
    
    Returns:
  - from
```
public static Database from(Connection con)
```
    Factory method. Uses the single connection provided and current thread scheduler (trampoline) to run all queries. The connection will not be closed in reality though the log may indicate it as having received a close call.
    
    Parameters:
    con - the connection
  - builder
```
public static Database.Builder builder()
```
    Returns a new Database.Builder.
    
    Returns:
  - queryContext
```
public com.github.davidmoten.rx.jdbc.QueryContext queryContext()
```
    Returns the thread local current query context (will not return null). Will return overriden context (for example using Database returned from beginTransaction() if set.
    
    Returns:
  - select
```
public QuerySelect.Builder select(String sql)
```
    Returns a QuerySelect.Builder builder based on the given select statement sql.
    
    Parameters:
    sql - a select statement.
    
    Returns:
    select query builder
  - select
```
public QuerySelect.Builder select()
```
    Returns a QuerySelect.Builder builder and defers specifying sql to the `autoMap` Class parameter.
    
    Returns:
    query builder
  - update
```
public QueryUpdate.Builder update(String sql)
```
    Returns a QueryUpdate.Builder builder based on the given update/insert/delete/DDL statement sql.
    
    Parameters:
    sql - an update/insert/delete/DDL statement.
    
    Returns:
    update/insert query builder
  - beginTransaction
```
public rx.Observable<Boolean> beginTransaction(rx.Observable<?> dependency)
```
    Starts a transaction. Until commit() or rollback() is called on the source this will set the query context for all created queries to be a single threaded executor with one (new) connection.
    
    Parameters:
    dependency -
    
    Returns:
  - beginTransaction
```
public rx.Observable<Boolean> beginTransaction()
```
    Starts a transaction. Until commit() or rollback() is called on the source this will set the query context for all created queries to be a single threaded executor with one (new) connection.
    
    Returns:
  - commit
```
public rx.Observable<Boolean> commit(rx.Observable<?>... depends)
```
    Commits a transaction and resets the current query context so that further queries will use the asynchronous version by default. All Observable dependencies must be complete before commit is called.
    
    Parameters:
    depends - depdencies that must complete before commit occurs.
    
    Returns:
  - commitOperator
```
public <T> rx.Observable.Operator<Boolean,T> commitOperator()
```
    Waits for the source to complete before returning the result of db.commit();
    
    Returns:
    commit operator
  - rollbackOperator
```
public <T> rx.Observable.Operator<Boolean,T> rollbackOperator()
```
    Waits for the source to complete before returning the result of db.rollback();
    
    Returns:
    rollback operator
  - rollback
```
public rx.Observable<Boolean> rollback(rx.Observable<?>... depends)
```
    Rolls back a transaction and resets the current query context so that further queries will use the asynchronous version by default. All Observable dependencies must be complete before rollback is called.
    
    Parameters:
    depends - depdencies that must complete before commit occurs.
    
    Returns:
  - lastTransactionResult
```
public rx.Observable<Boolean> lastTransactionResult()
```
    Returns observable that emits true when last transaction committed or false when last transaction is rolled back.
    
    Returns:
  - close
```
public Database close()
```
    Close the database in particular closes the ConnectionProvider for the database. For a ConnectionProviderPooled this will be a required call for cleanup.
    
    Returns:
  - commitOnCompleteOperator
```
public <T> rx.Observable.Operator<Boolean,T> commitOnCompleteOperator()
```
    Commits current transaction on the completion of source if and only if the source sequence is non-empty.
    
    Returns:
    operator that commits on completion of source.
  - rollbackOnCompleteOperator
```
public <T> rx.Observable.Operator<Boolean,T> rollbackOnCompleteOperator()
```
    Rolls back current transaction on the completion of source if and only if the source sequence is non-empty.
    
    Returns:
    operator that rolls back on completion of source.
  - beginTransactionOnNextOperator
```
public <T> rx.Observable.Operator<T,T> beginTransactionOnNextOperator()
```
    Starts a database transaction for each onNext call. Following database calls will be subscribed on current thread (Schedulers.trampoline()) and share the same Connection until transaction is rolled back or committed.
    
    Returns:
    begin transaction operator
  - commitOnNextOperator
```
public <T> rx.Observable.Operator<Boolean,T> commitOnNextOperator()
```
    Commits the currently open transaction. Emits true.
    
    Returns:
  - commitOnNextListOperator
```
public <T> rx.Observable.Operator<Boolean,rx.Observable<T>> commitOnNextListOperator()
```
  - rollbackOnNextListOperator
```
public <T> rx.Observable.Operator<Boolean,rx.Observable<T>> rollbackOnNextListOperator()
```
  - rollbackOnNextOperator
```
public rx.Observable.Operator<Boolean,?> rollbackOnNextOperator()
```
    Rolls back the current transaction. Emits false.
    
    Returns:
  - run
```
public rx.Observable<Integer> run(rx.Observable<String> commands)
```
    Returns an Observable that is the result of running a sequence of update commands (insert/update/delete, ddl) read from the given Observable sequence.
    
    Parameters:
    commands -
    
    Returns:
  - run
```
public rx.Observable.Operator<Integer,String> run()
```
    Returns an Observable.Operator version of run(Observable).
    
    Returns:
  - run
```
public rx.Observable<Integer> run(InputStream is,
                         String delimiter)
```
    Returns an Observable that is the result of running a sequence of update commands (insert/update/delete, ddl) commands read from an InputStream using the given delimiter as the statement delimiter (for example semicolon).
    
    Parameters:
    is -
    delimiter -
    
    Returns:
  - run
```
public rx.Observable<Integer> run(InputStream is,
                         Charset charset,
                         String delimiter)
```
    Returns an Observable that is the result of running a sequence of update commands (insert/update/delete, ddl) commands read from an InputStream with the given Charset using the given delimiter as the statement delimiter (for example semicolon).
    
    Parameters:
    is -
    delimiter -
    
    Returns:
  - asynchronous
```
public Database asynchronous()
```
    Returns a Database based on the current Database except all non-transactional queries run Schedulers.io().
    
    Returns:
    new Database instance
  - asynchronous
```
public Database asynchronous(rx.Scheduler nonTransactionalScheduler)
```
    Returns a Database based on the current Database except all non-transactional queries run on the given scheduler.
    
    Returns:
    new Database instance
  - asynchronous
```
public Database asynchronous(rx.functions.Func0<rx.Scheduler> nonTransactionalSchedulerFactory)
```
    Returns a Database based on the current Database except all non-transactional queries run on the scheduler provided by the given factory.
    
    Returns:
    new Database instance
  - toSentinelIfNull
```
public static Object toSentinelIfNull(String s)
```
  - toSentinelIfNull
```
public static Object toSentinelIfNull(byte[] bytes)
```

Class Database

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_CLOB

NULL_NUMBER

NULL_BLOB

Constructor Detail

Database

Database

Database

Database

Method Detail

getConnectionProvider

from

from

fromContext

fromDataSource

from

from

builder

queryContext

select

select

update

beginTransaction

beginTransaction

commit

commitOperator

rollbackOperator

rollback

lastTransactionResult

close

commitOnCompleteOperator

rollbackOnCompleteOperator

beginTransactionOnNextOperator

commitOnNextOperator

commitOnNextListOperator

rollbackOnNextListOperator

rollbackOnNextOperator

run

run

run

run

asynchronous

asynchronous

asynchronous

toSentinelIfNull

toSentinelIfNull