java.lang.Object
- io.vertx.sqlclient.SqlConnectOptions
- - io.vertx.pgclient.PgConnectOptions

public class PgConnectOptions
extends SqlConnectOptions

Author:: Julien Viet, Billy Yuan

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_DATABASE`
`static String`	`DEFAULT_HOST`
`static String`	`DEFAULT_PASSWORD`
`static int`	`DEFAULT_PIPELINING_LIMIT`
`static int`	`DEFAULT_PORT`
`static Map<String,String>`	`DEFAULT_PROPERTIES`
`static SslMode`	`DEFAULT_SSLMODE`
`static boolean`	`DEFAULT_USE_LAYER_7_PROXY`
`static String`	`DEFAULT_USER`

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
`PgConnectOptions()`
`PgConnectOptions(JsonObject json)`
`PgConnectOptions(PgConnectOptions other)`
`PgConnectOptions(SqlConnectOptions other)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PgConnectOptions`	`addProperty(String key, String value)`
`boolean`	`equals(Object o)`
`static PgConnectOptions`	`fromEnv()`	Provide a `PgConnectOptions` configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.
`static PgConnectOptions`	`fromUri(String connectionUri)`	Provide a `PgConnectOptions` configured from a connection URI.
`int`	`getPipeliningLimit()`
`SocketAddress`	`getSocketAddress()`
`SslMode`	`getSslMode()`
`boolean`	`getUseLayer7Proxy()`
`int`	`hashCode()`
`protected void`	`init()`	Initialize with the default options.
`boolean`	`isUsingDomainSocket()`
`PgConnectOptions`	`merge(JsonObject other)`
`PgConnectOptions`	`setCachePreparedStatements(boolean cachePreparedStatements)`
`PgConnectOptions`	`setDatabase(String database)`
`PgConnectOptions`	`setHost(String host)`
`PgConnectOptions`	`setPassword(String password)`
`PgConnectOptions`	`setPipeliningLimit(int pipeliningLimit)`
`PgConnectOptions`	`setPort(int port)`
`PgConnectOptions`	`setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)`
`PgConnectOptions`	`setPreparedStatementCacheSqlFilter(Predicate<String> predicate)`
`PgConnectOptions`	`setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)`
`PgConnectOptions`	`setProperties(Map<String,String> properties)`
`PgConnectOptions`	`setReconnectAttempts(int attempts)`
`PgConnectOptions`	`setReconnectInterval(long interval)`
`PgConnectOptions`	`setSslMode(SslMode sslmode)`	Set `SslMode` for the client, this option can be used to provide different levels of secure protection.
`PgConnectOptions`	`setSslOptions(ClientSSLOptions sslOptions)`
`PgConnectOptions`	`setTracingPolicy(TracingPolicy tracingPolicy)`
`PgConnectOptions`	`setUseLayer7Proxy(boolean useLayer7Proxy)`	Set the client to use a layer 7 (application) proxy compatible protocol, set to `true` when the client interacts with a layer 7 proxy like PgBouncer instead of a server.
`PgConnectOptions`	`setUser(String user)`
`JsonObject`	`toJson()`
`static PgConnectOptions`	`wrap(SqlConnectOptions options)`

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, 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 int DEFAULT_PORT
```
  - DEFAULT_DATABASE
```
public static final String DEFAULT_DATABASE
```
    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_PIPELINING_LIMIT
```
public static final int DEFAULT_PIPELINING_LIMIT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSLMODE
```
public static final SslMode DEFAULT_SSLMODE
```
  - DEFAULT_USE_LAYER_7_PROXY
```
public static final boolean DEFAULT_USE_LAYER_7_PROXY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROPERTIES
```
public static final Map<String,String> DEFAULT_PROPERTIES
```
- Constructor Detail
  - PgConnectOptions
```
public PgConnectOptions()
```
  - PgConnectOptions
```
public PgConnectOptions(JsonObject json)
```
  - PgConnectOptions
```
public PgConnectOptions(SqlConnectOptions other)
```
  - PgConnectOptions
```
public PgConnectOptions(PgConnectOptions other)
```
- Method Detail
  - wrap
```
public static PgConnectOptions wrap(SqlConnectOptions options)
```
    Returns:
    
    the options as PostgreSQL specific connect options
  - fromUri
```
public static PgConnectOptions fromUri(String connectionUri)
                                throws IllegalArgumentException
```
    Provide a PgConnectOptions configured from a connection URI.
    
    Parameters:
    
    connectionUri - the connection URI to configure from
    
    Returns:
    
    a PgConnectOptions parsed from the connection URI
    
    Throws:
    
    IllegalArgumentException - when the connectionUri is in an invalid format
  - fromEnv
```
public static PgConnectOptions fromEnv()
```
    Provide a PgConnectOptions configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.
  - setHost
```
public PgConnectOptions setHost(String host)
```
    Overrides:
    
    setHost in class SqlConnectOptions
  - setPort
```
public PgConnectOptions setPort(int port)
```
    Overrides:
    
    setPort in class SqlConnectOptions
  - setUser
```
public PgConnectOptions setUser(String user)
```
    Overrides:
    
    setUser in class SqlConnectOptions
  - setPassword
```
public PgConnectOptions setPassword(String password)
```
    Overrides:
    
    setPassword in class SqlConnectOptions
  - setDatabase
```
public PgConnectOptions setDatabase(String database)
```
    Overrides:
    
    setDatabase in class SqlConnectOptions
  - getPipeliningLimit
```
public int getPipeliningLimit()
```
  - setPipeliningLimit
```
public PgConnectOptions setPipeliningLimit(int pipeliningLimit)
```
  - setCachePreparedStatements
```
public PgConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)
```
    Overrides:
    
    setCachePreparedStatements in class SqlConnectOptions
  - setPreparedStatementCacheMaxSize
```
public PgConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
```
    Overrides:
    
    setPreparedStatementCacheMaxSize in class SqlConnectOptions
  - setPreparedStatementCacheSqlFilter
```
public PgConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
```
    Overrides:
    
    setPreparedStatementCacheSqlFilter in class SqlConnectOptions
  - setPreparedStatementCacheSqlLimit
```
public PgConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
```
    Overrides:
    
    setPreparedStatementCacheSqlLimit in class SqlConnectOptions
  - setProperties
```
public PgConnectOptions setProperties(Map<String,String> properties)
```
    Overrides:
    
    setProperties in class SqlConnectOptions
  - addProperty
```
public PgConnectOptions addProperty(String key,
                                    String value)
```
    Overrides:
    
    addProperty in class SqlConnectOptions
  - getSslMode
```
public SslMode getSslMode()
```
    Returns:
    
    the value of current sslmode
  - setSslMode
```
public PgConnectOptions setSslMode(SslMode sslmode)
```
    Set SslMode for the client, this option can be used to provide different levels of secure protection.
    
    Parameters:
    
    sslmode - the value of sslmode
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getUseLayer7Proxy
```
@Unstable
public boolean getUseLayer7Proxy()
```
    Returns:
    
    whether the client interacts with a layer 7 proxy instead of a server
  - setUseLayer7Proxy
```
@Unstable
public PgConnectOptions setUseLayer7Proxy(boolean useLayer7Proxy)
```
    Set the client to use a layer 7 (application) proxy compatible protocol, set to true when the client interacts with a layer 7 proxy like PgBouncer instead of a server. Prepared statement caching must be disabled.
    
    Parameters:
    
    useLayer7Proxy - whether to use a layer 7 proxy instead of a server
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setReconnectAttempts
```
public PgConnectOptions setReconnectAttempts(int attempts)
```
    Overrides:
    
    setReconnectAttempts in class SqlConnectOptions
  - setReconnectInterval
```
public PgConnectOptions setReconnectInterval(long interval)
```
    Overrides:
    
    setReconnectInterval in class SqlConnectOptions
  - setTracingPolicy
```
public PgConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)
```
    Overrides:
    
    setTracingPolicy in class SqlConnectOptions
  - setSslOptions
```
public PgConnectOptions 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
  - getSocketAddress
```
public SocketAddress getSocketAddress()
```
    Overrides:
    
    getSocketAddress in class SqlConnectOptions
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isUsingDomainSocket
```
public boolean isUsingDomainSocket()
```
    Overrides:
    
    isUsingDomainSocket in class SqlConnectOptions
  - merge
```
public PgConnectOptions merge(JsonObject other)
```
    Overrides:
    
    merge in class SqlConnectOptions

Class PgConnectOptions

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_DATABASE

DEFAULT_USER

DEFAULT_PASSWORD

DEFAULT_PIPELINING_LIMIT

DEFAULT_SSLMODE

DEFAULT_USE_LAYER_7_PROXY

DEFAULT_PROPERTIES

Constructor Detail

PgConnectOptions

PgConnectOptions

PgConnectOptions

PgConnectOptions

Method Detail

wrap

fromUri

fromEnv

setHost

setPort

setUser

setPassword

setDatabase

getPipeliningLimit

setPipeliningLimit

setCachePreparedStatements

setPreparedStatementCacheMaxSize

setPreparedStatementCacheSqlFilter

setPreparedStatementCacheSqlLimit

setProperties

addProperty

getSslMode

setSslMode

getUseLayer7Proxy

setUseLayer7Proxy

setReconnectAttempts

setReconnectInterval

setTracingPolicy

setSslOptions

init

toJson

getSocketAddress

equals

hashCode

isUsingDomainSocket

merge