Package 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, Moritz Halbritter

  • Method Details

    • 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:

    • 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

    • 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

    • decorator

      public ConnectionFactoryBuilder decorator(ConnectionFactoryDecorator decorator)
      Add a decorator.
      Parameters:
      decorator - the decorator to add
      Returns:
      this for method chaining
      Since:
      3.2.0

    • decorators

      public ConnectionFactoryBuilder decorators(Iterable<ConnectionFactoryDecorator> decorators)
      Add decorators.
      Parameters:
      decorators - the decorators to add
      Returns:
      this for method chaining
      Since:
      3.2.0

    • 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