com.github.mauricio.async.db

Configuration

case class Configuration(username: String, host: String = "localhost", port: Int = 5432, password: Option[String] = scala.None, database: Option[String] = scala.None, ssl: SSLConfiguration = ..., charset: Charset = Configuration.DefaultCharset, maximumMessageSize: Int = 16777216, allocator: ByteBufAllocator = ..., connectTimeout: Duration = ..., testTimeout: Duration = ..., queryTimeout: Option[Duration] = scala.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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Configuration(username: String, host: String = "localhost", port: Int = 5432, password: Option[String] = scala.None, database: Option[String] = scala.None, ssl: SSLConfiguration = ..., charset: Charset = Configuration.DefaultCharset, maximumMessageSize: Int = 16777216, allocator: ByteBufAllocator = ..., connectTimeout: Duration = ..., testTimeout: Duration = ..., queryTimeout: Option[Duration] = scala.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. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val allocator: ByteBufAllocator

    the netty buffer allocator to be used

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. val charset: Charset

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

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val connectTimeout: Duration

    the timeout for connecting to servers

  11. val database: Option[String]

    database name, defaults to no database

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

    Definition Classes
    AnyRef

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. val host: String

    database host, defaults to "localhost"

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. val maximumMessageSize: Int

    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.

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

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val password: Option[String]

    password, defaults to no password

  22. val port: Int

    database port, defaults to 5432

  23. val queryTimeout: Option[Duration]

    the optional query timeout

  24. val ssl: SSLConfiguration

    ssl configuration

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

    Definition Classes
    AnyRef

  26. val testTimeout: Duration

    the timeout for connection tests performed by pools

  27. val username: String

    database username

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped