Class PostgresqlConnectionConfiguration.Builder

java.lang.Object

io.r2dbc.postgresql.PostgresqlConnectionConfiguration.Builder

Enclosing class:

PostgresqlConnectionConfiguration

public static final class PostgresqlConnectionConfiguration.Builder
extends Object

A builder for PostgresqlConnectionConfiguration instances.

This class is not threadsafe

Method Summary

Modifier and Type	Method	Description
PostgresqlConnectionConfiguration.Builder	addHost(String host)	Add host with default port to the hosts list.
PostgresqlConnectionConfiguration.Builder	addHost(String host, int port)	Add host to the hosts list.
PostgresqlConnectionConfiguration.Builder	applicationName(String applicationName)	Configure the application name.
PostgresqlConnectionConfiguration.Builder	autodetectExtensions(boolean autodetectExtensions)	Configures whether to use ServiceLoader to discover and register extensions.
PostgresqlConnectionConfiguration	build()	Returns a configured PostgresqlConnectionConfiguration.
PostgresqlConnectionConfiguration.Builder	codecRegistrar(CodecRegistrar codecRegistrar)	Register a CodecRegistrar that can contribute extension Codecs.
PostgresqlConnectionConfiguration.Builder	compatibilityMode(boolean compatibilityMode)	Enables protocol compatibility mode for cursored query execution.
PostgresqlConnectionConfiguration.Builder	connectTimeout(@Nullable Duration connectTimeout)	Configure the connection timeout.
PostgresqlConnectionConfiguration.Builder	database(@Nullable String database)	Configure the database.
PostgresqlConnectionConfiguration.Builder	enableSsl()	Enable SSL usage.
PostgresqlConnectionConfiguration.Builder	errorResponseLogLevel(io.r2dbc.postgresql.util.LogLevel errorResponseLogLevel)	Configure the LogLevel for error responses that are part of a statement execution.
PostgresqlConnectionConfiguration.Builder	extendWith(Extension extension)	Registers a Extension to extend driver functionality.
PostgresqlConnectionConfiguration.Builder	fetchSize(int fetchSize)	Set the default number of rows to return when fetching results from a query.
PostgresqlConnectionConfiguration.Builder	fetchSize(ToIntFunction<String> fetchSizeFunction)	Set a function that maps a SQL query to the number of rows to return when fetching results for that query.
PostgresqlConnectionConfiguration.Builder	forceBinary(boolean forceBinary)	Force binary results (Binary Transfer).
PostgresqlConnectionConfiguration.Builder	host(String host)	Configure the host.
PostgresqlConnectionConfiguration.Builder	hostRecheckTime(Duration hostRecheckTime)	Controls how long the knowledge about a host state is cached connection factory.
PostgresqlConnectionConfiguration.Builder	loadBalanceHosts(boolean loadBalanceHosts)	In default mode (disabled) hosts are connected in the given order.
PostgresqlConnectionConfiguration.Builder	lockWaitTimeout(Duration lockWaitTimeout)	Configure the Lock wait timeout.
PostgresqlConnectionConfiguration.Builder	loopResources(reactor.netty.resources.LoopResources loopResources)	Configure LoopResources.
PostgresqlConnectionConfiguration.Builder	noticeLogLevel(io.r2dbc.postgresql.util.LogLevel noticeLogLevel)	Configure the LogLevel for notice responses.
PostgresqlConnectionConfiguration.Builder	options(Map<String,String> options)	Configure connection initialization parameters.
PostgresqlConnectionConfiguration.Builder	password(@Nullable CharSequence password)	Configure the password.
PostgresqlConnectionConfiguration.Builder	password(Supplier<CharSequence> password)	Configure the password supplier.
PostgresqlConnectionConfiguration.Builder	password(Publisher<CharSequence> password)	Configure the password publisher.
PostgresqlConnectionConfiguration.Builder	port(int port)	Configure the port.
PostgresqlConnectionConfiguration.Builder	preferAttachedBuffers(boolean preferAttachedBuffers)	Configure whether codecs should prefer attached data buffers.
PostgresqlConnectionConfiguration.Builder	preparedStatementCacheQueries(int preparedStatementCacheQueries)	Configure the preparedStatementCacheQueries.
PostgresqlConnectionConfiguration.Builder	schema(@Nullable String schema)	Configure the schema.
PostgresqlConnectionConfiguration.Builder	socket(String socket)	Configure the unix domain socket to connect to.
PostgresqlConnectionConfiguration.Builder	sslCert(String sslCert)	Configure ssl cert for client certificate authentication.
PostgresqlConnectionConfiguration.Builder	sslCert(URL sslCert)	Configure ssl cert for client certificate authentication.
PostgresqlConnectionConfiguration.Builder	sslContextBuilderCustomizer(Function<io.netty.handler.ssl.SslContextBuilder, io.netty.handler.ssl.SslContextBuilder> sslContextBuilderCustomizer)	Configure a SslContextBuilder customizer.
PostgresqlConnectionConfiguration.Builder	sslEngineCustomizer(Function<SSLEngine, SSLEngine> sslEngineCustomizer)	Configure a SSLEngine customizer.
PostgresqlConnectionConfiguration.Builder	sslHostnameVerifier(HostnameVerifier sslHostnameVerifier)	Configure ssl HostnameVerifier.
PostgresqlConnectionConfiguration.Builder	sslKey(String sslKey)	Configure ssl key for client certificate authentication.
PostgresqlConnectionConfiguration.Builder	sslKey(URL sslKey)	Configure ssl key for client certificate authentication.
PostgresqlConnectionConfiguration.Builder	sslMode(io.r2dbc.postgresql.client.SSLMode sslMode)	Configure ssl mode.
PostgresqlConnectionConfiguration.Builder	sslNegotiation(io.r2dbc.postgresql.client.SSLNegotiation sslNegotiation)	Configure ssl negotiation.
PostgresqlConnectionConfiguration.Builder	sslParameters(Function<SocketAddress, SSLParameters> sslParametersFactory)	Configure a SSLParameters provider for a given SocketAddress.
PostgresqlConnectionConfiguration.Builder	sslPassword(@Nullable CharSequence sslPassword)	Configure ssl password.
PostgresqlConnectionConfiguration.Builder	sslRootCert(String sslRootCert)	Configure ssl root cert for server certificate validation.
PostgresqlConnectionConfiguration.Builder	sslRootCert(URL sslRootCert)	Configure ssl root cert for server certificate validation.
PostgresqlConnectionConfiguration.Builder	sslSni(boolean sslSni)	Configure whether to indicate the hostname and port via SNI to the server.
PostgresqlConnectionConfiguration.Builder	statementTimeout(Duration statementTimeout)	Configure the Statement timeout.
PostgresqlConnectionConfiguration.Builder	targetServerType(MultiHostConnectionStrategy.TargetServerType targetServerType)	Allows opening connections to only servers with required state.
PostgresqlConnectionConfiguration.Builder	tcpKeepAlive(boolean enabled)	Configure TCP KeepAlive.
PostgresqlConnectionConfiguration.Builder	tcpNoDelay(boolean enabled)	Configure TCP NoDelay.
PostgresqlConnectionConfiguration.Builder	timeZone(String timeZone)	Configure the session timezone.
PostgresqlConnectionConfiguration.Builder	timeZone(TimeZone timeZone)	Configure the session timezone.
String	toString()
PostgresqlConnectionConfiguration.Builder	username(String username)	Configure the username.
PostgresqlConnectionConfiguration.Builder	username(Supplier<String> username)	Configure the username supplier.
PostgresqlConnectionConfiguration.Builder	username(Publisher<String> username)	Configure the username publisher.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

