MySQL NDB Cluster API Developer Guide

4.3.1.14 Constants

Constants used in the ClusterJ project.

4.3.1.14.1 Synopsis
 public interface Constants {
// Public Static Fields  public static final String DEFAULT_PROPERTY_CLUSTER_BYTE_BUFFER_POOL_SIZES = "256, 10240, 102400, 1048576";
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_BATCH_SIZE = 10;
  public static final long DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_START = 1L;
  public static final long DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_STEP = 1L;
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_DELAY = 5;
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_RETRIES = 4;
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_AFTER = 20;
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_BEFORE = 30;
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_MGM = 30000;
  public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_VERBOSE = 0;
  public static final String DEFAULT_PROPERTY_CLUSTER_DATABASE = "test";
  public static final int DEFAULT_PROPERTY_CLUSTER_MAX_CACHED_SESSIONS = 100;
  public static final int DEFAULT_PROPERTY_CLUSTER_MAX_TRANSACTIONS = 4;
  public static final String DEFAULT_PROPERTY_CLUSTER_MULTI_DB = "false";
  public static final int DEFAULT_PROPERTY_CONNECTION_POOL_RECV_THREAD_ACTIVATION_THRESHOLD = 8;
  public static final int DEFAULT_PROPERTY_CONNECTION_POOL_SIZE = 1;
  public static final int DEFAULT_PROPERTY_CONNECTION_RECONNECT_TIMEOUT = 0;
  public static final int DEFAULT_PROPERTY_MGM_STRICT_TLS = 0;
  public static final int DEFAULT_PROPERTY_TABLE_WAIT_MSEC = 50;
  public static final String DEFAULT_PROPERTY_TLS_SEARCH_PATH = "$HOME/ndb-tls";
  public static final String ENV_CLUSTERJ_LOGGER_FACTORY_NAME = "CLUSTERJ_LOGGER_FACTORY";
  public static final String PROPERTY_CLUSTER_BYTE_BUFFER_POOL_SIZES = "com.mysql.clusterj.byte.buffer.pool.sizes";
  public static final String PROPERTY_CLUSTER_CONNECTION_SERVICE = "com.mysql.clusterj.connection.service";
  public static final String PROPERTY_CLUSTER_CONNECTSTRING = "com.mysql.clusterj.connectstring";
  public static final String PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_BATCH_SIZE = "com.mysql.clusterj.connect.autoincrement.batchsize";
  public static final String PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_START = "com.mysql.clusterj.connect.autoincrement.offset";
  public static final String PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_STEP = "com.mysql.clusterj.connect.autoincrement.increment";
  public static final String PROPERTY_CLUSTER_CONNECT_DELAY = "com.mysql.clusterj.connect.delay";
  public static final String PROPERTY_CLUSTER_CONNECT_RETRIES = "com.mysql.clusterj.connect.retries";
  public static final String PROPERTY_CLUSTER_CONNECT_TIMEOUT_AFTER = "com.mysql.clusterj.connect.timeout.after";
  public static final String PROPERTY_CLUSTER_CONNECT_TIMEOUT_BEFORE = "com.mysql.clusterj.connect.timeout.before";
  public static final String PROPERTY_CLUSTER_CONNECT_TIMEOUT_MGM = "com.mysql.clusterj.connect.timeout.mgm";
  public static final String PROPERTY_CLUSTER_CONNECT_VERBOSE = "com.mysql.clusterj.connect.verbose";
  public static final String PROPERTY_CLUSTER_DATABASE = "com.mysql.clusterj.database";
  public static final String PROPERTY_CLUSTER_MAX_CACHED_SESSIONS = "com.mysql.clusterj.max.cached.sessions";
  public static final String PROPERTY_CLUSTER_MAX_TRANSACTIONS = "com.mysql.clusterj.max.transactions";
  public static final String PROPERTY_CLUSTER_MULTI_DB = "com.mysql.clusterj.multi.database";
  public static final String PROPERTY_CONNECTION_POOL_NODEIDS = "com.mysql.clusterj.connection.pool.nodeids";
  public static final String PROPERTY_CONNECTION_POOL_RECV_THREAD_ACTIVATION_THRESHOLD = "com.mysql.clusterj.connection.pool.recv.thread.activation.threshold";
  public static final String PROPERTY_CONNECTION_POOL_RECV_THREAD_CPUIDS = "com.mysql.clusterj.connection.pool.recv.thread.cpuids";
  public static final String PROPERTY_CONNECTION_POOL_SIZE = "com.mysql.clusterj.connection.pool.size";
  public static final String PROPERTY_CONNECTION_RECONNECT_TIMEOUT = "com.mysql.clusterj.connection.reconnect.timeout";
  public static final String PROPERTY_DEFER_CHANGES = "com.mysql.clusterj.defer.changes";
  public static final String PROPERTY_JDBC_DRIVER_NAME = "com.mysql.clusterj.jdbc.driver";
  public static final String PROPERTY_JDBC_PASSWORD = "com.mysql.clusterj.jdbc.password";
  public static final String PROPERTY_JDBC_URL = "com.mysql.clusterj.jdbc.url";
  public static final String PROPERTY_JDBC_USERNAME = "com.mysql.clusterj.jdbc.username";
  public static final String PROPERTY_MGM_STRICT_TLS = "com.mysql.clusterj.tls.strict";
  public static final String PROPERTY_TABLE_WAIT_MSEC = "com.mysql.clusterj.table.wait.msec";
  public static final String PROPERTY_TLS_SEARCH_PATH = "com.mysql.clusterj.tls.path";
  public static final String SESSION_FACTORY_SERVICE_CLASS_NAME = "com.mysql.clusterj.SessionFactoryService";
  public static final String SESSION_FACTORY_SERVICE_FILE_NAME = "META-INF/services/com.mysql.clusterj.SessionFactoryService";
}
4.3.1.14.2 DEFAULT_PROPERTY_CLUSTER_BYTE_BUFFER_POOL_SIZES
public static final String DEFAULT_PROPERTY_CLUSTER_BYTE_BUFFER_POOL_SIZES = "256, 10240, 102400, 1048576";

The default value of the byte buffer pool sizes property: 256, 10K, 100K, 1M

4.3.1.14.3 DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_BATCH_SIZE
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_BATCH_SIZE = 10;

The default value of the connection autoincrement batch size property

4.3.1.14.4 DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_START
public static final long DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_START = 1L;

The default value of the connection autoincrement start property

4.3.1.14.5 DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_STEP
public static final long DEFAULT_PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_STEP = 1L;

The default value of the connection autoincrement step property

4.3.1.14.6 DEFAULT_PROPERTY_CLUSTER_CONNECT_DELAY
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_DELAY = 5;

The default value of the connection delay property

4.3.1.14.7 DEFAULT_PROPERTY_CLUSTER_CONNECT_RETRIES
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_RETRIES = 4;

The default value of the connection retries property

4.3.1.14.8 DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_AFTER
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_AFTER = 20;

The default value of the connection timeout after property

4.3.1.14.9 DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_BEFORE
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_BEFORE = 30;

The default value of the connection timeout before property

4.3.1.14.10 DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_MGM
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_TIMEOUT_MGM = 30000;

The default value of the connection timeout mgm property

4.3.1.14.11 DEFAULT_PROPERTY_CLUSTER_CONNECT_VERBOSE
public static final int DEFAULT_PROPERTY_CLUSTER_CONNECT_VERBOSE = 0;

The default value of the connection verbose property

4.3.1.14.12 DEFAULT_PROPERTY_CLUSTER_DATABASE
public static final String DEFAULT_PROPERTY_CLUSTER_DATABASE = "test";

The default value of the database property

4.3.1.14.13 DEFAULT_PROPERTY_CLUSTER_MAX_CACHED_SESSIONS
public static final int DEFAULT_PROPERTY_CLUSTER_MAX_CACHED_SESSIONS = 100;

The default size of the global session cache.

4.3.1.14.14 DEFAULT_PROPERTY_CLUSTER_MAX_TRANSACTIONS
public static final int DEFAULT_PROPERTY_CLUSTER_MAX_TRANSACTIONS = 4;

