Uses of Class
org.mariadb.jdbc.Configuration.Builder

Packages that use Configuration.Builder

Package	Description
org.mariadb.jdbc

Uses of Configuration.Builder in org.mariadb.jdbc

Fields in org.mariadb.jdbc declared as Configuration.Builder

Modifier and Type	Field	Description
private Configuration.Builder	MariaDbDataSource.builder	Sole state of this datasource.
private Configuration.Builder	MariaDbPoolDataSource.builder	Sole state of this datasource.

Methods in org.mariadb.jdbc that return Configuration.Builder

Modifier and Type	Method	Description
Configuration.Builder	Configuration.Builder.addHost(java.lang.String host, int port)	Add Host to possible addresses to connect
Configuration.Builder	Configuration.Builder.addHost(java.lang.String host, int port, boolean master)	Add Host to possible addresses to connect
Configuration.Builder	Configuration.Builder.addHost(java.lang.String host, int port, boolean master, java.lang.String sslMode)	Add Host to possible addresses to connect
Configuration.Builder	Configuration.Builder.addHost(java.lang.String host, int port, java.lang.String sslMode)	Add Host to possible addresses to connect
Configuration.Builder	Configuration.Builder.addLocalSocketHost(java.lang.String localSocket)	Add a unix socket host
Configuration.Builder	Configuration.Builder.addPipeHost(java.lang.String pipe)	Add a windows pipe host
Configuration.Builder	Configuration.Builder.addresses(java.util.List<HostAddress> hostAddress)	add host addresses
Configuration.Builder	Configuration.Builder.addresses(HostAddress... hostAddress)	add host addresses
Configuration.Builder	Configuration.Builder.allowLocalInfile(java.lang.Boolean allowLocalInfile)	Indicate if LOAD DATA LOCAL INFILE are permitted.
Configuration.Builder	Configuration.Builder.allowMultiQueries(java.lang.Boolean allowMultiQueries)	Indicate that multi-queries are allowed.
Configuration.Builder	Configuration.Builder.allowPublicKeyRetrieval(java.lang.Boolean allowPublicKeyRetrieval)	Allow RSA server file retrieval from MySQL server
Configuration.Builder	Configuration.Builder.autocommit(java.lang.Boolean autocommit)	Permit to force autocommit connection value
Configuration.Builder	Configuration.Builder.blankTableNameMeta(java.lang.Boolean blankTableNameMeta)	Set blank table name for metadata (old oracle compatibility)
Configuration.Builder	Configuration.Builder.cacheCodecs(java.lang.Boolean cacheCodecs)	Permit caching codecs
Configuration.Builder	Configuration.Builder.cachePrepStmts(java.lang.Boolean cachePrepStmts)	Cache server prepare result
Configuration.Builder	Configuration.Builder.connectionAttributes(java.lang.String connectionAttributes)	Additional connection attributes to identify connection
Configuration.Builder	Configuration.Builder.connectionCollation(java.lang.String connectionCollation)	indicate what utf8mb4 collation to use.
Configuration.Builder	Configuration.Builder.connectionTimeZone(java.lang.String connectionTimeZone)	indicate what timestamp timezone to use in exchanges with server possible value are LOCAL|SERVER|user-defined time zone
Configuration.Builder	Configuration.Builder.connectTimeout(java.lang.Integer connectTimeout)	Indicate connect timeout value, in milliseconds, or zero for no timeout.
Configuration.Builder	Configuration.Builder.createDatabaseIfNotExist(java.lang.Boolean createDatabaseIfNotExist)	Create database if not exist.
Configuration.Builder	Configuration.Builder.credentialType(java.lang.String credentialType)	set credential plugin type
Configuration.Builder	Configuration.Builder.database(java.lang.String database)	Set default database
Configuration.Builder	Configuration.Builder.defaultFetchSize(java.lang.Integer defaultFetchSize)	Set default fetch size
Configuration.Builder	Configuration.Builder.disablePipeline(java.lang.Boolean disablePipeline)	Disable pipeline
Configuration.Builder	Configuration.Builder.disconnectOnExpiredPasswords(java.lang.Boolean disconnectOnExpiredPasswords)	On connection creation, indicate behavior when password is expired.
Configuration.Builder	Configuration.Builder.dumpQueriesOnException(java.lang.Boolean dumpQueriesOnException)	Must queries be dump on exception stracktrace.
Configuration.Builder	Configuration.Builder.enabledSslCipherSuites(java.lang.String enabledSslCipherSuites)	set possible cipher list (comma separated), not using default java cipher list
Configuration.Builder	Configuration.Builder.enabledSslProtocolSuites(java.lang.String enabledSslProtocolSuites)	Set ssl protocol list to user (comma separated)
Configuration.Builder	Configuration.Builder.fallbackToSystemKeyStore(java.lang.Boolean fallbackToSystemKeyStore)	Indicate if keystore system properties can be used.
Configuration.Builder	Configuration.Builder.fallbackToSystemTrustStore(java.lang.Boolean fallbackToSystemTrustStore)	Indicate if system default truststore can be used.
Configuration.Builder	Configuration.Builder.forceConnectionTimeZoneToSession(java.lang.Boolean forceConnectionTimeZoneToSession)	Indicate if connectionTimeZone must be forced to session
Configuration.Builder	Configuration.Builder.galeraAllowedState(java.lang.String galeraAllowedState)	Indicate galera allowed state (comma separated), permitting to validate if galera node is synchronized
Configuration.Builder	Configuration.Builder.geometryDefaultType(java.lang.String geometryDefault)	Indicate what default Object type Geometry a resultset.getObject must return.
Configuration.Builder	Configuration.Builder.haMode(HaMode haMode)	Set failover High-availability mode
Configuration.Builder	Configuration.Builder.includeInnodbStatusInDeadlockExceptions(java.lang.Boolean includeInnodbStatusInDeadlockExceptions)	On dead-lock exception must add innodb status in exception error message.
Configuration.Builder	Configuration.Builder.includeThreadDumpInDeadlockExceptions(java.lang.Boolean includeThreadDumpInDeadlockExceptions)	Dead-lock error will contain threads information
Configuration.Builder	Configuration.Builder.initSql(java.lang.String initSql)	permit to execute an SQL command on connection creation
Configuration.Builder	Configuration.Builder.jdbcCompliantTruncation(java.lang.Boolean jdbcCompliantTruncation)	indicate if connector must force sql_mode strict mode for jdbc compliance
Configuration.Builder	Configuration.Builder.keyPassword(java.lang.String keyPassword)	Client keystore alias password
Configuration.Builder	Configuration.Builder.keyStore(java.lang.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	Configuration.Builder.keyStorePassword(java.lang.String keyStorePassword)	Client keystore password
Configuration.Builder	Configuration.Builder.keyStoreType(java.lang.String keyStoreType)	Key store type
Configuration.Builder	Configuration.Builder.localSocket(java.lang.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	Configuration.Builder.localSocketAddress(java.lang.String localSocketAddress)	Indicate Hostname or IP address to bind the connection socket to a local (UNIX domain) socket.
Configuration.Builder	Configuration.Builder.maxAllowedColumns(java.lang.Integer maxAllowedColumns)	Maximum number of columns the driver will accept in result-set or prepare metadata received from the server.
Configuration.Builder	Configuration.Builder.maxAllowedPacket(java.lang.Integer maxAllowedPacket)	Maximum size (in bytes) of a packet the driver will send or receive.
Configuration.Builder	Configuration.Builder.maxIdleTime(java.lang.Integer maxIdleTime)	Set the maximum idle time of a connection indicating that connection must be released
Configuration.Builder	Configuration.Builder.maxPoolSize(java.lang.Integer maxPoolSize)	Set the limit number of connection in pool.
Configuration.Builder	Configuration.Builder.maxQuerySizeToLog(java.lang.Integer maxQuerySizeToLog)	Set the log size limit for query
Configuration.Builder	Configuration.Builder.metaExportedKeys(java.lang.String metaExportedKeys)	Indicate what implementation to use for metadata getExportedKeys.
Configuration.Builder	Configuration.Builder.minPoolSize(java.lang.Integer minPoolSize)	Minimum pool size.
Configuration.Builder	Configuration.Builder.nullDatabaseMeansCurrent(java.lang.Boolean nullDatabaseMeansCurrent)	Permit indicating in DatabaseMetadata if null value must be considered current schema/catalog
Configuration.Builder	Configuration.Builder.oldModeNoPrecisionTimestamp(java.lang.Boolean oldModeNoPrecisionTimestamp)	Force Timestamp string representation compatible 2.7 version Timestamp string representation will then correspond to Timestamp.toString() in place of taking field precision
Configuration.Builder	Configuration.Builder.password(java.lang.String password)	User password
Configuration.Builder	Configuration.Builder.permitNoResults(java.lang.Boolean permitNoResults)	Indicate if Statement/PreparedStatement.executeQuery for command that produce no result will return an exception or just an empty result-set When enabled, command not returning no data will end returning an empty result-set When disabled, command not returning no data will end throwing an exception
Configuration.Builder	Configuration.Builder.permitRedirect(java.lang.Boolean permitRedirect)	indicate if connector must redirect connection when receiving server redirect information
Configuration.Builder	Configuration.Builder.pinGlobalTxToPhysicalConnection(java.lang.Boolean pinGlobalTxToPhysicalConnection)	Indicate if for XA transaction, connector must reuse same connection.
Configuration.Builder	Configuration.Builder.pipe(java.lang.String pipe)	Indicate to use windows named pipe, specify named pipe name to connect
Configuration.Builder	Configuration.Builder.pool(java.lang.Boolean pool)	Create pool if not existing, or get a connection for the pool associate with this connection string if existing.
Configuration.Builder	Configuration.Builder.poolName(java.lang.String poolName)	set pool name
Configuration.Builder	Configuration.Builder.poolValidMinDelay(java.lang.Integer poolValidMinDelay)	Pool will validate connection before giving it.
Configuration.Builder	Configuration.Builder.prepStmtCacheSize(java.lang.Integer prepStmtCacheSize)	If using server prepared statement, set LRU prepare cache size
Configuration.Builder	Configuration.Builder.preserveInstants(java.lang.Boolean preserveInstants)	Indicate if connection must preserve instants
Configuration.Builder	Configuration.Builder.pureLocalDateTime(java.lang.Boolean pureLocalDateTime)	Indicate if LocalDateTime is treated as a pure zoneless wall-clock value (default true).
Configuration.Builder	Configuration.Builder.readOnlyPropagatesToServer(java.lang.Boolean readOnlyPropagatesToServer)	When enabled (the default), Connection.setReadOnly(boolean) on a single-host connection propagates the read-only state to the server by issuing SET SESSION TRANSACTION READ ONLY / READ WRITE, for servers >= 5.6.5, so the server rejects DML on a read-only connection.
Configuration.Builder	Configuration.Builder.registerJmxPool(java.lang.Boolean registerJmxPool)	Must pool register JMX information
Configuration.Builder	Configuration.Builder.restrictedAuth(java.lang.String restrictedAuth)	restrict authentication method to secure list.
Configuration.Builder	Configuration.Builder.retriesAllDown(java.lang.Integer retriesAllDown)	When failover occurs, how many connection attempt before throwing error when reconnecting
Configuration.Builder	Configuration.Builder.returnMultiValuesGeneratedIds(java.lang.Boolean returnMultiValuesGeneratedIds)	indicate if connector must return multi-generated ids.
Configuration.Builder	Configuration.Builder.rewriteBatchedStatements(java.lang.Boolean rewriteBatchedStatements)	For insert queries, rewrite batchedStatement to execute in a single executeQuery.
Configuration.Builder	Configuration.Builder.serverRsaPublicKeyFile(java.lang.String serverRsaPublicKeyFile)	MySQL Authentication RSA server file, for mysql authentication
Configuration.Builder	Configuration.Builder.serverSslCert(java.lang.String serverSslCert)	Server SSL certificate (path or file content)
Configuration.Builder	Configuration.Builder.servicePrincipalName(java.lang.String servicePrincipalName)	set service principal name (GSSAPI)
Configuration.Builder	Configuration.Builder.sessionVariables(java.lang.String sessionVariables)	set connection session variables (comma separated)
Configuration.Builder	Configuration.Builder.socketFactory(java.lang.String socketFactory)	Socket factory
Configuration.Builder	Configuration.Builder.socketTimeout(java.lang.Integer socketTimeout)	Indicate the network socket timeout (SO_TIMEOUT) in milliseconds.
Configuration.Builder	Configuration.Builder.sslMode(java.lang.String sslMode)	Set ssl model
Configuration.Builder	Configuration.Builder.tcpAbortiveClose(java.lang.Boolean tcpAbortiveClose)	Indicate that when connection fails, to send an RST TCP packet.
Configuration.Builder	Configuration.Builder.tcpKeepAlive(java.lang.Boolean tcpKeepAlive)	Indicate if TCP keep-alive must be enabled.
Configuration.Builder	Configuration.Builder.tcpKeepCount(java.lang.Integer tcpKeepCount)	Indicate TCP keep-count value (for java 11+ only).
Configuration.Builder	Configuration.Builder.tcpKeepIdle(java.lang.Integer tcpKeepIdle)	Indicate TCP keep-idle value (for java 11+ only).
Configuration.Builder	Configuration.Builder.tcpKeepInterval(java.lang.Integer tcpKeepInterval)	Indicate TCP keep-interval value (for java 11+ only).
Configuration.Builder	Configuration.Builder.timezone(java.lang.String timezone)	Force timezone to use this timezone, not default java one
Configuration.Builder	Configuration.Builder.tinyInt1isBit(java.lang.Boolean tinyInt1isBit)	TinyInt(1) to be considered as bit
Configuration.Builder	Configuration.Builder.tlsSocketType(java.lang.String tlsSocketType)	Permit to defined default tls plugin type
Configuration.Builder	Configuration.toBuilder()	Create a Builder from current configuration.
Configuration.Builder	Configuration.Builder.transactionIsolation(java.lang.String transactionIsolation)	force default transaction isolation, not using server default
Configuration.Builder	Configuration.Builder.transactionReplay(java.lang.Boolean transactionReplay)	Must cache commands in transaction and replay transaction on failover.
Configuration.Builder	Configuration.Builder.transactionReplaySize(java.lang.Integer transactionReplaySize)	Transaction replay cache size
Configuration.Builder	Configuration.Builder.transformedBitIsBoolean(java.lang.Boolean transformedBitIsBoolean)	TinyInt(1) to be considered as boolean
Configuration.Builder	Configuration.Builder.trustStore(java.lang.String trustStore)	File path of the trustStore file that contain trusted certificates (similar to java System property \"javax.net.ssl.trustStore\")
Configuration.Builder	Configuration.Builder.trustStorePassword(java.lang.String trustStorePassword)	Client truststore password
Configuration.Builder	Configuration.Builder.trustStoreType(java.lang.String trustStoreType)	trust store type
Configuration.Builder	Configuration.Builder.useAffectedRows(java.lang.Boolean useAffectedRows)	Indicate server to return affected rows in place of found rows.
Configuration.Builder	Configuration.Builder.useBulkStmts(java.lang.Boolean useBulkStmts)	Use server dedicated bulk batch command
Configuration.Builder	Configuration.Builder.useBulkStmtsForInserts(java.lang.Boolean useBulkStmtsForInserts)	Use server dedicated bulk batch command for insert (if useBulkStmts is enabled, useBulkStmtsForInserts will be enabled as well)
Configuration.Builder	Configuration.Builder.useCatalogTerm(java.lang.String useCatalogTerm)	"schema" and "database" are server synonymous.
Configuration.Builder	Configuration.Builder.useCompression(java.lang.Boolean useCompression)	Indicate to compress exchanges with the database through gzip.
Configuration.Builder	Configuration.Builder.useIpForKillQuery(java.lang.Boolean useIpForKillQuery)	When cancelling a query, reuse the current socket IP instead of the original hostname.
Configuration.Builder	Configuration.Builder.useLocalSessionState(java.lang.Boolean useLocalSessionState)	indicate if connector can use local state to avoid unnecessary queries.
Configuration.Builder	Configuration.Builder.useMysqlMetadata(java.lang.Boolean useMysqlMetadata)	Permit indicating to force DatabaseMetadata.getDatabaseProductName() to return `MySQL` as database type, not real database type
Configuration.Builder	Configuration.Builder.user(java.lang.String user)	set user to authenticate to server
Configuration.Builder	Configuration.Builder.useReadAheadInput(java.lang.Boolean useReadAheadInput)	Cache all socket available information.
Configuration.Builder	Configuration.Builder.useResetConnection(java.lang.Boolean useResetConnection)	Indicate that connection returned to pool must be RESETed like having proper connection state.
Configuration.Builder	Configuration.Builder.useServerPrepStmts(java.lang.Boolean useServerPrepStmts)	Indicate to use Client or Server prepared statement
Configuration.Builder	Configuration.Builder.uuidAsString(java.lang.Boolean uuidAsString)	Indicate if UUID fields must returns as String
Configuration.Builder	Configuration.Builder.yearIsDateType(java.lang.Boolean yearIsDateType)	Year datatype to be considered as date

Methods in org.mariadb.jdbc with parameters of type Configuration.Builder

Modifier and Type	Method	Description
private static void	Configuration.handleBooleanField(Configuration.Builder builder, java.lang.reflect.Field field, java.lang.Object value, java.lang.Object originalKey)
private static void	Configuration.handleIntegerField(Configuration.Builder builder, java.lang.reflect.Field field, java.lang.Object value, java.lang.Object originalKey)
private static void	Configuration.handleLegacySslSettings(Configuration.Builder builder, java.util.Properties nonMappedOptions)
private static void	Configuration.handleStringField(Configuration.Builder builder, java.lang.reflect.Field field, java.lang.Object value)
private void	Configuration.initializeAdditionalConfig(Configuration.Builder builder)
private void	Configuration.initializeBasicConfig(Configuration.Builder builder)
private void	Configuration.initializeBulkConfig(Configuration.Builder builder)
private void	Configuration.initializeDatabaseConfig(Configuration.Builder builder)
private void	Configuration.initializeDataTypeConfig(Configuration.Builder builder)
private void	Configuration.initializeExceptionConfig(Configuration.Builder builder)
private void	Configuration.initializePipelineConfig(Configuration.Builder builder)
private void	Configuration.initializePoolConfig(Configuration.Builder builder)
private void	Configuration.initializeQueryConfig(Configuration.Builder builder)
private void	Configuration.initializeSecurityConfig(Configuration.Builder builder)
private void	Configuration.initializeSocketConfig(Configuration.Builder builder)
private void	Configuration.initializeSslConfig(Configuration.Builder builder)
private void	Configuration.initializeTimezoneConfig(Configuration.Builder builder)
private void	Configuration.initializeTransactionConfig(Configuration.Builder builder)
private static void	Configuration.mapPropertiesToOption(Configuration.Builder builder, java.util.Properties properties)
private static void	Configuration.processDatabaseAndParameters(java.lang.String additionalParameters, Configuration.Builder builder, java.util.Properties properties)
private static void	Configuration.processProperties(Configuration.Builder builder, java.util.Properties properties, java.util.Properties nonMappedOptions)
private static void	Configuration.processProperty(Configuration.Builder builder, java.lang.String realKey, java.lang.Object propertyValue, java.lang.Object originalKey, java.util.Properties nonMappedOptions)
private static void	Configuration.setFieldValue(Configuration.Builder builder, java.lang.reflect.Field field, java.lang.Object propertyValue, java.lang.Object originalKey)

Constructors in org.mariadb.jdbc with parameters of type Configuration.Builder

Constructor	Description
Configuration(Configuration.Builder builder)