Packages

case class Configuration(username: String, host: String = "localhost", port: Int = 5432, password: Option[String] = None, database: Option[String] = None, ssl: SSLConfiguration = SSLConfiguration(), charset: Charset = Configuration.DefaultCharset, maximumMessageSize: Int = 16777216, allocator: ByteBufAllocator = PooledByteBufAllocator.DEFAULT, connectTimeout: Duration = 5.seconds, testTimeout: Duration = 5.seconds, queryTimeout: Option[Duration] = None) extends Product with Serializable

Contains the configuration necessary to connect to a database.

username

database username

host

database host, defaults to "localhost"

port

database port, defaults to 5432

password

password, defaults to no password

database

database name, defaults to no database

ssl

ssl configuration

charset

charset for the connection, defaults to UTF-8, make sure you know what you are doing if you change this

maximumMessageSize

the maximum size a message from the server could possibly have, this limits possible OOM or eternal loop attacks the client could have, defaults to 16 MB. You can set this to any value you would like but again, make sure you know what you are doing if you do change it.

allocator

the netty buffer allocator to be used

connectTimeout

the timeout for connecting to servers

testTimeout

the timeout for connection tests performed by pools

queryTimeout

the optional query timeout

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Configuration
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Configuration(username: String, host: String = "localhost", port: Int = 5432, password: Option[String] = None, database: Option[String] = None, ssl: SSLConfiguration = SSLConfiguration(), charset: Charset = Configuration.DefaultCharset, maximumMessageSize: Int = 16777216, allocator: ByteBufAllocator = PooledByteBufAllocator.DEFAULT, connectTimeout: Duration = 5.seconds, testTimeout: Duration = 5.seconds, queryTimeout: Option[Duration] = None)

    username

    database username

    host

    database host, defaults to "localhost"

    port

    database port, defaults to 5432

    password

    password, defaults to no password

    database

    database name, defaults to no database

    ssl

    ssl configuration

    charset

    charset for the connection, defaults to UTF-8, make sure you know what you are doing if you change this

    maximumMessageSize

    the maximum size a message from the server could possibly have, this limits possible OOM or eternal loop attacks the client could have, defaults to 16 MB. You can set this to any value you would like but again, make sure you know what you are doing if you do change it.

    allocator

    the netty buffer allocator to be used

    connectTimeout

    the timeout for connecting to servers

    testTimeout

    the timeout for connection tests performed by pools

    queryTimeout

    the optional query timeout

Value Members

  1. val allocator: ByteBufAllocator
  2. val charset: Charset
  3. val connectTimeout: Duration
  4. val database: Option[String]
  5. val host: String
  6. val maximumMessageSize: Int
  7. val password: Option[String]
  8. val port: Int
  9. def productElementNames: Iterator[String]
    Definition Classes
    Product
  10. val queryTimeout: Option[Duration]
  11. val ssl: SSLConfiguration
  12. val testTimeout: Duration
  13. val username: String