java.lang.Object
- io.vertx.sqlclient.SqlConnectOptions
- - io.vertx.mssqlclient.MSSQLConnectOptions

public class MSSQLConnectOptions
extends SqlConnectOptions

Connect options for configuring MSSQLConnection.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_APP_NAME`
`static String`	`DEFAULT_CLIENT_INTERFACE_NAME`
`static String`	`DEFAULT_DATABASE`
`static String`	`DEFAULT_HOST`
`static int`	`DEFAULT_PACKET_SIZE`
`static String`	`DEFAULT_PASSWORD`
`static int`	`DEFAULT_PORT`
`static Map<String,String>`	`DEFAULT_PROPERTIES`
`static boolean`	`DEFAULT_SSL`
`static String`	`DEFAULT_USER`
`static int`	`MAX_PACKET_SIZE`
`static int`	`MIN_PACKET_SIZE`

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions
DEFAULT_CACHE_PREPARED_STATEMENTS, DEFAULT_METRICS_NAME, DEFAULT_PREPARED_STATEMENT_CACHE_FILTER, DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE, DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL

Constructor Summary

Constructors
Constructor	Description
`MSSQLConnectOptions()`
`MSSQLConnectOptions(JsonObject json)`
`MSSQLConnectOptions(MSSQLConnectOptions other)`
`MSSQLConnectOptions(SqlConnectOptions other)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MSSQLConnectOptions`	`addProperty(String key, String value)`
`static MSSQLConnectOptions`	`fromUri(String connectionUri)`	Provide a `MSSQLConnectOptions` configured from a connection URI.
`int`	`getPacketSize()`	Get the desired size (in bytes) for TDS packets.
`protected void`	`init()`	Initialize with the default options.
`boolean`	`isSsl()`
`MSSQLConnectOptions`	`merge(JsonObject other)`
`MSSQLConnectOptions`	`setCachePreparedStatements(boolean cachePreparedStatements)`
`MSSQLConnectOptions`	`setDatabase(String database)`
`MSSQLConnectOptions`	`setHost(String host)`
`MSSQLConnectOptions`	`setPacketSize(int packetSize)`	Set the desired size (in bytes) for TDS packets.
`MSSQLConnectOptions`	`setPassword(String password)`
`MSSQLConnectOptions`	`setPort(int port)`
`MSSQLConnectOptions`	`setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)`
`MSSQLConnectOptions`	`setPreparedStatementCacheSqlFilter(Predicate<String> predicate)`
`MSSQLConnectOptions`	`setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)`
`MSSQLConnectOptions`	`setProperties(Map<String,String> properties)`
`MSSQLConnectOptions`	`setReconnectAttempts(int attempts)`
`MSSQLConnectOptions`	`setReconnectInterval(long interval)`
`MSSQLConnectOptions`	`setSsl(boolean ssl)`	Set whether SSL/TLS is enabled
`MSSQLConnectOptions`	`setSslOptions(ClientSSLOptions sslOptions)`
`MSSQLConnectOptions`	`setUser(String user)`
`JsonObject`	`toJson()`
`static MSSQLConnectOptions`	`wrap(SqlConnectOptions options)`

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions
getCachePreparedStatements, getDatabase, getHost, getMetricsName, getPassword, getPort, getPreparedStatementCacheMaxSize, getPreparedStatementCacheSqlFilter, getProperties, getReconnectAttempts, getReconnectInterval, getSocketAddress, getSslOptions, getTracingPolicy, getUser, isUsingDomainSocket, setMetricsName, setTracingPolicy

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

- Field Detail
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USER
```
public static final String DEFAULT_USER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PASSWORD
```
public static final String DEFAULT_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DATABASE
```
public static final String DEFAULT_DATABASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_APP_NAME
```
public static final String DEFAULT_APP_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CLIENT_INTERFACE_NAME
```
public static final String DEFAULT_CLIENT_INTERFACE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROPERTIES
```
public static final Map<String,String> DEFAULT_PROPERTIES
```
  - MIN_PACKET_SIZE
```
public static final int MIN_PACKET_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_PACKET_SIZE
```
public static final int MAX_PACKET_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PACKET_SIZE
```
public static final int DEFAULT_PACKET_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL
```
public static final boolean DEFAULT_SSL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MSSQLConnectOptions
```
public MSSQLConnectOptions()
```
  - MSSQLConnectOptions
```
public MSSQLConnectOptions(JsonObject json)
```
  - MSSQLConnectOptions
```
public MSSQLConnectOptions(SqlConnectOptions other)
```
  - MSSQLConnectOptions
```
public MSSQLConnectOptions(MSSQLConnectOptions other)
```
- Method Detail
  - wrap
```
public static MSSQLConnectOptions wrap(SqlConnectOptions options)
```
    Returns:
    
    the options as MSSQL specific connect options
  - fromUri
```
public static MSSQLConnectOptions fromUri(String connectionUri)
                                   throws IllegalArgumentException
```
    Provide a MSSQLConnectOptions configured from a connection URI.
    
    Parameters:
    
    connectionUri - the connection URI to configure from
    
    Returns:
    
    a MSSQLConnectOptions parsed from the connection URI
    
    Throws:
    
    IllegalArgumentException - when the connectionUri is in an invalid format
  - setHost
