play.db

Class Databases

java.lang.Object

play.db.Databases

public final class Databases
extends java.lang.Object

Creation helpers for manually instantiating databases.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

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.

Parameters:

k1 - an H2 configuration key.

v1 - configuration value corresponding to `k1`

Returns:

a configured in-memory H2 database

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.

Parameters:

k1 - an H2 configuration key

v1 - H2 configuration value corresponding to `k1`

k2 - a second H2 configuration key

v2 - a configuration value corresponding to `k2`

Returns:

a configured in-memory H2 database

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.

Parameters:

k1 - an H2 configuration key

v1 - H2 configuration value corresponding to `k1`

k2 - a second H2 configuration key

v2 - a configuration value corresponding to `k2`

k3 - a third H2 configuraiton key

v3 - a configuration value corresponding to `k3`

Returns:

a configured in-memory H2 database