MySqlConnectionFactoryProvider (Reactive Relational Database Connectivity

java.lang.Object
- io.asyncer.r2dbc.mysql.MySqlConnectionFactoryProvider

All Implemented Interfaces:

io.r2dbc.spi.ConnectionFactoryProvider
```
public final class MySqlConnectionFactoryProvider
extends Object
implements io.r2dbc.spi.ConnectionFactoryProvider
```
An implementation of ConnectionFactoryProvider for creating MySqlConnectionFactorys.

Field Summary

Fields
Modifier and Type	Field and Description
`static io.r2dbc.spi.Option<String>`	`ALLOW_LOAD_LOCAL_INFILE_IN_PATH` Option to set the allowed local infile path.
`static io.r2dbc.spi.Option<Boolean>`	`AUTODETECT_EXTENSIONS` Enable/Disable auto-detect driver extensions.
`static io.r2dbc.spi.Option<CompressionAlgorithm[]>`	`COMPRESSION_ALGORITHMS` Option to set compression algorithms.
`static io.r2dbc.spi.Option<String>`	`CONNECTION_TIME_ZONE` Option to set the time zone of connection.
`static io.r2dbc.spi.Option<Boolean>`	`CREATE_DATABASE_IF_NOT_EXIST` Enable/Disable database creation if not exist.
`static io.r2dbc.spi.Option<Boolean>`	`FORCE_CONNECTION_TIME_ZONE_TO_SESSION` Option to force the time zone of connection to session time zone.
`static io.r2dbc.spi.Option<Integer>`	`LOCAL_INFILE_BUFFER_SIZE` Option to set the buffer size for local infile.
`static io.r2dbc.spi.Option<reactor.netty.resources.LoopResources>`	`LOOP_RESOURCES` Option to set the `LoopResources` for the connection.
`static String`	`MYSQL_DRIVER` The name of the driver used for discovery, should not be changed.
`static io.r2dbc.spi.Option<Publisher<String>>`	`PASSWORD_PUBLISHER` Password Publisher function can be used to retrieve password before creating a connection.
`static io.r2dbc.spi.Option<Integer>`	`PREPARE_CACHE_SIZE` Option to set the maximum size of the `Query` parsing cache.
`static io.r2dbc.spi.Option<Boolean>`	`PRESERVE_INSTANTS` Option to set the time zone conversion.
`static io.r2dbc.spi.Option<Integer>`	`QUERY_CACHE_SIZE` Option to set the maximum size of the server-preparing cache.
`static io.r2dbc.spi.Option<ZoneId>`	`SERVER_ZONE_ID` Deprecated. since 1.1.2, use `CONNECTION_TIME_ZONE` instead.
`static io.r2dbc.spi.Option<String[]>`	`SESSION_VARIABLES` Option to set session variables.
`static io.r2dbc.spi.Option<String>`	`SSL_CA` Option to set a PEM file of server SSL CA.
`static io.r2dbc.spi.Option<String>`	`SSL_CERT` Option to set a PEM file of client SSL cert.
`static io.r2dbc.spi.Option<Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder>>`	`SSL_CONTEXT_BUILDER_CUSTOMIZER` Option to custom `SslContextBuilder`.
`static io.r2dbc.spi.Option<HostnameVerifier>`	`SSL_HOSTNAME_VERIFIER` Option to configure `HostnameVerifier`.
`static io.r2dbc.spi.Option<String>`	`SSL_KEY` Option to set a PEM file of client SSL key.
`static io.r2dbc.spi.Option<CharSequence>`	`SSL_KEY_PASSWORD` Option to set a PEM file password of client SSL key.
`static io.r2dbc.spi.Option<SslMode>`	`SSL_MODE` Option to `SslMode`.
`static io.r2dbc.spi.Option<Boolean>`	`TCP_KEEP_ALIVE` Enable/Disable TCP KeepAlive.
`static io.r2dbc.spi.Option<Boolean>`	`TCP_NO_DELAY` Enable/Disable TCP NoDelay.
`static io.r2dbc.spi.Option<String[]>`	`TLS_VERSION` Option to TLS versions for SslContext protocols, see also `TlsVersions`.
`static io.r2dbc.spi.Option<String>`	`UNIX_SOCKET` Option to set the Unix Domain Socket.
`static io.r2dbc.spi.Option<Object>`	`USE_SERVER_PREPARE_STATEMENT` Enable server preparing for parameterized statements and prefer server preparing simple statements.
`static io.r2dbc.spi.Option<ZeroDateOption>`	`ZERO_DATE` Option to configure handling when MySQL server returning "zero date" (aka.
`static io.r2dbc.spi.Option<Integer>`	`ZSTD_COMPRESSION_LEVEL` Option to set the zstd compression level.

Constructor Summary

Constructors
Constructor and Description

MySqlConnectionFactoryProvider()

Constructors
Constructor and Description
`MySqlConnectionFactoryProvider()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.r2dbc.spi.ConnectionFactory`	`create(io.r2dbc.spi.ConnectionFactoryOptions options)`
`String`	`getDriver()`
`boolean`	`supports(io.r2dbc.spi.ConnectionFactoryOptions options)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MYSQL_DRIVER
```
public static final String MYSQL_DRIVER
```
    The name of the driver used for discovery, should not be changed.
    
    See Also:
    
    Constant Field Values
  - UNIX_SOCKET
```
public static final io.r2dbc.spi.Option<String> UNIX_SOCKET
```
    Option to set the Unix Domain Socket.
    
    Since:
    
    0.8.1
  - PRESERVE_INSTANTS
```
public static final io.r2dbc.spi.Option<Boolean> PRESERVE_INSTANTS
```
    Option to set the time zone conversion. Default to true means enable conversion between JVM and CONNECTION_TIME_ZONE.
    Note: disable it will ignore the time zone of connection, and use the JVM local time zone.
    
    Since:
    
    1.1.2
  - CONNECTION_TIME_ZONE
```
public static final io.r2dbc.spi.Option<String> CONNECTION_TIME_ZONE
```
    Option to set the time zone of connection. Default to LOCAL means use JVM local time zone. It should be "LOCAL", "SERVER", or a valid ID of ZoneId. "SERVER" means querying the server-side timezone during initialization.
    
    Since:
    
    1.1.2
  - FORCE_CONNECTION_TIME_ZONE_TO_SESSION
```
public static final io.r2dbc.spi.Option<Boolean> FORCE_CONNECTION_TIME_ZONE_TO_SESSION
```
    Option to force the time zone of connection to session time zone. Default to false.
    Note: alter the time zone of session will affect the results of MySQL date/time functions, e.g. NOW([n]), CURRENT_TIME([n]), CURRENT_DATE(), etc. Please use with caution.
    
    Since:
    
    1.1.2
  - SERVER_ZONE_ID
```
@Deprecated
public static final io.r2dbc.spi.Option<ZoneId> SERVER_ZONE_ID
```
    Deprecated. since 1.1.2, use CONNECTION_TIME_ZONE instead.
    
    Option to set ZoneId of server. If it is set, driver will ignore the real time zone of server-side.
    
    Since:
    
    0.8.2
  - ZERO_DATE
```
public static final io.r2dbc.spi.Option<ZeroDateOption> ZERO_DATE
```
    Option to configure handling when MySQL server returning "zero date" (aka. "0000-00-00 00:00:00")
    
    Since:
    
    0.8.1
  - SSL_MODE
```
public static final io.r2dbc.spi.Option<SslMode> SSL_MODE
```
    Option to SslMode.
    
    Since:
    
    0.8.1
  - SSL_HOSTNAME_VERIFIER
```
public static final io.r2dbc.spi.Option<HostnameVerifier> SSL_HOSTNAME_VERIFIER
```
    Option to configure HostnameVerifier. It is available only if the SSL_MODE set to SslMode.VERIFY_IDENTITY. It can be an implementation class name of HostnameVerifier with a public no-args constructor.
    
    Since:
    
    0.8.2
  - TLS_VERSION
```
public static final io.r2dbc.spi.Option<String[]> TLS_VERSION
```
    Option to TLS versions for SslContext protocols, see also TlsVersions. Usually sorted from higher to lower. It can be a Collection<String>. It can be a String, protocols will be split by ,. e.g. "TLSv1.2,TLSv1.1,TLSv1".
    
    Since:
    
    0.8.1
  - SSL_CA
```
public static final io.r2dbc.spi.Option<String> SSL_CA
```
    Option to set a PEM file of server SSL CA. It will be used to verify server certificates. And it will be used only if SSL_MODE set to SslMode.VERIFY_CA or higher level.
    
    Since:
    
    0.8.1
  - SSL_KEY
```
public static final io.r2dbc.spi.Option<String> SSL_KEY
```
    Option to set a PEM file of client SSL key.
    
    Since:
    
    0.8.1
  - SSL_KEY_PASSWORD
```
public static final io.r2dbc.spi.Option<CharSequence> SSL_KEY_PASSWORD
```
    Option to set a PEM file password of client SSL key. It will be used only if SSL_KEY and SSL_CERT set.
    
    Since:
    
    0.8.1
  - SSL_CERT
```
public static final io.r2dbc.spi.Option<String> SSL_CERT
```
    Option to set a PEM file of client SSL cert.
    
    Since:
    
    0.8.1
  - SSL_CONTEXT_BUILDER_CUSTOMIZER
```
public static final io.r2dbc.spi.Option<Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder>> SSL_CONTEXT_BUILDER_CUSTOMIZER
```
    Option to custom SslContextBuilder. It can be an implementation class name of Function with a public no-args constructor.
    
    Since:
    
    0.8.2
  - TCP_KEEP_ALIVE
```
public static final io.r2dbc.spi.Option<Boolean> TCP_KEEP_ALIVE
```
    Enable/Disable TCP KeepAlive.
    
    Since:
    
    0.8.2
  - TCP_NO_DELAY
```
public static final io.r2dbc.spi.Option<Boolean> TCP_NO_DELAY
```
    Enable/Disable TCP NoDelay.
    
    Since:
    
    0.8.2
  - CREATE_DATABASE_IF_NOT_EXIST
```
public static final io.r2dbc.spi.Option<Boolean> CREATE_DATABASE_IF_NOT_EXIST
```
    Enable/Disable database creation if not exist.
    
    Since:
    
    1.0.6
  - USE_SERVER_PREPARE_STATEMENT
```
public static final io.r2dbc.spi.Option<Object> USE_SERVER_PREPARE_STATEMENT
```
    Enable server preparing for parameterized statements and prefer server preparing simple statements.
    The value can be a Boolean. If it is true, driver will use server preparing for parameterized statements and text query for simple statements. If it is false, driver will use client preparing for parameterized statements and text query for simple statements.
    The value can be a Predicate<String>. If it is set, driver will server preparing for parameterized statements, it configures whether to prefer prepare execution on a statement-by-statement basis (simple statements). The Predicate<String> accepts the simple SQL query string and returns a boolean flag indicating preference.
    The value can be a String. If it is set, driver will try to convert it to Boolean or an instance of Predicate<String> which use reflection with a public no-args constructor.
    
    Since:
    
    0.8.1
  - SESSION_VARIABLES
```
public static final io.r2dbc.spi.Option<String[]> SESSION_VARIABLES
```
    Option to set session variables. It should be a list of key-value pairs. e.g. ["sql_mode='ANSI_QUOTES,STRICT_TRANS_TABLES'", "time_zone=00:00"].
    
    Since:
    
    1.1.2
  - ALLOW_LOAD_LOCAL_INFILE_IN_PATH
```
public static final io.r2dbc.spi.Option<String> ALLOW_LOAD_LOCAL_INFILE_IN_PATH
```
    Option to set the allowed local infile path.
    
    Since:
    
    1.1.0
  - LOCAL_INFILE_BUFFER_SIZE
```
public static final io.r2dbc.spi.Option<Integer> LOCAL_INFILE_BUFFER_SIZE
```
    Option to set the buffer size for local infile. Default to 8192.
    
    Since:
    
    1.1.2
  - COMPRESSION_ALGORITHMS
```
public static final io.r2dbc.spi.Option<CompressionAlgorithm[]> COMPRESSION_ALGORITHMS
```
    Option to set compression algorithms. Default to [CompressionAlgorithm.UNCOMPRESSED].
    It will auto choose an algorithm that's contained in the list and supported by the server, preferring zstd, then zlib. If the list does not contain CompressionAlgorithm.UNCOMPRESSED and the server does not support any algorithm in the list, an exception will be thrown when connecting.
    Note: zstd requires a dependency com.github.luben:zstd-jni.
    
    Since:
    
    1.1.2
  - ZSTD_COMPRESSION_LEVEL
```
public static final io.r2dbc.spi.Option<Integer> ZSTD_COMPRESSION_LEVEL
```
    Option to set the zstd compression level. Default to 3.
    It is only used if zstd is chosen for the connection.
    Note: MySQL protocol does not allow to set the zlib compression level of the server, only zstd is configurable.
    
    Since:
    
    1.1.2
  - LOOP_RESOURCES
```
public static final io.r2dbc.spi.Option<reactor.netty.resources.LoopResources> LOOP_RESOURCES
```
    Option to set the LoopResources for the connection. Default to global tcp Resources
    
    Since:
    
    1.1.2
  - PREPARE_CACHE_SIZE
```
public static final io.r2dbc.spi.Option<Integer> PREPARE_CACHE_SIZE
```
    Option to set the maximum size of the Query parsing cache. Default to 256.
    
    Since:
    
    0.8.3
  - QUERY_CACHE_SIZE
```
public static final io.r2dbc.spi.Option<Integer> QUERY_CACHE_SIZE
```
    Option to set the maximum size of the server-preparing cache. Default to 0.
    
    Since:
    
    0.8.3
  - AUTODETECT_EXTENSIONS
```
public static final io.r2dbc.spi.Option<Boolean> AUTODETECT_EXTENSIONS
```
    Enable/Disable auto-detect driver extensions.
    
    Since:
    
    0.8.2
  - PASSWORD_PUBLISHER
```
public static final io.r2dbc.spi.Option<Publisher<String>> PASSWORD_PUBLISHER
```
    Password Publisher function can be used to retrieve password before creating a connection. This can be used with Amazon RDS Aurora IAM authentication, wherein it requires token to be generated. The token is valid for 15 minutes, and this token will be used as password.
- Constructor Detail
  - MySqlConnectionFactoryProvider
```
public MySqlConnectionFactoryProvider()
```
- Method Detail
  - create
```
public io.r2dbc.spi.ConnectionFactory create(io.r2dbc.spi.ConnectionFactoryOptions options)
```
    Specified by:
    
    create in interface io.r2dbc.spi.ConnectionFactoryProvider
  - supports
```
public boolean supports(io.r2dbc.spi.ConnectionFactoryOptions options)
```
    Specified by:
    
    supports in interface io.r2dbc.spi.ConnectionFactoryProvider
  - getDriver
```
public String getDriver()
```
    Specified by:
    
    getDriver in interface io.r2dbc.spi.ConnectionFactoryProvider

Class MySqlConnectionFactoryProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MYSQL_DRIVER

UNIX_SOCKET

PRESERVE_INSTANTS

CONNECTION_TIME_ZONE

FORCE_CONNECTION_TIME_ZONE_TO_SESSION

SERVER_ZONE_ID

ZERO_DATE

SSL_MODE

SSL_HOSTNAME_VERIFIER

TLS_VERSION

SSL_CA

SSL_KEY

SSL_KEY_PASSWORD

SSL_CERT

SSL_CONTEXT_BUILDER_CUSTOMIZER

TCP_KEEP_ALIVE

TCP_NO_DELAY

CREATE_DATABASE_IF_NOT_EXIST

USE_SERVER_PREPARE_STATEMENT

SESSION_VARIABLES

ALLOW_LOAD_LOCAL_INFILE_IN_PATH

LOCAL_INFILE_BUFFER_SIZE

COMPRESSION_ALGORITHMS

ZSTD_COMPRESSION_LEVEL

LOOP_RESOURCES

PREPARE_CACHE_SIZE

QUERY_CACHE_SIZE

AUTODETECT_EXTENSIONS

PASSWORD_PUBLISHER

Constructor Detail

MySqlConnectionFactoryProvider

Method Detail

create

supports

getDriver