Configuration

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

Instance Constructors

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, preparedStatementCacheSize: Int = 64, preparedStatementExpireTime: Duration = 60.seconds, eventLoopGroup: EventLoopGroup = NettyUtils.DefaultEventLoopGroup, channelClass: Class[_ <: SocketChannel] = NettyUtils.SocketChannelClass, 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

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val allocator: ByteBufAllocator

the netty buffer allocator to be used
final def asInstanceOf[T0]: T0

Definition Classes
Any
val channelClass: Class[_ <: SocketChannel]
val charset: Charset

charset for the connection, defaults to UTF-8, make sure you know what you are doing if you change this
def clone(): AnyRef

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

the timeout for connecting to servers
val database: Option[String]

database name, defaults to no database
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val eventLoopGroup: EventLoopGroup
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val host: String

database host, defaults to "localhost"
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val password: Option[String]

password, defaults to no password
val port: Int

database port, defaults to 5432
val preparedStatementCacheSize: Int
val preparedStatementExpireTime: Duration
val queryTimeout: Option[Duration]

the optional query timeout
val ssl: SSLConfiguration

ssl configuration
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val testTimeout: Duration

the timeout for connection tests performed by pools
val username: String

database username
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Configuration | package db

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allocator: ByteBufAllocator

final def asInstanceOf[T0]: T0

val channelClass: Class[_ <: SocketChannel]

val charset: Charset

def clone(): AnyRef

val connectTimeout: Duration

val database: Option[String]

final def eq(arg0: AnyRef): Boolean

val eventLoopGroup: EventLoopGroup

def finalize(): Unit

final def getClass(): Class[_]

val host: String

final def isInstanceOf[T0]: Boolean

val maximumMessageSize: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val password: Option[String]

val port: Int

val preparedStatementCacheSize: Int

val preparedStatementExpireTime: Duration

val queryTimeout: Option[Duration]

val ssl: SSLConfiguration

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

val testTimeout: Duration

val username: String

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped