com.pivotal.gemfirexd.jdbc

Interface ClientAttribute

public interface ClientAttribute

List of all the connection properties used by the client driver. Do not put any other properties in here since some parts (e.g. ODBC driver) depend on getting the full list of available properties by doing a reflection on this interface. Client side system properties (starting with "gemfirexd.") are fine here since those are ignored by the ODBC driver.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_RETRIEVE_MESSAGE_TEXT retrieveMessageText.
static String	CLIENT_SECURITY_MECHANISM securityMechanism sets the DRDA mechanism in-use for the client
static String	CLIENT_TRACE_APPEND traceFileAppend.
static String	CLIENT_TRACE_DIRECTORY traceDirectory sets the client side trace directory.
static String	CLIENT_TRACE_FILE traceFile sets the client side trace file.
static String	CLIENT_TRACE_LEVEL traceLevel.
static String	DISABLE_STREAMING A connection level property (i.e.
static String	DISABLE_THINCLIENT_CANCEL A connection level property to disable Statement.cancel() over thin client.
static String	DISABLE_TX_BATCHING A connection level property to disable all batching in transactions, flushing ops immediately to detect conflicts immediately.
static String	GFXD_DISABLE_THINCLIENT_CANCEL System property to set to disable Statement.cancel() over thin client.
static String	GFXD_DISABLE_TX_BATCHING System property to set DISABLE_TX_BATCHING for all connections.
static String	GFXD_TX_SYNC_COMMITS System property to set TX_SYNC_COMMITS for all connections.
static String	GFXD_USE_PRE1302_HASHCODE Set this to true to force using pre GemFireXD 1.3.0.2 release hashing schema.
static String	KEEPALIVE_CNT TCP KeepAlive COUNT for the network server and client sockets.
static String	KEEPALIVE_IDLE TCP KeepAlive IDLE timeout in seconds for the network server and client sockets.
static String	KEEPALIVE_INTVL TCP KeepAlive INTERVAL timeout in seconds for the network server and client sockets.
static String	LOAD_BALANCE If set to false then no load-balancing is attempted for JDBC client connection, else the default is to try and load-balance the new one.
static String	LOG_FILE The GemFireXD log file path property.
static String	LOG_FILE_STAMP Log file path to which the initialization nano time is appended.
static String	NCJ_BATCH_SIZE A connection level property.
static String	NCJ_CACHE_SIZE A connection level property.
static String	PASSWORD The attribute that is used to set the user password.
static String	QUERY_HDFS A connection level property.
static String	READ_TIMEOUT Read timeout for the connection, in seconds.
static String	ROUTE_QUERY A connection level property to disable query routing.
static String	SECONDARY_LOCATORS Any alternative locators/servers that have to be tried when connecting to a distributed system.
static String	SERVER_GROUPS The property used to specify the server groups to use for a connection.
static String	SINGLE_HOP_ENABLED The attribute that is used to set client single hop property.
static String	SINGLE_HOP_MAX_CONNECTIONS The attribute that is used to set the internal connection size per network server.
static String	SKIP_CONSTRAINT_CHECKS Connection property to skip primary key, foreign key, unique and check constraint checks.
static String	SKIP_LISTENERS A connection level property if set to true, would skip invocation of listeners/writers/DBSynchronizer/AsyncEventListener on server.
static String	SKIP_LOCKS A connection level property to disable all table and datadictionary locking for operations from the connection.
static String	SOCKET_INPUT_BUFFER_SIZE Input buffer size to use for client-server sockets.
static String	SOCKET_OUTPUT_BUFFER_SIZE Output buffer size to use for client-server sockets.
static String	SQLF_DISABLE_TX_BATCHING [SQLFire] System property to set DISABLE_TX_BATCHING for all connections for old SQLFire product.
static String	SQLF_TX_SYNC_COMMITS [SQLFire]: System property to set TX_SYNC_COMMITS for all connections for old SQLFire product.
static String	SSL The attribute that is used to set client SSL mode.
static String	THRIFT_SECURITY_MECHANISM The security mechanism to use by the thrift driver.
static String	THRIFT_SSL_PROPERTIES A comma-separated SSL property key=value pairs that can be set for a thrift client connection.
static String	THRIFT_USE_BINARY_PROTOCOL If true then use TBinaryProtocol for the thrift server, else the default is to use TCompactProtocol.
static String	TX_SYNC_COMMITS A connection level property to wait for 2nd phase commit to complete on all nodes instead of returning as soon as current server's 2nd phase commit is done.
static String	USERNAME The attribute that is used to set the user name.
static String	USERNAME_ALT The attribute that is used to set the user name.
static String	USING_ODBC_DRIVER System property to denote that the driver is invoked using ODBC API.

Field Detail

USERNAME

static final String USERNAME

The attribute that is used to set the user name.

See Also:

Constant Field Values

USERNAME_ALT

static final String USERNAME_ALT

The attribute that is used to set the user name.

See Also:

Constant Field Values

PASSWORD

static final String PASSWORD

The attribute that is used to set the user password.

See Also:

Constant Field Values

READ_TIMEOUT

static final String READ_TIMEOUT

Read timeout for the connection, in seconds. Only for thin client connections.

See Also:

Constant Field Values

KEEPALIVE_IDLE

static final String KEEPALIVE_IDLE

TCP KeepAlive IDLE timeout in seconds for the network server and client sockets. This is the idle time after which a TCP KeepAlive probe is sent over the socket to determine if the other side is alive or not.

See Also:

Constant Field Values

KEEPALIVE_INTVL

static final String KEEPALIVE_INTVL

TCP KeepAlive INTERVAL timeout in seconds for the network server and client sockets. This is the time interval between successive TCP KeepAlive probes if there is no response to the previous probe (KEEPALIVE_IDLE) to determine if the other side is alive or not. Note that this may not be supported by all platforms (e.g. Solaris), in which case this will be ignored and an info-level message logged that the option could not be enabled on the socket.

See Also:

Constant Field Values

KEEPALIVE_CNT

static final String KEEPALIVE_CNT

TCP KeepAlive COUNT for the network server and client sockets. This is the number of TCP KeepAlive probes sent before declaring the other side to be dead. Note that this may not be supported by all platforms (e.g. Solaris), in which case this will be ignored and an info-level message logged that the option could not be enabled on the socket.

See Also:

Constant Field Values

SOCKET_INPUT_BUFFER_SIZE

static final String SOCKET_INPUT_BUFFER_SIZE

Input buffer size to use for client-server sockets.

See Also:

Constant Field Values

SOCKET_OUTPUT_BUFFER_SIZE

static final String SOCKET_OUTPUT_BUFFER_SIZE

Output buffer size to use for client-server sockets.

See Also:

Constant Field Values

LOAD_BALANCE

static final String LOAD_BALANCE

If set to false then no load-balancing is attempted for JDBC client connection, else the default is to try and load-balance the new one.

See Also:

Constant Field Values

SECONDARY_LOCATORS

static final String SECONDARY_LOCATORS

Any alternative locators/servers that have to be tried when connecting to a distributed system. This affects only the initial connection semantics while the list of all the servers available in the system is determined and kept updated by the client driver.

See Also:

Constant Field Values

SERVER_GROUPS

static final String SERVER_GROUPS

The property used to specify the server groups to use for a connection.

See Also:

Constant Field Values

SINGLE_HOP_ENABLED

static final String SINGLE_HOP_ENABLED

The attribute that is used to set client single hop property.

See Also:

Constant Field Values

SINGLE_HOP_MAX_CONNECTIONS

static final String SINGLE_HOP_MAX_CONNECTIONS

The attribute that is used to set the internal connection size per network server.

See Also:

Constant Field Values

DISABLE_STREAMING

static final String DISABLE_STREAMING

A connection level property (i.e. needs to be set on each connection) which when set to true will disable streaming of results on query node. This will make the performance slower and require more memory for large query results but with more predictable results in case a server happens to go down while iterating over a ResultSet. When this is not set then an SQLException with state will be thrown in case a node happens to go down in the middle of ResultSet iteration and application has to retry the query. With this property set, GemFireXD will always wait for at least one result from all the nodes and disable chunking of results from nodes, so will always transparently failover in such a scenario.

See Also:

Constant Field Values

SKIP_LISTENERS

static final String SKIP_LISTENERS

A connection level property if set to true, would skip invocation of listeners/writers/DBSynchronizer/AsyncEventListener on server.

See Also:

Constant Field Values

SKIP_CONSTRAINT_CHECKS

static final String SKIP_CONSTRAINT_CHECKS

Connection property to skip primary key, foreign key, unique and check constraint checks. For the case of primary key, an insert is converted into PUT DML so row will retain the last values without throwing a constraint violation.

See Also:

Constant Field Values

TX_SYNC_COMMITS

static final String TX_SYNC_COMMITS

A connection level property to wait for 2nd phase commit to complete on all nodes instead of returning as soon as current server's 2nd phase commit is done.

See Also:

Constant Field Values

GFXD_TX_SYNC_COMMITS

static final String GFXD_TX_SYNC_COMMITS

System property to set TX_SYNC_COMMITS for all connections.

See Also:

Constant Field Values

SQLF_TX_SYNC_COMMITS

static final String SQLF_TX_SYNC_COMMITS

[SQLFire]: System property to set TX_SYNC_COMMITS for all connections for old SQLFire product.

See Also:

Constant Field Values

DISABLE_THINCLIENT_CANCEL

static final String DISABLE_THINCLIENT_CANCEL

A connection level property to disable Statement.cancel() over thin client.

See Also:

Constant Field Values

GFXD_DISABLE_THINCLIENT_CANCEL

static final String GFXD_DISABLE_THINCLIENT_CANCEL

System property to set to disable Statement.cancel() over thin client.

See Also:

Constant Field Values

DISABLE_TX_BATCHING

static final String DISABLE_TX_BATCHING

A connection level property to disable all batching in transactions, flushing ops immediately to detect conflicts immediately. Note that this can have a significant performance impact so turn this on only if it is really required by application for some reason.

See Also:

Constant Field Values

GFXD_DISABLE_TX_BATCHING

static final String GFXD_DISABLE_TX_BATCHING

System property to set DISABLE_TX_BATCHING for all connections.

See Also:

Constant Field Values

SQLF_DISABLE_TX_BATCHING

static final String SQLF_DISABLE_TX_BATCHING

[SQLFire] System property to set DISABLE_TX_BATCHING for all connections for old SQLFire product.

See Also:

Constant Field Values

QUERY_HDFS

static final String QUERY_HDFS

A connection level property. If set to true, data in HDFS can be queried. Otherwise, only in-memory data is queried.

See Also:

Constant Field Values

NCJ_BATCH_SIZE

static final String NCJ_BATCH_SIZE

A connection level property. If value greater than zero, rows will be batched for NCJ Query. Otherwise, batching will be disabled.

See Also:

Attribute.NCJ_BATCH_SIZE, Constant Field Values

NCJ_CACHE_SIZE

static final String NCJ_CACHE_SIZE

A connection level property. If value greater than zero, rows will be cached with limited size for NCJ Query. Otherwise, caching will be disabled.

See Also:

Attribute.NCJ_CACHE_SIZE, Constant Field Values

SKIP_LOCKS

static final String SKIP_LOCKS

A connection level property to disable all table and datadictionary locking for operations from the connection. Can only be used by the admin user.

WARNING: USE THIS WITH CARE SINCE IT CAN CAUSE INCONSISTENCIES IN THE CLUSTER IF CONCURRENT DDL OPERATIONS ARE BEING EXECUTED FROM ANOTHER CONNECTION INTO THE CLUSTER.

See Also:

Constant Field Values

ROUTE_QUERY

static final String ROUTE_QUERY

A connection level property to disable query routing.

See Also:

Constant Field Values

LOG_FILE

static final String LOG_FILE

The GemFireXD log file path property. added by GemStone

See Also:

Constant Field Values

LOG_FILE_STAMP

static final String LOG_FILE_STAMP

Log file path to which the initialization nano time is appended.

See Also:

Constant Field Values

CLIENT_SECURITY_MECHANISM

static final String CLIENT_SECURITY_MECHANISM

securityMechanism sets the DRDA mechanism in-use for the client

See Also:

Constant Field Values

CLIENT_TRACE_FILE

static final String CLIENT_TRACE_FILE

traceFile sets the client side trace file. Client driver attribute.

See Also:

Constant Field Values

CLIENT_TRACE_DIRECTORY

static final String CLIENT_TRACE_DIRECTORY

traceDirectory sets the client side trace directory. Client driver attribute.

See Also:

Constant Field Values

CLIENT_TRACE_APPEND

static final String CLIENT_TRACE_APPEND

traceFileAppend. Client driver attribute.

See Also:

Constant Field Values

CLIENT_TRACE_LEVEL

static final String CLIENT_TRACE_LEVEL

traceLevel. Client driver attribute.

See Also:

Constant Field Values

CLIENT_RETRIEVE_MESSAGE_TEXT

static final String CLIENT_RETRIEVE_MESSAGE_TEXT

retrieveMessageText. Client driver attribute.

See Also:

Constant Field Values

SSL

static final String SSL

The attribute that is used to set client SSL mode.

See Also:

Constant Field Values

USING_ODBC_DRIVER

static final String USING_ODBC_DRIVER

System property to denote that the driver is invoked using ODBC API.

See Also:

Constant Field Values

THRIFT_USE_BINARY_PROTOCOL

static final String THRIFT_USE_BINARY_PROTOCOL

If true then use TBinaryProtocol for the thrift server, else the default is to use TCompactProtocol.

This property can be specified when specifying each thrift server startup in FabricService.startThriftServer.

TODO: SW: allow for specifying different protocols for locator control connection vs data connection so that locators can always be generic base configuration while servers can be mixed as required (e.g. if the cluster has to service a mix of SSL and non-SSL clients, then common configuration for locators will help use them for all clients if client configuration has separate options for locator)

See Also:

Constant Field Values

THRIFT_SSL_PROPERTIES

static final String THRIFT_SSL_PROPERTIES

A comma-separated SSL property key=value pairs that can be set for a thrift client connection. The available property values are:

protocol: Protocol level to use e.g. TLSv1.2, TLS. See SSLContext.getInstance(protocol). enabled-protocols: A colon (":") separated list of precise protocols to enable for the socket. Note that the "protocol" property specifies a family e.g. TLSv1.2 will usually also support TLSv1.1, TLSv1 etc, so this can be used to further restrict the enabled protocols. See SSLSocket.setEnabledProtocols. cipher-suites: A colon (":") separated list of cipher suites to enable for the connection e.g. TLS_RSA_WITH_AES_256_CBC_SHA256. See SSLSocket.setEnabledCipherSuites. keystore: Path to the keystore file. keystore-type: Type of the keystore file e.g. JKS. See KeyStore.getInstance(type). keystore-password: Password to read the keystore. keymanager-type: Type of the keymanager e.g. . See KeyManagerFactory.getInstance(algorithm) truststore: Path to the truststore file. truststore-type: Type of the truststore file e.g. JKS. See KeyStore.getInstance(type). truststore-password: Password to read the truststore. trustmanager-type: Type of the trustmanager e.g. . See TrustManagerFactory.getInstance(algorithm) client-auth: If true, then require client connections to be authenticated. Only applicable for server side connections. See SSLSocket.setNeedClientAuth.

If this is not specified then default java SSL properties as per "-Djavax.net.ssl.*" or system defaults will be used. See JSSE reference guide and JCA Providers Documentation for more details of above properties.

This property can be specified when specifying each thrift server startup in FabricService.startThriftServer.

See Also:

Constant Field Values

THRIFT_SECURITY_MECHANISM

static final String THRIFT_SECURITY_MECHANISM

The security mechanism to use by the thrift driver. Supported values are:

PLAIN: User name and password sent in plaintext TOKEN: In addition to user and password, a unique random token is generated by server and returned to client that is required to be passed to server in every request for verification DIFFIE_HELLMAN: Use Diffie-Hellman key exchange to generate AES symmetric encryption keys to encrypt user and password. In addition this will use random token as in TOKEN scheme which will also be encrypted.

See the enumerated values in com.pivotal.gemfirexd.thrift.SecurityMechanism.