Configuration (singlestore-jdbc-client 1.2.7 API)

java.lang.Object
- com.singlestore.jdbc.Configuration

```
public class Configuration
extends Object
```
parse and verification of URL.
basic syntax :
jdbc:singlestore:[sequential:|failover|loadbalance:]//<hostDescription>[,<hostDescription>]/[database>] [?<key1>=<value1>[&<key2>=<value2>]]
hostDescription:
- simple :
<host>:<portnumber>
(for example localhost:3306)

- complex :
address=[(port=<portnumber>)](host=<host>)

type is by default master
port is by default 3306

host can be dns name, ipv4 or ipv6.
in case of ipv6 and simple host description, the ip must be written inside bracket.
exemple : jdbc:singlestore://[2001:0660:7401:0200:0000:0000:0edf:bdd7]:3306

Some examples :
jdbc:singlestore://localhost:3306/database?user=greg&password=pass
jdbc:singlestore://address=(port=3306)(host=master1),address=(port=3307)(host=child1)/database?user=greg&password=pass

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Configuration.Builder
A builder for Configuration instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Configuration.Builder` A builder for `Configuration` instances.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`acceptsUrl(String url)` Tell if the driver accepts url string.
`List<HostAddress>`	`addresses()` addresses
`boolean`	`allowLocalInfile()` permits LOAD LOCAL INFILE commands
`boolean`	`allowMultiQueries()` permit using multi queries command
`Boolean`	`autocommit()` Force session autocommit on connection creation
`boolean`	`blankTableNameMeta()` force returning blank table metadata (for old oracle compatibility)
`protected static String`	`buildUrl(Configuration conf)`
`boolean`	`cachePrepStmts()`
`Configuration`	`clone(String username, String password)`
`Codec<?>[]`	`codecs()`
`String`	`connectionAttributes()`
`int`	`connectTimeout()` socket connect timeout
`Configuration`	`connectTimeout(int connectTimeout)` Set connect timeout
`boolean`	`createDatabaseIfNotExist()` create database if not exist
`CredentialPlugin`	`credentialPlugin()` credential plugin to use
`String`	`database()` Connection default database
`int`	`defaultFetchSize()`
`boolean`	`disablePipeline()`
`boolean`	`dumpQueriesOnException()` Must query by logged on exception.
`String`	`enabledSslCipherSuites()` autorized cipher list.
`String`	`enabledSslProtocolSuites()` permitted ssl protocol list (comma separated)
`boolean`	`enableExtendedDataTypes()`
`boolean`	`equals(Object o)`
`String`	`geometryDefaultType()`
`String`	`getConsoleLogFilepath()`
`String`	`getConsoleLogLevel()`
`HaMode`	`haMode()` High availability mode
`int`	`hashCode()`
`boolean`	`includeThreadDumpInDeadlockExceptions()`
`String`	`initialUrl()` Configuration generated URL depending on current configuration option.
`String`	`initSql()` Execute initial command when connection is established
`String`	`jaasApplicationName()`
`String`	`keyPassword()` key store alias password
`String`	`keyStore()` key store
`String`	`keyStorePassword()` key store password
`String`	`keyStoreType()` key store type (to replace default javax.net.ssl.keyStoreType system property)
`String`	`localSocket()` local socket configuration
`String`	`localSocketAddress()` local socket address path
`Integer`	`maxAllowedPacket()` max_allowed_packet value to avoid sending packet with non supported size, droping the connection without reason.
`int`	`maxIdleTime()`
`int`	`maxPoolSize()`
`int`	`maxPrintStackSizeToLog()`
`int`	`maxQuerySizeToLog()`
`int`	`minPoolSize()`
`Properties`	`nonMappedOptions()`
`boolean`	`nullDatabaseMeansCurrent()` When enabled, in DatabaseMetadata, will handle null database as current
`static Configuration`	`parse(String url)`
`static Configuration`	`parse(String url, Properties prop)` Parse url connection string with additional properties.
`String`	`password()` configuration password
`String`	`pipe()` Pipe path
`boolean`	`pool()`
`String`	`poolName()`
`int`	`poolValidMinDelay()`
`int`	`prepStmtCacheSize()` Prepare statement cache size.
`boolean`	`printStackTrace()`
`boolean`	`registerJmxPool()`
`String`	`restrictedAuth()`
`int`	`retriesAllDown()`
`boolean`	`rewriteBatchedStatements()`
`String`	`serverSslCert()` server ssl certificate (file path / certificat content)
`String`	`servicePrincipalName()`
`String`	`sessionVariables()` coma separated Session variable list
`String`	`socketFactory()` Socket factory class name
`int`	`socketTimeout()` socket timeout
`SslMode`	`sslMode()` SSl mode
`boolean`	`tcpAbortiveClose()` close using TCP abortive close (RST TCP packet, in place or FIN packet)
`boolean`	`tcpKeepAlive()` socket tcp keep alive
`int`	`tcpKeepCount()` socket tcp keep count (java 11+ only)
`int`	`tcpKeepIdle()` socket tcp keep idle (java 11+ only)
`int`	`tcpKeepInterval()` socket tcp keep interval (java 11+ only)
`boolean`	`tinyInt1isBit()` Must tinyint be considered as Bit (TINYINT is always has reserved length = 4)
`String`	`tlsSocketType()`
`static String`	`toConf(String url)` Permit to have string information on how string is parsed.
`String`	`toString()` ToString implementation.
`TransactionIsolation`	`transactionIsolation()` Default transaction isolation
`boolean`	`transactionReplay()`
`int`	`transactionReplaySize()` transaction replay maximum number of saved command.
`boolean`	`transformedBitIsBoolean()` Must tinyint be considered as Boolean or Bit
`String`	`trustStore()` trust store
`String`	`trustStorePassword()` trust store password
`String`	`trustStoreType()` trust store type
`boolean`	`useAffectedRows()` Use affected row
`boolean`	`useCompression()` Enable compression if server has compression capability
`boolean`	`useMysqlVersion()`
`String`	`user()` configuration user
`boolean`	`useReadAheadInput()`
`boolean`	`useResetConnection()`
`boolean`	`useServerPrepStmts()` Use server prepared statement.
`boolean`	`vectorExtendedMetadata()`
`String`	`vectorTypeOutputFormat()`
`boolean`	`yearIsDateType()` Must year be return by default as Date in result-set

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

- Method Detail
  - acceptsUrl
```
public static boolean acceptsUrl(String url)
```
    Tell if the driver accepts url string. (Correspond to interface java.jdbc.Driver.acceptsURL() method)
    
    Parameters:
    
    url - url String
    
    Returns:
    
    true if url string correspond.
  - parse
```
public static Configuration parse(String url)
                           throws SQLException
