play.db

Class DefaultDatabase

java.lang.Object

play.db.Database

play.db.DefaultDatabase

public class DefaultDatabase
extends Database

Default delegating implementation of the database API.

Constructor Summary

Constructors

Constructor and Description
DefaultDatabase(play.api.db.Database database)
DefaultDatabase(java.lang.String name, Configuration configuration) Create a default BoneCP-backed database.
DefaultDatabase(java.lang.String name, java.util.Map<java.lang.String,? extends java.lang.Object> config) Create a default BoneCP-backed database.

Method Summary

Modifier and Type	Method and Description
java.sql.Connection	getConnection() Get a JDBC connection from the underlying data source.
java.sql.Connection	getConnection(boolean autocommit) Get a JDBC connection from the underlying data source.
javax.sql.DataSource	getDataSource() The underlying JDBC data source for this database.
java.lang.String	getName() The configuration name for this database.
java.lang.String	getUrl() The JDBC connection URL this database, i.e.
void	shutdown() Shutdown this database, closing the underlying data source.
<A> A	withConnection(boolean autocommit, ConnectionCallable<A> block) Execute a block of code, providing a JDBC connection.
void	withConnection(boolean autocommit, ConnectionRunnable block) Execute a block of code, providing a JDBC connection.
<A> A	withConnection(ConnectionCallable<A> block) Execute a block of code, providing a JDBC connection.
void	withConnection(ConnectionRunnable block) Execute a block of code, providing a JDBC connection.
<A> A	withTransaction(ConnectionCallable<A> block) Execute a block of code in the scope of a JDBC transaction.
void	withTransaction(ConnectionRunnable block) Execute a block of code in the scope of a JDBC transaction.

Methods inherited from class play.db.Database

createFrom, createFrom, createFrom, createFrom, inMemory, inMemory, inMemory, inMemory, inMemory, inMemory, inMemoryWith, inMemoryWith, inMemoryWith, toScala

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDatabase

public DefaultDatabase(play.api.db.Database database)

DefaultDatabase

public DefaultDatabase(java.lang.String name,
                       Configuration configuration)

Create a default BoneCP-backed database.

DefaultDatabase

public DefaultDatabase(java.lang.String name,
                       java.util.Map<java.lang.String,? extends java.lang.Object> config)

Create a default BoneCP-backed database.

Method Detail

getName

public java.lang.String getName()

Description copied from class: Database

The configuration name for this database.

Specified by:

getName in class Database

getDataSource

public javax.sql.DataSource getDataSource()

Description copied from class: Database

The underlying JDBC data source for this database.

Specified by:

getDataSource in class Database

getUrl

public java.lang.String getUrl()

Description copied from class: Database

The JDBC connection URL this database, i.e. `jdbc:...` Normally retrieved via a connection.

Specified by:

getUrl in class Database

getConnection

public java.sql.Connection getConnection()

Description copied from class: Database

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().

Specified by:

getConnection in class Database

Returns:

a JDBC connection

getConnection

public java.sql.Connection getConnection(boolean autocommit)

Description copied from class: Database

Get a JDBC connection from the underlying data source. Don't forget to release the connection at some point by calling close().

Specified by:

getConnection in class Database

Parameters:

autocommit - determines whether to autocommit the connection

Returns:

a JDBC connection

withConnection

public void withConnection(ConnectionRunnable block)

Description copied from class: Database

Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.

Specified by:

withConnection in class Database

Parameters:

block - code to execute

withConnection

public <A> A withConnection(ConnectionCallable<A> block)

Description copied from class: Database

Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.

Specified by:

withConnection in class Database

Parameters:

block - code to execute

Returns:

the result of the code block

withConnection

public void withConnection(boolean autocommit,
                           ConnectionRunnable block)

Description copied from class: Database

Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.

Specified by:

withConnection in class Database

Parameters:

autocommit - determines whether to autocommit the connection

block - code to execute

withConnection

public <A> A withConnection(boolean autocommit,
                            ConnectionCallable<A> block)

Description copied from class: Database

Execute a block of code, providing a JDBC connection. The connection and all created statements are automatically released.

Specified by:

withConnection in class Database

Parameters:

autocommit - determines whether to autocommit the connection

block - code to execute

Returns:

the result of the code block

withTransaction

public void withTransaction(ConnectionRunnable block)

Description copied from class: Database

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.

Specified by:

withTransaction in class Database

Parameters:

block - code to execute

withTransaction

public <A> A withTransaction(ConnectionCallable<A> block)

Description copied from class: Database

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.

Specified by:

withTransaction in class Database

Parameters:

block - code to execute

Returns:

the result of the code block

shutdown

public void shutdown()

Description copied from class: Database

Shutdown this database, closing the underlying data source.

Specified by:

shutdown in class Database