Module io.vertx.sql.client.mysql

Package io.vertx.mysqlclient

Class MySQLConnectOptions

java.lang.Object

io.vertx.sqlclient.SqlConnectOptions

io.vertx.mysqlclient.MySQLConnectOptions

public class MySQLConnectOptions
extends SqlConnectOptions

Connect options for configuring MySQLConnection or MySQLBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CHARACTER_ENCODING
static String	DEFAULT_CHARSET
static Map<String,String>	DEFAULT_CONNECTION_ATTRIBUTES
static String	DEFAULT_HOST
static String	DEFAULT_PASSWORD
static int	DEFAULT_PIPELINING_LIMIT
static int	DEFAULT_PORT
static String	DEFAULT_SCHEMA
static SslMode	DEFAULT_SSL_MODE
static boolean	DEFAULT_USE_AFFECTED_ROWS
static String	DEFAULT_USER

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_METRICS_NAME, DEFAULT_PREPARED_STATEMENT_CACHE_FILTER, DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE, DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL

Constructor Summary

Constructors

Constructor	Description
MySQLConnectOptions()
MySQLConnectOptions(JsonObject json)
MySQLConnectOptions(MySQLConnectOptions other)
MySQLConnectOptions(SqlConnectOptions other)

Method Summary

Modifier and Type	Method	Description
MySQLConnectOptions	addProperty(String key, String value)
static MySQLConnectOptions	fromUri(String connectionUri)	Provide a MySQLConnectOptions configured from a connection URI.
MySQLAuthenticationPlugin	getAuthenticationPlugin()	Get the default authentication plugin for connecting the server.
String	getCharacterEncoding()	Get the Java charset for encoding string values.
String	getCharset()	Get the charset for the connection.
String	getCollation()	Get the collation for the connection.
int	getPipeliningLimit()	Get the pipelining limit count.
String	getServerRsaPublicKeyPath()	Get the path of the server RSA public key.
Buffer	getServerRsaPublicKeyValue()	Get the value of the server RSA public key.
SocketAddress	getSocketAddress()
SslMode	getSslMode()	Get the value of the configured SSL mode.
protected void	init()	Initialize with the default options.
boolean	isUseAffectedRows()	Get how affected rows are calculated on update/delete/insert.
boolean	isUsingDomainSocket()
MySQLConnectOptions	merge(JsonObject other)
MySQLConnectOptions	setAuthenticationPlugin(MySQLAuthenticationPlugin authenticationPlugin)	Set the default authentication plguin for the client, the option will take effect at the connection start.
MySQLConnectOptions	setCachePreparedStatements(boolean cachePreparedStatements)
MySQLConnectOptions	setCharacterEncoding(String characterEncoding)	Set the Java charset for encoding string values, this value is UTF-8 by default.
MySQLConnectOptions	setCharset(String charset)	Set the charset for the connection.
MySQLConnectOptions	setCollation(String collation)	Set the collation for the connection.
MySQLConnectOptions	setDatabase(String database)
MySQLConnectOptions	setHost(String host)
MySQLConnectOptions	setPassword(String password)
MySQLConnectOptions	setPipeliningLimit(int pipeliningLimit)	Set the pipelining limit count.
MySQLConnectOptions	setPort(int port)
MySQLConnectOptions	setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
MySQLConnectOptions	setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
MySQLConnectOptions	setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
MySQLConnectOptions	setProperties(Map<String,String> properties)
MySQLConnectOptions	setReconnectAttempts(int attempts)
MySQLConnectOptions	setReconnectInterval(long interval)
MySQLConnectOptions	setServerRsaPublicKeyPath(String serverRsaPublicKeyPath)	Set the path of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.
MySQLConnectOptions	setServerRsaPublicKeyValue(Buffer serverRsaPublicKeyValue)	Set the value of server RSA public key which is mostly used for encrypting password under insecure connections when performing authentication.
MySQLConnectOptions	setSslMode(SslMode sslMode)	Set the SslMode for the client, this option can be used to specify the desired security state of the connection to the server.
MySQLConnectOptions	setSslOptions(ClientSSLOptions sslOptions)
MySQLConnectOptions	setTracingPolicy(TracingPolicy tracingPolicy)
MySQLConnectOptions	setUseAffectedRows(boolean 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.
MySQLConnectOptions	setUser(String user)
JsonObject	toJson()
static MySQLConnectOptions	wrap(SqlConnectOptions options)

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

getCachePreparedStatements, getDatabase, getHost, getMetricsName, getPassword, getPort, getPreparedStatementCacheMaxSize, getPreparedStatementCacheSqlFilter, getProperties, getReconnectAttempts, getReconnectInterval, getSslOptions, getTracingPolicy, getUser, setMetricsName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_USER

public static final String DEFAULT_USER

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

See Also:

Constant Field Values

DEFAULT_SCHEMA

public static final String DEFAULT_SCHEMA

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

DEFAULT_USE_AFFECTED_ROWS

public static final boolean DEFAULT_USE_AFFECTED_ROWS

See Also:

Constant Field Values

DEFAULT_CONNECTION_ATTRIBUTES

public static final Map<String,String> DEFAULT_CONNECTION_ATTRIBUTES

DEFAULT_SSL_MODE

public static final SslMode DEFAULT_SSL_MODE

DEFAULT_CHARACTER_ENCODING

public static final String DEFAULT_CHARACTER_ENCODING

See Also:

Constant Field Values

DEFAULT_PIPELINING_LIMIT

public static final int DEFAULT_PIPELINING_LIMIT

See Also:

Constant Field Values

Constructor Detail

MySQLConnectOptions

public MySQLConnectOptions()

MySQLConnectOptions

public MySQLConnectOptions(JsonObject json)

MySQLConnectOptions

public MySQLConnectOptions(SqlConnectOptions other)

MySQLConnectOptions

public MySQLConnectOptions(MySQLConnectOptions other)

Method Detail

wrap

public static MySQLConnectOptions wrap(SqlConnectOptions options)

Returns:

the options as MySQL specific connect options

fromUri

public static MySQLConnectOptions fromUri(String connectionUri)
                                   throws IllegalArgumentException

Provide a MySQLConnectOptions configured from a connection URI.

Parameters:

connectionUri - the connection URI to configure from

Returns:

a MySQLConnectOptions parsed from the connection URI

Throws:

IllegalArgumentException - when the connectionUri is in an invalid format

getCollation

public String getCollation()

Get the collation for the connection.

Returns:

the MySQL collation

setCollation

public MySQLConnectOptions setCollation(String collation)

Set the collation for the connection.

Parameters:

collation - the collation to set

Returns:

a reference to this, so the API can be used fluently

getCharset

public String getCharset()

Get the charset for the connection.

Returns:

the MySQL collation

setCharset

public MySQLConnectOptions setCharset(String charset)

Set the charset for the connection.

Parameters:

charset - the charset to set

Returns:

a reference to this, so the API can be used fluently

getCharacterEncoding

public String getCharacterEncoding()

Get the Java charset for encoding string values.

Returns:

the charset name

setCharacterEncoding

public MySQLConnectOptions setCharacterEncoding(String characterEncoding)

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

Parameters:

characterEncoding - the Java charset to configure

Returns:

a reference to this, so the API can be used fluently

isUseAffectedRows

public boolean isUseAffectedRows()

Get how affected rows are calculated on update/delete/insert.

Returns:

how affected rows are calculated on update/delete/insert.

setUseAffectedRows

public MySQLConnectOptions setUseAffectedRows(boolean 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.

Parameters:

useAffectedRows - whether only affected rows are count

Returns:

a reference to this, so the API can be used fluently

getSslMode

public SslMode getSslMode()

Get the value of the configured SSL mode.

Returns:

the sslmode

setSslMode

public MySQLConnectOptions setSslMode(SslMode sslMode)

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

Parameters:

sslMode - the ssl-mode to specify

Returns:

a reference to this, so the API can be used fluently

getAuthenticationPlugin

public MySQLAuthenticationPlugin getAuthenticationPlugin()

Get the default authentication plugin for connecting the server.

Returns:

the authentication plugin

setAuthenticationPlugin

public MySQLConnectOptions setAuthenticationPlugin(MySQLAuthenticationPlugin authenticationPlugin)

Set the default authentication plguin for the client, the option will take effect at the connection start.

Parameters:

authenticationPlugin - the auth plugin to use

Returns:

a reference to this, so the API can be used fluently

setServerRsaPublicKeyPath

public MySQLConnectOptions setServerRsaPublicKeyPath(String serverRsaPublicKeyPath)

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

Parameters:

serverRsaPublicKeyPath - the path of the server RSA public key

Returns:

a reference to this, so the API can be used fluently

getServerRsaPublicKeyPath

public String getServerRsaPublicKeyPath()

Get the path of the server RSA public key.

Returns:

the public key path

setServerRsaPublicKeyValue

public MySQLConnectOptions setServerRsaPublicKeyValue(Buffer serverRsaPublicKeyValue)

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

Parameters:

serverRsaPublicKeyValue - the value of the server RSA public key

Returns:

a reference to this, so the API can be used fluently

getServerRsaPublicKeyValue

public Buffer getServerRsaPublicKeyValue()

Get the value of the server RSA public key.

Returns:

the public key value

getPipeliningLimit

public int getPipeliningLimit()

Get the pipelining limit count.

Returns:

the pipelining count

setPipeliningLimit

public MySQLConnectOptions setPipeliningLimit(int pipeliningLimit)

Set the pipelining limit count.

Parameters:

pipeliningLimit - the count to configure

Returns:

a reference to this, so the API can be used fluently

setHost

public MySQLConnectOptions setHost(String host)

Overrides:

setHost in class SqlConnectOptions

setPort

public MySQLConnectOptions setPort(int port)

Overrides:

setPort in class SqlConnectOptions

setUser

public MySQLConnectOptions setUser(String user)

Overrides:

setUser in class SqlConnectOptions

setPassword

public MySQLConnectOptions setPassword(String password)

Overrides:

setPassword in class SqlConnectOptions

setDatabase

public MySQLConnectOptions setDatabase(String database)

Overrides:

setDatabase in class SqlConnectOptions

setCachePreparedStatements

public MySQLConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)

Overrides:

setCachePreparedStatements in class SqlConnectOptions

setPreparedStatementCacheMaxSize

public MySQLConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

Overrides:

setPreparedStatementCacheMaxSize in class SqlConnectOptions

setPreparedStatementCacheSqlFilter

public MySQLConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)

