= Cheatsheets

[[MySQLAuthOptions]]
== MySQLAuthOptions

++++
Authentication options for MySQL authentication which can be used for CHANGE_USER command.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[charset]]`@charset`|`String`|+++
Set the charset for the connection.
+++
|[[collation]]`@collation`|`String`|+++
Set the collation for the connection.
+++
|[[database]]`@database`|`String`|+++
Specify the default database for the re-authentication.
+++
|[[password]]`@password`|`String`|+++
Specify the user password to be used for the authentication.
+++
|[[properties]]`@properties`|`String`|+++
Set connection attributes which will be sent to server at the re-authentication.
+++
|[[serverRsaPublicKeyPath]]`@serverRsaPublicKeyPath`|`String`|+++
Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.
+++
|[[serverRsaPublicKeyValue]]`@serverRsaPublicKeyValue`|`Buffer`|+++
Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.
+++
|[[user]]`@user`|`String`|+++
Specify the user account to be used for the authentication.
+++
|===

[[MySQLConnectOptions]]
== MySQLConnectOptions

++++
Connect options for configuring link or link.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[authenticationPlugin]]`@authenticationPlugin`|`link:enums.html#MySQLAuthenticationPlugin[MySQLAuthenticationPlugin]`|+++
Set the default link for the client, the option will take effect at the connection start.
+++
|[[cachePreparedStatements]]`@cachePreparedStatements`|`Boolean`|-
|[[characterEncoding]]`@characterEncoding`|`String`|+++
Set the Java charset for encoding string values, this value is UTF-8 by default.
+++
|[[charset]]`@charset`|`String`|+++
Set the charset for the connection.
+++
|[[collation]]`@collation`|`String`|+++
Set the collation for the connection.
+++
|[[connectTimeout]]`@connectTimeout`|`Number (int)`|-
|[[crlPaths]]`@crlPaths`|`Array of String`|-
|[[crlValues]]`@crlValues`|`Array of Buffer`|-
|[[database]]`@database`|`String`|-
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|-
|[[host]]`@host`|`String`|-
|[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|-
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|-
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[localAddress]]`@localAddress`|`String`|-
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[metricsName]]`@metricsName`|`String`|-
|[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[password]]`@password`|`String`|-
|[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[port]]`@port`|`Number (int)`|-
|[[preparedStatementCacheMaxSize]]`@preparedStatementCacheMaxSize`|`Number (int)`|-
|[[preparedStatementCacheSqlLimit]]`@preparedStatementCacheSqlLimit`|`Number (int)`|-
|[[properties]]`@properties`|`String`|-
|[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|-
|[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|-
|[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|-
|[[reuseAddress]]`@reuseAddress`|`Boolean`|-
|[[reusePort]]`@reusePort`|`Boolean`|-
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|-
|[[serverRsaPublicKeyPath]]`@serverRsaPublicKeyPath`|`String`|+++
Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.
+++
|[[serverRsaPublicKeyValue]]`@serverRsaPublicKeyValue`|`Buffer`|+++
Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.
+++
|[[soLinger]]`@soLinger`|`Number (int)`|-
|[[ssl]]`@ssl`|`Boolean`|-
|[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|-
|[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[sslMode]]`@sslMode`|`link:enums.html#SslMode[SslMode]`|+++
Set the link for the client, this option can be used to specify the desired security state of the connection to the server.
+++
|[[tcpCork]]`@tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|-
|[[trafficClass]]`@trafficClass`|`Number (int)`|-
|[[trustAll]]`@trustAll`|`Boolean`|-
|[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAffectedRows]]`@useAffectedRows`|`Boolean`|+++
Sets how affected rows are calculated on update/delete/insert, if set to <code>true</code> an update that effectively
does not change any data returns zero affected rows.

See <a href="https://dev.mysql.com/doc/refman/8.0/en/mysql-affected-rows.html">mysql-affected-rows</a> for details.
+++
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|-
|[[user]]`@user`|`String`|-
|===