org.springframework.boot.r2dbc

Class ConnectionFactoryBuilder

java.lang.Object

org.springframework.boot.r2dbc.ConnectionFactoryBuilder

public final class ConnectionFactoryBuilder
extends Object

Builder for ConnectionFactory.

Since:

2.5.0

Author:

Mark Paluch, Tadaya Tsuyukubo, Stephane Nicoll, Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
io.r2dbc.spi.ConnectionFactory	build() Build a ConnectionFactory based on the state of this builder.
io.r2dbc.spi.ConnectionFactoryOptions	buildOptions() Build a ConnectionFactoryOptions based on the state of this builder.
ConnectionFactoryBuilder	configure(Consumer<io.r2dbc.spi.ConnectionFactoryOptions.Builder> options) Configure additional options.
ConnectionFactoryBuilder	database(String database) Configure the database.
static ConnectionFactoryBuilder	derivedFrom(io.r2dbc.spi.ConnectionFactory connectionFactory) Initialize a new ConnectionFactoryBuilder derived from the options of the specified connectionFactory.
static ConnectionFactoryBuilder	derivefrom(io.r2dbc.spi.ConnectionFactory connectionFactory) Deprecated. since 2.5.1 for removal in 2.7.0 in favor of derivedFrom(ConnectionFactory)
ConnectionFactoryBuilder	hostname(String host) Configure the host name.
ConnectionFactoryBuilder	password(CharSequence password) Configure the password.
ConnectionFactoryBuilder	port(int port) Configure the port.
ConnectionFactoryBuilder	username(String username) Configure the username.
static ConnectionFactoryBuilder	withOptions(io.r2dbc.spi.ConnectionFactoryOptions.Builder options) Initialize a new ConnectionFactoryBuilder based on the specified options.
static ConnectionFactoryBuilder	withUrl(String url) Initialize a new ConnectionFactoryBuilder based on the specified R2DBC url.

Methods inherited from class java.lang.Object

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

Method Detail

withUrl

public static ConnectionFactoryBuilder withUrl(String url)

Initialize a new ConnectionFactoryBuilder based on the specified R2DBC url.

Parameters:

url - the url to use

Returns:

a new builder initialized with the options exposed in the specified url

See Also:

EmbeddedDatabaseConnection.getUrl(String)

withOptions

public static ConnectionFactoryBuilder withOptions(io.r2dbc.spi.ConnectionFactoryOptions.Builder options)

Initialize a new ConnectionFactoryBuilder based on the specified options.

Parameters:

options - the options to use to initialize the builder

Returns:

a new builder initialized with the settings defined in the given options

derivefrom

@Deprecated
public static ConnectionFactoryBuilder derivefrom(io.r2dbc.spi.ConnectionFactory connectionFactory)

Deprecated. since 2.5.1 for removal in 2.7.0 in favor of derivedFrom(ConnectionFactory)

Initialize a new ConnectionFactoryBuilder derived from the options of the specified connectionFactory.

Parameters:

connectionFactory - the connection factory whose options are to be used to initialize the builder

Returns:

a new builder initialized with the options from the connection factory

derivedFrom

public static ConnectionFactoryBuilder derivedFrom(io.r2dbc.spi.ConnectionFactory connectionFactory)

Initialize a new ConnectionFactoryBuilder derived from the options of the specified connectionFactory.

Parameters:

connectionFactory - the connection factory whose options are to be used to initialize the builder

Returns:

a new builder initialized with the options from the connection factory

Since:

2.5.1

configure

public ConnectionFactoryBuilder configure(Consumer<io.r2dbc.spi.ConnectionFactoryOptions.Builder> options)

Configure additional options.

Parameters:

options - a Consumer to customize the options

Returns:

this for method chaining

username

public ConnectionFactoryBuilder username(String username)

Configure the username.

Parameters:

username - the connection factory username

Returns:

this for method chaining

password

public ConnectionFactoryBuilder password(CharSequence password)

Configure the password.

Parameters:

password - the connection factory password

Returns:

this for method chaining

hostname

public ConnectionFactoryBuilder hostname(String host)

Configure the host name.

Parameters:

host - the connection factory hostname

Returns:

this for method chaining

port

public ConnectionFactoryBuilder port(int port)

Configure the port.

Parameters:

port - the connection factory port

Returns:

this for method chaining

database

public ConnectionFactoryBuilder database(String database)

Configure the database.

Parameters:

database - the connection factory database

Returns:

this for method chaining

build

public io.r2dbc.spi.ConnectionFactory build()

Build a ConnectionFactory based on the state of this builder.

Returns:

a connection factory

buildOptions

public io.r2dbc.spi.ConnectionFactoryOptions buildOptions()

Build a ConnectionFactoryOptions based on the state of this builder.

Returns:

the options