MySQLConnectOptions

Connect options for configuring {@link MySQLConnection} or {@link MySQLPool}.

class MySQLConnectOptions : SqlConnectOptions {}

Constructors

this
this()
Undocumented in source.
this
this(HttpURI uri)
Undocumented in source.
this
this(MySQLConnectOptions other)
Undocumented in source.

Members

Functions

addProperty
MySQLConnectOptions addProperty(string key, string value)
Undocumented in source. Be warned that the author may not have intended to support it.
getCollation
string getCollation()

Get the collation for the connection.

initialize
void initialize()

Initialize with the default options.

setCachePreparedStatements
MySQLConnectOptions setCachePreparedStatements(bool cachePreparedStatements)
Undocumented in source. Be warned that the author may not have intended to support it.
setCollation
MySQLConnectOptions setCollation(string collation)

Set the collation for the connection.

setConnectTimeout
MySQLConnectOptions setConnectTimeout(Duration connectTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setDatabase
MySQLConnectOptions setDatabase(string database)
Undocumented in source. Be warned that the author may not have intended to support it.
setDecoderBufferSize
MySQLConnectOptions setDecoderBufferSize(int size)
Undocumented in source. Be warned that the author may not have intended to support it.
setEncoderBufferSize
MySQLConnectOptions setEncoderBufferSize(int size)
Undocumented in source. Be warned that the author may not have intended to support it.
setHost
MySQLConnectOptions setHost(string host)
Undocumented in source. Be warned that the author may not have intended to support it.
setHostnameVerificationAlgorithm
MySQLConnectOptions setHostnameVerificationAlgorithm(string hostnameVerificationAlgorithm)
Undocumented in source. Be warned that the author may not have intended to support it.
setIdleTimeout
MySQLConnectOptions setIdleTimeout(Duration idleTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setLocalAddress
MySQLConnectOptions setLocalAddress(string localAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setLogActivity
MySQLConnectOptions setLogActivity(bool logEnabled)
Undocumented in source. Be warned that the author may not have intended to support it.
setMetricsName
MySQLConnectOptions setMetricsName(string metricsName)
Undocumented in source. Be warned that the author may not have intended to support it.
setPassword
MySQLConnectOptions setPassword(string password)
Undocumented in source. Be warned that the author may not have intended to support it.
setPort
MySQLConnectOptions setPort(int port)
Undocumented in source. Be warned that the author may not have intended to support it.
setPreparedStatementCacheMaxSize
MySQLConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setPreparedStatementCacheSqlLimit
MySQLConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
Undocumented in source. Be warned that the author may not have intended to support it.
setProperties
MySQLConnectOptions setProperties(Map!(string, string) properties)
Undocumented in source. Be warned that the author may not have intended to support it.
setProxyOptions
MySQLConnectOptions setProxyOptions(ProxyOptions proxyOptions)
Undocumented in source. Be warned that the author may not have intended to support it.
setReceiveBufferSize
MySQLConnectOptions setReceiveBufferSize(int receiveBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setReconnectAttempts
MySQLConnectOptions setReconnectAttempts(int attempts)
Undocumented in source. Be warned that the author may not have intended to support it.
setReconnectInterval
MySQLConnectOptions setReconnectInterval(Duration interval)
Undocumented in source. Be warned that the author may not have intended to support it.
setReuseAddress
MySQLConnectOptions setReuseAddress(bool reuseAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setReusePort
MySQLConnectOptions setReusePort(bool reusePort)
Undocumented in source. Be warned that the author may not have intended to support it.
setSendBufferSize
MySQLConnectOptions setSendBufferSize(int sendBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setSoLinger
MySQLConnectOptions setSoLinger(int soLinger)
Undocumented in source. Be warned that the author may not have intended to support it.
setSslHandshakeTimeout
MySQLConnectOptions setSslHandshakeTimeout(Duration sslHandshakeTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpCork
MySQLConnectOptions setTcpCork(bool tcpCork)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpFastOpen
MySQLConnectOptions setTcpFastOpen(bool tcpFastOpen)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpKeepAlive
MySQLConnectOptions setTcpKeepAlive(bool tcpKeepAlive)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpNoDelay
MySQLConnectOptions setTcpNoDelay(bool tcpNoDelay)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpQuickAck
MySQLConnectOptions setTcpQuickAck(bool tcpQuickAck)
Undocumented in source. Be warned that the author may not have intended to support it.
setTrafficClass
MySQLConnectOptions setTrafficClass(int trafficClass)
Undocumented in source. Be warned that the author may not have intended to support it.
setTrustAll
MySQLConnectOptions setTrustAll(bool trustAll)
Undocumented in source. Be warned that the author may not have intended to support it.
setUseAlpn
MySQLConnectOptions setUseAlpn(bool useAlpn)
Undocumented in source. Be warned that the author may not have intended to support it.
setUser
MySQLConnectOptions setUser(string user)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

fromUri
MySQLConnectOptions fromUri(string connectionUri)

Provide a {@link MySQLConnectOptions} configured from a connection URI.

Variables

DEFAULT_COLLATION
enum string DEFAULT_COLLATION;
Undocumented in source.
DEFAULT_CONNECTION_ATTRIBUTES
enum string[string] DEFAULT_CONNECTION_ATTRIBUTES;
Undocumented in source.
DEFAULT_HOST
enum string DEFAULT_HOST;
Undocumented in source.
DEFAULT_PASSWORD
enum string DEFAULT_PASSWORD;
Undocumented in source.
DEFAULT_PORT
enum int DEFAULT_PORT;
Undocumented in source.
DEFAULT_SCHEMA
enum string DEFAULT_SCHEMA;
Undocumented in source.
DEFAULT_USER
enum string DEFAULT_USER;
Undocumented in source.

Inherited Members

From SqlConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS
enum bool DEFAULT_CACHE_PREPARED_STATEMENTS;
Undocumented in source.
DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE
enum int DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE;
Undocumented in source.
DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT
enum int DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT;
Undocumented in source.
getHost
string getHost()

Get the host for connecting to the server.

setHost
SqlConnectOptions setHost(string host)

Specify the host for connecting to the server.

getPort
int getPort()

Get the port for connecting to the server.

setPort
SqlConnectOptions setPort(int port)

Specify the port for connecting to the server.

getUser
string getUser()

Get the user account to be used for the authentication.

setUser
SqlConnectOptions setUser(string user)

Specify the user account to be used for the authentication.

getPassword
string getPassword()

Get the user password to be used for the authentication.

setPassword
SqlConnectOptions setPassword(string password)

Specify the user password to be used for the authentication.

getDatabase
string getDatabase()

Get the default database name for the connection.

setDatabase
SqlConnectOptions setDatabase(string database)

Specify the default database for the connection.

getCachePreparedStatements
bool getCachePreparedStatements()

Get whether prepared statements cache is enabled.

setCachePreparedStatements
SqlConnectOptions setCachePreparedStatements(bool cachePreparedStatements)

Set whether prepared statements cache should be enabled.

getPreparedStatementCacheMaxSize
int getPreparedStatementCacheMaxSize()

Get the maximum number of prepared statements that the connection will cache.

setPreparedStatementCacheMaxSize
SqlConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

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

getPreparedStatementCacheSqlLimit
int getPreparedStatementCacheSqlLimit()

Get the maximum length of prepared statement SQL string that the connection will cache.

setPreparedStatementCacheSqlLimit
SqlConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Set the maximum length of prepared statement SQL string that the connection will cache.

getProperties
Map!(string, string) getProperties()

@return the value of current connection properties

setProperties
SqlConnectOptions setProperties(Map!(string, string) properties)

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

addProperty
SqlConnectOptions addProperty(string key, string value)

Add a property for this client, which will be sent to server at the connection start.

initialize
void initialize()

Initialize with the default options.

Meta