PgConnectOptions

@author <a href="mailto:julien@julienviet.com">Julien Viet</a> @author Billy Yuan <billy112487983@gmail.com>

class PgConnectOptions : SqlConnectOptions {}

Constructors

this
this()
Undocumented in source.
this
this(HttpURI uri)
Undocumented in source.
this
this(PgConnectOptions other)
Undocumented in source.

Members

Functions

addProperty
PgConnectOptions addProperty(string key, string value)
Undocumented in source. Be warned that the author may not have intended to support it.
getPipeliningLimit
int getPipeliningLimit()
Undocumented in source. Be warned that the author may not have intended to support it.
getSslMode
SslMode getSslMode()

@return the value of current sslmode

initialize
void initialize()

Initialize with the default options.

isUsingDomainSocket
bool isUsingDomainSocket()
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Object o)
Undocumented in source. Be warned that the author may not have intended to support it.
setCachePreparedStatements
PgConnectOptions setCachePreparedStatements(bool cachePreparedStatements)
Undocumented in source. Be warned that the author may not have intended to support it.
setConnectTimeout
PgConnectOptions setConnectTimeout(Duration connectTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setDatabase
PgConnectOptions setDatabase(string database)
Undocumented in source. Be warned that the author may not have intended to support it.
setDecoderBufferSize
PgConnectOptions setDecoderBufferSize(int size)
Undocumented in source. Be warned that the author may not have intended to support it.
setEncoderBufferSize
PgConnectOptions setEncoderBufferSize(int size)
Undocumented in source. Be warned that the author may not have intended to support it.
setHost
PgConnectOptions setHost(string host)
Undocumented in source. Be warned that the author may not have intended to support it.
setHostnameVerificationAlgorithm
PgConnectOptions setHostnameVerificationAlgorithm(string hostnameVerificationAlgorithm)
Undocumented in source. Be warned that the author may not have intended to support it.
setIdleTimeout
PgConnectOptions setIdleTimeout(Duration idleTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setLocalAddress
PgConnectOptions setLocalAddress(string localAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setLogActivity
PgConnectOptions setLogActivity(bool logEnabled)
Undocumented in source. Be warned that the author may not have intended to support it.
setMetricsName
PgConnectOptions setMetricsName(string metricsName)
Undocumented in source. Be warned that the author may not have intended to support it.
setOpenSslEngineOptions
PgConnectOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
Undocumented in source. Be warned that the author may not have intended to support it.
setPassword
PgConnectOptions setPassword(string password)
Undocumented in source. Be warned that the author may not have intended to support it.
setPipeliningLimit
PgConnectOptions setPipeliningLimit(int pipeliningLimit)
Undocumented in source. Be warned that the author may not have intended to support it.
setPort
PgConnectOptions setPort(int port)
Undocumented in source. Be warned that the author may not have intended to support it.
setPreparedStatementCacheMaxSize
PgConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setPreparedStatementCacheSqlLimit
PgConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
Undocumented in source. Be warned that the author may not have intended to support it.
setProperties
PgConnectOptions setProperties(Map!(string, string) properties)
Undocumented in source. Be warned that the author may not have intended to support it.
setProxyOptions
PgConnectOptions setProxyOptions(ProxyOptions proxyOptions)
Undocumented in source. Be warned that the author may not have intended to support it.
setReceiveBufferSize
PgConnectOptions setReceiveBufferSize(int receiveBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setReconnectAttempts
PgConnectOptions setReconnectAttempts(int attempts)
Undocumented in source. Be warned that the author may not have intended to support it.
setReconnectInterval
PgConnectOptions setReconnectInterval(Duration interval)
Undocumented in source. Be warned that the author may not have intended to support it.
setReuseAddress
PgConnectOptions setReuseAddress(bool reuseAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setReusePort
PgConnectOptions setReusePort(bool reusePort)
Undocumented in source. Be warned that the author may not have intended to support it.
setSendBufferSize
PgConnectOptions setSendBufferSize(int sendBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setSoLinger
PgConnectOptions setSoLinger(int soLinger)
Undocumented in source. Be warned that the author may not have intended to support it.
setSsl
PgConnectOptions setSsl(bool ssl)
Undocumented in source. Be warned that the author may not have intended to support it.
setSslHandshakeTimeout
PgConnectOptions setSslHandshakeTimeout(Duration sslHandshakeTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setSslMode
PgConnectOptions setSslMode(SslMode sslmode)

Set {@link SslMode} for the client, this option can be used to provide different levels of secure protection.

setTcpCork
PgConnectOptions setTcpCork(bool tcpCork)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpFastOpen
PgConnectOptions setTcpFastOpen(bool tcpFastOpen)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpKeepAlive
PgConnectOptions setTcpKeepAlive(bool tcpKeepAlive)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpNoDelay
PgConnectOptions setTcpNoDelay(bool tcpNoDelay)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpQuickAck
PgConnectOptions setTcpQuickAck(bool tcpQuickAck)
Undocumented in source. Be warned that the author may not have intended to support it.
setTrafficClass
PgConnectOptions setTrafficClass(int trafficClass)
Undocumented in source. Be warned that the author may not have intended to support it.
setUseAlpn
PgConnectOptions setUseAlpn(bool useAlpn)
Undocumented in source. Be warned that the author may not have intended to support it.
setUser
PgConnectOptions setUser(string user)
Undocumented in source. Be warned that the author may not have intended to support it.
toHash
size_t toHash()
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

fromUri
PgConnectOptions fromUri(string connectionUri)

Provide a {@link PgConnectOptions} configured from a connection URI.

Static variables

DEFAULT_PORT
int DEFAULT_PORT;
Undocumented in source.

Variables

DEFAULT_DATABASE
enum string DEFAULT_DATABASE;
Undocumented in source.
DEFAULT_HOST
enum string DEFAULT_HOST;

Provide a {@link PgConnectOptions} configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.

DEFAULT_PASSWORD
enum string DEFAULT_PASSWORD;
Undocumented in source.
DEFAULT_PIPELINING_LIMIT
enum int DEFAULT_PIPELINING_LIMIT;
Undocumented in source.
DEFAULT_PROPERTIES
enum string[string] DEFAULT_PROPERTIES;
Undocumented in source.
DEFAULT_SSLMODE
enum SslMode DEFAULT_SSLMODE;
Undocumented in source.
DEFAULT_USER
enum string DEFAULT_USER;
Undocumented in source.

Inherited Members

From SqlConnectOptions

DEFAULT_CACHE_PREPARED_STATEMENTS
enum bool DEFAULT_CACHE_PREPARED_STATEMENTS;
Undocumented in source.
DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE
enum int DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE;
Undocumented in source.
DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT
enum int DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT;
Undocumented in source.
getHost
string getHost()

Get the host for connecting to the server.

setHost
SqlConnectOptions setHost(string host)

Specify the host for connecting to the server.

getPort
int getPort()

Get the port for connecting to the server.

setPort
SqlConnectOptions setPort(int port)

Specify the port for connecting to the server.

getUser
string getUser()

Get the user account to be used for the authentication.

setUser
SqlConnectOptions setUser(string user)

Specify the user account to be used for the authentication.

getPassword
string getPassword()

Get the user password to be used for the authentication.

setPassword
SqlConnectOptions setPassword(string password)

Specify the user password to be used for the authentication.

getDatabase
string getDatabase()

Get the default database name for the connection.

setDatabase
SqlConnectOptions setDatabase(string database)

Specify the default database for the connection.

getCachePreparedStatements
bool getCachePreparedStatements()

Get whether prepared statements cache is enabled.

setCachePreparedStatements
SqlConnectOptions setCachePreparedStatements(bool cachePreparedStatements)

Set whether prepared statements cache should be enabled.

getPreparedStatementCacheMaxSize
int getPreparedStatementCacheMaxSize()

Get the maximum number of prepared statements that the connection will cache.

setPreparedStatementCacheMaxSize
SqlConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)

Set the maximum number of prepared statements that the connection will cache.

getPreparedStatementCacheSqlLimit
int getPreparedStatementCacheSqlLimit()

Get the maximum length of prepared statement SQL string that the connection will cache.

setPreparedStatementCacheSqlLimit
SqlConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)

Set the maximum length of prepared statement SQL string that the connection will cache.

getProperties
Map!(string, string) getProperties()

@return the value of current connection properties

setProperties
SqlConnectOptions setProperties(Map!(string, string) properties)

Set properties for this client, which will be sent to server at the connection start.

addProperty
SqlConnectOptions addProperty(string key, string value)

Add a property for this client, which will be sent to server at the connection start.

initialize
void initialize()

Initialize with the default options.

Meta