| Modifier and Type | Field and Description |
|---|---|
| public static final PGProperty | ADAPTIVE_FETCH
Specifies if number of rows, used during fetching rows of a result set, should be computed dynamically. |
| public static final PGProperty | ADAPTIVE_FETCH_MAXIMUM
Specifies the highest number of rows which can be calculated by adaptiveFetch. |
| public static final PGProperty | ADAPTIVE_FETCH_MINIMUM
Specifies the lowest number of rows which can be calculated by adaptiveFetch. |
| public static final PGProperty | ALLOW_ENCODING_CHANGES
When using the V3 protocol the driver monitors changes in certain server configuration parameters that should not be touched by end users. |
| public static final PGProperty | APPLICATION_NAME
The application name (require server version >= 9.0). |
| public static final PGProperty | ASSUME_MIN_SERVER_VERSION
Assume the server is at least that version. |
| public static final PGProperty | AUTHENTICATION_PLUGIN_CLASS_NAME
AuthenticationPluginClass |
| public static final PGProperty | AUTOSAVE
Specifies what the driver should do if a query fails. |
| public static final PGProperty | BINARY_TRANSFER
Use binary format for sending and receiving data if possible. |
| public static final PGProperty | BINARY_TRANSFER_DISABLE
Comma separated list of types to disable binary transfer. |
| public static final PGProperty | BINARY_TRANSFER_ENABLE
Comma separated list of types to enable binary transfer. |
| public static final PGProperty | CANCEL_SIGNAL_TIMEOUT
Cancel command is sent out of band over its own connection, so cancel message can itself get stuck. |
| private final @Nullable String[] | |
| public static final PGProperty | CLEANUP_SAVEPOINTS
Determine whether SAVEPOINTS used in AUTOSAVE will be released per query or not |
| public static final PGProperty | CONNECT_TIMEOUT
The timeout value used for socket connect operations. |
| public static final PGProperty | CURRENT_SCHEMA
Specify the schema (or several schema separated by commas) to be set in the search-path. |
| public static final PGProperty | DATABASE_METADATA_CACHE_FIELDS
Specifies the maximum number of fields to be cached per connection. |
| public static final PGProperty | DATABASE_METADATA_CACHE_FIELDS_MIB
Specifies the maximum size (in megabytes) of fields to be cached per connection. |
| public static final PGProperty | DEFAULT_ROW_FETCH_SIZE
Default parameter for |
| private final @Nullable String | |
| private final String | |
| public static final PGProperty | DISABLE_COLUMN_SANITISER
Enable optimization that disables column name sanitiser. |
| public static final PGProperty | ESCAPE_SYNTAX_CALL_MODE
Specifies how the driver transforms JDBC escape call syntax into underlying SQL, for invoking procedures or functions. |
| public static final PGProperty | GROUP_STARTUP_PARAMETERS
Group startup parameters in a transaction This is important in pool-by-transaction scenarios in order to make sure that all the statements reaches the same connection that is being initialized. |
| public static final PGProperty | |
| public static final PGProperty | |
| public static final PGProperty | GSS_RESPONSE_TIMEOUT
After requesting an upgrade to SSL from the server there are reports of the server not responding due to a failover without a timeout here, the client can wait forever. |
| public static final PGProperty | HIDE_UNPRIVILEGED_OBJECTS
Enable mode to filter out the names of database objects for which the current user has no privileges granted from appearing in the DatabaseMetaData returned by the driver. |
| public static final PGProperty | |
| public static final PGProperty | JAAS_APPLICATION_NAME
Specifies the name of the JAAS system or application login configuration. |
| public static final PGProperty | JAAS_LOGIN
Flag to enable/disable obtaining a GSS credential via JAAS login before authenticating. |
| public static final PGProperty | KERBEROS_SERVER_NAME
The Kerberos service name to use when authenticating with GSSAPI. |
| public static final PGProperty | |
| public static final PGProperty | LOCAL_SOCKET_ADDRESS
If this is set then the client side will bind to this address. |
| public static final PGProperty | LOG_SERVER_ERROR_DETAIL
Whether to include full server error detail in exception messages. |
| public static final PGProperty | LOG_UNCLOSED_CONNECTIONS
When connections that are not explicitly closed are garbage collected, log the stacktrace from the opening of the connection to trace the leak source. |
| public static final PGProperty | LOGGER_FILE
Deprecated
Logging is configured via java.util.logging.
This property is no longer used by the driver and will be ignored.
|
| public static final PGProperty | LOGGER_LEVEL
Deprecated
Logging is configured via java.util.logging.
This property is no longer used by the driver and will be ignored.
|
| public static final PGProperty | LOGIN_TIMEOUT
Specify how long to wait for establishment of a database connection. |
| public static final PGProperty | MAX_RESULT_BUFFER
Specifies size of buffer during fetching result set. |
| private final String | name
Hides java. |
| public static final PGProperty | OPTIONS
Specify 'options' connection initialization parameter. |
| public static final PGProperty | PASSWORD
Password to use when authenticating. |
| public static final PGProperty | PG_DBNAME
Database name to connect to (may be specified directly in the JDBC URL). |
| public static final PGProperty | PG_HOST
Hostname of the PostgreSQL server (may be specified directly in the JDBC URL). |
| public static final PGProperty | PG_PORT
Port of the PostgreSQL server (may be specified directly in the JDBC URL). |
| public static final PGProperty | PREFER_QUERY_MODE
Specifies which mode is used to execute queries to database: simple means ('Q' execute, no parse, no bind, text mode only), extended means always use bind/execute messages, extendedForPrepared means extended for prepared statements only, extendedCacheEverything means use extended protocol and try cache every statement (including Statement.execute(String sql)) in a query cache. |
| public static final PGProperty | PREPARE_THRESHOLD
Sets the default threshold for enabling server-side prepare. |
| public static final PGProperty | PREPARED_STATEMENT_CACHE_QUERIES
Specifies the maximum number of entries in cache of prepared statements. |
| public static final PGProperty | PREPARED_STATEMENT_CACHE_SIZE_MIB
Specifies the maximum size (in megabytes) of the prepared statement cache. |
| private static final Map | |
| public static final PGProperty | PROTOCOL_VERSION
Force use of a particular protocol version when connecting, if set, disables protocol version fallback. |
| public static final PGProperty | QUOTE_RETURNING_IDENTIFIERS
Quote returning columns. |
| public static final PGProperty | READ_ONLY
Puts this connection in read-only mode. |
| public static final PGProperty | READ_ONLY_MODE
Connection parameter to control behavior when
|
| public static final PGProperty | RECEIVE_BUFFER_SIZE
Socket read buffer size (SO_RECVBUF). |
| public static final PGProperty | REPLICATION
Connection parameter passed in the startup message. |
| private final boolean | |
| public static final PGProperty | REWRITE_BATCHED_INSERTS
Configure optimization to enable batch insert re-writing. |
| public static final PGProperty | SEND_BUFFER_SIZE
Socket write buffer size (SO_SNDBUF). |
| public static final PGProperty | SERVICE
Service name to use for additional parameters. |
| public static final PGProperty | SOCKET_FACTORY
Socket factory used to create socket. |
| public static final PGProperty | SOCKET_FACTORY_ARG
The String argument to give to the constructor of the Socket Factory. |
| public static final PGProperty | SOCKET_TIMEOUT
The timeout value used for socket read operations. |
| public static final PGProperty | SSL
Control use of SSL: empty or |
| public static final PGProperty | SSL_CERT
File containing the SSL Certificate. |
| public static final PGProperty | SSL_FACTORY
Classname of the SSL Factory to use (instance of |
| public static final PGProperty | SSL_FACTORY_ARG
Deprecated
use The String argument to give to the constructor of the SSL Factory.
..Factory(Properties) constructor.
|
| public static final PGProperty | SSL_HOSTNAME_VERIFIER
Classname of the SSL HostnameVerifier to use (instance of |
| public static final PGProperty | SSL_KEY
File containing the SSL Key. |
| public static final PGProperty | SSL_MODE
Parameter governing the use of SSL. |
| public static final PGProperty | SSL_PASSWORD
The SSL password to use in the default CallbackHandler. |
| public static final PGProperty | SSL_PASSWORD_CALLBACK
The classname instantiating |
| public static final PGProperty | SSL_RESPONSE_TIMEOUT
After requesting an upgrade to SSL from the server there are reports of the server not responding due to a failover without a timeout here, the client can wait forever. |
| public static final PGProperty | SSL_ROOT_CERT
File containing the root certificate when validating server ( |
| public static final PGProperty | SSPI_SERVICE_CLASS
Specifies the name of the SSPI service class that forms the service class part of the SPN. |
| public static final PGProperty | STRING_TYPE
Bind String to either |
| public static final PGProperty | |
| public static final PGProperty | TCP_KEEP_ALIVE
Enable or disable TCP keep-alive. |
| public static final PGProperty | |
| public static final PGProperty | UNKNOWN_LENGTH
Specifies the length to return for types of unknown length. |
| public static final PGProperty | USE_SPNEGO
Use SPNEGO in SSPI authentication requests. |
| public static final PGProperty | USER
Username to connect to the database as. |
| public static final PGProperty | XML_FACTORY_FACTORY
Factory class to instantiate factories for XML processing. |
| Access | Constructor and Description |
|---|---|
| private | |
| private | |
| private |
| Modifier and Type | Method and Description |
|---|---|
| public static @Nullable PGProperty | |
| public @Nullable String | Returns: evaluated value for this connection parameter or nullproperties to take actual value from properties)
Deprecated
use
getOrDefault(Properties) instead
Returns the value of the connection parameter from the given |
| public boolean | Returns: evaluated value for this connection parameter converted to booleanproperties to take actual value from properties)Return the boolean value for this connection parameter in the given |
| public @Nullable String[] | Returns: the available values for this connection parameter or nullReturns the available values for this connection parameter. |
| public @Nullable String | Returns: the default value for this connection parameter or nullReturns the default value for this connection parameter. |
| public String | Returns: the description for this connection parameterReturns the description for this connection parameter. |
| public int | Returns: evaluated value for this connection parameter converted to intproperties to take actual value from properties)Return the int value for this connection parameter in the given |
| public @Nullable Integer | Returns: evaluated value for this connection parameter converted to Integer or nullproperties to take actual value from properties)Return the |
| public int | Returns: evaluated value for this connection parameter converted to intproperties to take actual value from properties)Return the int value for this connection parameter in the given |
| public String | |
| public @Nullable String | Returns: evaluated value for this connection parameterproperties to take actual value from properties)Returns the value of the connection parameter from the given |
| public @Nullable String | Returns: evaluated value for this connection parameterproperties object to get value from properties)Returns the value of the connection parameter from the given |
| public @Nullable String | Returns: the value of a set propertyproperties bundle properties)Return the property if exists but avoiding the default. |
| public boolean | Returns: true if the parameter is specified in the given propertiesset of properties to check current in properties)Test whether this property is present in the given |
| public boolean | |
| public void | set(Properties
properties in which the value should be set properties, @Nullable String value for this connection parameter value)Set the value for this connection parameter in the given |
| public void | set(Properties
properties in which the value should be set properties, boolean boolean value for this connection parameter value)Set the boolean value for this connection parameter in the given |
| public void | set(Properties
properties in which the value should be set properties, int int value for this connection parameter value)Set the int value for this connection parameter in the given |
| public DriverPropertyInfo | Returns: a DriverPropertyInfo representing this connection parameterproperties to take actual value from properties)Convert this connection parameter and the value read from the given |
| public static PGProperty | |
| public static PGProperty[] |
| ADAPTIVE_FETCH | back to summary |
|---|---|
| public static final PGProperty ADAPTIVE_FETCH Specifies if number of rows, used during fetching rows of a result set, should be computed dynamically. Number of rows will be calculated by dividing maxResultBuffer size by max row size observed so far, rounded down. First fetch will have number of rows declared in defaultRowFetchSize. Number of rows can be limited by adaptiveFetchMinimum and adaptiveFetchMaximum. Requires declaring of maxResultBuffer and defaultRowFetchSize to work. Default value is false. | |
| ADAPTIVE_FETCH_MAXIMUM | back to summary |
|---|---|
| public static final PGProperty ADAPTIVE_FETCH_MAXIMUM Specifies the highest number of rows which can be calculated by adaptiveFetch. Requires adaptiveFetch set to true to work. Default value is -1 (used as infinity). | |
| ADAPTIVE_FETCH_MINIMUM | back to summary |
|---|---|
| public static final PGProperty ADAPTIVE_FETCH_MINIMUM Specifies the lowest number of rows which can be calculated by adaptiveFetch. Requires adaptiveFetch set to true to work. Default value is 0. | |
| ALLOW_ENCODING_CHANGES | back to summary |
|---|---|
| public static final PGProperty ALLOW_ENCODING_CHANGES When using the V3 protocol the driver monitors changes in certain server configuration
parameters that should not be touched by end users. The | |
| APPLICATION_NAME | back to summary |
|---|---|
| public static final PGProperty APPLICATION_NAME The application name (require server version >= 9.0). | |
| ASSUME_MIN_SERVER_VERSION | back to summary |
|---|---|
| public static final PGProperty ASSUME_MIN_SERVER_VERSION Assume the server is at least that version. | |
| AUTHENTICATION_PLUGIN_CLASS_NAME | back to summary |
|---|---|
| public static final PGProperty AUTHENTICATION_PLUGIN_CLASS_NAME AuthenticationPluginClass | |
| AUTOSAVE | back to summary |
|---|---|
| public static final PGProperty AUTOSAVE Specifies what the driver should do if a query fails. In | |
| BINARY_TRANSFER | back to summary |
|---|---|
| public static final PGProperty BINARY_TRANSFER Use binary format for sending and receiving data if possible. | |
| BINARY_TRANSFER_DISABLE | back to summary |
|---|---|
| public static final PGProperty BINARY_TRANSFER_DISABLE Comma separated list of types to disable binary transfer. Either OID numbers or names. Overrides values in the driver default set and values set with binaryTransferEnable. | |
| BINARY_TRANSFER_ENABLE | back to summary |
|---|---|
| public static final PGProperty BINARY_TRANSFER_ENABLE Comma separated list of types to enable binary transfer. Either OID numbers or names | |
| CANCEL_SIGNAL_TIMEOUT | back to summary |
|---|---|
| public static final PGProperty CANCEL_SIGNAL_TIMEOUT Cancel command is sent out of band over its own connection, so cancel message can itself get stuck. This property controls "connect timeout" and "socket timeout" used for cancel commands. The timeout is specified in seconds. Default value is 10 seconds. | |
| choices | back to summary |
|---|---|
| private final @Nullable String[] choices | |
| CLEANUP_SAVEPOINTS | back to summary |
|---|---|
| public static final PGProperty CLEANUP_SAVEPOINTS Determine whether SAVEPOINTS used in AUTOSAVE will be released per query or not | |
| CONNECT_TIMEOUT | back to summary |
|---|---|
| public static final PGProperty CONNECT_TIMEOUT The timeout value used for socket connect operations. If connecting to the server takes longer than this value, the connection is broken. The timeout is specified in seconds and a value of zero means that it is disabled. | |
| CURRENT_SCHEMA | back to summary |
|---|---|
| public static final PGProperty CURRENT_SCHEMA Specify the schema (or several schema separated by commas) to be set in the search-path. This schema will be used to resolve unqualified object names used in statements over this connection. | |
| DATABASE_METADATA_CACHE_FIELDS | back to summary |
|---|---|
| public static final PGProperty DATABASE_METADATA_CACHE_FIELDS Specifies the maximum number of fields to be cached per connection. A value of | |
| DATABASE_METADATA_CACHE_FIELDS_MIB | back to summary |
|---|---|
| public static final PGProperty DATABASE_METADATA_CACHE_FIELDS_MIB Specifies the maximum size (in megabytes) of fields to be cached per connection. A value of | |
| DEFAULT_ROW_FETCH_SIZE | back to summary |
|---|---|
| public static final PGProperty DEFAULT_ROW_FETCH_SIZE Default parameter for | |
| defaultValue | back to summary |
|---|---|
| private final @Nullable String defaultValue | |
| description | back to summary |
|---|---|
| private final String description | |
| DISABLE_COLUMN_SANITISER | back to summary |
|---|---|
| public static final PGProperty DISABLE_COLUMN_SANITISER Enable optimization that disables column name sanitiser. | |
| ESCAPE_SYNTAX_CALL_MODE | back to summary |
|---|---|
| public static final PGProperty ESCAPE_SYNTAX_CALL_MODE Specifies how the driver transforms JDBC escape call syntax into underlying SQL, for invoking procedures or functions. (backend >= 11)
In | |
| GROUP_STARTUP_PARAMETERS | back to summary |
|---|---|
| public static final PGProperty GROUP_STARTUP_PARAMETERS Group startup parameters in a transaction This is important in pool-by-transaction scenarios in order to make sure that all the statements reaches the same connection that is being initialized. All of the startup parameters will be wrapped in a transaction Note this is off by default as pgbouncer in statement mode | |
| GSS_ENC_MODE | back to summary |
|---|---|
| public static final PGProperty GSS_ENC_MODE | |
| GSS_LIB | back to summary |
|---|---|
| public static final PGProperty GSS_LIB Force one of
| |
| GSS_RESPONSE_TIMEOUT | back to summary |
|---|---|
| public static final PGProperty GSS_RESPONSE_TIMEOUT After requesting an upgrade to SSL from the server there are reports of the server not responding due to a failover without a timeout here, the client can wait forever. The pattern for requesting a GSS encrypted connection is the same so we provide the same timeout mechanism This timeout will be set before the request and reset after | |
| HIDE_UNPRIVILEGED_OBJECTS | back to summary |
|---|---|
| public static final PGProperty HIDE_UNPRIVILEGED_OBJECTS Enable mode to filter out the names of database objects for which the current user has no privileges granted from appearing in the DatabaseMetaData returned by the driver. | |
| HOST_RECHECK_SECONDS | back to summary |
|---|---|
| public static final PGProperty HOST_RECHECK_SECONDS | |
| JAAS_APPLICATION_NAME | back to summary |
|---|---|
| public static final PGProperty JAAS_APPLICATION_NAME Specifies the name of the JAAS system or application login configuration. | |
| JAAS_LOGIN | back to summary |
|---|---|
| public static final PGProperty JAAS_LOGIN Flag to enable/disable obtaining a GSS credential via JAAS login before authenticating. Useful if setting system property javax.security.auth.useSubjectCredsOnly=false or using native GSS with system property sun.security.jgss.native=true | |
| KERBEROS_SERVER_NAME | back to summary |
|---|---|
| public static final PGProperty KERBEROS_SERVER_NAME The Kerberos service name to use when authenticating with GSSAPI. This is equivalent to libpq's PGKRBSRVNAME environment variable. | |
| LOAD_BALANCE_HOSTS | back to summary |
|---|---|
| public static final PGProperty LOAD_BALANCE_HOSTS | |
| LOCAL_SOCKET_ADDRESS | back to summary |
|---|---|
| public static final PGProperty LOCAL_SOCKET_ADDRESS If this is set then the client side will bind to this address. This is useful if you need to choose which interface to connect to. | |
| LOG_SERVER_ERROR_DETAIL | back to summary |
|---|---|
| public static final PGProperty LOG_SERVER_ERROR_DETAIL Whether to include full server error detail in exception messages. | |
| LOG_UNCLOSED_CONNECTIONS | back to summary |
|---|---|
| public static final PGProperty LOG_UNCLOSED_CONNECTIONS When connections that are not explicitly closed are garbage collected, log the stacktrace from the opening of the connection to trace the leak source. | |
| LOGGER_FILE | back to summary |
|---|---|
| public static final PGProperty LOGGER_FILE
Deprecated Logging is configured via java.util.logging. This property is no longer used by the driver and will be ignored. | |
| LOGGER_LEVEL | back to summary |
|---|---|
| public static final PGProperty LOGGER_LEVEL
Deprecated Logging is configured via java.util.logging. This property is no longer used by the driver and will be ignored. | |
| LOGIN_TIMEOUT | back to summary |
|---|---|
| public static final PGProperty LOGIN_TIMEOUT Specify how long to wait for establishment of a database connection. The timeout is specified in seconds. | |
| MAX_RESULT_BUFFER | back to summary |
|---|---|
| public static final PGProperty MAX_RESULT_BUFFER Specifies size of buffer during fetching result set. Can be specified as specified size or percent of heap memory. | |
| name | back to summary |
|---|---|
| private final String name Hides java. | |
| OPTIONS | back to summary |
|---|---|
| public static final PGProperty OPTIONS Specify 'options' connection initialization parameter. The value of this parameter may contain spaces and other special characters or their URL representation. | |
| PASSWORD | back to summary |
|---|---|
| public static final PGProperty PASSWORD Password to use when authenticating. | |
| PG_DBNAME | back to summary |
|---|---|
| public static final PGProperty PG_DBNAME Database name to connect to (may be specified directly in the JDBC URL). | |
| PG_HOST | back to summary |
|---|---|
| public static final PGProperty PG_HOST Hostname of the PostgreSQL server (may be specified directly in the JDBC URL). | |
| PG_PORT | back to summary |
|---|---|
| public static final PGProperty PG_PORT Port of the PostgreSQL server (may be specified directly in the JDBC URL). | |
| PREFER_QUERY_MODE | back to summary |
|---|---|
| public static final PGProperty PREFER_QUERY_MODE Specifies which mode is used to execute queries to database: simple means ('Q' execute, no parse, no bind, text mode only), extended means always use bind/execute messages, extendedForPrepared means extended for prepared statements only, extendedCacheEverything means use extended protocol and try cache every statement (including Statement.execute(String sql)) in a query cache. This mode is meant for debugging purposes and/or for cases when extended protocol cannot be used (e.g. logical replication protocol) | |
| PREPARE_THRESHOLD | back to summary |
|---|---|
| public static final PGProperty PREPARE_THRESHOLD Sets the default threshold for enabling server-side prepare. A value of | |
| PREPARED_STATEMENT_CACHE_QUERIES | back to summary |
|---|---|
| public static final PGProperty PREPARED_STATEMENT_CACHE_QUERIES Specifies the maximum number of entries in cache of prepared statements. A value of | |
| PREPARED_STATEMENT_CACHE_SIZE_MIB | back to summary |
|---|---|
| public static final PGProperty PREPARED_STATEMENT_CACHE_SIZE_MIB Specifies the maximum size (in megabytes) of the prepared statement cache. A value of | |
| PROPS_BY_NAME | back to summary |
|---|---|
| private static final Map<String, PGProperty> PROPS_BY_NAME | |
| PROTOCOL_VERSION | back to summary |
|---|---|
| public static final PGProperty PROTOCOL_VERSION Force use of a particular protocol version when connecting, if set, disables protocol version fallback. | |
| QUOTE_RETURNING_IDENTIFIERS | back to summary |
|---|---|
| public static final PGProperty QUOTE_RETURNING_IDENTIFIERS Quote returning columns. There are some ORM's that quote everything, including returning columns If we quote them, then we end up sending ""colname"" to the backend which will not be found | |
| READ_ONLY | back to summary |
|---|---|
| public static final PGProperty READ_ONLY Puts this connection in read-only mode. | |
| READ_ONLY_MODE | back to summary |
|---|---|
| public static final PGProperty READ_ONLY_MODE Connection parameter to control behavior when
| |
| RECEIVE_BUFFER_SIZE | back to summary |
|---|---|
| public static final PGProperty RECEIVE_BUFFER_SIZE Socket read buffer size (SO_RECVBUF). A value of | |
| REPLICATION | back to summary |
|---|---|
| public static final PGProperty REPLICATION Connection parameter passed in the startup message. This parameter accepts two values; "true" and "database". Passing "true" tells the backend to go into walsender mode, wherein a small set of replication commands can be issued instead of SQL statements. Only the simple query protocol can be used in walsender mode. Passing "database" as the value instructs walsender to connect to the database specified in the dbname parameter, which will allow the connection to be used for logical replication from that database. Parameter should be use together with | |
| required | back to summary |
|---|---|
| private final boolean required | |
| REWRITE_BATCHED_INSERTS | back to summary |
|---|---|
| public static final PGProperty REWRITE_BATCHED_INSERTS Configure optimization to enable batch insert re-writing. | |
| SEND_BUFFER_SIZE | back to summary |
|---|---|
| public static final PGProperty SEND_BUFFER_SIZE Socket write buffer size (SO_SNDBUF). A value of | |
| SERVICE | back to summary |
|---|---|
| public static final PGProperty SERVICE Service name to use for additional parameters. It specifies a service name in "pg_service .conf" that holds additional connection parameters. This allows applications to specify only a service name so connection parameters can be centrally maintained. | |
| SOCKET_FACTORY | back to summary |
|---|---|
| public static final PGProperty SOCKET_FACTORY Socket factory used to create socket. A null value, which is the default, means system default. | |
| SOCKET_FACTORY_ARG | back to summary |
|---|---|
| public static final PGProperty SOCKET_FACTORY_ARG The String argument to give to the constructor of the Socket Factory. | |
| SOCKET_TIMEOUT | back to summary |
|---|---|
| public static final PGProperty SOCKET_TIMEOUT The timeout value used for socket read operations. If reading from the server takes longer than this value, the connection is closed. This can be used as both a brute force global query timeout and a method of detecting network problems. The timeout is specified in seconds and a value of zero means that it is disabled. | |
| SSL | back to summary |
|---|---|
| public static final PGProperty SSL Control use of SSL: empty or | |
| SSL_CERT | back to summary |
|---|---|
| public static final PGProperty SSL_CERT File containing the SSL Certificate. Default will be the file | |
| SSL_FACTORY | back to summary |
|---|---|
| public static final PGProperty SSL_FACTORY Classname of the SSL Factory to use (instance of | |
| SSL_FACTORY_ARG | back to summary |
|---|---|
| public static final PGProperty SSL_FACTORY_ARG
Deprecated use The String argument to give to the constructor of the SSL Factory. | |
| SSL_HOSTNAME_VERIFIER | back to summary |
|---|---|
| public static final PGProperty SSL_HOSTNAME_VERIFIER Classname of the SSL HostnameVerifier to use (instance of | |
| SSL_KEY | back to summary |
|---|---|
| public static final PGProperty SSL_KEY File containing the SSL Key. Default will be the file | |
| SSL_MODE | back to summary |
|---|---|
| public static final PGProperty SSL_MODE Parameter governing the use of SSL. The allowed values are | |
| SSL_PASSWORD | back to summary |
|---|---|
| public static final PGProperty SSL_PASSWORD The SSL password to use in the default CallbackHandler. | |
| SSL_PASSWORD_CALLBACK | back to summary |
|---|---|
| public static final PGProperty SSL_PASSWORD_CALLBACK The classname instantiating | |
| SSL_RESPONSE_TIMEOUT | back to summary |
|---|---|
| public static final PGProperty SSL_RESPONSE_TIMEOUT After requesting an upgrade to SSL from the server there are reports of the server not responding due to a failover without a timeout here, the client can wait forever. This timeout will be set before the request and reset after | |
| SSL_ROOT_CERT | back to summary |
|---|---|
| public static final PGProperty SSL_ROOT_CERT File containing the root certificate when validating server ( | |
| SSPI_SERVICE_CLASS | back to summary |
|---|---|
| public static final PGProperty SSPI_SERVICE_CLASS Specifies the name of the SSPI service class that forms the service class part of the SPN. The
default, | |
| STRING_TYPE | back to summary |
|---|---|
| public static final PGProperty STRING_TYPE Bind String to either | |
| TARGET_SERVER_TYPE | back to summary |
|---|---|
| public static final PGProperty TARGET_SERVER_TYPE | |
| TCP_KEEP_ALIVE | back to summary |
|---|---|
| public static final PGProperty TCP_KEEP_ALIVE Enable or disable TCP keep-alive. The default is | |
| TCP_NO_DELAY | back to summary |
|---|---|
| public static final PGProperty TCP_NO_DELAY | |
| UNKNOWN_LENGTH | back to summary |
|---|---|
| public static final PGProperty UNKNOWN_LENGTH Specifies the length to return for types of unknown length. | |
| USE_SPNEGO | back to summary |
|---|---|
| public static final PGProperty USE_SPNEGO Use SPNEGO in SSPI authentication requests. | |
| USER | back to summary |
|---|---|
| public static final PGProperty USER Username to connect to the database as. | |
| XML_FACTORY_FACTORY | back to summary |
|---|---|
| public static final PGProperty XML_FACTORY_FACTORY Factory class to instantiate factories for XML processing.
The default factory disables external entity processing.
Legacy behavior with external entity processing can be enabled by specifying a value of LEGACY_INSECURE.
Or specify a custom class that implements | |
| PGProperty | back to summary |
|---|---|
| private PGProperty(String name, @Nullable String defaultValue, String description) | |
| PGProperty | back to summary |
|---|---|
| private PGProperty(String name, @Nullable String defaultValue, String description, boolean required) | |
| PGProperty | back to summary |
|---|---|
| private PGProperty(String name, @Nullable String defaultValue, String description, boolean required, @Nullable String[] choices) | |
| forName | back to summary |
|---|---|
| public static @Nullable PGProperty forName(String name) | |
| get | back to summary |
|---|---|
| public @Nullable String get(Properties properties)
Deprecated use Returns the value of the connection parameter from the given
| |
| getBoolean | back to summary |
|---|---|
| public boolean getBoolean(Properties properties) Return the boolean value for this connection parameter in the given
| |
| getChoices | back to summary |
|---|---|
| public @Nullable String[] getChoices() Returns the available values for this connection parameter. | |
| getDefaultValue | back to summary |
|---|---|
| public @Nullable String getDefaultValue() Returns the default value for this connection parameter. | |
| getDescription | back to summary |
|---|---|
| public String getDescription() Returns the description for this connection parameter.
| |
| getInt | back to summary |
|---|---|
| public int getInt(Properties properties) throws PSQLException Return the int value for this connection parameter in the given
| |
| getInteger | back to summary |
|---|---|
| public @Nullable Integer getInteger(Properties properties) throws PSQLException Return the
| |
| getIntNoCheck | back to summary |
|---|---|
| public int getIntNoCheck(Properties properties) Return the int value for this connection parameter in the given
| |
| getName | back to summary |
|---|---|
| public String getName() Returns the name of the connection parameter. The name is the key that must be used in JDBC URL or in Driver properties
| |
| getOrDefault | back to summary |
|---|---|
| public @Nullable String getOrDefault(Properties properties) Returns the value of the connection parameter from the given
| |
| getOrNull | back to summary |
|---|---|
| public @Nullable String getOrNull(Properties properties) Returns the value of the connection parameter from the given
| |
| getSetString | back to summary |
|---|---|
| public @Nullable String getSetString(Properties properties) Return the property if exists but avoiding the default. Allowing the caller to detect the lack of a property.
| |
| isPresent | back to summary |
|---|---|
| public boolean isPresent(Properties properties) Test whether this property is present in the given
| |
| isRequired | back to summary |
|---|---|
| public boolean isRequired() Returns whether this parameter is required.
| |
| set | back to summary |
|---|---|
| public void set(Properties properties, @Nullable String value) Set the value for this connection parameter in the given
| |
| set | back to summary |
|---|---|
| public void set(Properties properties, boolean value) Set the boolean value for this connection parameter in the given
| |
| set | back to summary |
|---|---|
| public void set(Properties properties, int value) Set the int value for this connection parameter in the given
| |
| toDriverPropertyInfo | back to summary |
|---|---|
| public DriverPropertyInfo toDriverPropertyInfo(Properties properties) Convert this connection parameter and the value read from the given
| |
| valueOf | back to summary |
|---|---|
| public static PGProperty valueOf(String name) | |
| values | back to summary |
|---|---|
| public static PGProperty[] values() | |