Package org.springframework.boot.r2dbc
Class ConnectionFactoryBuilder
java.lang.Object
org.springframework.boot.r2dbc.ConnectionFactoryBuilder
Builder for
ConnectionFactory
.- Since:
- 2.5.0
- Author:
- Mark Paluch, Tadaya Tsuyukubo, Stephane Nicoll, Andy Wilkinson, Moritz Halbritter
-
Method Summary
Modifier and TypeMethodDescriptionio.r2dbc.spi.ConnectionFactory
build()
Build aConnectionFactory
based on the state of this builder.io.r2dbc.spi.ConnectionFactoryOptions
Build aConnectionFactoryOptions
based on the state of this builder.Configure additional options.Configure the database.decorator
(ConnectionFactoryDecorator decorator) Add adecorator
.decorators
(Iterable<ConnectionFactoryDecorator> decorators) Adddecorators
.static ConnectionFactoryBuilder
derivedFrom
(io.r2dbc.spi.ConnectionFactory connectionFactory) Initialize a newConnectionFactoryBuilder
derived from the options of the specifiedconnectionFactory
.Configure the host name.password
(CharSequence password) Configure the password.port
(int port) Configure the port.Configure the username.static ConnectionFactoryBuilder
withOptions
(io.r2dbc.spi.ConnectionFactoryOptions.Builder options) Initialize a newConnectionFactoryBuilder
based on the specifiedoptions
.static ConnectionFactoryBuilder
Initialize a newConnectionFactoryBuilder
based on the specified R2DBC url.
-
Method Details
-
withUrl
Initialize a newConnectionFactoryBuilder
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:
-
withOptions
public static ConnectionFactoryBuilder withOptions(io.r2dbc.spi.ConnectionFactoryOptions.Builder options) Initialize a newConnectionFactoryBuilder
based on the specifiedoptions
.- Parameters:
options
- the options to use to initialize the builder- Returns:
- a new builder initialized with the settings defined in the given
options
-
derivedFrom
public static ConnectionFactoryBuilder derivedFrom(io.r2dbc.spi.ConnectionFactory connectionFactory) Initialize a newConnectionFactoryBuilder
derived from the options of the specifiedconnectionFactory
.- 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
- aConsumer
to customize the options- Returns:
- this for method chaining
-
username
Configure the username.- Parameters:
username
- the connection factory username- Returns:
- this for method chaining
-
password
Configure the password.- Parameters:
password
- the connection factory password- Returns:
- this for method chaining
-
hostname
Configure the host name.- Parameters:
host
- the connection factory hostname- Returns:
- this for method chaining
-
port
Configure the port.- Parameters:
port
- the connection factory port- Returns:
- this for method chaining
-
database
Configure the database.- Parameters:
database
- the connection factory database- Returns:
- this for method chaining
-
decorator
Add adecorator
.- Parameters:
decorator
- the decorator to add- Returns:
- this for method chaining
- Since:
- 3.2.0
-
decorators
Adddecorators
.- Parameters:
decorators
- the decorators to add- Returns:
- this for method chaining
- Since:
- 3.2.0
-
build
public io.r2dbc.spi.ConnectionFactory build()Build aConnectionFactory
based on the state of this builder.- Returns:
- a connection factory
-
buildOptions
public io.r2dbc.spi.ConnectionFactoryOptions buildOptions()Build aConnectionFactoryOptions
based on the state of this builder.- Returns:
- the options
-