The default value of the maximum number of transactions property

4.3.1.14.15 DEFAULT_PROPERTY_CLUSTER_MULTI_DB
public static final String DEFAULT_PROPERTY_CLUSTER_MULTI_DB = "false";

The default value of the MultiDB property

4.3.1.14.16 DEFAULT_PROPERTY_CONNECTION_POOL_RECV_THREAD_ACTIVATION_THRESHOLD
public static final int DEFAULT_PROPERTY_CONNECTION_POOL_RECV_THREAD_ACTIVATION_THRESHOLD = 8;

The default value of the receive thread activation threshold

4.3.1.14.17 DEFAULT_PROPERTY_CONNECTION_POOL_SIZE
public static final int DEFAULT_PROPERTY_CONNECTION_POOL_SIZE = 1;

The default value of the connection pool size property

4.3.1.14.18 DEFAULT_PROPERTY_CONNECTION_RECONNECT_TIMEOUT
public static final int DEFAULT_PROPERTY_CONNECTION_RECONNECT_TIMEOUT = 0;
Since

7.5.7

The default value of the connection reconnect timeout property. The default means that the automatic reconnection due to network failures is disabled.

4.3.1.14.19 DEFAULT_PROPERTY_MGM_STRICT_TLS
public static final int DEFAULT_PROPERTY_MGM_STRICT_TLS = 0;

The default value of the MGM TLS level property

4.3.1.14.20 DEFAULT_PROPERTY_TABLE_WAIT_MSEC
public static final int DEFAULT_PROPERTY_TABLE_WAIT_MSEC = 50;

The default value of the table wait retry time property.

4.3.1.14.21 DEFAULT_PROPERTY_TLS_SEARCH_PATH
public static final String DEFAULT_PROPERTY_TLS_SEARCH_PATH = "$HOME/ndb-tls";

The default value of the TLS Search Path property.

4.3.1.14.22 ENV_CLUSTERJ_LOGGER_FACTORY_NAME
public static final String ENV_CLUSTERJ_LOGGER_FACTORY_NAME = "CLUSTERJ_LOGGER_FACTORY";

The name of the environment variable to set the logger factory

4.3.1.14.23 PROPERTY_CLUSTER_BYTE_BUFFER_POOL_SIZES
public static final String PROPERTY_CLUSTER_BYTE_BUFFER_POOL_SIZES = "com.mysql.clusterj.byte.buffer.pool.sizes";

The name of the byte buffer pool sizes property. To disable buffer pooling for blob objects, set the value of this property to "1". With this setting, buffers will be allocated and freed (and cleaned if possible) immediately after being used for blob data transfer.

4.3.1.14.24 PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_BATCH_SIZE
public static final String PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_BATCH_SIZE = "com.mysql.clusterj.connect.autoincrement.batchsize";

The name of the connection autoincrement batch size property.

4.3.1.14.25 PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_START
public static final String PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_START = "com.mysql.clusterj.connect.autoincrement.offset";

The name of the connection autoincrement start property.

4.3.1.14.26 PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_STEP
public static final String PROPERTY_CLUSTER_CONNECT_AUTO_INCREMENT_STEP = "com.mysql.clusterj.connect.autoincrement.increment";

The name of the connection autoincrement step property.

4.3.1.14.27 PROPERTY_CLUSTER_CONNECT_DELAY
public static final String PROPERTY_CLUSTER_CONNECT_DELAY = "com.mysql.clusterj.connect.delay";

The name of the connection delay property. For details, see Ndb_cluster_connection::connect()

4.3.1.14.28 PROPERTY_CLUSTER_CONNECT_RETRIES
public static final String PROPERTY_CLUSTER_CONNECT_RETRIES = "com.mysql.clusterj.connect.retries";

The name of the connection retries property. For details, see Ndb_cluster_connection::connect()

4.3.1.14.29 PROPERTY_CLUSTER_CONNECT_TIMEOUT_AFTER
public static final String PROPERTY_CLUSTER_CONNECT_TIMEOUT_AFTER = "com.mysql.clusterj.connect.timeout.after";

