io.r2dbc.h2

Class H2ConnectionConfiguration.Builder

java.lang.Object

io.r2dbc.h2.H2ConnectionConfiguration.Builder

Enclosing class:

H2ConnectionConfiguration

public static final class H2ConnectionConfiguration.Builder
extends Object

A builder for H2ConnectionConfiguration instances.

This class is not threadsafe

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
H2ConnectionConfiguration	build() Returns a configured H2ConnectionConfiguration.
H2ConnectionConfiguration.Builder	file(String path) Configure a file-based database, e.g.
H2ConnectionConfiguration.Builder	inMemory(String name) Configure an in-memory database, e.g.
H2ConnectionConfiguration.Builder	option(String option) Configure an option that is appended at the end, e.g.
H2ConnectionConfiguration.Builder	password(CharSequence password) Configure the password.
H2ConnectionConfiguration.Builder	property(H2ConnectionOption option, String value) Configure a property for H2 using pre-build H2ConnectionOption.
H2ConnectionConfiguration.Builder	property(String option, String value) Configure a property for H2.
H2ConnectionConfiguration.Builder	tcp(String host, int port, String path) Configure a TCP connection to a remote database
H2ConnectionConfiguration.Builder	tcp(String host, String path) Configure a TCP connection to a remote database.
String	toString()
H2ConnectionConfiguration.Builder	url(String url) Configure the database url.
H2ConnectionConfiguration.Builder	username(String username) Configure the username.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public H2ConnectionConfiguration build()

Returns a configured H2ConnectionConfiguration.

Returns:

a configured H2ConnectionConfiguration

file

public H2ConnectionConfiguration.Builder file(String path)

Configure a file-based database, e.g. ~/my-database or /path/to/my/database.db.

Parameters:

path - of the database file (automatically prefixed with file:)

Returns:

this H2ConnectionConfiguration.Builder

inMemory

public H2ConnectionConfiguration.Builder inMemory(String name)

Configure an in-memory database, e.g. my-test-database.

A in-memory database is shut down if the last connection gets closed. To avoid this behavior, configure either the H2ConnectionOption.DB_CLOSE_DELAY option through property(H2ConnectionOption, String) or use the H2ConnectionFactory.inMemory(String) connection factory to close the in-memory database by closing CloseableConnectionFactory externally.

Parameters:

name - of a private, in-memory database (automatically prefixed with mem:)

Returns:

this H2ConnectionConfiguration.Builder

tcp

public H2ConnectionConfiguration.Builder tcp(String host,
                                             String path)

Configure a TCP connection to a remote database.

Parameters:

host - - hostname of the remote database (can be localhost)

path - - path of the database, e.g. ~/test resolves to {user.home}/test.db

Returns:

this H2ConnectionConfiguration.Builder

tcp

public H2ConnectionConfiguration.Builder tcp(String host,
                                             int port,
                                             String path)

Configure a TCP connection to a remote database

Parameters:

host - - hostname of the remote database (can be localhost)

port - - port the database is serving from

path - - path of the database, e.g. ~/test resolves to {user.home}/test.db

Returns:

this H2ConnectionConfiguration.Builder

option

public H2ConnectionConfiguration.Builder option(String option)

Configure an option that is appended at the end, e.g. DB_CLOSE_DELAY=10, prefixed with ";".

Parameters:

option - to append at the end using a ; prefix.

Returns:

this H2ConnectionConfiguration.Builder

property

public H2ConnectionConfiguration.Builder property(String option,
                                                  String value)

Configure a property for H2.

Parameters:

option - the option key.

value - the option value.

Returns:

this H2ConnectionConfiguration.Builder

property

public H2ConnectionConfiguration.Builder property(H2ConnectionOption option,
                                                  String value)

Configure a property for H2 using pre-build H2ConnectionOption.

Parameters:

option - the option key enum

value - the option value

Returns:

this H2ConnectionConfiguration.Builder

password

public H2ConnectionConfiguration.Builder password(@Nullable
                                                  CharSequence password)

Configure the password.

Parameters:

password - the password

Returns:

this H2ConnectionConfiguration.Builder

toString

public String toString()

Overrides:

toString in class Object

url

public H2ConnectionConfiguration.Builder url(String url)

Configure the database url. Includes everything after the jdbc:h2: prefix. For in-memory and file-based databases, must include the proper prefix (e.g. file: or mem:).

See https://www.h2database.com/html/features.html#database_url for more details.

Parameters:

url - the url

Returns:

this H2ConnectionConfiguration.Builder

Throws:

NullPointerException - if url is null

username

public H2ConnectionConfiguration.Builder username(@Nullable
                                                  String username)

Configure the username.

Parameters:

username - the username

Returns:

this H2ConnectionConfiguration.Builder