Configuration (singlestore-jdbc-client 1.1.4 API)

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

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

- complex :
address=[(type=(master|slave))][(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=(type=master)(host=master1),address=(port=3307)(type=slave)(host=slave1)/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()`
`boolean`	`allowLocalInfile()`
`boolean`	`allowMultiQueries()`
`boolean`	`autocommit()`
`boolean`	`blankTableNameMeta()`
`protected static String`	`buildUrl(Configuration conf)`
`boolean`	`cachePrepStmts()`
`Configuration`	`clone(String username, String password)`
`com.singlestore.jdbc.codec.Codec<?>[]`	`codecs()`
`String`	`connectionAttributes()`
`int`	`connectTimeout()`
`Configuration`	`connectTimeout(int connectTimeout)`
`CredentialPlugin`	`credentialPlugin()`
`String`	`database()`
`int`	`defaultFetchSize()`
`boolean`	`dumpQueriesOnException()`
`String`	`enabledSslCipherSuites()`
`String`	`enabledSslProtocolSuites()`
`boolean`	`equals(Object o)`
`String`	`geometryDefaultType()`
`HaMode`	`haMode()`
`int`	`hashCode()`
`boolean`	`includeThreadDumpInDeadlockExceptions()`
`String`	`initialUrl()`
`String`	`keyStore()`
`String`	`keyStorePassword()`
`String`	`keyStoreType()`
`String`	`localSocket()`
`String`	`localSocketAddress()`
`int`	`maxIdleTime()`
`int`	`maxPoolSize()`
`int`	`maxQuerySizeToLog()`
`int`	`minPoolSize()`
`Properties`	`nonMappedOptions()`
`static Configuration`	`parse(String url)`
`static Configuration`	`parse(String url, Properties prop)` Parse url connection string with additional properties.
`String`	`password()`
`String`	`pipe()`
`boolean`	`pool()`
`String`	`poolName()`
`int`	`poolValidMinDelay()`
`int`	`prepStmtCacheSize()`
`boolean`	`registerJmxPool()`
`String`	`restrictedAuth()`
`int`	`retriesAllDown()`
`String`	`serverSslCert()`
`String`	`servicePrincipalName()`
`String`	`sessionVariables()`
`String`	`socketFactory()`
`int`	`socketTimeout()`
`SslMode`	`sslMode()`
`boolean`	`tcpAbortiveClose()`
`boolean`	`tcpKeepAlive()`
`int`	`tcpKeepCount()`
`int`	`tcpKeepIdle()`
`int`	`tcpKeepInterval()`
`boolean`	`tinyInt1isBit()`
`String`	`tlsSocketType()`
`String`	`toString()` ToString implementation.
`TransactionIsolation`	`transactionIsolation()`
`boolean`	`transactionReplay()`
`String`	`trustStore()`
`String`	`trustStorePassword()`
`String`	`trustStoreType()`
`boolean`	`useAffectedRows()`
`boolean`	`useCompression()`
`boolean`	`useMysqlVersion()`
`String`	`user()`
`boolean`	`useReadAheadInput()`
`boolean`	`useResetConnection()`
`boolean`	`useServerPrepStmts()`
`boolean`	`yearIsDateType()`

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

clone

public Configuration clone(String username,
                           String password)

database
```
public String database()
```

addresses
```
public List<HostAddress> addresses()
```

haMode
```
public HaMode haMode()
```

credentialPlugin

public CredentialPlugin credentialPlugin()

user
```
public String user()
```

password
```
public String password()
```

initialUrl
```
public String initialUrl()
```

serverSslCert
```
public String serverSslCert()
```

trustStore
```
public String trustStore()
```

trustStorePassword
```
public String trustStorePassword()
```

trustStoreType
```
public String trustStoreType()
```

keyStore
```
public String keyStore()
```

keyStorePassword
```
public String keyStorePassword()
```

keyStoreType
```
public String keyStoreType()
```

enabledSslProtocolSuites

public String enabledSslProtocolSuites()

socketFactory
```
public String socketFactory()
```

connectTimeout
```
public int connectTimeout()
```

connectTimeout

public Configuration connectTimeout(int connectTimeout)

pipe
```
public String pipe()
```

localSocket
```
public String localSocket()
```

tcpKeepAlive
```
public boolean tcpKeepAlive()
```

tcpKeepIdle
```
public int tcpKeepIdle()
```

tcpKeepCount
```
public int tcpKeepCount()
```

tcpKeepInterval
```
public int tcpKeepInterval()
```

tcpAbortiveClose
```
public boolean tcpAbortiveClose()
```

localSocketAddress
```
public String localSocketAddress()
```

socketTimeout
```
public int socketTimeout()
```

allowMultiQueries
```
public boolean allowMultiQueries()
```

allowLocalInfile
```
public boolean allowLocalInfile()
```

useCompression
```
public boolean useCompression()
```

blankTableNameMeta
```
public boolean blankTableNameMeta()
```

sslMode
```
public SslMode sslMode()
```

transactionIsolation

public TransactionIsolation transactionIsolation()

enabledSslCipherSuites

public String enabledSslCipherSuites()

sessionVariables
```
public String sessionVariables()
```

tinyInt1isBit
```
public boolean tinyInt1isBit()
```

yearIsDateType
```
public boolean yearIsDateType()
```

dumpQueriesOnException

public boolean dumpQueriesOnException()

prepStmtCacheSize
```
public int prepStmtCacheSize()
```

useAffectedRows
```
public boolean useAffectedRows()
```

useServerPrepStmts
```
public boolean useServerPrepStmts()
```

connectionAttributes
```
public String connectionAttributes()
```

autocommit
```
public boolean autocommit()
```

includeThreadDumpInDeadlockExceptions

public boolean includeThreadDumpInDeadlockExceptions()

servicePrincipalName
```
public String servicePrincipalName()
```

defaultFetchSize
```
public int defaultFetchSize()
```

nonMappedOptions
```
public Properties nonMappedOptions()
```

tlsSocketType
```
public String tlsSocketType()
```

maxQuerySizeToLog
```
public int maxQuerySizeToLog()
```

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()
```

geometryDefaultType
```
public String geometryDefaultType()
```

restrictedAuth
```
public String restrictedAuth()
```

codecs

public com.singlestore.jdbc.codec.Codec<?>[] codecs()

useMysqlVersion
```
public boolean useMysqlVersion()
```

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

clone

database

addresses

haMode

credentialPlugin

user

password

initialUrl

serverSslCert

trustStore

trustStorePassword

trustStoreType

keyStore

keyStorePassword

keyStoreType

enabledSslProtocolSuites

socketFactory

connectTimeout

connectTimeout

pipe

localSocket

tcpKeepAlive

tcpKeepIdle

tcpKeepCount

tcpKeepInterval

tcpAbortiveClose

localSocketAddress

socketTimeout

allowMultiQueries

allowLocalInfile

useCompression

blankTableNameMeta

sslMode

transactionIsolation

enabledSslCipherSuites

sessionVariables

tinyInt1isBit

yearIsDateType

dumpQueriesOnException

prepStmtCacheSize

useAffectedRows

useServerPrepStmts

connectionAttributes

autocommit

includeThreadDumpInDeadlockExceptions

servicePrincipalName

defaultFetchSize

nonMappedOptions

tlsSocketType

maxQuerySizeToLog

retriesAllDown

pool

poolName

maxPoolSize

minPoolSize

maxIdleTime

registerJmxPool

poolValidMinDelay

useResetConnection

useReadAheadInput

cachePrepStmts

transactionReplay

geometryDefaultType

restrictedAuth

codecs

useMysqlVersion

toString

equals

buildUrl

hashCode