Class PgConnectOptions

java.lang.Object
io.vertx.sqlclient.SqlConnectOptions
io.vertx.pgclient.PgConnectOptions
public class PgConnectOptions extends SqlConnectOptions
Author:
Julien Viet, Billy Yuan invalid input: '<'[email protected]>

  • Field Details

  • Constructor Details

    • PgConnectOptions

      public PgConnectOptions()

    • PgConnectOptions

      public PgConnectOptions(JsonObject json)

    • PgConnectOptions

      public PgConnectOptions(SqlConnectOptions other)

    • PgConnectOptions

      public PgConnectOptions(PgConnectOptions other)

  • Method Details

    • 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)
      Description copied from class: SqlConnectOptions
      Specify the host for connecting to the server.
      Overrides:
      setHost in class SqlConnectOptions
      Parameters:
      host - the host to specify
      Returns:
      a reference to this, so the API can be used fluently

    • setPort

      public PgConnectOptions setPort(int port)
      Description copied from class: SqlConnectOptions
      Specify the port for connecting to the server.
      Overrides:
      setPort in class SqlConnectOptions
      Parameters:
      port - the port to specify
      Returns:
      a reference to this, so the API can be used fluently

    • setUser

      public PgConnectOptions setUser(String user)
      Description copied from class: SqlConnectOptions
      Specify the user account to be used for the authentication.
      Overrides:
      setUser in class SqlConnectOptions
      Parameters:
      user - the user to specify
      Returns:
      a reference to this, so the API can be used fluently

    • setPassword

      public PgConnectOptions setPassword(String password)
      Description copied from class: SqlConnectOptions
      Specify the user password to be used for the authentication.
      Overrides:
      setPassword in class SqlConnectOptions
      Parameters:
      password - the password to specify
      Returns:
      a reference to this, so the API can be used fluently

    • setDatabase

      public PgConnectOptions setDatabase(String database)
      Description copied from class: SqlConnectOptions
      Specify the default database for the connection.
      Overrides:
      setDatabase in class SqlConnectOptions
      Parameters:
      database - the database name to specify
      Returns:
      a reference to this, so the API can be used fluently

    • getPipeliningLimit

      public int getPipeliningLimit()

    • setPipeliningLimit

      public PgConnectOptions setPipeliningLimit(int pipeliningLimit)

    • setCachePreparedStatements

      public PgConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)
      Description copied from class: SqlConnectOptions
      Set whether prepared statements cache should be enabled.
      Overrides:
      setCachePreparedStatements in class SqlConnectOptions
      Parameters:
      cachePreparedStatements - true if cache should be enabled
      Returns:
      a reference to this, so the API can be used fluently

    • setPreparedStatementCacheMaxSize

      public PgConnectOptions setPreparedStatementCacheMaxSize(int preparedStatementCacheMaxSize)
      Description copied from class: SqlConnectOptions
      Set the maximum number of prepared statements that the connection will cache.
      Overrides:
      setPreparedStatementCacheMaxSize in class SqlConnectOptions
      Parameters:
      preparedStatementCacheMaxSize - the size to set
      Returns:
      a reference to this, so the API can be used fluently

    • setPreparedStatementCacheSqlFilter

      public PgConnectOptions setPreparedStatementCacheSqlFilter(Predicate<String> predicate)
      Description copied from class: SqlConnectOptions
      Set a predicate filtering prepared statements that the connection will cache.

      The default predicate accepts predicate having query length invalid input: '<' SqlConnectOptions.DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT

      Overrides:
      setPreparedStatementCacheSqlFilter in class SqlConnectOptions
      Parameters:
      predicate - the filter

    • setPreparedStatementCacheSqlLimit

      public PgConnectOptions setPreparedStatementCacheSqlLimit(int preparedStatementCacheSqlLimit)
      Description copied from class: SqlConnectOptions
      Set the maximum length of prepared statement SQL string that the connection will cache.

      This is an helper setting the SqlConnectOptions.setPreparedStatementCacheSqlFilter(Predicate).

      Overrides:
      setPreparedStatementCacheSqlLimit in class SqlConnectOptions
      Parameters:
      preparedStatementCacheSqlLimit - the maximum length limit of SQL string to set
      Returns:
      a reference to this, so the API can be used fluently

    • setProperties

      public PgConnectOptions setProperties(Map<String,String> properties)
      Description copied from class: SqlConnectOptions
      Set properties for this client, which will be sent to server at the connection start.
      Overrides:
      setProperties in class SqlConnectOptions
      Parameters:
      properties - the value of properties to specify
      Returns:
      a reference to this, so the API can be used fluently

    • addProperty

      public PgConnectOptions addProperty(String key, String value)
      Description copied from class: SqlConnectOptions
      Add a property for this client, which will be sent to server at the connection start.
      Overrides:
      addProperty in class SqlConnectOptions
      Parameters:
      key - the value of property key
      value - the value of property value
      Returns:
      a reference to this, so the API can be used fluently

    • 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

    • getSslNegotiation

      public SslNegotiation getSslNegotiation()
      Returns:
      the value of current SSL negotiation mode

    • setSslNegotiation

      public PgConnectOptions setSslNegotiation(SslNegotiation sslNegotiation)
      Set SslNegotiation for the client, this option controls how SSL/TLS is negotiated with the server.
      Parameters:
      sslNegotiation - the SSL negotiation mode
      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)
      Description copied from class: SqlConnectOptions
      Set the value of reconnect attempts
      Overrides:
      setReconnectAttempts in class SqlConnectOptions
      Parameters:
      attempts - the maximum number of reconnect attempts
      Returns:
      a reference to this, so the API can be used fluently

    • setReconnectInterval

      public PgConnectOptions setReconnectInterval(long interval)
      Description copied from class: SqlConnectOptions
      Set the reconnect interval
      Overrides:
      setReconnectInterval in class SqlConnectOptions
      Parameters:
      interval - the reconnect interval in ms
      Returns:
      a reference to this, so the API can be used fluently

    • setTracingPolicy

      public PgConnectOptions setTracingPolicy(TracingPolicy tracingPolicy)
      Description copied from class: SqlConnectOptions
      Set the tracing policy for the client behavior when Vert.x has tracing enabled.
      Overrides:
      setTracingPolicy in class SqlConnectOptions
      Parameters:
      tracingPolicy - the tracing policy
      Returns:
      a reference to this, so the API can be used fluently

    • 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)
      Description copied from class: SqlConnectOptions
      Returns new options created after this object and merged with the other json config.
      Overrides:
      merge in class SqlConnectOptions
      Parameters:
      other - the other JSON object
      Returns:
      new options created after this object and merged with the other json config