public enum PicodataProperty extends Enum<PicodataProperty>
| Enum Constant and Description |
|---|
ADAPTIVE_FETCH
Specifies if number of rows, used during fetching rows of a result set, should be computed
dynamically.
|
ADAPTIVE_FETCH_MAXIMUM
Specifies the highest number of rows which can be calculated by adaptiveFetch.
|
ADAPTIVE_FETCH_MINIMUM
Specifies the lowest number of rows which can be calculated by adaptiveFetch.
|
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.
|
APPLICATION_NAME
The application name (require server version >= 9.0).
|
ASSUME_MIN_SERVER_VERSION
Assume the server is at least that version.
|
AUTHENTICATION_PLUGIN_CLASS_NAME
AuthenticationPluginClass
|
AUTOSAVE
Specifies what the driver should do if a query fails.
|
BINARY_TRANSFER
Use binary format for sending and receiving data if possible.
|
BINARY_TRANSFER_DISABLE
Comma separated list of types to disable binary transfer.
|
BINARY_TRANSFER_ENABLE
Comma separated list of types to enable binary transfer.
|
CANCEL_SIGNAL_TIMEOUT
Cancel command is sent out of band over its own connection, so cancel message can itself get
stuck.
|
CLEANUP_SAVEPOINTS
Determine whether SAVEPOINTS used in AUTOSAVE will be released per query or not
|
CONNECT_TIMEOUT
The timeout value used for socket connect operations.
|
CURRENT_SCHEMA
Specify the schema (or several schema separated by commas) to be set in the search-path.
|
DATABASE_METADATA_CACHE_FIELDS
Specifies the maximum number of fields to be cached per connection.
|
DATABASE_METADATA_CACHE_FIELDS_MIB
Specifies the maximum size (in megabytes) of fields to be cached per connection.
|
DEFAULT_ROW_FETCH_SIZE
Default parameter for
Statement.getFetchSize(). |
DISABLE_COLUMN_SANITISER
Enable optimization that disables column name sanitiser.
|
ESCAPE_SYNTAX_CALL_MODE
Specifies how the driver transforms JDBC escape call syntax into underlying SQL, for invoking procedures or functions.
|
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.
|
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
Specifies period (seconds) after which the host status is checked again in case it has changed
|
LOAD_BALANCE_HOSTS
If disabled hosts are connected in the given order.
|
LOCAL_SOCKET_ADDRESS
If this is set then the client side will bind to this address.
|
LOG_SERVER_ERROR_DETAIL
Whether to include full server error detail in exception messages.
|
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.
|
LOGIN_TIMEOUT
Specify how long to wait for establishment of a database connection.
|
MAX_RESULT_BUFFER
Specifies size of buffer during fetching result set.
|
OPTIONS
Specify 'options' connection initialization parameter.
|
PICODATA_HOST
Picodata server hostname.
|
PICODATA_PASSWORD
Password to use when authenticating to the Picodata server.
|
PICODATA_PORT
Picodata server port.
|
PICODATA_USER
Username to connect to the Picodata server as.
|
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.
|
PREPARE_THRESHOLD
Sets the default threshold for enabling server-side prepare.
|
PREPARED_STATEMENT_CACHE_QUERIES
Specifies the maximum number of entries in cache of prepared statements.
|
PREPARED_STATEMENT_CACHE_SIZE_MIB
Specifies the maximum size (in megabytes) of the prepared statement cache.
|
PROTOCOL_VERSION
Force use of a particular protocol version when connecting, if set, disables protocol version
fallback.
|
QUOTE_RETURNING_IDENTIFIERS
Quote returning columns.
|
READ_ONLY
Puts this connection in read-only mode.
|
READ_ONLY_MODE
Connection parameter to control behavior when
Connection.setReadOnly(boolean) is set to true. |
RECEIVE_BUFFER_SIZE
Socket read buffer size (SO_RECVBUF).
|
REWRITE_BATCHED_INSERTS
Configure optimization to enable batch insert re-writing.
|
SEND_BUFFER_SIZE
Socket write buffer size (SO_SNDBUF).
|
SOCKET_FACTORY
Socket factory used to create socket.
|
SOCKET_TIMEOUT
The timeout value used for socket read operations.
|
SSL_CERT
File containing the SSL Certificate.
|
SSL_FACTORY
Classname of the SSL Factory to use (instance of
SSLSocketFactory). |
SSL_HOSTNAME_VERIFIER
Classname of the SSL HostnameVerifier to use (instance of
HostnameVerifier). |
SSL_KEY
File containing the SSL Key.
|
SSL_MODE
Parameter governing the use of SSL.
|
SSL_PASSWORD
The SSL password to use in the default CallbackHandler.
|
SSL_PASSWORD_CALLBACK
The classname instantiating
CallbackHandler to use. |
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.
|
SSL_ROOT_CERT
File containing the root certificate when validating server (
sslmode = verify-ca
or verify-full). |
STRING_TYPE
Bind String to either
unspecified or varchar. |
TARGET_SERVER_TYPE
Specifies what kind of server to connect.
|
TCP_KEEP_ALIVE
Enable or disable TCP keep-alive.
|
TCP_NO_DELAY
Enable or disable TCP no delay.
|
UNKNOWN_LENGTH
Specifies the length to return for types of unknown length.
|
| Modifier and Type | Method and Description |
|---|---|
static PicodataProperty |
forName(String name)
Returns enum value for the string name if present.
|
String |
getAlias()
Returns the alias of the connection parameter.
|
String |
getDefaultValue()
Returns the default value for this connection parameter.
|
String |
getName()
Returns the name of the connection parameter.
|
String |
getOrDefault(Properties properties)
Returns the value of the connection parameter from the given
Properties or the
default value. |
boolean |
isPresent(Properties properties)
Test whether this property is present in the given
Properties. |
boolean |
isRequired()
Returns whether this parameter is required.
|
void |
set(Properties properties,
String value)
Set the value for this connection parameter in the given
Properties. |
void |
setByAlias(Properties properties,
String value)
Set the value for the alias for this connection parameter in the given
Properties. |
DriverPropertyInfo |
toDriverPropertyInfo(String value)
Convert this connection parameter and the specified value for it into
DriverPropertyInfo. |
static boolean |
validateHostsAndPorts(Properties properties)
Validate hosts and ports properties.
|
static boolean |
validateProperties(Properties properties)
Validate properties.
|
static PicodataProperty |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static PicodataProperty[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final PicodataProperty ADAPTIVE_FETCH
public static final PicodataProperty ADAPTIVE_FETCH_MAXIMUM
public static final PicodataProperty ADAPTIVE_FETCH_MINIMUM
public static final PicodataProperty ALLOW_ENCODING_CHANGES
client_encoding setting is set
by the driver and should not be altered. If the driver detects a change it will abort the
connection.public static final PicodataProperty APPLICATION_NAME
public static final PicodataProperty ASSUME_MIN_SERVER_VERSION
public static final PicodataProperty AUTHENTICATION_PLUGIN_CLASS_NAME
public static final PicodataProperty AUTOSAVE
autosave=always mode, JDBC driver sets a savepoint before each query,
and rolls back to that savepoint in case of failure. In autosave=never mode (default), no savepoint dance is made ever.
In autosave=conservative mode, savepoint is set for each query, however the rollback is done only for rare cases
like 'cached statement cannot change return type' or 'statement XXX is not valid' so JDBC driver rollsback and retriespublic static final PicodataProperty BINARY_TRANSFER
public static final PicodataProperty BINARY_TRANSFER_DISABLE
public static final PicodataProperty BINARY_TRANSFER_ENABLE
public static final PicodataProperty CANCEL_SIGNAL_TIMEOUT
public static final PicodataProperty CLEANUP_SAVEPOINTS
public static final PicodataProperty 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.
public static final PicodataProperty CURRENT_SCHEMA
public static final PicodataProperty DATABASE_METADATA_CACHE_FIELDS
0 disables the cache.public static final PicodataProperty DATABASE_METADATA_CACHE_FIELDS_MIB
0 disables the cache.public static final PicodataProperty DEFAULT_ROW_FETCH_SIZE
Statement.getFetchSize(). A value of 0 means
that need fetch all rows at oncepublic static final PicodataProperty DISABLE_COLUMN_SANITISER
public static final PicodataProperty ESCAPE_SYNTAX_CALL_MODE
escapeSyntaxCallMode=select mode (the default), the driver always uses a SELECT statement (allowing function invocation only).
In escapeSyntaxCallMode=callIfNoReturn mode, the driver uses a CALL statement (allowing procedure invocation) if there is no return parameter specified, otherwise the driver uses a SELECT statement.
In escapeSyntaxCallMode=call mode, the driver always uses a CALL statement (allowing procedure invocation only).public static final PicodataProperty GROUP_STARTUP_PARAMETERS
public static final PicodataProperty HIDE_UNPRIVILEGED_OBJECTS
public static final PicodataProperty HOST_RECHECK_SECONDS
public static final PicodataProperty LOAD_BALANCE_HOSTS
public static final PicodataProperty LOCAL_SOCKET_ADDRESS
public static final PicodataProperty LOGIN_TIMEOUT
public static final PicodataProperty LOG_SERVER_ERROR_DETAIL
public static final PicodataProperty LOG_UNCLOSED_CONNECTIONS
public static final PicodataProperty MAX_RESULT_BUFFER
public static final PicodataProperty OPTIONS
public static final PicodataProperty PICODATA_HOST
public static final PicodataProperty PICODATA_PASSWORD
public static final PicodataProperty PICODATA_PORT
public static final PicodataProperty PICODATA_USER
public static final PicodataProperty 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)
public static final PicodataProperty PREPARED_STATEMENT_CACHE_QUERIES
0
disables the cache.public static final PicodataProperty PREPARED_STATEMENT_CACHE_SIZE_MIB
0
disables the cache.public static final PicodataProperty PREPARE_THRESHOLD
-1 stands for
forceBinarypublic static final PicodataProperty PROTOCOL_VERSION
public static final PicodataProperty QUOTE_RETURNING_IDENTIFIERS
public static final PicodataProperty READ_ONLY
public static final PicodataProperty READ_ONLY_MODE
Connection.setReadOnly(boolean) is set to true.public static final PicodataProperty RECEIVE_BUFFER_SIZE
-1, which is the default, means system
default.public static final PicodataProperty REWRITE_BATCHED_INSERTS
public static final PicodataProperty SEND_BUFFER_SIZE
-1, which is the default, means system
default.public static final PicodataProperty SOCKET_FACTORY
public static final PicodataProperty SOCKET_TIMEOUT
public static final PicodataProperty SSL_CERT
picodata.crt in $HOME/.picodata.public static final PicodataProperty SSL_FACTORY
SSLSocketFactory).public static final PicodataProperty SSL_HOSTNAME_VERIFIER
HostnameVerifier).
Hostname verifier from pgJDBC is used by default.public static final PicodataProperty SSL_KEY
picodata.pk8 in $HOME/.picodata.public static final PicodataProperty SSL_MODE
disable, allow,
prefer, require, verify-ca, verify-full.
Default mode is "disable"public static final PicodataProperty SSL_PASSWORD
public static final PicodataProperty SSL_PASSWORD_CALLBACK
CallbackHandler to use.public static final PicodataProperty 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
public static final PicodataProperty SSL_ROOT_CERT
sslmode = verify-ca
or verify-full). Default will be the file root.crt in $HOME/.picodata.public static final PicodataProperty STRING_TYPE
unspecified or varchar. Default is varchar for
8.0+ backends.public static final PicodataProperty TARGET_SERVER_TYPE
public static final PicodataProperty TCP_KEEP_ALIVE
false.public static final PicodataProperty TCP_NO_DELAY
true.public static final PicodataProperty UNKNOWN_LENGTH
public static PicodataProperty[] values()
for (PicodataProperty c : PicodataProperty.values()) System.out.println(c);
public static PicodataProperty valueOf(String name)
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getName()
public String getAlias()
public String getDefaultValue()
public boolean isRequired()
public boolean isPresent(Properties properties)
Properties.properties - set of properties to check current inpublic String getOrDefault(Properties properties)
Properties or the
default value.properties - properties to take actual value frompublic static PicodataProperty forName(String name)
public void set(Properties properties, String value)
Properties.properties - properties in which the value should be setvalue - value for this connection parameterpublic void setByAlias(Properties properties, String value)
Properties.properties - properties in which the value should be setvalue - value for this connection parameterpublic DriverPropertyInfo toDriverPropertyInfo(String value)
DriverPropertyInfo.value - value for the parameterpublic static boolean validateProperties(Properties properties)
properties - propertiespublic static boolean validateHostsAndPorts(Properties properties)
properties - propertiesCopyright © 2025 Picodata. All rights reserved.