Overrides:

setPreparedStatementCacheSqlFilter in class SqlConnectOptions

setPreparedStatementCacheSqlLimit

public MySQLConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Overrides:

setPreparedStatementCacheSqlLimit in class SqlConnectOptions

setProperties

public MySQLConnectOptions setProperties(Map<String,String> properties)

Overrides:

setProperties in class SqlConnectOptions

addProperty

public MySQLConnectOptions addProperty(String key,
                                       String value)

Overrides:

addProperty in class SqlConnectOptions

setReconnectAttempts

public MySQLConnectOptions setReconnectAttempts(int attempts)

Overrides:

setReconnectAttempts in class SqlConnectOptions

setReconnectInterval

public MySQLConnectOptions setReconnectInterval(long interval)

Overrides:

setReconnectInterval in class SqlConnectOptions

setTracingPolicy

public MySQLConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)

Overrides:

setTracingPolicy in class SqlConnectOptions

setSslOptions

public MySQLConnectOptions setSslOptions(ClientSSLOptions sslOptions)

Overrides:

setSslOptions in class SqlConnectOptions

init

protected void init()

Initialize with the default options.

Overrides:

init in class SqlConnectOptions

toJson

public JsonObject toJson()

Overrides:

toJson in class SqlConnectOptions

getSocketAddress

public SocketAddress getSocketAddress()

Overrides:

getSocketAddress in class SqlConnectOptions

isUsingDomainSocket

public boolean isUsingDomainSocket()

Overrides:

isUsingDomainSocket in class SqlConnectOptions

merge

public MySQLConnectOptions merge(JsonObject other)

Overrides:

merge in class SqlConnectOptions