The name of the connection timeout after property. For details, see Ndb_cluster_connection::wait_until_ready()

4.3.1.14.30 PROPERTY_CLUSTER_CONNECT_TIMEOUT_BEFORE
public static final String PROPERTY_CLUSTER_CONNECT_TIMEOUT_BEFORE = "com.mysql.clusterj.connect.timeout.before";

The name of the connection timeout before property. For details, see Ndb_cluster_connection::wait_until_ready()

4.3.1.14.31 PROPERTY_CLUSTER_CONNECT_TIMEOUT_MGM
public static final String PROPERTY_CLUSTER_CONNECT_TIMEOUT_MGM = "com.mysql.clusterj.connect.timeout.mgm";

The name of the initial timeout for cluster connection to connect to MGM before connecting to data nodes Ndb_cluster_connection::set_timeout()

4.3.1.14.32 PROPERTY_CLUSTER_CONNECT_VERBOSE
public static final String PROPERTY_CLUSTER_CONNECT_VERBOSE = "com.mysql.clusterj.connect.verbose";

The name of the connection verbose property. For details, see Ndb_cluster_connection::connect()

4.3.1.14.33 PROPERTY_CLUSTER_CONNECTION_SERVICE
public static final String PROPERTY_CLUSTER_CONNECTION_SERVICE = "com.mysql.clusterj.connection.service";

The name of the connection service property

4.3.1.14.34 PROPERTY_CLUSTER_CONNECTSTRING
public static final String PROPERTY_CLUSTER_CONNECTSTRING = "com.mysql.clusterj.connectstring";

The name of the connection string property. For details, see Ndb_cluster_connection constructor

4.3.1.14.35 PROPERTY_CLUSTER_DATABASE
public static final String PROPERTY_CLUSTER_DATABASE = "com.mysql.clusterj.database";

The name of the database property. For details, see the catalogName parameter in the Ndb constructor. Ndb constructor

4.3.1.14.36 PROPERTY_CLUSTER_MAX_CACHED_SESSIONS
public static final String PROPERTY_CLUSTER_MAX_CACHED_SESSIONS = "com.mysql.clusterj.max.cached.sessions";
Since

9.4.0

Each Cluster/J session uses an Ndb object that holds a connection record. Obtaining these objects requires a network round-trip between the Cluster/J application and an NDB data node. To eliminate that network overhead in getSession(), these Ndb objects can be cached. Each cached object, in addition to a small amount of memory used inside Cluster/J, also consumes about 1KB of memory on each data node. This SessionFactory property is used to determine the size and behavior of the cache. If set to zero, the session cache will not be enabled for this SessionFactory. If set to some value greater than zero, the session cache will be enabled, with its size limited to the value given. Users should generally not expect the cache in a SessionFactory to grow to this maximum size, but rather to remain roughly equal to the number of threads using the SessionFactory. The total size of all session caches will not exceed the largest size requested for any one SessionFactory.

4.3.1.14.37 PROPERTY_CLUSTER_MAX_TRANSACTIONS
public static final String PROPERTY_CLUSTER_MAX_TRANSACTIONS = "com.mysql.clusterj.max.transactions";

The name of the maximum number of transactions property. For details, see Ndb::init()

4.3.1.14.38 PROPERTY_CONNECTION_POOL_NODEIDS
public static final String PROPERTY_CONNECTION_POOL_NODEIDS = "com.mysql.clusterj.connection.pool.nodeids";

The name of the connection pool node ids property. There is no default. This is the list of node ids to force the connections to be assigned to specific node ids. If this property is specified and connection pool size is not the default, the number of node ids of the list must match the connection pool size, or the number of node ids must be 1 and node ids will be assigned to connections starting with the specified node id.

4.3.1.14.39 PROPERTY_CONNECTION_POOL_RECV_THREAD_ACTIVATION_THRESHOLD
public static final String PROPERTY_CONNECTION_POOL_RECV_THREAD_ACTIVATION_THRESHOLD = "com.mysql.clusterj.connection.pool.recv.thread.activation.threshold";

The receive thread activation threshold for all connections in the connection pool. The default is no activation threshold.

4.3.1.14.40 PROPERTY_CONNECTION_POOL_RECV_THREAD_CPUIDS
public static final String PROPERTY_CONNECTION_POOL_RECV_THREAD_CPUIDS = "com.mysql.clusterj.connection.pool.recv.thread.cpuids";

The cpu binding of the receive threads for the connections in the connection pool. The default is no cpu binding for receive threads. If this property is specified, the number of cpu ids in the list must be equal to : a) the connection pool size if the connection pooling is not disabled (i.e. connection pool size > 0) (or) b) 1 if the connection pooling is disabled.

4.3.1.14.41 PROPERTY_CONNECTION_POOL_SIZE
public static final String PROPERTY_CONNECTION_POOL_SIZE = "com.mysql.clusterj.connection.pool.size";

The name of the connection pool size property. This is the number of connections to create in the connection pool. The default is 1 (all sessions share the same connection; all requests for a SessionFactory with the same connect string and database will share a single SessionFactory). A setting of 0 disables pooling; each request for a SessionFactory will receive its own unique SessionFactory.

4.3.1.14.42 PROPERTY_CONNECTION_RECONNECT_TIMEOUT
public static final String PROPERTY_CONNECTION_RECONNECT_TIMEOUT = "com.mysql.clusterj.connection.reconnect.timeout";
Since

7.5.7

The number of seconds to wait for all sessions to be closed when reconnecting a SessionFactory due to network failures. The default, 0, indicates that the automatic reconnection to the cluster due to network failures is disabled. Reconnection can be enabled by using the method SessionFactory.reconnect(int timeout) and specifying a new timeout value.

4.3.1.14.43 PROPERTY_DEFER_CHANGES
public static final String PROPERTY_DEFER_CHANGES = "com.mysql.clusterj.defer.changes";

The flag for deferred inserts, deletes, and updates

4.3.1.14.44 PROPERTY_JDBC_DRIVER_NAME
public static final String PROPERTY_JDBC_DRIVER_NAME = "com.mysql.clusterj.jdbc.driver";

The name of the jdbc driver

4.3.1.14.45 PROPERTY_JDBC_PASSWORD
public static final String PROPERTY_JDBC_PASSWORD = "com.mysql.clusterj.jdbc.password";

The jdbc password

4.3.1.14.46 PROPERTY_JDBC_URL
public static final String PROPERTY_JDBC_URL = "com.mysql.clusterj.jdbc.url";

The jdbc url

4.3.1.14.47 PROPERTY_JDBC_USERNAME
public static final String PROPERTY_JDBC_USERNAME = "com.mysql.clusterj.jdbc.username";

The jdbc username

4.3.1.14.48 PROPERTY_MGM_STRICT_TLS
public static final String PROPERTY_MGM_STRICT_TLS = "com.mysql.clusterj.tls.strict";

The name of the boolean strict MGM TLS property.

4.3.1.14.49 PROPERTY_TABLE_WAIT_MSEC
public static final String PROPERTY_TABLE_WAIT_MSEC = "com.mysql.clusterj.table.wait.msec";
Since

9.4.0

The name of the table wait retry time property. The property denotes a value from 0 to 1000 milliseconds, and specifies the behavior whenever Cluster/J attempts to open a table and the table is not found. If non-zero, it will try again to open the table, waiting up to the configured maximum number of milliseconds. If set to 0, it will immediately give up, and throw ClusterJTableException.

4.3.1.14.50 PROPERTY_TLS_SEARCH_PATH
public static final String PROPERTY_TLS_SEARCH_PATH = "com.mysql.clusterj.tls.path";

The name of the TLS Search Path property.

4.3.1.14.51 SESSION_FACTORY_SERVICE_CLASS_NAME
public static final String SESSION_FACTORY_SERVICE_CLASS_NAME = "com.mysql.clusterj.SessionFactoryService";

The name of the session factory service interface

4.3.1.14.52 SESSION_FACTORY_SERVICE_FILE_NAME
public static final String SESSION_FACTORY_SERVICE_FILE_NAME = "META-INF/services/com.mysql.clusterj.SessionFactoryService";

The name of the files with names of implementation classes for session factory service