Database (Play 2.4.0-M2)

java.lang.Object
- play.db.Database

Direct Known Subclasses:

DefaultDatabase
```
public abstract class Database
extends java.lang.Object
```
Database API for managing data sources and connections.

Constructor Summary

Constructors
Constructor and Description

Database()

Constructors
Constructor and Description
`Database()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Database`	`createFrom(java.lang.String driver, java.lang.String url)` Create a pooled database named "default" with the given driver and url.
`static Database`	`createFrom(java.lang.String driver, java.lang.String url, java.util.Map<java.lang.String,? extends java.lang.Object> config)` Create a pooled database named "default" with the given configuration.
`static Database`	`createFrom(java.lang.String name, java.lang.String driver, java.lang.String url)` Create a pooled database with the given configuration.
`static Database`	`createFrom(java.lang.String name, java.lang.String driver, java.lang.String url, java.util.Map<java.lang.String,? extends java.lang.Object> config)` Create a pooled database with the given configuration.
`abstract java.sql.Connection`	`getConnection()` Get a JDBC connection from the underlying data source.
`abstract java.sql.Connection`	`getConnection(boolean autocommit)` Get a JDBC connection from the underlying data source.
`abstract javax.sql.DataSource`	`getDataSource()` The underlying JDBC data source for this database.
`abstract java.lang.String`	`getName()` The configuration name for this database.
`abstract java.lang.String`	`getUrl()` The JDBC connection URL this database, i.e.
`static Database`	`inMemory()` Create an in-memory H2 database with name "default".
`static Database`	`inMemory(java.util.Map<java.lang.String,? extends java.lang.Object> config)` Create an in-memory H2 database with name "default".
`static Database`	`inMemory(java.lang.String name)` Create an in-memory H2 database.
`static Database`	`inMemory(java.lang.String name, java.util.Map<java.lang.String,? extends java.lang.Object> config)` Create an in-memory H2 database.
`static Database`	`inMemory(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> urlOptions, java.util.Map<java.lang.String,? extends java.lang.Object> config)` Create an in-memory H2 database.
`static Database`	`inMemory(java.lang.String name, java.lang.String url, java.util.Map<java.lang.String,? extends java.lang.Object> config)` Create an in-memory H2 database.
`static Database`	`inMemoryWith(java.lang.String k1, java.lang.Object v1)` Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
`static Database`	`inMemoryWith(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2)` Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
`static Database`	`inMemoryWith(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3)` Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
`abstract void`	`shutdown()` Shutdown this database, closing the underlying data source.
`abstract <A> A`	`withConnection(boolean autocommit, ConnectionCallable<A> block)` Execute a block of code, providing a JDBC connection.
`abstract void`	`withConnection(boolean autocommit, ConnectionRunnable block)` Execute a block of code, providing a JDBC connection.
`abstract <A> A`	`withConnection(ConnectionCallable<A> block)` Execute a block of code, providing a JDBC connection.
`abstract void`	`withConnection(ConnectionRunnable block)` Execute a block of code, providing a JDBC connection.
`abstract <A> A`	`withTransaction(ConnectionCallable<A> block)` Execute a block of code in the scope of a JDBC transaction.
`abstract void`	`withTransaction(ConnectionRunnable block)` Execute a block of code in the scope of a JDBC transaction.

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

- Constructor Detail
  - Database
```
public Database()
```
- Method Detail
  - getName
```
public abstract java.lang.String getName()
```
    The configuration name for this database.
  - getDataSource
```
public abstract javax.sql.DataSource getDataSource()
```
    The underlying JDBC data source for this database.
  - getUrl
```
public abstract java.lang.String getUrl()
```
    The JDBC connection URL this database, i.e. `jdbc:...` Normally retrieved via a connection.
  - getConnection
```
public abstract java.sql.Connection getConnection()
```
    Get a JDBC connection from the underlying data source. Autocommit is enabled by default. Don't forget to release the connection at some point by calling close().
    
    Returns:
    a JDBC connection
  - getConnection
```
public abstract java.sql.Connection getConnection(boolean autocommit)
```
    Get a JDBC connection from the underlying data source. Don't forget to release the connection at some point by calling close().
    
    Parameters:
    autocommit - determines whether to autocommit the connection
    
    Returns:
    a JDBC connection
  - withConnection
```
public abstract void withConnection(ConnectionRunnable block)
```
    Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.
    
    Parameters:
    block - code to execute
  - withConnection
```
public abstract <A> A withConnection(ConnectionCallable<A> block)
```
    Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.
    
    Parameters:
    block - code to execute
    
    Returns:
    the result of the code block
  - withConnection
```
public abstract void withConnection(boolean autocommit,
                  ConnectionRunnable block)
```
    Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.
    
    Parameters:
    autocommit - determines whether to autocommit the connection
    block - code to execute
  - withConnection