applicationName

public PostgresqlConnectionConfiguration.Builder applicationName(String applicationName)

Configure the application name. Defaults to postgresql-r2dbc.

Parameters:

applicationName - the application name

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if applicationName is null

autodetectExtensions

public PostgresqlConnectionConfiguration.Builder autodetectExtensions(boolean autodetectExtensions)

Configures whether to use ServiceLoader to discover and register extensions. Defaults to true.

Parameters:

autodetectExtensions - to discover and register extensions

Returns:

this PostgresqlConnectionConfiguration.Builder

build

public PostgresqlConnectionConfiguration build()

Returns a configured PostgresqlConnectionConfiguration.

Returns:

a configured PostgresqlConnectionConfiguration

compatibilityMode

public PostgresqlConnectionConfiguration.Builder compatibilityMode(boolean compatibilityMode)

Enables protocol compatibility mode for cursored query execution. Cursored query execution applies when configuring a non-zero fetch size. Compatibility mode uses Execute+Sync messages instead of Execute+Flush. The default mode uses optimized fetching which does not work with newer pgpool versions.

Parameters:

compatibilityMode - whether to enable compatibility mode

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.7

connectTimeout

public PostgresqlConnectionConfiguration.Builder connectTimeout(@Nullable Duration connectTimeout)

Configure the connection timeout. Default unconfigured.

Parameters:

connectTimeout - the connection timeout

Returns:

this PostgresqlConnectionConfiguration.Builder

codecRegistrar

public PostgresqlConnectionConfiguration.Builder codecRegistrar(CodecRegistrar codecRegistrar)

Register a CodecRegistrar that can contribute extension Codecs. Calling this method adds a CodecRegistrar and does not replace existing Extensions.

Parameters:

codecRegistrar - registrar to contribute codecs

Returns:

this PostgresqlConnectionConfiguration.Builder

database

public PostgresqlConnectionConfiguration.Builder database(@Nullable String database)

Configure the database.

Parameters:

database - the database

Returns:

this PostgresqlConnectionConfiguration.Builder

enableSsl

public PostgresqlConnectionConfiguration.Builder enableSsl()

Enable SSL usage. This flag is also known as Use Encryption in other drivers.

Returns:

this PostgresqlConnectionConfiguration.Builder

extendWith

public PostgresqlConnectionConfiguration.Builder extendWith(Extension extension)

Registers a Extension to extend driver functionality. Calling this method adds a Extension and does not replace existing Extensions.

Parameters:

extension - extension to extend driver functionality

Returns:

this PostgresqlConnectionConfiguration.Builder

errorResponseLogLevel

public PostgresqlConnectionConfiguration.Builder errorResponseLogLevel(io.r2dbc.postgresql.util.LogLevel errorResponseLogLevel)

Configure the LogLevel for error responses that are part of a statement execution.

Parameters:

errorResponseLogLevel - the log level to use.

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.9

fetchSize

public PostgresqlConnectionConfiguration.Builder fetchSize(int fetchSize)

Set the default number of rows to return when fetching results from a query. If the value specified is zero, then the hint is ignored and queries request all rows when running a statement.

Parameters:

fetchSize - the number of rows to fetch

Returns:

this Builder

Throws:

IllegalArgumentException - if fetchSize is negative

Since:

0.9

fetchSize

public PostgresqlConnectionConfiguration.Builder fetchSize(ToIntFunction<String> fetchSizeFunction)

Set a function that maps a SQL query to the number of rows to return when fetching results for that query.

Parameters:

fetchSizeFunction - a function that maps the number of rows to fetch

Returns:

this Builder

Throws:

IllegalArgumentException - if fetchSizeFunction is null

Since:

0.9

forceBinary

public PostgresqlConnectionConfiguration.Builder forceBinary(boolean forceBinary)

Force binary results (Binary Transfer). Defaults to false.

Parameters:

forceBinary - whether to force binary transfer

Returns:

this PostgresqlConnectionConfiguration.Builder

host

public PostgresqlConnectionConfiguration.Builder host(String host)

Configure the host. Calling this method prepares single-node configuration. This method can be only used if the builder was not configured with a multi-host configuration.

Parameters:

host - the host

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if host is null

IllegalStateException - if addHost(String), targetServerType(MultiHostConnectionStrategy.TargetServerType) or hostRecheckTime(Duration) was configured earlier to ensure a consistent configuration state

addHost

public PostgresqlConnectionConfiguration.Builder addHost(String host)

Add host with default port to the hosts list. Calling this method prepares multi-node configuration. This method can be only used if the builder was not configured with a single-host configuration.

Parameters:

host - the host

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if host is null

IllegalStateException - if port(int), host(String) or socket(String) was configured earlier to ensure a consistent configuration state

Since:

1.0

addHost

public PostgresqlConnectionConfiguration.Builder addHost(String host,
 int port)

Add host to the hosts list. Calling this method prepares multi-node configuration. This method can be only used if the builder was not configured with a single-host configuration.

Parameters:

host - the host

port - the port

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if host is null

IllegalStateException - if port(int), host(String) or socket(String) was configured earlier to ensure a consistent configuration state

Since:

1.0

hostRecheckTime

public PostgresqlConnectionConfiguration.Builder hostRecheckTime(Duration hostRecheckTime)

Controls how long the knowledge about a host state is cached connection factory. The default value is 10 seconds. Calling this method prepares multi-node configuration. This method can be only used if the builder was not configured with a single-host configuration.

Parameters:

hostRecheckTime - host recheck time

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalStateException - if port(int), host(String) or socket(String) was configured earlier to ensure a consistent configuration state

Since:

1.0

loadBalanceHosts

public PostgresqlConnectionConfiguration.Builder loadBalanceHosts(boolean loadBalanceHosts)

In default mode (disabled) hosts are connected in the given order. If enabled hosts are chosen randomly from the set of suitable candidates. Calling this method prepares multi-node configuration. This method can be only used if the builder was not configured with a single-host configuration.

Parameters:

loadBalanceHosts - is load balance mode enabled

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalStateException - if port(int), host(String) or socket(String) was configured earlier to ensure a consistent configuration state

Since:

1.0

lockWaitTimeout

public PostgresqlConnectionConfiguration.Builder lockWaitTimeout(Duration lockWaitTimeout)

Configure the Lock wait timeout. Default unconfigured.

This parameter is applied once after creating a new connection. If lockTimeout is already set using options(Map), it will be overridden. Lock Timeout

Parameters:

lockWaitTimeout - the lock timeout

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.9

loopResources

public PostgresqlConnectionConfiguration.Builder loopResources(reactor.netty.resources.LoopResources loopResources)

Configure LoopResources.

Parameters:

loopResources - the LoopResources

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.5

noticeLogLevel

public PostgresqlConnectionConfiguration.Builder noticeLogLevel(io.r2dbc.postgresql.util.LogLevel noticeLogLevel)

Configure the LogLevel for notice responses.

Parameters:

noticeLogLevel - the log level to use.

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.9

options

public PostgresqlConnectionConfiguration.Builder options(Map<String,String> options)

Configure connection initialization parameters.

These parameters are applied once after creating a new connection. This is useful for setting up client-specific runtime parameters like statement timeouts, time zones etc.

Parameters:

options - the options

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if options or any key or value of options is null

password

public PostgresqlConnectionConfiguration.Builder password(@Nullable CharSequence password)

Configure the password.

Parameters:

password - the password

Returns:

this PostgresqlConnectionConfiguration.Builder

password

public PostgresqlConnectionConfiguration.Builder password(Publisher<CharSequence> password)

Configure the password publisher. The publisher is used on each authentication attempt.

Parameters:

password - the password

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

1.0.3

password

public PostgresqlConnectionConfiguration.Builder password(Supplier<CharSequence> password)

Configure the password supplier. The supplier is used on each authentication attempt.

Parameters:

password - the password

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

1.0.3

port

public PostgresqlConnectionConfiguration.Builder port(int port)

Configure the port. Defaults to 5432. Calling this method prepares single-node configuration. This method can be only used if the builder was not configured with a multi-host configuration.

Parameters:

port - the port

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalStateException - if addHost(String), targetServerType(MultiHostConnectionStrategy.TargetServerType) or hostRecheckTime(Duration) was configured earlier to ensure a consistent configuration state

preferAttachedBuffers

public PostgresqlConnectionConfiguration.Builder preferAttachedBuffers(boolean preferAttachedBuffers)

Configure whether codecs should prefer attached data buffers. The default is false, meaning that codecs will copy data from the input buffer into a byte[] or similar data structure that is enabled for garbage collection. Using attached buffers is more efficient but comes with the requirement that decoded values (such as Json) must be consumed to release attached buffers to avoid memory leaks.

Parameters:

preferAttachedBuffers - the flag whether to prefer attached buffers

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.5

preparedStatementCacheQueries

public PostgresqlConnectionConfiguration.Builder preparedStatementCacheQueries(int preparedStatementCacheQueries)

Configure the preparedStatementCacheQueries. The default is -1, meaning there's no limit. The value of 0 disables the cache. Any other value specifies the cache size.

Parameters:

preparedStatementCacheQueries - the preparedStatementCacheQueries

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.1

schema

public PostgresqlConnectionConfiguration.Builder schema(@Nullable String schema)

Configure the schema.

Parameters:

schema - the schema

Returns:

this PostgresqlConnectionConfiguration.Builder

socket

public PostgresqlConnectionConfiguration.Builder socket(String socket)

Configure the unix domain socket to connect to. Calling this method prepares single-node configuration. This method can be only used if the builder was not configured with a multi-host configuration.

Parameters:

socket - the socket path

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if socket is null

IllegalStateException - if addHost(String), targetServerType(MultiHostConnectionStrategy.TargetServerType) or hostRecheckTime(Duration) was configured earlier to ensure a consistent configuration state

sslContextBuilderCustomizer

public PostgresqlConnectionConfiguration.Builder sslContextBuilderCustomizer(Function<io.netty.handler.ssl.SslContextBuilder, io.netty.handler.ssl.SslContextBuilder> sslContextBuilderCustomizer)

Configure a SslContextBuilder customizer. The customizer gets applied on each SSL connection attempt to allow for just-in-time configuration updates. The Function gets called with the prepared SslContextBuilder that has all configuration options applied. The customizer may return the same builder or return a new builder instance to be used to build the SSL context.

Parameters:

sslContextBuilderCustomizer - customizer function

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if sslContextBuilderCustomizer is null

sslEngineCustomizer

public PostgresqlConnectionConfiguration.Builder sslEngineCustomizer(Function<SSLEngine, SSLEngine> sslEngineCustomizer)

Configure a SSLEngine customizer. The customizer gets applied on each SSL connection attempt to allow for just-in-time configuration updates. The Function gets called with a SSLEngine instance that has all configuration options applied. The customizer may return the same builder or return a new builder instance to be used to build the SSL context.

Parameters:

sslEngineCustomizer - customizer function

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if sslEngineCustomizer is null

sslParameters

public PostgresqlConnectionConfiguration.Builder sslParameters(Function<SocketAddress, SSLParameters> sslParametersFactory)

Configure a SSLParameters provider for a given SocketAddress. The provider gets applied on each SSL connection attempt to allow for just-in-time configuration updates. Typically used to configure SSL protocols

Parameters:

sslParametersFactory - customizer function

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if sslParametersFactory is null

Since:

1.0.5

sslSni

public PostgresqlConnectionConfiguration.Builder sslSni(boolean sslSni)

Configure whether to indicate the hostname and port via SNI to the server. Enabled by default.

Parameters:

sslSni - whether to indicate the hostname and port via SNI. Sets SSLParameters.setServerNames(List) on the SSLParameters instance provided by sslParameters(Function).

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

1.0.5

sslCert

public PostgresqlConnectionConfiguration.Builder sslCert(String sslCert)

Configure ssl cert for client certificate authentication. Can point to either a resource within the classpath or a file.

Parameters:

sslCert - an X.509 certificate chain file in PEM format

Returns:

this PostgresqlConnectionConfiguration.Builder

sslCert

public PostgresqlConnectionConfiguration.Builder sslCert(URL sslCert)

Configure ssl cert for client certificate authentication.

Parameters:

sslCert - an X.509 certificate chain file in PEM format

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.7

sslHostnameVerifier

public PostgresqlConnectionConfiguration.Builder sslHostnameVerifier(HostnameVerifier sslHostnameVerifier)

Configure ssl HostnameVerifier.

Parameters:

sslHostnameVerifier - HostnameVerifier

Returns:

this PostgresqlConnectionConfiguration.Builder

sslKey

public PostgresqlConnectionConfiguration.Builder sslKey(String sslKey)

Configure ssl key for client certificate authentication. Can point to either a resource within the classpath or a file.

Parameters:

sslKey - a PKCS#8 private key file in PEM format

Returns:

this PostgresqlConnectionConfiguration.Builder

sslKey

public PostgresqlConnectionConfiguration.Builder sslKey(URL sslKey)

Configure ssl key for client certificate authentication.

Parameters:

sslKey - a PKCS#8 private key file in PEM format

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.7

sslMode

public PostgresqlConnectionConfiguration.Builder sslMode(io.r2dbc.postgresql.client.SSLMode sslMode)

Configure ssl mode.

Parameters:

sslMode - the SSL mode to use.

Returns:

this PostgresqlConnectionConfiguration.Builder

sslNegotiation

public PostgresqlConnectionConfiguration.Builder sslNegotiation(io.r2dbc.postgresql.client.SSLNegotiation sslNegotiation)

Configure ssl negotiation. Useful if the server is known to support SSL directly (e.g. Postgres 17+ or a SSL tunnel).

Parameters:

sslNegotiation - the SSL negotiation mechanism to use.

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

1.1

sslPassword

public PostgresqlConnectionConfiguration.Builder sslPassword(@Nullable CharSequence sslPassword)

Configure ssl password.

Parameters:

sslPassword - the password of the sslKey, or null if it's not password-protected

Returns:

this PostgresqlConnectionConfiguration.Builder

sslRootCert

public PostgresqlConnectionConfiguration.Builder sslRootCert(String sslRootCert)

Configure ssl root cert for server certificate validation. Can point to either a resource within the classpath or a file.

Parameters:

sslRootCert - an X.509 certificate chain file in PEM format

Returns:

this PostgresqlConnectionConfiguration.Builder

sslRootCert

public PostgresqlConnectionConfiguration.Builder sslRootCert(URL sslRootCert)

Configure ssl root cert for server certificate validation.

Parameters:

sslRootCert - an X.509 certificate chain file in PEM format

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.7

statementTimeout

public PostgresqlConnectionConfiguration.Builder statementTimeout(Duration statementTimeout)

Configure the Statement timeout. Default unconfigured.

This parameter is applied once after creating a new connection. If statementTimeout is already set using options(Map), it will be overridden. Statement Timeout

Parameters:

statementTimeout - the statement timeout

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.9

targetServerType

public PostgresqlConnectionConfiguration.Builder targetServerType(MultiHostConnectionStrategy.TargetServerType targetServerType)

Allows opening connections to only servers with required state. The primary/secondary distinction is currently done by observing if the server allows writes. The value MultiHostConnectionStrategy.TargetServerType.PREFER_SECONDARY tries to connect to a secondary if any are available, otherwise allows falls back to a primary. Default value is MultiHostConnectionStrategy.TargetServerType.ANY.

Parameters:

targetServerType - target server type

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if targetServerType is null

Since:

1.0

tcpKeepAlive

public PostgresqlConnectionConfiguration.Builder tcpKeepAlive(boolean enabled)

Configure TCP KeepAlive.

Parameters:

enabled - whether to enable TCP KeepAlive

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.4

See Also:

• Socket.setKeepAlive(boolean)

tcpNoDelay

public PostgresqlConnectionConfiguration.Builder tcpNoDelay(boolean enabled)

Configure TCP NoDelay.

Parameters:

enabled - whether to enable TCP NoDelay

Returns:

this PostgresqlConnectionConfiguration.Builder

Since:

0.8.4

See Also:

• Socket.setTcpNoDelay(boolean)

timeZone

public PostgresqlConnectionConfiguration.Builder timeZone(String timeZone)

Configure the session timezone.

Parameters:

timeZone - the timeZone identifier

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if timeZone is empty or null

Since:

1.0

See Also:

• TimeZone.getTimeZone(String)

timeZone

public PostgresqlConnectionConfiguration.Builder timeZone(TimeZone timeZone)

Configure the session timezone.

Parameters:

timeZone - the timeZone identifier

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if timeZone is null

Since:

1.0

See Also:

• TimeZone.getTimeZone(String)

username

public PostgresqlConnectionConfiguration.Builder username(String username)

Configure the username.

Parameters:

username - the username

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if username is null

username

public PostgresqlConnectionConfiguration.Builder username(Publisher<String> username)

Configure the username publisher. The publisher is used on each authentication attempt.

Parameters:

username - the username

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if username is null

username

public PostgresqlConnectionConfiguration.Builder username(Supplier<String> username)

Configure the username supplier. The supplier is used on each authentication attempt.

Parameters:

username - the username

Returns:

this PostgresqlConnectionConfiguration.Builder

Throws:

IllegalArgumentException - if username is null

toString

public String toString()

Overrides:

toString in class Object