```
    Throws:
    
    SQLException
  - parse
```
public static Configuration parse(String url,
                                  Properties prop)
                           throws SQLException
```
    Parse url connection string with additional properties.
    
    Parameters:
    
    url - connection string
    
    prop - properties
    
    Returns:
    
    UrlParser instance
    
    Throws:
    
    SQLException - if parsing exception occur
  - toConf
```
public static String toConf(String url)
                     throws SQLException
```
    Permit to have string information on how string is parsed. example : Configuration.toConf("jdbc:singlestore://localhost/test") will return a String containing: Configuration: * resulting Url : jdbc:singlestore://localhost/test Unknown options : None Non default options : * database : test default options : * user : null ...
    
    Parameters:
    
    url - url string
    
    Returns:
    
    string describing the configuration parsed from url
    
    Throws:
    
    SQLException - if parsing fails
  - clone
```
public Configuration clone(String username,
                           String password)
```
  - database
```
public String database()
```
    Connection default database
    
    Returns:
    
    database
  - addresses
```
public List<HostAddress> addresses()
```
    addresses
    
    Returns:
    
    addresses
  - haMode
```
public HaMode haMode()
```
    High availability mode
    
    Returns:
    
    configuration HA mode
  - credentialPlugin
```
public CredentialPlugin credentialPlugin()
```
    credential plugin to use
    
    Returns:
    
    credential plugin to use, null of none
  - user
```
public String user()
```
    configuration user
    
    Returns:
    
    user
  - password
```
public String password()
```
    configuration password
    
    Returns:
    
    password
  - initialUrl
```
public String initialUrl()
```
    Configuration generated URL depending on current configuration option. Password will be hidden by "***"
    
    Returns:
    
    generated url
  - serverSslCert
```
public String serverSslCert()
```
    server ssl certificate (file path / certificat content)
    
    Returns:
    
    server ssl certificate
  - trustStore
```
public String trustStore()
```
    trust store
    
    Returns:
    
    trust store
  - trustStorePassword
```
public String trustStorePassword()
```
    trust store password
    
    Returns:
    
    trust store password
  - trustStoreType
```
public String trustStoreType()
```
    trust store type
    
    Returns:
    
    trust store type
  - keyStore
```
public String keyStore()
```
    key store
    
    Returns:
    
    key store
  - keyStorePassword
```
public String keyStorePassword()
```
    key store password
    
    Returns:
    
    key store password
  - keyPassword
```
public String keyPassword()
```
    key store alias password
    
    Returns:
    
    key store alias password
  - keyStoreType
```
public String keyStoreType()
```
    key store type (to replace default javax.net.ssl.keyStoreType system property)
    
    Returns:
    
    key store type
  - enabledSslProtocolSuites
```
public String enabledSslProtocolSuites()
```
    permitted ssl protocol list (comma separated)
    
    Returns:
    
    enabled ssl protocol list
  - socketFactory
```
public String socketFactory()
```
    Socket factory class name
    
    Returns:
    
    socket factory
  - connectTimeout
```
public int connectTimeout()
```
    socket connect timeout
    
    Returns:
    
    connect timeout
  - connectTimeout
```
public Configuration connectTimeout(int connectTimeout)
```
    Set connect timeout
    
    Parameters:
    
    connectTimeout - timeout value
    
    Returns:
    
    current configuration
  - pipe
```
public String pipe()
```
    Pipe path
    
    Returns:
    
    pipe value
  - localSocket
```
public String localSocket()
```
    local socket configuration
    
    Returns:
    
    local socket path
  - tcpKeepAlive
```
public boolean tcpKeepAlive()
```
    socket tcp keep alive
    
    Returns:
    
    socket tcp keep alive value
  - tcpKeepIdle
```
public int tcpKeepIdle()
```
    socket tcp keep idle (java 11+ only)
    
    Returns:
    
    socket tcp keep idle
  - tcpKeepCount
```
public int tcpKeepCount()
```
    socket tcp keep count (java 11+ only)
    
    Returns:
    
    socket tcp keep count
  - tcpKeepInterval
```
public int tcpKeepInterval()
```
    socket tcp keep interval (java 11+ only)
    
    Returns:
    
    socket tcp keep interval
  - tcpAbortiveClose
```
public boolean tcpAbortiveClose()
```
    close using TCP abortive close (RST TCP packet, in place or FIN packet)
    
    Returns:
    
    close using TCP abortive close
  - localSocketAddress
```
public String localSocketAddress()
```
    local socket address path
    
    Returns:
    
    local socket address
  - socketTimeout
```
public int socketTimeout()
```
    socket timeout
    
    Returns:
    
    socket timeout
  - allowMultiQueries
```
public boolean allowMultiQueries()
```
    permit using multi queries command
    
    Returns:
    
    permit using multi queries command
  - allowLocalInfile
```
public boolean allowLocalInfile()
```
    permits LOAD LOCAL INFILE commands
    
    Returns:
    
    allow LOAD LOCAL INFILE
  - useCompression
```
public boolean useCompression()
```
    Enable compression if server has compression capability
    
    Returns:
    
    use compression
  - blankTableNameMeta
```
public boolean blankTableNameMeta()
```
    force returning blank table metadata (for old oracle compatibility)
    
    Returns:
    
    metadata table return blank
  - sslMode
```
public SslMode sslMode()
```
    SSl mode
    
    Returns:
    
    ssl mode
  - transactionIsolation
```
public TransactionIsolation transactionIsolation()
```
    Default transaction isolation
    
    Returns:
    
    default transaction isolation.
  - enabledSslCipherSuites
```
public String enabledSslCipherSuites()
```
    autorized cipher list.
    
    Returns:
    
    list of permitted ciphers
  - sessionVariables
```
public String sessionVariables()
```
    coma separated Session variable list
    
    Returns:
    
    session variable
  - tinyInt1isBit
```
public boolean tinyInt1isBit()
```
    Must tinyint be considered as Bit (TINYINT is always has reserved length = 4)
    
    Returns:
    
    true if tinyint must be considered as Bit
  - transformedBitIsBoolean
```
public boolean transformedBitIsBoolean()
```
    Must tinyint be considered as Boolean or Bit
    
    Returns:
    
    true if tinyint must be considered as Boolean
  - yearIsDateType
```
public boolean yearIsDateType()
```
    Must year be return by default as Date in result-set
    
    Returns:
    
    year is Date type
  - dumpQueriesOnException
```
public boolean dumpQueriesOnException()
```
    Must query by logged on exception.
    
    Returns:
    
    dump queries on exception
  - prepStmtCacheSize
```
public int prepStmtCacheSize()
```
    Prepare statement cache size.
    
    Returns:
    
    Prepare statement cache size
  - useAffectedRows
```
public boolean useAffectedRows()
```
    Use affected row
    
    Returns:
    
    use affected rows
  - disablePipeline
```
public boolean disablePipeline()
```
  - useServerPrepStmts
```
public boolean useServerPrepStmts()
```
    Use server prepared statement. IF false, using client prepared statement.
    
    Returns:
    
    use server prepared statement
  - connectionAttributes
```
public String connectionAttributes()
```
  - autocommit
```
public Boolean autocommit()
```
    Force session autocommit on connection creation
    
    Returns:
    
    autocommit forced value
  - nullDatabaseMeansCurrent
```
public boolean nullDatabaseMeansCurrent()
```
    When enabled, in DatabaseMetadata, will handle null database as current
    
    Returns:
    
    must null value be considered as current catalog
  - includeThreadDumpInDeadlockExceptions
```
public boolean includeThreadDumpInDeadlockExceptions()
```
  - createDatabaseIfNotExist
```
public boolean createDatabaseIfNotExist()
```
    create database if not exist
    
    Returns:
    
    create database if not exist
  - initSql
```
public String initSql()
```
    Execute initial command when connection is established
    
    Returns:
    
    initial SQL command
  - servicePrincipalName
```
public String servicePrincipalName()
```
  - jaasApplicationName
```
public String jaasApplicationName()
```
  - defaultFetchSize
```
public int defaultFetchSize()
```
  - nonMappedOptions
```
public Properties nonMappedOptions()
```
  - tlsSocketType
```
public String tlsSocketType()
```
  - maxQuerySizeToLog
```
public int maxQuerySizeToLog()
```
  - maxAllowedPacket
```
public Integer maxAllowedPacket()
```
    max_allowed_packet value to avoid sending packet with non supported size, droping the connection without reason.
    
    Returns:
    
    max_allowed_packet value
  - retriesAllDown
```
public int retriesAllDown()
```
  - pool
```
public boolean pool()
```
  - poolName
```
public String poolName()
```
  - maxPoolSize
```
public int maxPoolSize()
```
  - minPoolSize
```
public int minPoolSize()
```
  - maxIdleTime
```
public int maxIdleTime()
```
  - registerJmxPool
```
public boolean registerJmxPool()
```
  - poolValidMinDelay
```
public int poolValidMinDelay()
```
  - useResetConnection
```
public boolean useResetConnection()
```
  - useReadAheadInput
```
public boolean useReadAheadInput()
```
  - cachePrepStmts
```
public boolean cachePrepStmts()
```
  - transactionReplay
```
public boolean transactionReplay()
```
  - transactionReplaySize
```
public int transactionReplaySize()
```
    transaction replay maximum number of saved command.
    
    Returns:
    
    transaction replay buffer size.
  - geometryDefaultType
```
public String geometryDefaultType()
```
  - restrictedAuth
```
public String restrictedAuth()
```
  - codecs
```
public Codec<?>[] codecs()
```
  - useMysqlVersion
```
public boolean useMysqlVersion()
```
  - rewriteBatchedStatements
```
public boolean rewriteBatchedStatements()
```
  - getConsoleLogLevel
```
public String getConsoleLogLevel()
```
  - getConsoleLogFilepath
```
public String getConsoleLogFilepath()
```
  - printStackTrace
```
public boolean printStackTrace()
```
  - maxPrintStackSizeToLog
```
public int maxPrintStackSizeToLog()
```
  - enableExtendedDataTypes
```
public boolean enableExtendedDataTypes()
```
  - vectorTypeOutputFormat
```
public String vectorTypeOutputFormat()
```
  - vectorExtendedMetadata
```
public boolean vectorExtendedMetadata()
```
  - toString
```
public String toString()
```
    ToString implementation.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String value
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - buildUrl
```
protected static String buildUrl(Configuration conf)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Configuration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