```
public abstract <A> A withConnection(boolean autocommit,
                   ConnectionCallable<A> block)
```
    Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.
    
    Parameters:
    autocommit - determines whether to autocommit the connection
    block - code to execute
    
    Returns:
    the result of the code block
  - withTransaction
```
public abstract void withTransaction(ConnectionRunnable block)
```
    Execute a block of code in the scope of a JDBC transaction. The connection and all created statements are automatically released. The transaction is automatically committed, unless an exception occurs.
    
    Parameters:
    block - code to execute
  - withTransaction
```
public abstract <A> A withTransaction(ConnectionCallable<A> block)
```
    Execute a block of code in the scope of a JDBC transaction. The connection and all created statements are automatically released. The transaction is automatically committed, unless an exception occurs.
    
    Parameters:
    block - code to execute
    
    Returns:
    the result of the code block
  - shutdown
```
public abstract void shutdown()
```
    Shutdown this database, closing the underlying data source.
  - createFrom
```
public static Database createFrom(java.lang.String name,
                  java.lang.String driver,
                  java.lang.String url,
                  java.util.Map<java.lang.String,? extends java.lang.Object> config)
```
    Create a pooled database with the given configuration.
    
    Parameters:
    name - the database name
    driver - the database driver class
    url - the database url
    config - a map of extra database configuration
    
    Returns:
    a configured database
  - createFrom
```
public static Database createFrom(java.lang.String name,
                  java.lang.String driver,
                  java.lang.String url)
```
    Create a pooled database with the given configuration.
    
    Parameters:
    name - the database name
    driver - the database driver class
    url - the database url
    
    Returns:
    a configured database
  - createFrom
```
public static Database createFrom(java.lang.String driver,
                  java.lang.String url,
                  java.util.Map<java.lang.String,? extends java.lang.Object> config)
```
    Create a pooled database named "default" with the given configuration.
    
    Parameters:
    driver - the database driver class
    url - the database url
    config - a map of extra database configuration
    
    Returns:
    a configured database
  - createFrom
```
public static Database createFrom(java.lang.String driver,
                  java.lang.String url)
```
    Create a pooled database named "default" with the given driver and url.
    
    Parameters:
    driver - the database driver class
    url - the database url
    
    Returns:
    a configured database
  - inMemory
```
public static Database inMemory(java.lang.String name,
                java.lang.String url,
                java.util.Map<java.lang.String,? extends java.lang.Object> config)
```
    Create an in-memory H2 database.
    
    Parameters:
    name - the database name
    url - the database url
    config - a map of extra database configuration
    
    Returns:
    a configured in-memory h2 database
  - inMemory
```
public static Database inMemory(java.lang.String name,
                java.util.Map<java.lang.String,java.lang.String> urlOptions,
                java.util.Map<java.lang.String,? extends java.lang.Object> config)
```
    Create an in-memory H2 database.
    
    Parameters:
    name - the database name
    urlOptions - a map of extra url options
    config - a map of extra database configuration
    
    Returns:
    a configured in-memory h2 database
  - inMemory
```
public static Database inMemory(java.lang.String name,
                java.util.Map<java.lang.String,? extends java.lang.Object> config)
```
    Create an in-memory H2 database.
    
    Parameters:
    name - the database name
    config - a map of extra database configuration
    
    Returns:
    a configured in-memory h2 database
  - inMemory
```
public static Database inMemory(java.lang.String name)
```
    Create an in-memory H2 database.
    
    Parameters:
    name - the database name
    
    Returns:
    a configured in-memory h2 database
  - inMemory
```
public static Database inMemory(java.util.Map<java.lang.String,? extends java.lang.Object> config)
```
    Create an in-memory H2 database with name "default".
    
    Parameters:
    config - a map of extra database configuration
    
    Returns:
    a configured in-memory h2 database
  - inMemory
```
public static Database inMemory()
```
    Create an in-memory H2 database with name "default".
    
    Returns:
    a configured in-memory h2 database
  - inMemoryWith
```
public static Database inMemoryWith(java.lang.String k1,
                    java.lang.Object v1)
```
    Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
  - inMemoryWith
```
public static Database inMemoryWith(java.lang.String k1,
                    java.lang.Object v1,
                    java.lang.String k2,
                    java.lang.Object v2)
```
    Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.
  - inMemoryWith
```
public static Database inMemoryWith(java.lang.String k1,
                    java.lang.Object v1,
                    java.lang.String k2,
                    java.lang.Object v2,
                    java.lang.String k3,
                    java.lang.Object v3)
```
    Create an in-memory H2 database with name "default" and with extra configuration provided by the given entries.

Class Database

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Database

Method Detail

getName

getDataSource

getUrl

getConnection

getConnection

withConnection

withConnection

withConnection

withConnection

withTransaction

withTransaction

shutdown

createFrom

createFrom

createFrom

createFrom

inMemory

inMemory

inMemory

inMemory

inMemory

inMemory

inMemoryWith

inMemoryWith

inMemoryWith