io.micronaut.r2dbc

Interface BasicR2dbcProperties

All Superinterfaces:

io.micronaut.core.naming.Named

All Known Implementing Classes:

DefaultBasicR2dbcProperties

public interface BasicR2dbcProperties
extends io.micronaut.core.naming.Named

An interface to model configuring basic R2DBC properties.

Since:

1.0.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX The prefix for configuration.

Method Summary

Modifier and Type	Method and Description
io.r2dbc.spi.ConnectionFactoryOptions.Builder	builder()
BasicR2dbcProperties	setConnectTimeout(java.time.Duration duration) Sets the connect timeout.
BasicR2dbcProperties	setDatabase(@NotBlank java.lang.String database) Sets the initial database name.
BasicR2dbcProperties	setDriver(@NotBlank java.lang.String driver) Sets the driver.
BasicR2dbcProperties	setHost(@NotBlank java.lang.String host) Sets the host.
BasicR2dbcProperties	setOptions(java.util.Map<java.lang.String,java.lang.String> options) Sets the connection properties.
BasicR2dbcProperties	setPassword(java.lang.CharSequence password) Sets the password.
BasicR2dbcProperties	setPort(@Positive int port) Sets the port.
BasicR2dbcProperties	setProtocol(@NotBlank java.lang.String protocol) Sets the protocol.
BasicR2dbcProperties	setSsl(boolean ssl) Sets whether to prefer SSL configuration.
BasicR2dbcProperties	setUsername(@NotBlank java.lang.String username) Sets the username.

Methods inherited from interface io.micronaut.core.naming.Named

getName

Field Detail

PREFIX

static final java.lang.String PREFIX

The prefix for configuration.

See Also:

Constant Field Values

Method Detail

setHost

BasicR2dbcProperties setHost(@NotBlank
                             @NotBlank java.lang.String host)

Sets the host.

Parameters:

host - The host

Returns:

These properties

setPort

BasicR2dbcProperties setPort(@Positive
                             @Positive int port)

Sets the port.

Parameters:

port - The port

Returns:

These properties

setDriver

BasicR2dbcProperties setDriver(@NotBlank
                               @NotBlank java.lang.String driver)

Sets the driver.

Parameters:

driver - The driver

Returns:

These properties

setProtocol

BasicR2dbcProperties setProtocol(@NotBlank
                                 @NotBlank java.lang.String protocol)

Sets the protocol.

Parameters:

protocol - The protocol

Returns:

These properties

setConnectTimeout

BasicR2dbcProperties setConnectTimeout(java.time.Duration duration)

Sets the connect timeout.

Parameters:

duration - The duration

Returns:

These properties

setSsl

BasicR2dbcProperties setSsl(boolean ssl)

Sets whether to prefer SSL configuration.

Parameters:

ssl - Sets whether to prefer SSL

Returns:

These properties

setUsername

BasicR2dbcProperties setUsername(@NotBlank
                                 @NotBlank java.lang.String username)

Sets the username.

Parameters:

username - The username

Returns:

These properties

setPassword

BasicR2dbcProperties setPassword(java.lang.CharSequence password)

Sets the password.

Parameters:

password - The password

Returns:

These properties

setDatabase

BasicR2dbcProperties setDatabase(@NotBlank
                                 @NotBlank java.lang.String database)

Sets the initial database name.

Parameters:

database - The database

Returns:

These properties

setOptions

BasicR2dbcProperties setOptions(@Nullable
                                java.util.Map<java.lang.String,java.lang.String> options)

Sets the connection properties.

Parameters:

options - The options

Returns:

These properties

builder

@NonNull
io.r2dbc.spi.ConnectionFactoryOptions.Builder builder()

Returns:

Return the current builder