acceptsUrl

parse

parse

toConf

clone

database

addresses

haMode

credentialPlugin

user

password

initialUrl

serverSslCert

trustStore

trustStorePassword

trustStoreType

keyStore

keyStorePassword

keyPassword

keyStoreType

enabledSslProtocolSuites

socketFactory

connectTimeout

connectTimeout

pipe

localSocket

tcpKeepAlive

tcpKeepIdle

tcpKeepCount

tcpKeepInterval

tcpAbortiveClose

localSocketAddress

socketTimeout

allowMultiQueries

allowLocalInfile

useCompression

blankTableNameMeta

sslMode

transactionIsolation

enabledSslCipherSuites

sessionVariables

tinyInt1isBit

transformedBitIsBoolean

yearIsDateType

dumpQueriesOnException

prepStmtCacheSize

useAffectedRows

disablePipeline

useServerPrepStmts

connectionAttributes

autocommit

nullDatabaseMeansCurrent

includeThreadDumpInDeadlockExceptions

createDatabaseIfNotExist

initSql

servicePrincipalName

jaasApplicationName

defaultFetchSize

nonMappedOptions

tlsSocketType

maxQuerySizeToLog

maxAllowedPacket

retriesAllDown

pool

poolName

maxPoolSize

minPoolSize

maxIdleTime

registerJmxPool

poolValidMinDelay

useResetConnection

useReadAheadInput

cachePrepStmts

transactionReplay

transactionReplaySize