| GemFire XD Reference | |
You use JDBC connection properties, connection boot properties, and Java system properties to configure GemFire XD members and connections.
The names of GemFire XD system properties always include the "gemfirexd." prefix. For example, all properties that configure LDAP server information for user authentication must be specified as Java system properties, rather than JDBC properties, when you boot a server.
Certain properties have additional behaviors or restrictions. See the individual property descriptions for more information.
You must add a prefix to connection and boot property names when you define those properties as Java system properties. The Prefix row in each property table lists a prefix value ("gemfirexd." or "gemfire.") when one is required. Do not use an indicated prefix when you specify the property in a connection string or with the FabricServer API.
If no prefix is specified, use only the indicated property name in all circumstances. For example, use "host-data" whether you define this property in gemfirexd.properties, as a Java system property, or as a property definition for FabricServer.
s1=hello there s2=\u3053\u3093\u306b\u3061\u306fFor example, in gemfirexd.properties, you might write:
log-file=my\u00df.logto indicate the desired property definition of log-file=myß.log.
If you have edited and saved the file in a non-ASCII encoding, you can convert it to ASCII with the native2ascii tool included in your Oracle Java distribution. For example, you might want to do this when editing a properties file in Shift_JIS, a popular Japanese encoding.
The following table lists all of the GemFire XD configuration properties names and provides links to each property reference page.
| Description | The number of seconds the distributed system waits after the ack-wait-threshold for a message to be acknowledged before it issues an alert at severe level. A value of zero disables this feature. |
| Default Value | 0 (disabled) |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The number of seconds a distributed message waits for
acknowledgment before it sends an alert to signal that something might be wrong
with the system member that is unresponsive. After sending this alert the
waiter continues to wait. The alerts are logged in the system member’s log as
warnings.
Valid values are in the range 0...2147483647 |
| Default Value | 15 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The maximum size in megabytes of all inactive statistic archive files combined. If this limit is exceeded, inactive archive files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. |
| Default Value | 0 (unlimited) |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The maximum size in megabytes of a single statistic archive file. Once this limit is exceeded, a new statistic archive file is created, and the current archive file becomes inactive. If set to zero, file size is unlimited. |
| Default Value | 0 (unlimited) |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication.
Number of milliseconds a process that is publishing to this process should attempt to distribute a cache operation before switching over to asynchronous messaging for this process. The switch to asynchronous messaging lasts until this process catches up, departs, or some specified limit is reached, such as async-queue-timeout or async-max-queue-size. To enable asynchronous messaging, the value must be set above zero. Valid values are in the range 0..60000. |
| Default Value | 0 (disabled) |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication. It applies to
non-conflated asynchronous queues for members that publish to this member.
Maximum size of the queue in megabytes before the
publisher asks this member to leave the distributed system.
Valid values are in the range 0..1024. |
| Default Value | 8 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication. It affects
asynchronous queues for members that publish to this member.
Maximum milliseconds the publisher waits with no distribution to this member before it asks the member to leave the distributed system. Used for handling slow receivers. |
| Default Value | 6000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Specifies the authentication scheme to use for network clients. The available GemFire XD implementations are BUILTIN and LDAP. You can also specify the name of a custom provider class that implements the UserAuthenticator interface. |
| Default Value | None |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description |
Note: This setting is relevant only for multi-homed hosts (machines
with multiple network interface cards).
Adapter card the cache binds to for peer-to-peer communication. It also specifies the default location for GemFire XD servers to listen on, which is used unless overridden by the server-bind-address. Specify the IP address, not the hostname, because each network card may not have a unique hostname. An empty string (the default) causes the member to listen on the default card for the machine. This attribute is a machine-wide attribute used for system member and client/server communication. It has no effect on locator location, unless the locator is embedded in a member process. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Specifies whether sockets are shared by the system member’s
threads. If true, threads share, and a minimum number of sockets are used to
connect to the distributed system. If false, every application thread has its
own sockets for distribution purposes. You can override this setting for
individual threads inside your application. Where possible, it is better to set
conserve-sockets to true and enable the use of specific extra sockets in the
application code if needed. The length of time a thread can have exclusive
access to a socket can be configured with
socket-lease-time.
Note: WAN deployments increase the messaging demands on a GemFire
XD system. To avoid hangs related to WAN messaging, always set
conserve-sockets=false for GemFire XD members that participate in a WAN
deployment. See
Prerequisites for WAN Replication.
|
| Default Value | true |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Specifies a default RECOVERYDELAY value for all tables in the
cluster. If a GemFire XD member leaves the cluster and no new members join,
the remaining GemFire XD members wait for a period of time before they
perform recovery to satisfy the redundancy requirements of partitioned
tables. This attribute specifies the period of time to wait before
initiating recovery. Note: GemFire XD always initiates recovery for
redundant, partitioned tables when a new GemFire XD member joins the
cluster or when a rebalance operation occurs.
A value of -1, the default value, indicates that no recovery is performed unless a new GemFire XD member joins the cluster, or unless individual tables override the recovery delay by specifying the RECOVERYDELAY clause in their CREATE TABLE statements. See Configuring High Availability for Partitioned Tables. |
| Default Value | -1 |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | The number of seconds of process failure history kept by the system for correlating the loss of processes eligible to be the membership coordinator and the lead member. |
| Default Value | 1800 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Specifies whether the GemFire XD member should automatically reconnect to the distributed system after a forced disconnect. A GemFire XD member may be forcibly disconnected from a distributed system if it is unresponsive for a period of time, or if a network partition separates one or more members into a group that is too small to act as the distributed system. When this property is set to "false" (the default), the member automatically shuts down and then restarts into a "reconnecting" state, where it periodically attempts to rejoin the distributed system. If it succeeds in reconnecting, the member rebuilds its view of the distributed system from existing members, and it receives a new distributed system ID. See also max-num-reconnect-tries, max-wait-time-reconnect, and Handling Forced Disconnection. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Disables results streaming on the query node for this connection. Disabling streaming
degrades performance and requires more memory for large query results, but
provides more predictable results if a GemFire XD member happens to go down
while iterating over a ResultSet. When this property is not enabled, a SQLException with state GFXD_NODE_SHUTDOWN is thrown if a member goes offline in the middle of ResultSet iteration; in this case, the application has to retry the query. When this property is enabled, GemFire XD waits for at least one result from each member and does not group results from members. This provides transparent failover if a member goes offline. |
| Default Value | false |
| Property Type | connection |
| Prefix | gemfirexd. |
| Description | Boolean indicating whether to disable the use of TCP/IP sockets for inter-cache point-to-point messaging. If disabled, the cache uses datagram (UDP) sockets. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Identifier used to distinguish messages from different
distributed systems.
When starting a locator, set this property to a unique value for the cluster in a multi-site (WAN) configuration. Valid values are integers in the range -1...255. All locators for a single cluster must use the same value. -1 means no setting. Individual GemFire XD members can use the setting of -1 and connect to one or more locators that specify a unique distribute-system-id. |
| Default Value | -1 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Sets the connection identity. |
| Default Value | Connection number |
| Property Type | connection |
| Prefix | n/a |
| Description | Boolean instructing the system to detect and handle splits in the distributed system, typically caused by a partitioning of the network (split brain) where the distributed system is running. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | This property can only be used with a peer client
connection; you cannot use it from a thin client.
Enables statistics collection at the statement level for the associated connection. See Evaluating Statistics for the System and Applications. |
| Default Value | false |
| Property Type | connection |
| Prefix | gemfirexd. |
| Description | Boolean instructing the system to track time-based statistics for the distributed system. Disabled by default for performance. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This property can only be used with a peer client connection;
you cannot use it from a thin client.
Boolean instructing the system to track time-based statistics for the current connection. Disabled by default for performance. See Evaluating Statistics for the System and Applications. |
| Default Value | false |
| Property Type | connection |
| Prefix | gemfirexd. |
| Description | Boolean that determines whether GemFire XD puts redundant copies of the same data in different members running on the same physical machine. By default, GemFire XD tries to put redundant copies on different machines, but it puts them on the same machine if no other machines are available. Setting this property to true prevents this and requires different machines for redundant copies. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Configures the frequency (in milliseconds) with which
GemFire XD logs warning messages for low disk space conditions. GemFire XD logs
a low disk space warning in the following situations:
|
| Default Value | 10000 |
| Property Type | system |
| Prefix | n/a |
| Description | Configures the maximum size, in bytes, of a locator's membership view
log, which can be used to verify that your product usage is compliance with
your GemFire XD license. (See Product Usage Logging.) The minimum file size is 1000000 bytes. If you specify a smaller value,
GemFire XD uses a value of 1000000 instead. After the maximum file size is reached, the locator deletes the log file and begins recording messages in a new file. |
| Default Value | 5000000 |
| Property Type | system |
| Prefix | n/a |
| Description | This is the maximum time to wait for a transaction that is
committing a row that the current transaction is trying to read or write. Do
not change this property unless transactions involve a large number of writes
and potentially can take a very long time during commit to write to datastores.
The default is 5 minutes.
If you change this property, set it to the same value on every data store member in your distributed system. This property configures conflict detection for READ_COMMITTED and REPEATABLE_READ transactions. See Supported Transaction Isolation Levels. |
| Default Value | 5 |
| Property Type | system |
| Prefix | n/a |
| Description |
Boolean that determines whether GemFire XD pre-allocates the disk space required for disk store files (.crf and .drf extensions) using operating system-native calls. Pre-allocating disk space can avoid later failures or hangs caused by disk full conditions. See also gemfire.preAllocateIF. |
| Default Value | false |
| Property Type | system |
| Prefix | n/a |
| Description |
Boolean that determines whether GemFire XD pre-allocates the disk space required for disk store metadata files (.if extensions) using operating system-native calls. Pre-allocating disk space can avoid later failures or hangs caused by disk full conditions. See also gemfire.preAllocateDisk. |
| Default Value | false |
| Property Type | system |
| Prefix | n/a |
| Description |
Boolean that determines whether GemFire XD synchronously writes all disk store changes through to the underlying local storage device. See Managing How Data is Written to Disk. |
| Default Value | false |
| Property Type | system |
| Prefix | n/a |
| Description | Boolean that determines whether GemFire XD detects conflicts
in thin client transactions lazily or at operation time. With the default value
of "false," GemFire XD detects any conflicts in DML operations lazily. DML
conflicts may be thrown by the system at some point later in the transaction
(for example, even when executing queries or at commit time). Set this option
to "true" on all data store members in your distributed system to immediately
detect conflicts at operation time for thin clients.
Note: Enabling
gemfire.tx-disable-batching can degrade
performance significantly. Enable this option only after you have thoroughly
tested the setting in your system, and you have determined that the performance
tradeoff is necessary to provide immediate conflict detection with thin
clients.
|
| Default Value | false |
| Property Type | system |
| Prefix | n/a |
| Description | Specifies the default HDFS root directory in which GemFire XD creates new HDFS stores.
All HDFS store directories and files are created relative to this directory,
unless an absolute directory is specifies in the CREATE HDFSSTORE statement. The GemFire XD JVM owner must
have HDFS read and write permission on this directory. The value of this
property must not contain the the Hadoop NameNode URL. By default, this property resolves to the current HDFS directory "." in the home directory of the user who starts the GemFire XD JVM. For example, this would default to /user/gfxd if you installed GemFire XD as a component of Pivotal HD Enterprise, because the Pivotal HD installation process installs and runs GemFire XD as the "gfxd" user. Note: This variable always refers to an HDFS directory, rather than
a local directory on the UNIX filesystem.
|
| Default Value | . |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | Specifies whether this GemFire XD member will host table
data.
Setting this value to false boots a GemFire XD accessor member with the full GemFire XD engine. The accessor (or peer client) participates in routing queries to other members, but it does not host replicated or partitioned data, and it does not persist the data dictionary. Setting this value to true boots a GemFire XD data store. Data stores host data, and they persist the data dictionary by default. All data stores in the same GemFire XD cluster must use the same persistence settings (using the persist-dd boot property). You should generally specify one or more server groups for the data store by including the server-groups attribute. By default, all new GemFire XD data stores are added to the default server group. |
| Default Value | true |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | One or more SQL script files to execute after loading DDL from the data dictionary. Use a comma-separated list of files to supply multiple values. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | If true then this member can become a JMX Manager. All other jmx-manager-* properties are used when it does become a JMX Manager. If this property is false then all other jmx-manager-* properties are ignored. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | By default the JMX Manager allows full access to all MBeans by any client. If this property is set to the name of a file, then it can restrict clients to only reading MBeans; they cannot modify MBeans. The access level can be configured differently in this file for each user name defined in the password file. For more information about the format of this file see Oracle's documentation of the com.sun.management.jmxremote.access.file system property. Ignored if jmx-manager is false or if jmx-manager-port is zero. See Setting Up JMX Manager Authentication. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | By default, the JMX Manager when configured with a port listens on all the local host's addresses. You can use this property to configure which particular IP address or host name the JMX Manager will listen on. This property is ignored if jmx-manager is false or jmx-manager-port is zero. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Hostname given to clients that ask the locator for the location of a JMX Manager. By default the IP address of the JMX Manager is used. However, for clients on a different network, you can configure a different hostname to be given to clients. Ignored if jmx-manager is false or if jmx-manager-port is zero. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | If non-zero, when started the JMX Manager will also start an embedded Web server and will listen on this port. The Web server is used to host the GemFire XD Pulse Web application. If you are hosting the Pulse web app in your own Web server, then disable this embedded server by setting this property to zero. Ignored if jmx-manager is false. |
| Default Value | 7070 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | By default the JMX Manager allows clients without credentials to connect. If this property is set to the name of a file, only clients that connect with credentials that match an entry in this file will be allowed. Most JVMs require that the file is only readable by the owner. For more information about the format of this file see Oracle's documentation of the com.sun.management.jmxremote.password.file system property. Ignored if jmx-manager is false or if jmx-manager-port is zero. See Setting Up JMX Manager Authentication. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | The port on which this JMX Manager listens for client connections. If this property is set to zero, GemFire XD does not allow remote client connections. Alternatively, use the standard system properties supported by the JVM for configuring access from remote JMX clients. Ignored if jmx-manager is false. The Default RMI port is 1099. |
| Default Value | 1099 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | If true and jmx-manager-port is not zero, the JMX Manager accepts only SSL connections. The ssl-enabled property does not apply to the JMX Manager, but the other SSL properties do. This allows SSL to be configured for just the JMX Manager without needing to configure it for the other GemFire XD connections. Ignored if jmx-manager is false. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | If true, this member starts a JMX Manager when it boots. In most cases you should not set this property to true because a JMX Manager is automatically started when needed on a member that sets jmx-manager to true. Ignored if jmx-manager is false. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | The rate, in milliseconds, at which this member pushes updates to any JMX Managers. Currently this value should be greater than or equal to the statistic-sample-rate. |
| Default Value | 2000 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Number of consecutive TCP keepalive probes that can be sent without receiving a
response. After this count is reached, the client or server sending the
probes declares that the recipient is offline. You can use this property
with either a GemFire XD client socket (to determine when a server is
offline) or a GemFire XD network server socket (to determine when clients go
offline). Note: Windows platforms do not support per-socket configuration
for keepalive-count. As an alternative, you can
configure a system-wide keepalive-count value in some
versions of Windows. See http://msdn.microsoft.com/en-us/library/windows/desktop/dd877220%28v=vs.85%29.aspx.
Windows Vista and later versions keep this value fixed at 10.
|
| Default Value | 10 |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | TCP keepalive idle timeout in seconds. This is the idle time after which a TCP
keepalive probe is sent over the socket to determine if the other side of
the socket is alive. You can use this property with either a GemFire XD
client socket (to determine when a server is offline) or a GemFire XD
network server socket (to determine when clients go offline). Note: On
Solaris platforms prior to r10, system-wide TCP keepalive settings must
be changed to larger values (approximately 30 seconds) in order to
detect server failures by clients and vice versa. See http://docs.oracle.com/cd/E19082-01/819-2724/fsvdg/index.html.
This also applies to other non-Linux, non-Windows platforms. For
example, see http://www-01.ibm.com/support/docview.wss?uid=swg21231084.
|
| Default Value | 20 |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | TCP keepalive timeout interval in seconds. This is the time interval to wait between
successive TCP keepalive probes if there is no response to the previous
probe. You can use this property with either a GemFire XD client socket (to
determine when a server is offline) or a GemFire XD network server socket
(to determine when clients go offline). Note: On Solaris platforms prior to
r10, system-wide TCP keepalive settings must be changed to larger values
(approximately 30 seconds) in order to detect server failures by clients
and vice versa. See http://docs.oracle.com/cd/E19082-01/819-2724/fsvdg/index.html.
This also applies to other non-Linux, non-Windows platforms. For
example, see http://www-01.ibm.com/support/docview.wss?uid=swg21231084.
|
| Default Value | 1 |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | Specifies whether load balancing is performed for the JDBC client connection. Note that
load balancing is provided only for GemFire XD distributed systems that use
locators for member discovery. With the default value ("true") clients are
automatically connected to a less-loaded server if locators are used for
member discovery. Note that when load balancing is enabled, clients may not
be able to connect to a specific server even if they provide that server's
unique port number for client connections. As a best practice, clients
should always request connections using a locator address and port when load
balancing is enabled. If a JDBC client needs to connect to a specific
member, set load-balance to "false" in the connection
string and specify the connection details for a specific GemFire XD
member, rather than a locator. For
example:
gfxd> connect client 'server_hostname:server_port/;load-balance=false' |
| Default Value | true |
| Property Type | connection |
| Prefix | n/a |
| Description | List of locators used by system members. The list must be
configured consistently for every member of the distributed system. If the list
is empty, locators are not used.
For each locator, provide a host name and/or address (separated
by ‘@’, if you use both), followed by a port number in brackets. Examples:
locators=address1[port1],address2[port2] locators=hostName1@address1[port1],name2@address2[port2] locators=hostName1[port1],name2[port2] Note: On multi-homed hosts, this last notation uses the default
address. If you use bind addresses for your locators, explicitly specify the
addresses in the locators list—do not use just the hostname.
|
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Maximum size in megabytes of all inactive log files combined. If this limit is exceeded, inactive log files are deleted, oldest first, until the total size is within the limit. If set to zero, disk space use is unlimited. |
| Default Value | 0 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | File to to use for writing log messages. If set to null, the
default is used.
Each member type has its own default output:
|
| Default Value | not set |
| Property Type | connection |
| Prefix | gemfirexd. or gemfirexd.client. |
| Description | The maximum size in megabytes of a log file before it is closed and logging rolls on to a new (child) log file. If set to 0, log rolling is disabled. |
| Default Value | 0 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Level of detail of the messages written to the system
member’s log. Setting log-level to one of the ordered levels causes all
messages of that level and greater severity to be printed.
Valid values from lowest to highest are fine, config, info, warning, error, severe, and none. |
| Default Value | config |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The maximum number of reconnection attempts to make after the member is forcibly disconnected from the distributed system. See also max-wait-time-reconnect, disable-auto-reconnect, and Handling Forced Disconnection. |
| Default Value | 3 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The maximum time in milliseconds to wait for the distributed system to reconnect between each reconnection attempt. See also max-num-reconnect-tries, disable-auto-reconnect, and Handling Forced Disconnection. |
| Default Value | 60000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication.
Address used to discover other members of the distributed system. Only used if mcast-port is non-zero. This attribute must be consistent across the distributed system. Note: Select different multicast addresses and different ports for
different distributed systems. Do not just use different addresses. Some
operating systems may not keep communication separate between systems that use
unique addresses but the same port number.
This default multicast address was assigned by IANA ( http://www.iana.org/assignments/multicast-addresses ). Consult the IANA chart when selecting another multicast address to use with GemFire XD. |
| Default Value | 239.192.81.1 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication.
Tuning property for flow-of-control protocol for unicast and multicast no-ack UDP messaging. Compound property made up of three settings separated by commas: byteAllowance, rechargeThreshold, and rechargeBlockMs. Valid values range from these minimums: 10000,0.1,500 to these maximums: no_maximum ,0.5,60000. |
| Default Value | 1048576,0.25, 5000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication.
Port used, along with the mcast-address, for multicast communication with other members of the distributed system. If zero, multicast is disabled for member discovery and distribution. Note: Select different multicast addresses and ports for different
distributed systems. Do not just use different addresses. Some operating
systems may not keep communication separate between systems that use unique
addresses but the same port number.
Valid values are in the range 0..65535. Either mcast-port or locators is required for a peer. If mcast-port is specified, do not specify locators or set start-locator. |
| Default Value | 10334 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication.
Size of the socket buffer used for incoming multicast
transmissions. You should set this high if there will be high volumes of
messages.
The default setting is higher than the default OS maximum buffer size on Unix, which should be increased to at least 1 megabyte to provide high-volume messaging on Unix systems. Valid values are in the range 2048.. OS_maximum. |
| Default Value | 1048576 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication.
The size of the socket buffer used for outgoing multicast
transmissions.
Valid values are in the range 2048.. OS_maximum. |
| Default Value | 65535 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description |
Note: This setting controls only peer-to-peer communication and
does not apply to client/server or multi-site communication.
How far multicast messaging goes in your network. Lower settings may improve system performance. A setting of 0 constrains multicast messaging to the machine. |
| Default Value | 32 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Interval, in milliseconds, between two attempts to determine
whether another system member is alive. When another member appears to be gone,
GemFire XD tries to contact it twice before quitting.
Valid values are in the range 1000..600000. |
| Default Value | 5000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The range of ports available for unicast UDP messaging and
for TCP failure detection. Specify this value as two integers separated by a
minus sign. Different members can use different ranges.
GemFire XD randomly chooses two unique integers from this range for the member, one for UDP unicast messaging and the other for TCP failure detection messaging. Additionally, the system uniquely identifies the member using the combined host IP address and UDP port number. You may want to restrict the range of ports that GemFire XD uses so the product can run in an environment where routers only allow traffic on certain ports. |
| Default Value | 1024-65535 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The total size of off-heap memory, specified with a numerical value followed by g, m, or k to indicate gigabytes, megabytes, or kilobytes. See Storing Tables in Off-Heap Memory . |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | A password for the user name given at boot or connection
time.
Use this attribute in conjunction with the user attribute. |
| Default Value | not set |
| Property Type | connection |
| Prefix | n/a |
| Description | Enables or disables disk persistence for the data
dictionary. By default, all data stores (GemFire XD members booted with
host-data=true) set this value to "true" to enable persistence. All GemFire XD
data stores in the same cluster must use the same persistence setting.
When persistence is enabled, if all data stores in a cluster are down, then clients cannot execute DDL statements in the cluster until a data store becomes available. This ensures that the persisent data dictionary can be recovered when the final data store rejoins the cluster. Note: You cannot enable persistence for GemFire XD accessors
(members that booted with host-data=false).
When persist-dd is set to "false," then no tables can be declared as persistent. However, overflow can still be configured if you explicitly define the sys-disk-dir attribute. When a new GemFire XD member joins an existing cluster, the data dictionary is obtained either from other members, or it is retrieved from persisted data if the new member is determined to have to most current copy of the data in the cluster. Optimizing a System with Disk Stores provides more information about starting and shutting down GemFire XD clusters that utilize disk stores for persistence. |
| Default Value | true |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | Determines whether locators (or intermediate servers, if locators are not used for
discovery) provide server hostnames or server IP addresses to clients who
are connecting to the distributed system. With the default setting (false),
a locator provides hostnames to a client. Hostnames are generally preferable
to use because it is more likely that an IP address may not be valid outside
of a firewall, where clients typically reside. However, if you configure a
system using only IP addresses, or there is a likelihood of a mismatch
between hostnames and IP addresses (either due to misconfigured
/etc/hosts files or DHCP hostnames are overwritten),
then set this property to true to provide IP addresses for client
connections. Note: This is a server-side boot property. You cannot use
this property in a thin client connection string.
|
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | Determines whether queries that are executed from this connection access a table's HDFS
persistent data as well as the table's in-memory, operational data. By
default, queries operate only against the in-memory, operational data set of
a table, ignoring any data that is persisted to HDFS. Specify the
query-HDFS=true connection property to access both
operational and HDFS-persistent data. Note: Any queries that access
HDFS-persistent data should reference a primary key, for performance
reasons. Non primary key-based queries require a full table scan, which
can lead to poor performance when accessing HDFS data.
Note: Most
DML commands (update and delete operations) always operate against the
full data set of the table, even if you do not specify the
queryHDFS hint. For HDFS Write-only tables,
TRUNCATE TABLE removes only the in-memory data for the table, but leaves
the HDFS log files available for later processing with MapReduce and
HAWQ. This occurs regardless of the queryHDFS
setting.
For HDFS Read-Write tables, TRUNCATE TABLE removes the in-memory data for the table and marks the table's HDFS log files for expiry. This means that GemFire XD queries, MapReduce jobs with CHECKPOINT mode enabled, and HAWQ external tables with CHECKPOINT mode enabled no longer return data for the truncated table. MapReduce jobs and HAWQ external tables that do not use CHECKPOINT mode will continue to return some table values until the log files expire. |
| Default Value | false |
| Property Type | connection |
| Prefix | n/a |
| Description | Defines the read-timeout for a thin-client connection, in seconds. If no response is received after this time, the connection is dropped and GemFire XD can attempt to reconnect. |
| Default Value | not set |
| Property Type | connection |
| Prefix | n/a |
| Description | Defines this member's redundancy zone. Used to separate members into different groups for satisfying partitioned table redundancy. If this property is set, GemFire XD does not put redundant copies of data in members with the same redundancy zone setting. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Provides the address and port number of one or more secondary GemFire XD locator members to use for connecting to the distributed system. The secondary locator addresses are used to establish an initial connection to GemFire XD if the primary locator is not available. Specify the address and port number of each locator using either the locator[port] or locator:port format. Use a comma-separated list to specify multiple secondary locators. See Thin Client Failover. |
| Default Value | not set |
| Property Type | connection |
| Prefix | n/a |
| Description | Used with authentication. The log file for security log messages. If not specified, the member's regular log file is used. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Used with authentication. Logging level detail for security
log messages.
Valid values from lowest to highest are fine, config, info, warning, error, severe, and none. |
| Default Value | config |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Used with authentication. Timeout in milliseconds used by a peer to verify membership of an unknown authenticated peer requesting a secure connection. |
| Default Value | 1000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Specifies the authentication scheme to use for server connections. Possible values are same as those for auth-provider. |
| Default Value | Inherits from auth-provider |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description |
Note: This setting is only relevant for servers on multi-homed
hosts (machines with multiple network cards).
Network adapter card a GemFire XD server binds to for client/server communication. You can use this to separate the server’s client/server communication from its peer-to-peer communication, spreading the traffic load. Specify the IP address, not the hostname, because each network card may not have a unique hostname. This is a machine-wide attribute used for communication with clients in client/server and multi-site installations. It has no effect on locator location. An empty string (the default) causes the servers to listen on the same card that is used for peer-to-peer communication. This is either the bind-address or, if that is not set, the machine’s default card. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | One or more server groups in which the GemFire XD member participates. Use a
comma-separated list of server group names to supply multiple values.
Note: GemFire XD converts server group names to all-uppercase letters
before storing the values in the SYS.MEMBERS table. DDL statements and
procedures automatically convert any supplied server group values to
all-uppercase letters. However, you must specify uppercase values for
server groups when you directly query the SYS.MEMBERS
table.
Server groups are used with GemFire XD DDL statements, and also for executing data-aware procedures. If you do not use the server-groups attribute, or if you do not specify a value for the attribute, then the GemFire XD member is added only to the default server group. The default server group includes all of the GemFire XD members that participate in the distributed system. GemFire XD members that do not host data (host-data=false) can still participate in server groups in order to provide routing information for data-aware procedures that target specific server groups. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | Stops GemFire XD in the current process. A successful
shutdown always results in a SQLException indicating that StopsGemFire XD has
shut down and that there is no longer a connection active.
shutdown=true overrides all other attributes that might be specified in the JDBC connection. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Determines whether a JDBC thin-client driver connection provides single-hop access to data for queries that are distributed to multiple GemFire XD members. By default, the thin-client driver provides one-hop or two-hop access to data. See Connect to a GemFire XD Server with the Thin Client JDBC Driver. See also gemfirexd.client.single-hop-max-connections. |
| Default Value | false |
| Property Type | connection |
| Prefix | n/a |
| Description | When skip-constraint-checks is set to true, GemFire XD ignores all
primary key, foreign key, and unique constraints for all SQL statements that
are executed over the connection. This connection property is typically used
only when importing data into a GemFire XD system, in order to speed the
execution of insert statements. Warning: When you set this
property on a connection, you must ensure that no SQL operations violate
the foreign key and unique constraints defined in the system. For
primary key constraints, GemFire XD uses the PUT INTO DML syntax to ensures that only the
last primary key value inserted or updated remains in the system; this
preserves primary key constraints. However, foreign key and unique
constraints can be violated when this property is set. This can
lead to undefined behavior in the system, because other connections that
do not enable skip-constraint-checks still require
constraint checks for correct operation.
One exception to the skip-constraint-checks behavior is that GemFire XD will throw a constraint violation error if a SQL statement would cause a local unique index to have duplicate values. This type of local index is created when you specify a unique index on a replicated table, or on non-HDFS partitioned tables where the number unique index columns is greater than or equal to the table's partitioning columns. The exception does not apply to updating global indexes, because GemFire XD uses the PUT INTO DML syntax to update global indexes when skip-constraint-checks is enabled. Using PUT INTO ensures that only the last index entry for a given value remains in the index, which preserves uniqueness. |
| Default Value | false |
| Property Type | connection |
| Prefix | n/a |
| Description | If true, GemFire XD does not propagate DML operations to
configured DBSynchronizer, AsyncEventListener, or EventCallBack (Writer and
Listener) implementations. This is a connection-level property and applies only
to DML operations generated by the specific connection that enables the
property.
Note: This property does not affect WAN replication using a
configured gateway. GemFire XD always propagates DML operations to an enabled
WAN site.
|
| Default Value | false |
| Property Type | connection |
| Prefix | n/a |
| Description |
Warning: This property is provided only
for the purpose of cancelling a long-running query in cases where the
query causes a DDL operation to hold a DataDictionary lock, preventing
new logins to the system. Using this property outside of its intended
purpose can lead to data corruption, especially if DDL is performed
while the property is enabled.
skip-locks forces the associated connection to avoid acquiring DataDictionary and table locks, enabling a JVM owner user to log into a system where a blocked DDL operation holds a DataDictionary lock and prevents new connections. Any operation that attempts to acquire a table or DataDictionary lock from the connection logs a warning and sends a SQLWarning in the statement. Transaction locks are still obtained as usual. Use this property to connect directly to a GemFire XD server, rather than a locator. (The property disables the load-balance property by default, as load balancing can cause local deadlocks even when skip-locks is enabled.) After connecting, use SYS.CANCEL_STATEMENT to cancel the long-running query (DDL statements cannot be canceled) and disconnect. See Cancelling Long-Running Statements for more information. This property is restricted to JVM owners. Attempting to set the property without JVM owner credentials fails with the error, "Connection refused: administrator access required for skip-locks." If authorization is disabled, the default user "APP" is the JVM owner. |
| Default Value | false |
| Property Type | connection |
| Prefix | n/a |
| Description | Receive buffer sizes in bytes of the TCP/IP connections used for data transmission. To minimize the buffer size allocation needed for distributing large, serializable messages, the messages are sent in chunks. This setting determines the size of the chunks. Larger buffers can handle large messages more quickly, but take up more memory. |
| Default Value | 32768 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The time, in milliseconds, that a thread can have exclusive
access to a socket it is not actively using. A value of zero causes socket
leases to never expire. This property is ignored if conserve-sockets is true.
Valid values are in the range 0..600000. |
| Default Value | 60000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Use this property to limit the search space used when
GemFire XD verifies a user login ID. Specify the name of the context or object
to search, that is a parameter to javax.naming.directory.DirContext.search().
For example:
ou=ldapTesting,dc=pivotal,dc=com By default, GemFire XD tries to bind the anonymous user for searching when you configure gemfirexd.auth-ldap-search-base. If your LDAP server does not support anonymous binding, also configure gemfirexd.auth-ldap-search-dn and gemfirexd.auth-ldap-search-pw. |
| Default Value | not set |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | If the LDAP server does not allow anonymous binding (or if
this functionality is disabled), specify the user distinguished name (DN) to
use for binding to the LDAP server for searching. For example:
uid=guest,o=pivotal.com |
| Default Value | Null |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Specifies a user's objectClass, used to narrow the LDAP
search. For example:
objectClass=person |
| Default Value | (&(objectClass=inetOrgPerson)(uid=%USERNAME%)) |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | The password for the guest user DN, used for looking up the
DN (see
gemfirexd.auth-ldap-search-dn).
For example:
guestPassword |
| Default Value | Null |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | The URI of the LDAP server (beginning with either ldap:// or ldaps://). |
| Default Value | not set |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | If authorization is enabled, then this property sets the access mode for all users that
are not listed in the gemfirexd.authz-full-access-users or
gemfirexd.authz-read-only-access-users properties.
Configure this property only if you do not intend to use the GRANT and
REVOKE commands to manage privileges on SQL objects. The possible values are
NOACCESS, READONLYACCESS, and FULLACCESS. Keep in mind that using this property overrides any fine-grained privileges that are granted using the GRANT statement. For example, if you set this property to NOACCESS, then any user that is not listed under gemfirexd.authz-full-access-users or gemfirexd.authz-read-only-access-users has no access to GemFire XD tables. You cannot use GRANT to give such a user additional privileges. Tip: If you set the
gemfirexd.authz-default-connection-mode property to
noAccess or readOnlyAccess,
you should allow at least one user read-write access. Otherwise,
depending on the default connection authorization that you specify, your
system may contain database objects that cannot be accessed or changed.
You must specify that the user has access by specifying
gemfirexd.authz-full-access-users=username
on the command line when starting GemFire XD; you cannot define the
property in gemfirexd.properties.
|
| Default Value | If you do not configure this property, then all users have full access (read/write privileges) unless the user is listed in gemfirexd.authz-read-only-access-users or have been given specific permissions with GRANT and REVOKE. |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Defines the list of user names that have full access to SQL objects. Users that are listed in gemfirexd.authz-full-access-users have full access regardless of whether specific privileges were taken away using the REVOKE statement. |
| Default Value | not set |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Defines the list of user names that have read-only access to SQL objects. This property is generally used when gemfirexd.authz-default-connection-mode is set to FULLACCESS. Configure this property only if you do not intend to use the GRANT and REVOKE commands to manage privileges on SQL objects. Any users that are listed in gemfirexd.authz-read-only-access-users have read-only access, regardless of whether any additional privileges were granted using the GRANT statement. |
| Default Value | not set |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Enables or disables authorization in GemFire XD. See Configuring User Authorization. The default value of this property is "false." However, if you use the -auth-provider option to specify a client authentication mechanism when starting a GemFire XD member, SQL authorization is enabled by default. |
| Default Value | false |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Enables a GemFire XD member to start up, ignoring DDL statements that fail during member initialization. This property enables you to resolve startup problems manually, after forcing the member to start. Typical DDL initialization problems occur when a required disk store file is unavailable, or when GemFire XD cannot initialize a DBSynchronizer configuration due to the external RDBMS being unavailable. Use gemfirexd.datadictionary.allow-startup-errors to drop and recreate the disk store or DBSynchronizer configuration after startup. See also Member Startup Problems. |
| Default Value | false |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | The number of milliseconds to wait after a member joins the distributed system before recovering redundancy for partitioned tables. The default of 0 (zero) configures immediate redundancy recovery whenever a new partitioned table host joins. A value of -1 disables automatic recovery after a new member joins the distributed system. If both this property and default-recovery-delay are set to -1, then no automatic redundancy recovery is performed when a new member joins the system. See Configuring High Availability for Partitioned Tables. |
| Default Value | 0 |
| Property Type | system |
| Prefix | n/a |
| Description | Network interface on which the network server listens.
This property allows multiple members of a Network Server to run on a single machine, each using its own unique host:port combination. If the property is set to 0.0.0.0, the Network Server listens on all interfaces. Ensure that you are running under the security manager and that user authorization is enabled before you enable remote connections with this property |
| Default Value | The Network Server listens only on the loopback address (localhost). |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | If true, GemFire XD attempts to clean up disconnected clients. The idle time is two hours by default. |
| Default Value | true |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Specifies whether to log network client connections and disconnections. This setting can be enabled dynamically using NetworkInterface as well. |
| Default Value | false |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Maximum number of connection threads that the Network Server allocates. If the maximum number of threads are allocated, then connections are shared using the gemfirexd.drda.timeSlice property to switch between connections. This setting can be enabled using NetworkInterface as well, but the Network Server must be restarted for the change to take effect. |
| Default Value | 0 (unlimited) |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Minimum number of connection threads that the Network Server allocates. This setting can be enabled using NetworkInterface as well, but the Network Server must be restarted for the change to take effect. |
| Default Value | On-demand allocation. |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Port number to use. |
| Default Value | 1527 |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Restricts client connections based on the security
mechanism. If set to a valid mechanism, then only those connections with the
specified mechanism are allowed. If no value is set, then connections with any
mechanism are allowed.
Possible values are:
|
| Default Value | None |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Determines whether client connections to the member are encrypted or not, and whether
certificate-based peer authentication is enabled. Possible values are Off,
Basic, and peerAuthentication. Thin clients connecting to a server that implements SSL should specify the connection property ssl. |
| Default Value | Off |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Configures the size of the buffer used for streaming BLOB/CLOB data from the server to a client. If the configured size is 0 or less, then the buffer is not created. |
| Default Value | 0 |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Number of milliseconds that each connection uses before
yielding to another connection. This property is effective only if
gemfirexd.drda.maxThreads is set greater than
zero.
The server must be restarted for changes to take effect. |
| Default Value | 0 |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Enables tracing for the client session. This setting can be enabled dynamically using NetworkInterface as well. |
| Default Value | false |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Enables tracing for all client sessions. This setting can be enabled dynamically using NetworkInterface as well. |
| Default Value | false |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | Location of the tracing directory on the server. This setting can be enabled using NetworkInterface as well, but the Network Server must be restarted for the change to take effect. |
| Default Value | Uses the gemfirexd.system.home property (if set). Otherwise, uses the current directory. |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | The path and filename in which the gfxd utility stores a list of the commands executed during an interactive gfxd session. Specify this system property in the JAVA_ARGS environment variable before you execute gfxd (for example, JAVA_ARGS="-Dgfxd.history=path-to-file"). Specify an empty string value to disable recording a history of commands. See gfxd Interactive Commands. |
| Default Value |
%UserProfile%\.gfxd.history (Windows) $HOME/.gfxd.history (Linux) |
| Property Type | system |
| Prefix | n/a |
| Description | The size of the permissions that GemFire XD caches in m memory for faster lookup performance. This property cannot be overridden using a system property. Specify the number of entries to cache. |
| Default Value | 64 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | The size of the stored prepared statement descriptor cache that GemFire XD uses for looking up definitions. Specify the number of entries to cache. |
| Default Value | 32 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | The size of the precompiled statement cache for DML statements. Specify the number of entries to cache. |
| Default Value | 100 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | The size of table descriptors that GemFire XD caches in memory for faster lookup performance. This property cannot be overridden using a system property. Specify the number of entries to cache. |
| Default Value | 64 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Maximum time in milliseconds that a DDL statement waits for a distributed lock on the data dictionary or a table. |
| Default Value | 300000 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Overrides the default lookup for application file properties in the file named 'gemfirexd.properties.' |
| Default Value | gemfirexd.properties |
| Property Type | system Note: You must define this property as a Java system property (for example by
using -J-Dproperty_name=property_value with a
gfxd utility, or by setting
JAVA_ARGS="-Dproperty_name=property_value").
|
| Prefix | n/a |
| Description | After used memory used passes a critical limit, GemFire XD begins cancelling queries to free memory. This attribute specifies the period in milliseconds after which GemFire XD cancels a query during periods of critical memory usage. With the default value, GemFire XD cancels a query every 100 milliseconds when necessary to free memory. |
| Default Value | 100 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | After a query has run for longer than the specified amount of time in seconds, GemFire XD automatically cancels the query. See Cancelling Long-Running Statements. |
| Default Value | n/a |
| Property Type | system |
| Prefix | n/a |
| Description | All properties that are prefixed with gemfirexd.security. are propagated to the plug-in implementation of UserAuthenticator and CredentialInitializer. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfirexd.security. |
| Description | If
gemfirexd.client.single-hop-max-connections
is set to true, then this system property specifies the maximum number of
single-hop client connections that a server can support. The default value of 5
creates enough connections for 5 single-hop clients to distribute queries to
other GemFire XD members in the cluster. Set this value to the maximum number
of single-hop clients that you want to support at one time.
Note that the actual number of connections that may be created for single-hop clients is determined by the number of members in the GemFire XD distributed system. For example, if the GemFire XD cluster has 10 members, then the default gemfirexd.client.single-hop-max-connections setting of 5 means that a maximum of 50 connections could be created for single-hop access (5 simultaneous single-hop clients connecting to all servers in the cluster). However, the actual connection resources are created only when necessary. See Connect to a GemFire XD Server with the Thin Client JDBC Driver. |
| Default Value | 5 |
| Property Type | system |
| Prefix | n/a |
| Description | Logging for messages of different severity levels. Possible
values for this property are:
|
| Default Value | 0 |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | The temporary directory for overflowing intermediate data. For example, this directory is used during join processing to temporarily store sorted data in multiple files. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Specifies the GemFire XD home directory. Any relative paths in the system are accessed using this property value. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Determines whether this connection is encrypted or not, and whether
certificate-based peer authentication is enabled. Possible values are Off,
Basic, and peerAuthentication. This is the client connection property counterpart to the system property gemfirexd.drda.sslMode. |
| Default Value | Off |
| Property Type | connection |
| Prefix | n/a |
| Description | Used for configuring SSL encryption between GemFire XD members. A space-separated list of the valid SSL ciphers for member connections. A setting of 'any' uses any ciphers that are enabled by default in the configured JSSE provider. |
| Default Value | any |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Used for configuring SSL encryption between GemFire XD members. Boolean indicating whether to use SSL for member connections. A true setting requires the use of locators (mcast-port=0). This attribute must be consistent across the distributed system. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Used for configuring SSL encryption between GemFire XD members. A space-separated list of the valid SSL protocols for member connections. A setting of 'any' uses any protocol that is enabled by default in the configured JSSE provider. |
| Default Value | any |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Used for configuring SSL encryption between GemFire XD members. Boolean indicating whether to require authentication for member connections. |
| Default Value | true |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | If set, automatically starts a locator in the current
process when the member connects to the distributed system and stops the
locator when the member disconnects.
To use, specify the locator with an optional address or host
specification and a required port number, in one of these formats:
start-locator=address[port1] start-locator=port1If you only specify the port, the address assigned to the member is used for the locator. If not already there, this locator is automatically added to the list of locators in this set of GemFire XD properties. If you set start-locator, do not also specify mcast-port. |
| Default Value | not set |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The file to which the running system member writes statistic samples. An empty string disables archiving. Adding .gz suffix to the file name causes it to be compressed. This property is commonly used with archive-disk-space-limit and archive-file-size-limit. |
| Default Value | not set (this disables statistic archiving) |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Boot property that specifies how often to sample statistics,
in milliseconds.
Valid values are in the range 100..60000. |
| Default Value | 1000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Determines whether to collect and archive statistics on the
member.
Turning statistics sampling off saves on resources, but it also takes away potentially valuable information for ongoing system tuning and about unexpected system problems. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Determines whether second-phase commit actions occur in the
background for the current connection, or whether the connection waits for
second-phase commit actions to complete. By default (sync-commits=false)
GemFire XD performs second-phase commits in the background, but ensures that
the connection that issued the transaction only sees completed results. This
means that other threads or connections may see different results until the
second-phase commit actions complete.
Using sync-commits=true ensures that the current thin client or peer client connection waits until all second-phase commit actions complete. |
| Default Value | false |
| Property Type | connection (boot) |
| Prefix | n/a |
| Description | Specifies the base path of the default disk store. This
directory also holds the
datadictionary subdirectory, which stores the
persistent data dictionary.
Other GemFire XD features also use this directory for storing files. For example, gateway queue overflow and overflow tables use this attribute by default. You can override sys-disk-dir for table overflow using options in a table's CREATE TABLE statement. |
| Default Value | The GemFire XD working directory. |
| Property Type | connection (boot) |
| Prefix | gemfirexd. |
| Description | TCP port to listen on for cache communications. If set to
zero, the operating system selects an available port. Each process on a machine
must have its own TCP port. Some operating systems restrict the range of ports
usable by non-privileged users, and using restricted port numbers can cause
runtime errors in GemFire XD startup.
Valid values are in the range 0..65535. |
| Default Value | 0 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The maximum fragment size, in bytes, for transmission over
UDP unicast or multicast sockets. Smaller messages are combined, if possible,
for transmission up to the fragment size setting.
Valid values are in the range 1000..60000. |
| Default Value | 60000 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Size of the socket buffer used for incoming UDP
point-to-point transmissions. If disable-tcp is false, a reduced buffer size of
65535 is used by default.
The default setting of 1048576 is higher than the default OS maximum buffer size on Unix, which should be increased to at least 1MB to provide high-volume messaging on Unix systems. Valid values are in the range 2048.. OS_maximum. |
| Default Value | 1048576 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | Size of the socket buffer used for outgoing UDP
point-to-point transmissions.
Valid values are in the range 2048..OS_maximum. |
| Default Value | 65535 |
| Property Type | connection (boot) |
| Prefix | gemfire. |
| Description | The user name for the member or connection. A valid user
name and password are required when user authentication is turned on.
Use this attribute in conjunction with the password attribute. |
| Default Value | not set |
| Property Type | connection |
| Prefix | n/a |
| Description | Writable directory where this member should persist runtime information. Keep this directory the same between runs for each member so the member application can read what it persisted on the last run. |
| Default Value | member's current working directory |
| Property Type | connection (boot) |
| Prefix | gemfire. |