root
API
Generated with
root/play.api.db

play.api.db

package play.api.db

Contains the JDBC database access API.

Example, retrieving a connection from the 'customers' datasource:

val conn = db.getConnection("customers")

Attributes

Members list

Type members

Classlikes

trait ConnectionPool

Connection pool API for managing data sources.

Connection pool API for managing data sources.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ConnectionPool

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
@Singleton
class DBApiProvider(environment: Environment, configuration: Configuration, defaultConnectionPool: ConnectionPool, lifecycle: ApplicationLifecycle, maybeInjector: Option[Injector]) extends Provider[DBApi]

Inject provider for DB implementation of DB API.

Inject provider for DB implementation of DB API.

Attributes

Supertypes
trait Provider[DBApi]
class Object
trait Matchable
class Any
trait DBComponents

DB components (for compile-time injection).

DB components (for compile-time injection).

Attributes

Supertypes
class Object
trait Matchable
class Any
final class DBModule extends SimpleModule

DB runtime inject module.

DB runtime inject module.

Attributes

Supertypes
class SimpleModule
class Module
class Object
trait Matchable
class Any
case class DatabaseConfig(driver: Option[String], url: Option[String], username: Option[String], password: Option[String], jndiName: Option[String])

The generic database configuration.

The generic database configuration.

Value parameters

driver

The driver

jndiName

The JNDI name

password

The password

url

The jdbc URL

username

The username

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DatabaseConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Databases

Creation helpers for manually instantiating databases.

Creation helpers for manually instantiating databases.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Databases.type
class DefaultDBApi(configuration: Map[String, Config], defaultConnectionPool: ConnectionPool, environment: Environment, injector: Injector) extends DBApi

Default implementation of the DB API.

Default implementation of the DB API.

Attributes

Companion
object
Supertypes
trait DBApi
class Object
trait Matchable
class Any
object DefaultDBApi

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class DefaultDatabase(val name: String, configuration: Config, environment: Environment) extends Database

Default implementation of the database API. Provides driver registration and connection methods.

Default implementation of the database API. Provides driver registration and connection methods.

Attributes

Supertypes
trait Database
class Object
trait Matchable
class Any
Known subtypes
trait HikariCPComponents

HikariCP components (for compile-time injection).

HikariCP components (for compile-time injection).

Attributes

Supertypes
class Object
trait Matchable
class Any
@Singleton
class HikariCPConnectionPool(environment: Environment) extends ConnectionPool

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object HikariCPConnectionPool

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class HikariCPModule extends SimpleModule

HikariCP runtime inject module.

HikariCP runtime inject module.

Attributes

Supertypes
class SimpleModule
class Module
class Object
trait Matchable
class Any
class NamedDatabaseProvider(name: String) extends Provider[Database]

Inject provider for named databases.

Inject provider for named databases.

Attributes

Supertypes
trait Provider[Database]
class Object
trait Matchable
class Any
class PooledDatabase(name: String, configuration: Config, environment: Environment, val pool: ConnectionPool) extends DefaultDatabase

Default implementation of the database API using a connection pool.

Default implementation of the database API using a connection pool.

Attributes

Supertypes
trait Database
class Object
trait Matchable
class Any

Types

Generated with