public static final class Configuration.Builder extends Object implements Cloneable
Configuration instances.| Constructor and Description |
|---|
Builder() |
| Modifier and Type | Method and Description |
|---|---|
Configuration.Builder |
addHost(String host,
int port) |
Configuration.Builder |
addresses(HostAddress... hostAddress) |
Configuration.Builder |
allowLocalInfile(Boolean allowLocalInfile)
Indicate if LOAD DATA LOCAL INFILE are permitted.
|
Configuration.Builder |
allowMultiQueries(Boolean allowMultiQueries)
Indicate that multi-queries are allowed.
|
Configuration.Builder |
autocommit(Boolean autocommit)
Permit to force autocommit connection value
|
Configuration.Builder |
blankTableNameMeta(Boolean blankTableNameMeta) |
Configuration |
build()
Build a configuration
|
Configuration.Builder |
cachePrepStmts(Boolean cachePrepStmts)
Cache server prepare result
|
Configuration.Builder |
connectionAttributes(String connectionAttributes) |
Configuration.Builder |
connectTimeout(Integer connectTimeout)
Indicate connect timeout value, in milliseconds, or zero for no timeout.
|
Configuration.Builder |
consoleLogFilepath(String consoleLogFilepath) |
Configuration.Builder |
consoleLogLevel(String consoleLogLevel) |
Configuration.Builder |
createDatabaseIfNotExist(Boolean createDatabaseIfNotExist)
Create database if not exist.
|
Configuration.Builder |
credentialType(String credentialType) |
Configuration.Builder |
database(String database) |
Configuration.Builder |
defaultFetchSize(Integer defaultFetchSize) |
Configuration.Builder |
disablePipeline(Boolean disablePipeline) |
Configuration.Builder |
dumpQueriesOnException(Boolean dumpQueriesOnException) |
Configuration.Builder |
enabledSslCipherSuites(String enabledSslCipherSuites) |
Configuration.Builder |
enabledSslProtocolSuites(String enabledSslProtocolSuites) |
Configuration.Builder |
enableExtendedDataTypes(Boolean enableExtendedDataTypes)
Enable protocol extended types response.
|
Configuration.Builder |
geometryDefaultType(String geometryDefault)
Indicate what default Object type Geometry a resultset.getObject must return.
|
Configuration.Builder |
haMode(HaMode haMode) |
Configuration.Builder |
includeThreadDumpInDeadlockExceptions(Boolean includeThreadDumpInDeadlockExceptions) |
Configuration.Builder |
initSql(String initSql)
permit to execute an SQL command on connection creation
|
Configuration.Builder |
jaasApplicationName(String jaasApplicationName) |
Configuration.Builder |
keyPassword(String keyPassword)
Client keystore alias password
|
Configuration.Builder |
keyStore(String keyStore)
File path of the keyStore file that contain client private key store and associate
certificates (similar to java System property \"javax.net.ssl.keyStore\", but ensure that
only the private key's entries are used)
|
Configuration.Builder |
keyStorePassword(String keyStorePassword)
Client keystore password
|
Configuration.Builder |
keyStoreType(String keyStoreType) |
Configuration.Builder |
localSocket(String localSocket)
Indicate to use Unix domain socket, if the server allows it, specifying named pipe name to
connect The value is the path of Unix domain socket (available with "select @@socket"
command).
|
Configuration.Builder |
localSocketAddress(String localSocketAddress)
Indicate Hostname or IP address to bind the connection socket to a local (UNIX domain)
socket.
|
Configuration.Builder |
maxAllowedPacket(Integer maxAllowedPacket)
Indicate to driver server max_allowed_packet.
|
Configuration.Builder |
maxIdleTime(Integer maxIdleTime) |
Configuration.Builder |
maxPoolSize(Integer maxPoolSize) |
Configuration.Builder |
maxPrintStackSizeToLog(Integer maxPrintStackSizeToLog) |
Configuration.Builder |
maxQuerySizeToLog(Integer maxQuerySizeToLog) |
Configuration.Builder |
minPoolSize(Integer minPoolSize) |
Configuration.Builder |
nullDatabaseMeansCurrent(Boolean nullDatabaseMeansCurrent)
Permit indicating in DatabaseMetadata if null value must be considered current catalog
|
Configuration.Builder |
password(String password) |
Configuration.Builder |
pipe(String pipe)
Indicate to use windows named pipe, specify named pipe name to connect
|
Configuration.Builder |
pool(Boolean pool) |
Configuration.Builder |
poolName(String poolName) |
Configuration.Builder |
poolValidMinDelay(Integer poolValidMinDelay) |
Configuration.Builder |
prepStmtCacheSize(Integer prepStmtCacheSize) |
Configuration.Builder |
printStackTrace(Boolean printStackTrace) |
Configuration.Builder |
registerJmxPool(Boolean registerJmxPool) |
Configuration.Builder |
restrictedAuth(String restrictedAuth)
restrict authentication method to secure list.
|
Configuration.Builder |
retriesAllDown(Integer retriesAllDown) |
Configuration.Builder |
rewriteBatchedStatements(Boolean rewriteBatchedStatements) |
Configuration.Builder |
serverSslCert(String serverSslCert) |
Configuration.Builder |
servicePrincipalName(String servicePrincipalName) |
Configuration.Builder |
sessionVariables(String sessionVariables) |
Configuration.Builder |
socketFactory(String socketFactory) |
Configuration.Builder |
socketTimeout(Integer socketTimeout)
Indicate the network socket timeout (SO_TIMEOUT) in milliseconds.
|
Configuration.Builder |
sslMode(String sslMode) |
Configuration.Builder |
tcpAbortiveClose(Boolean tcpAbortiveClose)
Indicate that when connection fails, to send an RST TCP packet.
|
Configuration.Builder |
tcpKeepAlive(Boolean tcpKeepAlive)
Indicate if TCP keep-alive must be enable.
|
Configuration.Builder |
tcpKeepCount(Integer tcpKeepCount)
Indicate TCP keep-count value (for java 11+ only).
|
Configuration.Builder |
tcpKeepIdle(Integer tcpKeepIdle)
Indicate TCP keep-idle value (for java 11+ only).
|
Configuration.Builder |
tcpKeepInterval(Integer tcpKeepInterval)
Indicate TCP keep-interval value (for java 11+ only).
|
Configuration.Builder |
tinyInt1isBit(Boolean tinyInt1isBit)
TinyInt(1) to be considered as bit
|
Configuration.Builder |
tlsSocketType(String tlsSocketType) |
Configuration.Builder |
transactionIsolation(String transactionIsolation) |
Configuration.Builder |
transactionReplay(Boolean transactionReplay)
Must cache commands in transaction and replay transaction on failover.
|
Configuration.Builder |
transactionReplaySize(Integer transactionReplaySize)
Transaction replay cache size
|
Configuration.Builder |
transformedBitIsBoolean(Boolean transformedBitIsBoolean)
TinyInt(1) to be considered as boolean
|
Configuration.Builder |
trustStore(String trustStore) |
Configuration.Builder |
trustStorePassword(String trustStorePassword) |
Configuration.Builder |
trustStoreType(String trustStoreType) |
Configuration.Builder |
useAffectedRows(Boolean useAffectedRows) |
Configuration.Builder |
useCompression(Boolean useCompression)
Indicate to compresses exchanges with the database through gzip.
|
Configuration.Builder |
useMysqlVersion(Boolean useMysqlVersion) |
Configuration.Builder |
user(String user) |
Configuration.Builder |
useReadAheadInput(Boolean useReadAheadInput)
Cache all socket available information.
|
Configuration.Builder |
useResetConnection(Boolean useResetConnection) |
Configuration.Builder |
useServerPrepStmts(Boolean useServerPrepStmts) |
Configuration.Builder |
vectorExtendedMetadata(Boolean vectorExtendedMetadata)
Enable extended metadata for
VECTOR(<N> [, <elementType>]) data type. |
Configuration.Builder |
vectorTypeOutputFormat(String vectorTypeOutputFormat)
Sets Vector type output format as JSON or BINARY.
|
Configuration.Builder |
yearIsDateType(Boolean yearIsDateType) |
public Configuration.Builder user(String user)
public Configuration.Builder serverSslCert(String serverSslCert)
public Configuration.Builder trustStore(String trustStore)
public Configuration.Builder trustStorePassword(String trustStorePassword)
public Configuration.Builder trustStoreType(String trustStoreType)
public Configuration.Builder keyStore(String keyStore)
keyStore - client store certificatesConfiguration.Builderpublic Configuration.Builder keyStorePassword(String keyStorePassword)
keyStorePassword - client store passwordConfiguration.Builderpublic Configuration.Builder keyPassword(String keyPassword)
keyPassword - client store alias passwordConfiguration.Builderpublic Configuration.Builder keyStoreType(String keyStoreType)
public Configuration.Builder password(String password)
public Configuration.Builder enabledSslProtocolSuites(String enabledSslProtocolSuites)
public Configuration.Builder database(String database)
public Configuration.Builder haMode(HaMode haMode)
public Configuration.Builder addHost(String host, int port)
public Configuration.Builder addresses(HostAddress... hostAddress)
public Configuration.Builder socketFactory(String socketFactory)
public Configuration.Builder connectTimeout(Integer connectTimeout)
connectTimeout - connect TimeoutConfiguration.Builderpublic Configuration.Builder pipe(String pipe)
pipe - windows named pipeConfiguration.Builderpublic Configuration.Builder localSocket(String localSocket)
localSocket - local socket pathConfiguration.Builderpublic Configuration.Builder tcpKeepAlive(Boolean tcpKeepAlive)
tcpKeepAlive - valueConfiguration.Builderpublic Configuration.Builder tcpKeepIdle(Integer tcpKeepIdle)
tcpKeepIdle - valueConfiguration.Builderpublic Configuration.Builder tcpKeepCount(Integer tcpKeepCount)
tcpKeepCount - valueConfiguration.Builderpublic Configuration.Builder tcpKeepInterval(Integer tcpKeepInterval)
tcpKeepInterval - valueConfiguration.Builderpublic Configuration.Builder tcpAbortiveClose(Boolean tcpAbortiveClose)
tcpAbortiveClose - valueConfiguration.Builderpublic Configuration.Builder geometryDefaultType(String geometryDefault)
geometryDefault - valueConfiguration.Builderpublic Configuration.Builder restrictedAuth(String restrictedAuth)
restrictedAuth - use authentication plugin listConfiguration.Builderpublic Configuration.Builder localSocketAddress(String localSocketAddress)
localSocketAddress - Hostname or IP addressConfiguration.Builderpublic Configuration.Builder socketTimeout(Integer socketTimeout)
If the goal is to set a timeout for all queries, the server has permitted a solution to limit the query time by setting a system variable, max_statement_time. Default: 0
socketTimeout - socket timeout valueConfiguration.Builderpublic Configuration.Builder allowMultiQueries(Boolean allowMultiQueries)
If application build sql command string, this is probably a bad idea to enable this option, opening the door to sql injection. default: false.
allowMultiQueries - indicate if activeConfiguration.Builderpublic Configuration.Builder allowLocalInfile(Boolean allowLocalInfile)
allowLocalInfile - indicate if permit LOAD DATA LOCAL INFILE commandsConfiguration.Builderpublic Configuration.Builder useCompression(Boolean useCompression)
useCompression - to enable/disable compressionConfiguration.Builderpublic Configuration.Builder blankTableNameMeta(Boolean blankTableNameMeta)
public Configuration.Builder credentialType(String credentialType)
public Configuration.Builder sslMode(String sslMode)
public Configuration.Builder transactionIsolation(String transactionIsolation)
public Configuration.Builder enabledSslCipherSuites(String enabledSslCipherSuites)
public Configuration.Builder sessionVariables(String sessionVariables)
public Configuration.Builder tinyInt1isBit(Boolean tinyInt1isBit)
tinyInt1isBit - Indicate if Tinyint(1) to be considered as bitConfiguration.Builderpublic Configuration.Builder transformedBitIsBoolean(Boolean transformedBitIsBoolean)
transformedBitIsBoolean - Indicate if Tinyint(1) to be considered as booleanConfiguration.Builderpublic Configuration.Builder yearIsDateType(Boolean yearIsDateType)
public Configuration.Builder dumpQueriesOnException(Boolean dumpQueriesOnException)
public Configuration.Builder prepStmtCacheSize(Integer prepStmtCacheSize)
public Configuration.Builder useAffectedRows(Boolean useAffectedRows)
public Configuration.Builder disablePipeline(Boolean disablePipeline)
public Configuration.Builder useServerPrepStmts(Boolean useServerPrepStmts)
public Configuration.Builder autocommit(Boolean autocommit)
autocommit - autocommit valueConfiguration.Builderpublic Configuration.Builder nullDatabaseMeansCurrent(Boolean nullDatabaseMeansCurrent)
nullDatabaseMeansCurrent - indicating in DatabaseMetadata if null value must be
considered current catalogConfiguration.Builderpublic Configuration.Builder createDatabaseIfNotExist(Boolean createDatabaseIfNotExist)
createDatabaseIfNotExist - must driver create database if doesn't existConfiguration.Builderpublic Configuration.Builder initSql(String initSql)
initSql - initial SQL commandConfiguration.Builderpublic Configuration.Builder connectionAttributes(String connectionAttributes)
public Configuration.Builder includeThreadDumpInDeadlockExceptions(Boolean includeThreadDumpInDeadlockExceptions)
public Configuration.Builder servicePrincipalName(String servicePrincipalName)
public Configuration.Builder jaasApplicationName(String jaasApplicationName)
public Configuration.Builder defaultFetchSize(Integer defaultFetchSize)
public Configuration.Builder tlsSocketType(String tlsSocketType)
public Configuration.Builder maxQuerySizeToLog(Integer maxQuerySizeToLog)
public Configuration.Builder maxAllowedPacket(Integer maxAllowedPacket)
maxAllowedPacket - indicate server max_allowed_packet valueConfiguration.Builderpublic Configuration.Builder retriesAllDown(Integer retriesAllDown)
public Configuration.Builder pool(Boolean pool)
public Configuration.Builder poolName(String poolName)
public Configuration.Builder maxPoolSize(Integer maxPoolSize)
public Configuration.Builder minPoolSize(Integer minPoolSize)
public Configuration.Builder maxIdleTime(Integer maxIdleTime)
public Configuration.Builder registerJmxPool(Boolean registerJmxPool)
public Configuration.Builder poolValidMinDelay(Integer poolValidMinDelay)
public Configuration.Builder useResetConnection(Boolean useResetConnection)
public Configuration.Builder useReadAheadInput(Boolean useReadAheadInput)
useReadAheadInput - cache available socket data when reading socket.Configuration.Builderpublic Configuration.Builder cachePrepStmts(Boolean cachePrepStmts)
cachePrepStmts - cache server prepared resultConfiguration.Builderpublic Configuration.Builder transactionReplay(Boolean transactionReplay)
transactionReplay - cache transaction and replay on failoverConfiguration.Builderpublic Configuration.Builder transactionReplaySize(Integer transactionReplaySize)
transactionReplaySize - transaction replay cache sizeConfiguration.Builderpublic Configuration.Builder useMysqlVersion(Boolean useMysqlVersion)
public Configuration.Builder rewriteBatchedStatements(Boolean rewriteBatchedStatements)
public Configuration.Builder consoleLogLevel(String consoleLogLevel)
public Configuration.Builder consoleLogFilepath(String consoleLogFilepath)
public Configuration.Builder printStackTrace(Boolean printStackTrace)
public Configuration.Builder maxPrintStackSizeToLog(Integer maxPrintStackSizeToLog)
public Configuration.Builder enableExtendedDataTypes(Boolean enableExtendedDataTypes)
enableExtendedDataTypes - to enable extended type like Vector, Bson, etc...Configuration.Builderpublic Configuration.Builder vectorTypeOutputFormat(String vectorTypeOutputFormat)
vectorTypeOutputFormat - Vector type output formatConfiguration.Builderpublic Configuration.Builder vectorExtendedMetadata(Boolean vectorExtendedMetadata)
VECTOR(<N> [, <elementType>]) data type.vectorExtendedMetadata - to enable extended metadata for VECTORConfiguration.Builderpublic Configuration build() throws SQLException
SQLException - if option data type doesn't correspondCopyright © 2025 SingleStore. All rights reserved.