```
public MSSQLConnectOptions setHost(String host)
```
    Overrides:
    
    setHost in class SqlConnectOptions
  - setPort
```
public MSSQLConnectOptions setPort(int port)
```
    Overrides:
    
    setPort in class SqlConnectOptions
  - setUser
```
public MSSQLConnectOptions setUser(String user)
```
    Overrides:
    
    setUser in class SqlConnectOptions
  - setPassword
```
public MSSQLConnectOptions setPassword(String password)
```
    Overrides:
    
    setPassword in class SqlConnectOptions
  - setDatabase
```
public MSSQLConnectOptions setDatabase(String database)
```
    Overrides:
    
    setDatabase in class SqlConnectOptions
  - setProperties
```
public MSSQLConnectOptions setProperties(Map<String,String> properties)
```
    Overrides:
    
    setProperties in class SqlConnectOptions
  - addProperty
```
public MSSQLConnectOptions addProperty(String key,
                                       String value)
```
    Overrides:
    
    addProperty in class SqlConnectOptions
  - getPacketSize
```
public int getPacketSize()
```
    Get the desired size (in bytes) for TDS packets.
    
    Returns:
    
    the desired packet size
  - setPacketSize
```
public MSSQLConnectOptions setPacketSize(int packetSize)
```
    Set the desired size (in bytes) for TDS packets.
    The client will use the value as a parameter in the LOGIN7 packet. The server may or may not accept it.
    
    Parameters:
    
    packetSize - the desired packet size (in bytes)
    
    Returns:
    
    a reference to this, so the API can be used fluently
    
    Throws:
    
    IllegalArgumentException - if packetSize is smaller than MIN_PACKET_SIZE or bigger than MAX_PACKET_SIZE
  - isSsl
```
public boolean isSsl()
```
    Returns:
    
    is SSL/TLS enabled?
  - setSsl
```
public MSSQLConnectOptions setSsl(boolean ssl)
```
    Set whether SSL/TLS is enabled
    
    Parameters:
    
    ssl - true if enabled
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setReconnectAttempts
```
public MSSQLConnectOptions setReconnectAttempts(int attempts)
```
    Overrides:
    
    setReconnectAttempts in class SqlConnectOptions
  - setReconnectInterval
```
public MSSQLConnectOptions setReconnectInterval(long interval)
```
    Overrides:
    
    setReconnectInterval in class SqlConnectOptions
  - setCachePreparedStatements
```
public MSSQLConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)
```
    Overrides:
    
    setCachePreparedStatements in class SqlConnectOptions
  - setPreparedStatementCacheMaxSize
```
public MSSQLConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
```
    Overrides:
    
    setPreparedStatementCacheMaxSize in class SqlConnectOptions
  - setPreparedStatementCacheSqlFilter
```
public MSSQLConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
```
    Overrides:
    
    setPreparedStatementCacheSqlFilter in class SqlConnectOptions
  - setPreparedStatementCacheSqlLimit
```
public MSSQLConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
```
    Overrides:
    
    setPreparedStatementCacheSqlLimit in class SqlConnectOptions
  - setSslOptions
```
public MSSQLConnectOptions setSslOptions(ClientSSLOptions sslOptions)
```
    Overrides:
    
    setSslOptions in class SqlConnectOptions
  - init
```
protected void init()
```
    Initialize with the default options.
    
    Overrides:
    
    init in class SqlConnectOptions
  - toJson
```
public JsonObject toJson()
```
    Overrides:
    
    toJson in class SqlConnectOptions
  - merge
```
public MSSQLConnectOptions merge(JsonObject other)
```
    Overrides:
    
    merge in class SqlConnectOptions

Class MSSQLConnectOptions

Field Summary

Fields inherited from class io.vertx.sqlclient.SqlConnectOptions

Constructor Summary

Method Summary

Methods inherited from class io.vertx.sqlclient.SqlConnectOptions

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HOST

DEFAULT_PORT

DEFAULT_USER

DEFAULT_PASSWORD

DEFAULT_DATABASE

DEFAULT_APP_NAME

DEFAULT_CLIENT_INTERFACE_NAME

DEFAULT_PROPERTIES

MIN_PACKET_SIZE

MAX_PACKET_SIZE

DEFAULT_PACKET_SIZE

DEFAULT_SSL

Constructor Detail

MSSQLConnectOptions

MSSQLConnectOptions

MSSQLConnectOptions

MSSQLConnectOptions

Method Detail

wrap

fromUri

setHost

setPort

setUser

setPassword

setDatabase

setProperties

addProperty

getPacketSize

setPacketSize

isSsl

setSsl

setReconnectAttempts

setReconnectInterval

setCachePreparedStatements

setPreparedStatementCacheMaxSize

setPreparedStatementCacheSqlFilter

setPreparedStatementCacheSqlLimit

setSslOptions

init

toJson

merge