DefaultOptions (mariadb-java-client 1.2.1 API)

java.lang.Object
- java.lang.Enum<DefaultOptions>
- - org.mariadb.jdbc.internal.common.DefaultOptions

All Implemented Interfaces:

Serializable, Comparable<DefaultOptions>
```
public enum DefaultOptions
extends Enum<DefaultOptions>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALLOW_LOCAL_INFILE` If set to 'false', exception thrown during LOCAL INFILE if no InputStream has already been set.
`ALLOW_MULTI_QUERIES` Allows multiple statements in single executeQuery
`AUTO_RECONNECT` Driver must recreateConnection after a failover
`CONNECT_TIMOUT`
`CREATE_DATABASE_IF_NOT_EXISTS` The database precised in url will be created if doesn't exist
`DUMP_QUERY_ON_EXCEPTION` If set to 'true', exception thrown during query execution contain query string
`FAIL_ON_READ_ONLY` After a master failover and no other master found, back on a read-only host ( throw exception if not)
`FAILOVER_LOOP_RETRIES` When using failover, the number of times the driver should cycle silently through available hosts, attempting to connect.
`INTERACTIVE_CLIENT` Session timeout is defined by the wait_timeout server variable.
`LOAD_BALANCE_BLACKLIST_TIMEOUT` time in second a server is blacklisted after a connection failure.
`LOCAL_SOCKET` Allows to connect to database via Unix domain socket, if server allows it.
`LOCAL_SOCKET_ADDRESS` Hostname or IP address to bind the connection socket to a local (UNIX domain) socket.
`NULL_CATALOG_MEANS_CURRENT` DatabaseMetaData use current catalog if null
`PASSWORD` Password of database user
`PIN_GLOBAL_TX_TO_PHYSICAL_CONNECTION`
`PIPE` On Windows, specify named pipe name to connect to mysqld.exe
`QUERY_BEFORE_RETRY_MASTER` Number of queries to issue before falling back to master when failed over (when using multi-host failover).
`RETRY_ALL_DOWN` When using loadbalancing, the number of times the driver should cycle through available hosts, attempting to connect.
`REWRITE_BATCHED_STATEMENTS` rewrite batchedStatement to have only one server call
`SECONDS_BEFORE_RETRY_MASTER` Number of seconds to issue before falling back to master when failed over (when using multi-host failover).
`SERVER_SSL_CERT` Server's certificatem in DER form, or server's CA certificate.
`SERVER_TIMEZONE` Defined the server time zone.
`SESSION_VARIABLES` var=value pairs separated by comma, mysql session variables, set upon establishing successful connection
`SHARED_MEMORY` Allowed to connect database via shared memory, if server allows it.
`SOCKET_FACTORY` to use custom socket factory, set it to full name of the class that implements javax.net.SocketFactory
`SOCKET_TIMEOUT` Defined the network socket timeout (SO_TIMEOUT) in milliseconds. 0 (default) disable this timeout
`TCP_ABORTIVE_CLOSE` Sets corresponding option on the connection socket
`TCP_KEEP_ALIVE` Sets corresponding option on the connection socket
`TCP_NO_DELAY` Sets corresponding option on the connection socket
`TCP_RCV_BUF` set buffer size for TCP buffer (SO_RCVBUF)
`TCP_SND_BUF` set buffer size for TCP buffer (SO_SNDBUF)
`TINY_INT_IS_BIT` Datatype mapping flag, handle MySQL Tiny as BIT(boolean)
`TRUST_SERVER_CERTIFICATE` When using SSL, do not check server's certificate
`USE_FRACTIONAL_SECONDS` Correctly handle subsecond precision in timestamps (feature available with MariaDB 5.3 and later).May confuse 3rd party components (Hibernated)
`USE_OLD_ALIAS_METADATA_BEHAVIOR` Metadata ResultSetMetaData.getTableName() return the physical table name.
`USE_SSL` Force SSL on connection
`USER` Database user name
`USER_COMPRESSION` allow compression in MySQL Protocol
`VALID_CONNECTION_TIMEOUT` When in multiple hosts, after this time in second without used, verification that the connections havn't been lost.
`YEAR_IS_DATE_TYPE` Year is date type, rather than numerical

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`defaultValue`
`protected String`	`implementationVersion`
`protected Object`	`maxValue`
`protected Object`	`minValue`
`protected String`	`name`
`protected Object`	`objType`
`protected Object`	`value`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Options`	`addProperty(UrlHAMode haMode, Properties additionnalProperties, Options options)`
`static Options`	`addProperty(UrlHAMode haMode, String name, String value, Options options)`
`boolean`	`boolValue()`
`static Options`	`defaultValues(UrlHAMode haMode)`
`static Properties`	`getProperties(Options options)`
`static String`	`getProperties(String optionName, Options options)`
`int`	`intValue()`
`static Options`	`parse(UrlHAMode haMode, String urlParameters, Options options)`
`static Options`	`parse(UrlHAMode haMode, String urlParameters, Properties properties)`
`String`	`stringValue()`
`static DefaultOptions`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DefaultOptions[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - USER
```
public static final DefaultOptions USER
```
    Database user name
  - PASSWORD
```
public static final DefaultOptions PASSWORD
```
    Password of database user
  - CONNECT_TIMOUT
```
public static final DefaultOptions CONNECT_TIMOUT
```
  - PIPE
```
public static final DefaultOptions PIPE
```
    On Windows, specify named pipe name to connect to mysqld.exe
  - LOCAL_SOCKET
```
public static final DefaultOptions LOCAL_SOCKET
```
    Allows to connect to database via Unix domain socket, if server allows it. The value is the path of Unix domain socket, i.e "socket" database parameter
  - SHARED_MEMORY
```
public static final DefaultOptions SHARED_MEMORY
```
    Allowed to connect database via shared memory, if server allows it. The value is base name of the shared memory
  - TCP_NO_DELAY
```
public static final DefaultOptions TCP_NO_DELAY
```
    Sets corresponding option on the connection socket
  - TCP_ABORTIVE_CLOSE
```
public static final DefaultOptions TCP_ABORTIVE_CLOSE
```
    Sets corresponding option on the connection socket
  - LOCAL_SOCKET_ADDRESS
```
public static final DefaultOptions LOCAL_SOCKET_ADDRESS
```
    Hostname or IP address to bind the connection socket to a local (UNIX domain) socket.
  - SOCKET_TIMEOUT
```
public static final DefaultOptions SOCKET_TIMEOUT
```
    Defined the network socket timeout (SO_TIMEOUT) in milliseconds. 0 (default) disable this timeout
  - INTERACTIVE_CLIENT
```
public static final DefaultOptions INTERACTIVE_CLIENT
```
    Session timeout is defined by the wait_timeout server variable. Setting interactiveClient to true will tell server to use the interactive_timeout server variable
  - DUMP_QUERY_ON_EXCEPTION
```
public static final DefaultOptions DUMP_QUERY_ON_EXCEPTION
```
    If set to 'true', exception thrown during query execution contain query string
  - USE_OLD_ALIAS_METADATA_BEHAVIOR
```
public static final DefaultOptions USE_OLD_ALIAS_METADATA_BEHAVIOR
```
    Metadata ResultSetMetaData.getTableName() return the physical table name. "useOldAliasMetadataBehavior" permit to activate the legacy code that send the table alias if set.
  - ALLOW_LOCAL_INFILE
```
public static final DefaultOptions ALLOW_LOCAL_INFILE
```
    If set to 'false', exception thrown during LOCAL INFILE if no InputStream has already been set.
  - SESSION_VARIABLES
```
public static final DefaultOptions SESSION_VARIABLES
```
    var=value pairs separated by comma, mysql session variables, set upon establishing successful connection
  - CREATE_DATABASE_IF_NOT_EXISTS
```
public static final DefaultOptions CREATE_DATABASE_IF_NOT_EXISTS
```
    The database precised in url will be created if doesn't exist
  - SERVER_TIMEZONE
```
public static final DefaultOptions SERVER_TIMEZONE
```
    Defined the server time zone. to use only if jre server as a different time implementation of the server. (best to have the same server time zone when possible)
  - NULL_CATALOG_MEANS_CURRENT
```
public static final DefaultOptions NULL_CATALOG_MEANS_CURRENT
```
    DatabaseMetaData use current catalog if null
  - TINY_INT_IS_BIT
```
public static final DefaultOptions TINY_INT_IS_BIT
```
    Datatype mapping flag, handle MySQL Tiny as BIT(boolean)
  - YEAR_IS_DATE_TYPE
```
public static final DefaultOptions YEAR_IS_DATE_TYPE
```
    Year is date type, rather than numerical
  - USE_SSL
```
public static final DefaultOptions USE_SSL
```
    Force SSL on connection
  - USER_COMPRESSION
```
public static final DefaultOptions USER_COMPRESSION
```
    allow compression in MySQL Protocol
  - ALLOW_MULTI_QUERIES
```
public static final DefaultOptions ALLOW_MULTI_QUERIES
```
    Allows multiple statements in single executeQuery
  - REWRITE_BATCHED_STATEMENTS
```
public static final DefaultOptions REWRITE_BATCHED_STATEMENTS
```
    rewrite batchedStatement to have only one server call
  - TCP_KEEP_ALIVE
```
public static final DefaultOptions TCP_KEEP_ALIVE
```
    Sets corresponding option on the connection socket
  - TCP_RCV_BUF
```
public static final DefaultOptions TCP_RCV_BUF
```
    set buffer size for TCP buffer (SO_RCVBUF)
  - TCP_SND_BUF
```
public static final DefaultOptions TCP_SND_BUF
```
    set buffer size for TCP buffer (SO_SNDBUF)
  - SOCKET_FACTORY
```
public static final DefaultOptions SOCKET_FACTORY
```
    to use custom socket factory, set it to full name of the class that implements javax.net.SocketFactory
  - PIN_GLOBAL_TX_TO_PHYSICAL_CONNECTION
```
public static final DefaultOptions PIN_GLOBAL_TX_TO_PHYSICAL_CONNECTION
```
  - TRUST_SERVER_CERTIFICATE
```
public static final DefaultOptions TRUST_SERVER_CERTIFICATE
```
    When using SSL, do not check server's certificate
  - SERVER_SSL_CERT
```
public static final DefaultOptions SERVER_SSL_CERT
```
    Server's certificatem in DER form, or server's CA certificate. Can be used in one of 3 forms, sslServerCert=/path/to/cert.pem (full path to certificate), sslServerCert=classpath:relative/cert.pem (relative to current classpath), or as verbatim DER-encoded certificate string "------BEGING CERTIFICATE-----"
  - USE_FRACTIONAL_SECONDS
```
public static final DefaultOptions USE_FRACTIONAL_SECONDS
```
    Correctly handle subsecond precision in timestamps (feature available with MariaDB 5.3 and later).May confuse 3rd party components (Hibernated)
  - AUTO_RECONNECT
```
public static final DefaultOptions AUTO_RECONNECT
```
    Driver must recreateConnection after a failover
  - FAIL_ON_READ_ONLY
```
public static final DefaultOptions FAIL_ON_READ_ONLY
```
    After a master failover and no other master found, back on a read-only host ( throw exception if not)
  - SECONDS_BEFORE_RETRY_MASTER
```
public static final DefaultOptions SECONDS_BEFORE_RETRY_MASTER
```
    Number of seconds to issue before falling back to master when failed over (when using multi-host failover). Whichever condition is met first, 'queriesBeforeRetryMaster' or 'secondsBeforeRetryMaster' will cause an attempt to be made to reconnect to the master. Defaults to 50
  - QUERY_BEFORE_RETRY_MASTER
```
public static final DefaultOptions QUERY_BEFORE_RETRY_MASTER
```
    Number of queries to issue before falling back to master when failed over (when using multi-host failover). Whichever condition is met first, 'queriesBeforeRetryMaster' or 'secondsBeforeRetryMaster' will cause an attempt to be made to reconnect to the master. Defaults to 30
  - RETRY_ALL_DOWN
```
public static final DefaultOptions RETRY_ALL_DOWN
```
    When using loadbalancing, the number of times the driver should cycle through available hosts, attempting to connect. Between cycles, the driver will pause for 250ms if no servers are available.
  - FAILOVER_LOOP_RETRIES
```
public static final DefaultOptions FAILOVER_LOOP_RETRIES
```
    When using failover, the number of times the driver should cycle silently through available hosts, attempting to connect. Between cycles, the driver will pause for 250ms if no servers are available. if set to 0, there will be no silent reconnection
  - VALID_CONNECTION_TIMEOUT
```
public static final DefaultOptions VALID_CONNECTION_TIMEOUT
```
    When in multiple hosts, after this time in second without used, verification that the connections havn't been lost. When 0, no verification will be done. Defaults to 120
  - LOAD_BALANCE_BLACKLIST_TIMEOUT
```
public static final DefaultOptions LOAD_BALANCE_BLACKLIST_TIMEOUT
```
    time in second a server is blacklisted after a connection failure. default to 50s
- Field Detail
  - name
```
protected final String name
```
  - objType
```
protected final Object objType
```
  - defaultValue
```
protected final Object defaultValue
```
  - minValue
```
protected final Object minValue
```
  - maxValue
```
protected final Object maxValue
```
  - implementationVersion
```
protected final String implementationVersion
```
  - value
```
protected Object value
```
- Method Detail
  - values
```
public static DefaultOptions[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DefaultOptions c : DefaultOptions.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DefaultOptions valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - intValue
```
public int intValue()
```
  - boolValue
```
public boolean boolValue()
```
  - stringValue
```
public String stringValue()
```
  - defaultValues
```
public static Options defaultValues(UrlHAMode haMode)
```
  - parse
```
public static Options parse(UrlHAMode haMode,
                            String urlParameters,
                            Options options)
```
  - parse
```
public static Options parse(UrlHAMode haMode,
                            String urlParameters,
                            Properties properties)
```
  - addProperty
```
public static Options addProperty(UrlHAMode haMode,
                                  String name,
                                  String value,
                                  Options options)
```
  - addProperty
```
public static Options addProperty(UrlHAMode haMode,
                                  Properties additionnalProperties,
                                  Options options)
```
  - getProperties
```
public static Properties getProperties(Options options)
```
  - getProperties
```
public static String getProperties(String optionName,
                                   Options options)
```

Enum DefaultOptions

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

USER

PASSWORD

CONNECT_TIMOUT

PIPE

LOCAL_SOCKET

SHARED_MEMORY

TCP_NO_DELAY

TCP_ABORTIVE_CLOSE

LOCAL_SOCKET_ADDRESS

SOCKET_TIMEOUT

INTERACTIVE_CLIENT

DUMP_QUERY_ON_EXCEPTION

USE_OLD_ALIAS_METADATA_BEHAVIOR

ALLOW_LOCAL_INFILE

SESSION_VARIABLES

CREATE_DATABASE_IF_NOT_EXISTS

SERVER_TIMEZONE

NULL_CATALOG_MEANS_CURRENT

TINY_INT_IS_BIT

YEAR_IS_DATE_TYPE

USE_SSL

USER_COMPRESSION

ALLOW_MULTI_QUERIES

REWRITE_BATCHED_STATEMENTS

TCP_KEEP_ALIVE

TCP_RCV_BUF

TCP_SND_BUF

SOCKET_FACTORY

PIN_GLOBAL_TX_TO_PHYSICAL_CONNECTION

TRUST_SERVER_CERTIFICATE

SERVER_SSL_CERT

USE_FRACTIONAL_SECONDS

AUTO_RECONNECT

FAIL_ON_READ_ONLY

SECONDS_BEFORE_RETRY_MASTER

QUERY_BEFORE_RETRY_MASTER

RETRY_ALL_DOWN

FAILOVER_LOOP_RETRIES

VALID_CONNECTION_TIMEOUT

LOAD_BALANCE_BLACKLIST_TIMEOUT

Field Detail

name

objType

defaultValue

minValue

maxValue

implementationVersion

value

Method Detail

values

valueOf

intValue

boolValue

stringValue

defaultValues

parse

parse

addProperty

addProperty

getProperties

getProperties