vertx / io.vertx.kotlin.mysqlclient / mySQLConnectOptionsOf

mySQLConnectOptionsOf

fun mySQLConnectOptionsOf(authenticationPlugin: MySQLAuthenticationPlugin? = null, cachePreparedStatements: Boolean? = null, characterEncoding: String? = null, charset: String? = null, collation: String? = null, connectTimeout: Int? = null, crlPaths: Iterable<String>? = null, crlValues: Iterable<Buffer>? = null, database: String? = null, enabledCipherSuites: Iterable<String>? = null, enabledSecureTransportProtocols: Iterable<String>? = null, host: String? = null, hostnameVerificationAlgorithm: String? = null, idleTimeout: Int? = null, idleTimeoutUnit: TimeUnit? = null, jdkSslEngineOptions: JdkSSLEngineOptions? = null, keyStoreOptions: JksOptions? = null, localAddress: String? = null, logActivity: Boolean? = null, metricsName: String? = null, openSslEngineOptions: OpenSSLEngineOptions? = null, password: String? = null, pemKeyCertOptions: PemKeyCertOptions? = null, pemTrustOptions: PemTrustOptions? = null, pfxKeyCertOptions: PfxOptions? = null, pfxTrustOptions: PfxOptions? = null, port: Int? = null, preparedStatementCacheMaxSize: Int? = null, preparedStatementCacheSqlLimit: Int? = null, properties: Map<String, String>? = null, proxyOptions: ProxyOptions? = null, receiveBufferSize: Int? = null, reconnectAttempts: Int? = null, reconnectInterval: Long? = null, reuseAddress: Boolean? = null, reusePort: Boolean? = null, sendBufferSize: Int? = null, serverRsaPublicKeyPath: String? = null, serverRsaPublicKeyValue: Buffer? = null, soLinger: Int? = null, ssl: Boolean? = null, sslHandshakeTimeout: Long? = null, sslHandshakeTimeoutUnit: TimeUnit? = null, sslMode: SslMode? = null, tcpCork: Boolean? = null, tcpFastOpen: Boolean? = null, tcpKeepAlive: Boolean? = null, tcpNoDelay: Boolean? = null, tcpQuickAck: Boolean? = null, trafficClass: Int? = null, trustAll: Boolean? = null, trustStoreOptions: JksOptions? = null, useAffectedRows: Boolean? = null, useAlpn: Boolean? = null, usePooledBuffers: Boolean? = null, user: String? = null): MySQLConnectOptions

A function providing a DSL for building io.vertx.mysqlclient.MySQLConnectOptions objects.

Connect options for configuring io.vertx.mysqlclient.MySQLConnection or io.vertx.mysqlclient.MySQLPool.

Parameters

authenticationPlugin - Set the default io.vertx.mysqlclient.MySQLAuthenticationPlugin for the client, the option will take effect at the connection start.

cachePreparedStatements - Set whether prepared statements cache should be enabled.

characterEncoding - Set the Java charset for encoding string values, this value is UTF-8 by default.

charset - Set the charset for the connection.

collation - Set the collation for the connection.

connectTimeout - Set the connect timeout

crlPaths - Add a CRL path

crlValues - Add a CRL value

database - Specify the default database for the connection.

enabledCipherSuites - Add an enabled cipher suite, appended to the ordered suites.

enabledSecureTransportProtocols - Sets the list of enabled SSL/TLS protocols.

host - Specify the host for connecting to the server.

hostnameVerificationAlgorithm - Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

idleTimeout - Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, use io.vertx.mysqlclient.MySQLConnectOptions

idleTimeoutUnit - Set the idle timeout unit. If not specified, default is seconds.

jdkSslEngineOptions -

keyStoreOptions - Set the key/cert options in jks format, aka Java keystore.

localAddress - Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

logActivity - Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

metricsName - Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

openSslEngineOptions -

password - Specify the user password to be used for the authentication.

pemKeyCertOptions - Set the key/cert store options in pem format.

pemTrustOptions - Set the trust options in pem format

pfxKeyCertOptions - Set the key/cert options in pfx format.

pfxTrustOptions - Set the trust options in pfx format

port - Specify the port for connecting to the server.

preparedStatementCacheMaxSize - Set the maximum number of prepared statements that the connection will cache.

preparedStatementCacheSqlLimit - Set the maximum length of prepared statement SQL string that the connection will cache. This is an helper setting the io.vertx.mysqlclient.MySQLConnectOptions.

properties - Set properties for this client, which will be sent to server at the connection start.

proxyOptions - Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

receiveBufferSize - Set the TCP receive buffer size

reconnectAttempts - Set the value of reconnect attempts

reconnectInterval - Set the reconnect interval

reuseAddress - Set the value of reuse address

reusePort - Set the value of reuse port. This is only supported by native transports.

sendBufferSize - Set the TCP send buffer size

serverRsaPublicKeyPath - Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

serverRsaPublicKeyValue - Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.

soLinger - Set whether SO_linger keep alive is enabled

ssl - Set whether SSL/TLS is enabled

sslHandshakeTimeout - Set the SSL handshake timeout, default time unit is seconds.

sslHandshakeTimeoutUnit - Set the SSL handshake timeout unit. If not specified, default is seconds.

sslMode - Set the io.vertx.mysqlclient.SslMode for the client, this option can be used to specify the desired security state of the connection to the server.

tcpCork - Enable the TCP_CORK option - only with linux native transport.

tcpFastOpen - Enable the TCP_FASTOPEN option - only with linux native transport.

tcpKeepAlive - Set whether TCP keep alive is enabled

tcpNoDelay - Set whether TCP no delay is enabled

tcpQuickAck - Enable the TCP_QUICKACK option - only with linux native transport.

trafficClass - Set the value of traffic class

trustAll - Set whether all server certificates should be trusted

trustStoreOptions - Set the trust options in jks format, aka Java truststore

useAffectedRows - Sets how affected rows are calculated on update/delete/insert, if set to true an update that effectively does not change any data returns zero affected rows. See mysql-affected-rows for details.

useAlpn - Set the ALPN usage.

usePooledBuffers - Set whether Netty pooled buffers are enabled

user - Specify the user account to be used for the authentication.