Class/Object

com.github.mauricio.async.db

Configuration

Related Docs: object Configuration | package db

Permalink

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, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Configuration
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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)

    Permalink

    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. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allocator: ByteBufAllocator

    Permalink

    the netty buffer allocator to be used

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val charset: Charset

    Permalink

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

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val connectTimeout: Duration

    Permalink

    the timeout for connecting to servers

  9. val database: Option[String]

    Permalink

    database name, defaults to no database

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. val host: String

    Permalink

    database host, defaults to "localhost"

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. val maximumMessageSize: Int

    Permalink

    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.

    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.

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val password: Option[String]

    Permalink

    password, defaults to no password

  20. val port: Int

    Permalink

    database port, defaults to 5432

  21. val queryTimeout: Option[Duration]

    Permalink

    the optional query timeout

  22. val ssl: SSLConfiguration

    Permalink

    ssl configuration

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. val testTimeout: Duration

    Permalink

    the timeout for connection tests performed by pools

  25. val username: String

    Permalink

    database username

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped