PostgresqlConnectionConfiguration.Builder (Reactive Relational Database Connectivity

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)` Registers a `CodecRegistrar` that can contribute extension `Codec`s.
`PostgresqlConnectionConfiguration.Builder`	`compatibilityMode(boolean compatibilityMode)` Enables protocol compatibility mode for cursored query execution.
`PostgresqlConnectionConfiguration.Builder`	`connectTimeout(Duration connectTimeout)` Configures the connection timeout.
`PostgresqlConnectionConfiguration.Builder`	`database(String database)` Configure the database.
`PostgresqlConnectionConfiguration.Builder`	`enableSsl()` Enable SSL usage.
`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`	`lockWaitTimeout(Duration lockWaitTimeout)` Configure the Lock wait timeout.
`PostgresqlConnectionConfiguration.Builder`	`loopResources(reactor.netty.resources.LoopResources loopResources)` Configure `LoopResources`.
`PostgresqlConnectionConfiguration.Builder`	`options(Map<String,String> options)` Configure connection initialization parameters.
`PostgresqlConnectionConfiguration.Builder`	`password(CharSequence password)` Configure the password.
`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(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`	`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`	`sslPassword(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`	`statementTimeout(Duration statementTimeout)` Configure the Statement timeout.
`PostgresqlConnectionConfiguration.Builder`	`tcpKeepAlive(boolean enabled)` Configure TCP KeepAlive.
`PostgresqlConnectionConfiguration.Builder`	`tcpNoDelay(boolean enabled)` Configure TCP NoDelay.
`String`	`toString()`
`PostgresqlConnectionConfiguration.Builder`	`username(String username)` Configure the username.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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)
```
    Configures the connection timeout. Default unconfigured.
    
    Parameters:
    
    connectTimeout - the connection timeout
    
    Returns:
    
    this PostgresqlConnectionConfiguration.Builder
  - codecRegistrar
```
public PostgresqlConnectionConfiguration.Builder codecRegistrar(CodecRegistrar codecRegistrar)
```
    Registers 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
  - 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.8.2
  - 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.8.2
  - 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.
    
    Parameters:
    
    host - the host
    
    Returns:
    
    this PostgresqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if host is null
  - 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
  - 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
  - port
```
public PostgresqlConnectionConfiguration.Builder port(int port)
```
    Configure the port. Defaults to 5432.
    
    Parameters:
    
    port - the port
    
    Returns:
    
    this PostgresqlConnectionConfiguration.Builder
  - 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
    
    Throws:
    
    IllegalArgumentException - if username is null
    
    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.
    
    Parameters:
    
    socket - the socket path
    
    Returns:
    
    this PostgresqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if socket is null
  - 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
  - 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
  - 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
  - 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)
  - username
```
public PostgresqlConnectionConfiguration.Builder username(String username)
```
    Configure the username.
    
    Parameters:
    
    username - the username
    
    Returns:
    
    this PostgresqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if username is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PostgresqlConnectionConfiguration.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

applicationName

autodetectExtensions

build

compatibilityMode

connectTimeout

codecRegistrar

database

enableSsl

extendWith

fetchSize

fetchSize

forceBinary

host

lockWaitTimeout

loopResources

options

password

port

preferAttachedBuffers

preparedStatementCacheQueries

schema

socket

sslContextBuilderCustomizer

sslCert

sslCert

sslHostnameVerifier

sslKey

sslKey

sslMode

sslPassword

sslRootCert

sslRootCert

statementTimeout

tcpKeepAlive

tcpNoDelay

username

toString