Note: Documentation for Pivotal SQLFire 1.1.x is now available at http://docs.gopivotal.com/sqlfire/index.html. Please reference the docs.gopivotal.com site for the latest and most up-to-date documentation on SQLFire. The vFabric SQLFire documentation site will no longer be updated.

Configuration Properties

You use JDBC connection properties, connection boot properties, and Java system properties to configure SQLFire members and connections.


Property Types

SQLFire configuration properties are divided into the following property types:
  • Connection properties. Connection properties configure the features of a SQLFire member or a SQLFire client connection when you start or connect to a SQLFire member. You can define connection properties directly in the JDBC connection URL (or in the "connect" command in an interactive sqlf session). You can also define connection properties in the sqlfire.properties file or as Java system properties. For example, use -J-Dproperty_name=property_value when you execute a sqlf utility. Or, use the JAVA_ARGS environment variable to define a Java system property for an interactive sqlf session (JAVA_ARGS="-Dproperty_name=property_value").
    Note: You must add a prefix to certain connection property names in order to specify those properties in sqlfire.properties or as Java system properties. See Property Prefixes.
    Connection properties can be further categorized as either boot properties or client properties:
    • Boot properties. A boot connection property configures features of a SQLFire member, and can only be applied with the first connection that starts a SQLFire member. You can specify boot properties when you start a SQLFire member using the FabricServer API or sqlf command, when you make the first connection to an embedded SQLFire member with the JDBC embedded driver, or when you use the connect peer command from an interactive sqlf session to start a peer client. Boot properties have no effect when they are specified on connections to a member after the member has started. Boot properties have no effect when they are specified on a thin client connection.
    • For example, the server-groups property configures a data store's server groups when the data store boots. If you specify server-groups on any subsequent connection to the data store, the server group configuration is not changed.
    • Client properties. A client connection property configures features of the client connection itself, and can be used with the JDBC thin client drive (for example, using a JDBC thin client connection URL or the connect client command from an interactive sqlf session).
  • System properties. Certain SQLFire configuration properties must be specified either in the sqlfire.properties file or as Java system properties (using -J-Dproperty_name=property_value with a sqlf utility, or setting JAVA_ARGS="-Dproperty_name=property_value" for an interactive sqlf session). You cannot define these properties in a JDBC URL connection. Many of these SQLFire system properties affect features of the SQLFire member at boot time.

    The names of SQLFire system properties always include the "sqlfire." 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.

Property Prefixes

You must add a prefix to certain connection and boot property names when you define those properties in the sqlfire.properties file or as Java system properties. The Prefix row in each property table lists a prefix value when one is required. Where indicated, the "sqlfire." prefix is required when defining the property either in sqlfire.properties or as a Java system property. The "gemfire." prefix is required only when defining a Java system property.

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 sqlfire.properties, as a Java system property, or as a property definition for FabricServer.

Using Non-ASCII Strings in SQLFire Property Files

You can specify Unicode (non-ASCII) characters in vFabric SQLFire property files by using a \uXXXX escape sequence. For a supplementary character, you need two escape sequences, one for each of the two UTF-16 code units. The XXXX denotes the 4 hexadecimal digits for the value of the UTF-16 code unit. For example, a properties file might have the following entries:
s1=hello there
s2=\u3053\u3093\u306b\u3061\u306f
For example, in sqlfire.properties, you might write:
log-file=my\u00df.log
to 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.

For more information on internationalization in Java, see http://www.oracle.com/us/technologies/java/faq-jsp-138165.html.

List of Property Names

The following table lists all of the vFabric SQLFire configuration properties names and provides links to each property reference page.

Connection Properties System Properties
Boot Properties Client Properties

ack-severe-alert-threshold

ack-wait-threshold

archive-disk-space-limit

archive-file-size-limit

async-distribution-timeout

async-max-queue-size

async-queue-timeout

auth-provider

bind-address

config-scripts

conserve-sockets

departure-correlation-window

disable-tcp

distributed-system-id

enable-network-partition-detection

enable-time-statistics

enforce-unique-host

host-data

init-scripts

jmx-manager

jmx-manager-access-file

jmx-manager-bind-address

jmx-manager-hostname-for-clients

jmx-manager-http-port

jmx-manager-password-file

jmx-manager-port

jmx-manager-ssl

jmx-manager-start

jmx-manager-update-rate

keepalive-count

keepalive-idle

keepalive-interval

license-serial-number

license-server-timeout

license-working-dir

locators

log-disk-space-limit

log-file

log-file-size-limit

log-level

max-num-reconnect-tries

max-wait-time-reconnect

mcast-address

mcast-flow-control

mcast-port

mcast-recv-buffer-size

mcast-send-buffer-size

mcast-ttl

member-timeout

membership-port-range

password

persist-dd

redundancy-zone

security-log-file

security-log-level

security-peer-verifymember-timeout

server-auth-provider

server-bind-address

server-groups

shutdown

socket-buffer-size

socket-lease-time

sqlfire.language.permissionsCacheSize

sqlfire.language.spsCacheSize

sqlfire.language.statementCacheSize

sqlfire.language.tableDescriptorCacheSize

sqlfire.max-lock-wait

sqlfire.properties

sqlfire.query-cancellation-interval

sqlfire.security. Properties (prefix)

sqlfire.stream.error.logSeverityLevel

sqlfire.storage.tempDirectory

sqlfire.system.home

ssl-ciphers

ssl-enabled

ssl-protocols

ssl-require-authentication

start-locator

statistic-archive-file

statistic-sample-rate

statistic-sampling-enabled

sync-commits

sys-disk-dir

tcp-port

udp-fragment-size

udp-recv-buffer-size

udp-send-buffer-size

user

writable-working-dir

auth-provider

default-recovery-delay

disable-streaming

drdaID

enable-stats

enable-timestats

enable-tx-wait-mode

load-balance

log-file

password

read-timeout

secondary-locators

single-hop-enabled

skip-listeners

ssl

sync-commits

user

gemfire.DISKSPACE_WARNING_INTERVAL

gemfire.WRITE_LOCK_TIMEOUT

gemfire.READ_LOCK_TIMEOUT

gemfire.LOCK_MAX_TIMEOUT

gemfire.preAllocateIF

gemfire.preAllocateIF

gemfire.tx-disable-batching

sqlfire.datadictionary.allow-startup-errors

sqlfire.drda.host

sqlfire.drda.keepAlive

sqlfire.drda.logConnections

sqlfire.drda.maxThreads

sqlfire.drda.minThreads

sqlfire.drda.portNumber

sqlfire.drda.securityMechanism

sqlfire.drda.sslMode

sqlfire.drda.streamOutBufferSize

sqlfire.drda.timeSlice

sqlfire.drda.trace

sqlfire.drda.traceAll

sqlfire.drda.traceDirectory

sqlfire.auth-ldap-search-base

sqlfire.auth-ldap-search-dn

sqlfire.auth-ldap-search-filter

sqlfire.auth-ldap-search-pw

sqlfire.auth-ldap-server

sqlfire.authz-default-connection-mode

sqlfire.authz-full-access-users

sqlfire.authz-read-only-access-users

sqlfire.history

sqlfire.client.single-hop-max-connections

sqlfire.sql-authorization

Configuration Property Reference

ack-severe-alert-threshold

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.

ack-wait-threshold

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.

archive-disk-space-limit

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.

archive-file-size-limit

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.

async-distribution-timeout

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.

async-max-queue-size

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.

async-queue-timeout

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.

auth-provider

Description Specifies the authentication scheme to use for network clients. The available SQLFire 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 sqlfire.

bind-address

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 SQLFire 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.

config-scripts

Description Specifies one or more SQL script files to execute immediately, before 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 sqlfire.

conserve-sockets

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 SQLFire system. To avoid hangs related to WAN messaging, always set conserve-sockets=false for SQLFire members that participate in a WAN deployment. See Prerequisites for WAN Replication.
Default Value true
Property Type connection (boot)
Prefix gemfire.

default-recovery-delay

Description Specifies a default RECOVERYDELAY value for all tables in the cluster. If a SQLFire member leaves the cluster and no new members join, the remaining SQLFire 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: SQLFire always initiates recovery for redundant, partitioned tables when a new SQLFire member joins the cluster.

A value of -1, the default value, indicates that no recovery is performed unless a new SQLFire member joins the cluster, or unless individual tables override the recovery delay by specifying the RECOVERYDELAY clause in their CREATE TABLE statements.

Default Value -1
Property Type connection
Prefix sqlfire.

departure-correlation-window

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.

disable-streaming

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 SQLFire member happens to go down while iterating over a ResultSet.

When this property is not enabled, a SQLException with state SQLF_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, SQLFire 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 sqlfire.

disable-tcp

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.

distributed-system-id

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 SQLFire 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.

drdaID

Description Sets the connection identity.
Default Value Connection number
Property Type connection
Prefix n/a

enable-network-partition-detection

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.

enable-stats

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 System and Application Performance.

Default Value false
Property Type connection
Prefix sqlfire.

enable-time-statistics

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.

enable-timestats

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 System and Application Performance.

Default Value false
Property Type connection
Prefix sqlfire.

enable-tx-wait-mode

Description Uses lock waiting mode instead of the default "fail-fast" conflict mode for transactions. In lock waiting mode, a committed transaction is serialized and waits for other ongoing transactions instead of conflicting with those transactions.
Default Value false
Property Type connection
Prefix sqlfire.

enforce-unique-host

Description Boolean that determines whether SQLFire puts redundant copies of the same data in different members running on the same physical machine. By default, SQLFire 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.

gemfire.DISKSPACE_WARNING_INTERVAL

Description Configures the frequency (in milliseconds) with which SQLFire logs warning messages for low disk space conditions. SQLFire logs a low disk space warning in the following situations:
  • For a log file directory it logs a warning if the available space is less than 100 MB.
  • For a disk store directory it logs a warning if the usable space is less than 1.15 times the space required to create a new oplog file.
  • For the data dictionary directory it logs a warning if the remaining space is less than 50 MB.
Default Value 10000
Property Type system
Prefix n/a

gemfire.WRITE_LOCK_TIMEOUT

Description The time to wait before throwing a conflict exception (X0Z02) for a write-write conflict that is detected between two transactions. If the first transaction that acquired the lock on the conflicting row completes in this period of time (for example, it commits or aborts) then no conflict occurs. However, keep in mind that SQLFire does not have any built-in mechanism for detecting distributed deadlocks, so setting this property too high can cause two interlocked transactions to both block for that period of time. Keep this timeout value small, because increasing the value can have a negative impact on the overall throughput of a system that has transactions that perform lots of DML. The default value is 0, which means that the system throws a conflict immediately when it is detected.

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 0
Property Type system
Prefix n/a

gemfire.READ_LOCK_TIMEOUT

Description The time to wait before throwing a conflict exception (X0Z02) for a write-read conflict that is detected between two REPEATABLE_READ transactions. If the read lock acquired by the transaction that has read the conflicting row completes in this period of time (for example, it commits or aborts) then no conflict occurs for the transaction that is writing the row. However, keep in mind that SQLFire does not have any built-in mechanism for detecting distributed deadlocks, so setting this property too high can cause two interlocked transactions to both block for that period of time. Keep this value small. The default value is 0, which means that the system throws a conflict for the writer immediately on detection during commit.

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 0
Property Type system
Prefix n/a

gemfire.LOCK_MAX_TIMEOUT

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

gemfire.preAllocateDisk

Description

Boolean that determines whether SQLFire 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

gemfire.preAllocateIF

Description

Boolean that determines whether SQLFire 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

gemfire.tx-disable-batching

Description Boolean that determines whether SQLFire detects conflicts in thin client transactions lazily or at operation time. With the default value of "false," SQLFire 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

host-data

Description Specifies whether this SQLFire member will host table data.

Setting this value to false boots a SQLFire accessor member with the full SQLFire 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 SQLFire data store. Data stores host data, and they persist the data dictionary by default. All data stores in the same SQLFire 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 SQLFire data stores are added to the default server group.

Default Value true
Property Type connection (boot)
Prefix sqlfire.

init-scripts

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 sqlfire.

jmx-manager

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

jmx-manager-access-file

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

jmx-manager-bind-address

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

jmx-manager-hostname-for-clients

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

jmx-manager-http-port

Description Not used. If you require HTTP access for JMX management, use a standalone JMX Agent instead of a manager node. See Using a vFabric SQLFire JMX Agent.
Default Value 8080 (not used)
Property Type connection (boot)
Prefix n/a

jmx-manager-password-file

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

jmx-manager-port

Description The port on which this JMX Manager listens for client connections. If this property is set to zero, SQLFire 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

jmx-manager-ssl

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 SQLFire connections. Ignored if jmx-manager is false.
Default Value false
Property Type connection (boot)
Prefix n/a

jmx-manager-start

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

jmx-manager-update-rate

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

keepalive-count

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 SQLFire client socket (to determine when a server is offline) or a SQLFire network server socket (to determine when clients go offline). To use this property with a SQLFire thin client, include the jna.jar library in your CLASSPATH.
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 sqlfire.

keepalive-idle

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 SQLFire client socket (to determine when a server is offline) or a SQLFire network server socket (to determine when clients go offline). To use this property with a SQLFire thin client, include the jna.jar library in your CLASSPATH.
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 sqlfire.

keepalive-interval

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 SQLFire client socket (to determine when a server is offline) or a SQLFire network server socket (to determine when clients go offline). To use this property with a SQLFire thin client, include the jna.jar library in your CLASSPATH.
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 sqlfire.

license-serial-number

Description Specifies the serial number(s) this distributed system member will use. The distributed member will attempt to activate the license if it acts as a data store.

If you have a serial number for the or Global WAN Upgrade, then list it after the vFabric SQLFire Enterprise serial number, separating each with a comma.

Use the keyword "dynamic" to specify that the member will attempt to acquire a license from either a vFabric serial number file or a vFabric License Server.

Note: You can only use a vFabric License Server you are running SQLFire on a vSphere virtual machine as part of vFabric Suite. The vFabric License Server cannot provide a standalone vFabric SQLFire license, such as a vFabric SQLFire Enterprise license.

See Activating vFabric SQLFire Licensing.

Default Value not set
Property Type connection (boot)
Prefix sqlfire.

license-server-timeout

Description Specifies the maximum number of milliseconds to wait for a license from a vFabric License Server when attempting to dynamically acquire a license. This timeout is observed when using the keyword "dynamic" for the license-serial-number property.

Valid values are in the range of 1000...3600000.

See Activating vFabric SQLFire Licensing.

Default Value 10000
Property Type connection (boot)
Prefix gemfire.

license-working-dir

Description The writable directory where this member persists runtime information about licensing. Keep this directory the same between runs for each member so the member can read what it persisted on the last run.

See Activating vFabric SQLFire Licensing.

Default Value The member's current working directory as determined by System.getProperty("user.dir")
Property Type connection (boot)
Prefix gemfire.

load-balance

Description Specifies whether load balancing is performed for the JDBC client connection. If "false," then no load-balancing is attempted for the connection.
Default Value true
Property Type connection
Prefix n/a

locators

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.

log-disk-space-limit

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.

log-file

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:
  • application: standard out
  • locator: locator.log
  • server: sqlfserver.log
Use the sqlfire. prefix for SQLFire members, or use the sqlfire.client prefix for client-side logging.
Default Value not set
Property Type connection
Prefix sqlfire. or sqlfire.client.

log-file-size-limit

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

log-level

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.

max-num-reconnect-tries

Description The maximum reconnection attempts to the distributed system when membership roles are missing. Used when membership attributes specify to disconnect from the distributed system and reconnect in an attempt to regain lost membership roles.
Default Value 3
Property Type connection (boot)
Prefix gemfire.

max-wait-time-reconnect

Description The maximum milliseconds to wait for the distributed system to reconnect on each reconnect attempt. Used when membership attributes specify to disconnect from the distributed system and reconnect in an attempt to regain lost membership roles.
Default Value 10000
Property Type connection (boot)
Prefix gemfire.

mcast-address

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 SQLFire.

Default Value 239.192.81.1
Property Type connection (boot)
Prefix gemfire.

mcast-flow-control

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.

mcast-port

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.

mcast-recv-buffer-size

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.

mcast-send-buffer-size

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.

mcast-ttl

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.

member-timeout

Description Interval, in milliseconds, between two attempts to determine whether another system member is alive. When another member appears to be gone, SQLFire tries to contact it twice before quitting.

Valid values are in the range 1000..600000.

Default Value 5000
Property Type connection (boot)
Prefix gemfire.

membership-port-range

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.

SQLFire 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 SQLFire 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.

password

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

persist-dd

Description Enables or disables disk persistence for the data dictionary. By default, all data stores (SQLFire members booted with host-data=true) set this value to "true" to enable persistence. All SQLFire 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 SQLFire 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 SQLFire 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 Availability and Performance provides more information about starting and shutting down SQLFire clusters that utilize disk stores for persistence.

Default Value true
Property Type connection (boot)
Prefix sqlfire.

read-timeout

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 SQLFire can attempt to reconnect.
Default Value not set
Property Type connection
Prefix n/a

redundancy-zone

Description Defines this member's redundancy zone. Used to separate members into different groups for satisfying partitioned table redundancy. If this property is set, SQLFire 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.

secondary-locators

Description Provides the address and port number of a secondary SQLFire locator member to use for connecting to the distributed system. The secondary locator address is used to establish an initial connection to SQLFire if the primary locator is not available.
Default Value not set
Property Type connection
Prefix n/a

security-log-file

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.

security-log-level

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.

security-peer-verifymember-timeout

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.

server-auth-provider

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 sqlfire.

server-bind-address

Description
Note: This setting is only relevant for servers on multi-homed hosts (machines with multiple network cards).

Network adapter card a SQLFire 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 communica­tion. 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.

server-groups

Description One or more server groups in which the SQLFire member participates. Use a comma-separated list of server group names to supply multiple values.

Server groups are used with SQLFire 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 SQLFire member is added only to the default server group. The default server group includes all of the SQLFire members that participate in the distributed system.

SQLFire 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 sqlfire.

shutdown

Description Stops SQLFire in the current process. A successful shutdown always results in a SQLException indicating that StopsSQLFire 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

single-hop-enabled

Description Determines whether a JDBC thin-client driver connection provides single-hop access to data for queries that are distributed to multiple SQLFire members. By default, the thin-client driver provides one-hop or two-hop access to data. See Connect to a SQLFire Server with the Thin Client JDBC Driver. See also sqlfire.client.single-hop-max-connections.
Default Value false
Property Type connection
Prefix n/a

skip-listeners

Description If true, SQLFire 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. SQLFire always propagates DML operations to an enabled WAN site.
Default Value false
Property Type connection
Prefix n/a

socket-buffer-size

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.

socket-lease-time

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.

sqlfire.auth-ldap-search-base

Description Use this property to limit the search space used when SQLFire 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=vmware,dc=com

By default, SQLFire tries to bind the anonymous user for searching when you configure sqlfire.auth-ldap-search-base. If your LDAP server does not support anonymous binding, also configure sqlfire.auth-ldap-search-dn and sqlfire.auth-ldap-search-pw.

Default Value not set
Property Type system
Prefix n/a

sqlfire.auth-ldap-search-dn

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=vmware.com
Default Value Null
Property Type system
Prefix n/a

sqlfire.auth-ldap-search-filter

Description Specifies a user's objectClass, used to narrow the LDAP search. For example:
objectClass=person

See Guest Access to Search for DNs.

Default Value (&(objectClass=inetOrgPerson)(uid=%USERNAME%))
Property Type system
Prefix n/a

sqlfire.auth-ldap-search-pw

Description The password for the guest user DN, used for looking up the DN (see sqlfire.auth-ldap-search-dn). For example:
guestPassword
Default Value Null
Property Type system
Prefix n/a

sqlfire.auth-ldap-server

Description The URI of the LDAP server (beginning with either ldap:// or ldaps://).
Default Value not set
Property Type system
Prefix n/a

sqlfire.authz-default-connection-mode

Description If authorization is enabled, then this property sets the access mode for all users that are not listed in the sqlfire.authz-full-access-users or sqlfire.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 sqlfire.authz-full-access-users or sqlfire.authz-read-only-access-users has no access to SQLFire tables. You cannot use GRANT to give such a user additional privileges.

Default Value If you do not configure this property, then all users have full access (read/write privileges) unless the user is listed in sqlfire.authz-read-only-access-users or have been given specific permissions with GRANT and REVOKE.
Property Type system
Prefix n/a

sqlfire.authz-full-access-users

Description Defines the list of user names that have full access to SQL objects. Users that are listed in sqlfire.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
Prefix n/a

sqlfire.authz-read-only-access-users

Description Defines the list of user names that have read-only access to SQL objects. This property is generally used when sqlfire.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 sqlfire.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
Prefix n/a

sqlfire.sql-authorization

Description Enables or disables authorization in SQLFire. 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 SQLFire member, SQL authorization is enabled by default.
Default Value false
Property Type system
Prefix n/a

sqlfire.datadictionary.allow-startup-errors

Description Enables a SQLFire 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 SQLFire cannot initialize a DBSynchronizer configuration due to the external RDBMS being unavailable. Use sqlfire.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
Prefix n/a

sqlfire.drda.host

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
Prefix n/a

sqlfire.drda.keepAlive

Description If true, SQLFire attempts to clean up disconnected clients. The idle time is two hours by default.
Default Value true
Property Type system
Prefix n/a

sqlfire.drda.logConnections

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
Prefix n/a

sqlfire.drda.maxThreads

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 sqlfire.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
Prefix n/a

sqlfire.drda.minThreads

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
Prefix n/a

sqlfire.drda.portNumber

Description Port number to use.
Default Value 1527
Property Type system
Prefix n/a

sqlfire.drda.securityMechanism

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:
  • USER_ONLY_SECURITY
  • CLEAR_TEXT_PASSWORD_SECURITY
  • ENCRYPTED_USER_AND_PASSWORD_SECURITY
  • STRONG_PASSWORD_SUBSTITUTE_SECURITY
Default Value None
Property Type system
Prefix n/a

sqlfire.drda.sslMode

Description Determines whether the client connection is encrypted or not, and whether certificate-based peer authentication is enabled. Possible values are Off, Basic, and peerAuthentication
Default Value Off
Property Type system
Prefix n/a

sqlfire.drda.streamOutBufferSize

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
Prefix n/a

sqlfire.drda.timeSlice

Description Number of milliseconds that each connection uses before yielding to another connection. This property is effective only if sqlfire.drda.maxThreads is set greater than zero.

The server must be restarted for changes to take effect.

Default Value 0
Property Type system
Prefix n/a

sqlfire.drda.trace

Description Enables tracing for the client session. This setting can be enabled dynamically using NetworkInterface as well.
Default Value false
Property Type system
Prefix n/a

sqlfire.drda.traceAll

Description Enables tracing for all client sessions. This setting can be enabled dynamically using NetworkInterface as well.
Default Value false
Property Type system
Prefix n/a

sqlfire.drda.traceDirectory

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 sqlfire.system.home property (if set). Otherwise, uses the current directory.
Property Type system
Prefix n/a

sqlfire.history

Description The path and filename in which the sqlf utility stores a list of the commands executed during an interactive sqlf session. Specify this system property in the JAVA_ARGS environment variable before you execute sqlf (for example, JAVA_ARGS="-Dsqlf.history=path-to-file"). Specify an empty string value to disable recording a history of commands. See sqlf Interactive Commands.
Default Value

%UserProfile%\.sqlf.history (Windows)

$HOME/.sqlf.history (Linux)

Property Type system
Prefix n/a

sqlfire.language.permissionsCacheSize

Description The size of the permissions that SQLFire 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

sqlfire.language.spsCacheSize

Description The size of the stored prepared statement descriptor cache that SQLFire uses for looking up definitions. Specify the number of entries to cache.
Default Value 32
Property Type connection (boot)
Prefix n/a

sqlfire.language.statementCacheSize

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

sqlfire.language.tableDescriptorCacheSize

Description The size of table descriptors that SQLFire 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

sqlfire.max-lock-wait

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

sqlfire.properties

Description Overrides the default lookup for application file properties in the file named 'sqlfire.properties.'
Default Value sqlfire.properties
Property Type system
Prefix n/a

sqlfire.query-cancellation-interval

Description After used memory used passes a critical limit, SQLFire begins cancelling queries to free memory. This attribute specifies the period in milliseconds after which SQLFire cancels a query during periods of critical memory usage. With the default value, SQLFire cancels a query every 100 milliseconds when necessary to free memory.
Default Value 100
Property Type connection (boot)
Prefix n/a

sqlfire.security. Properties (prefix)

Description All properties that are prefixed with sqlfire.security. are propagated to the plug-in implementation of UserAuthenticator and CredentialInitializer.
Default Value not set
Property Type connection (boot)
Prefix sqlfire.security.

sqlfire.client.single-hop-max-connections

Description If sqlfire.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 SQLFire 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 SQLFire distributed system. For example, if the SQLFire cluster has 10 members, then the default sqlfire.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 SQLFire Server with the Thin Client JDBC Driver.

Default Value 5
Property Type system
Prefix n/a

sqlfire.stream.error.logSeverityLevel

Description Logging for messages of different severity levels. Possible values for this property are:
  • 0—NO_APPLICABLE_SEVERITY occurs only when the system was unable to determine the severity.
  • 10000—WARNING_SEVERITY includes SQLWarnings.

  • 20000—STATEMENT_SEVERITY includes errors that cause only the current statement to be aborted.

  • 30000—TRANSACTION_SEVERITY includes errors that cause the current transaction to be aborted.

  • 40000—SESSION_SEVERITY includes errors that cause the current connection to be closed.

  • 45000—DATABASE_SEVERITY includes errors that cause the current database to be closed.

  • 50000—SYSTEM_SEVERITY includes internal errors that cause the system to shut down.

Default Value 0
Property Type connection (boot)
Prefix n/a

sqlfire.storage.tempDirectory

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

sqlfire.system.home

Description Specifies the SQLFire 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

ssl

Description Boolean indicating whether to use SSL for this connection.
Default Value false
Property Type connection
Prefix n/a

ssl-ciphers

Description Used for SSL security. A space-separated list of the valid SSL ciphers for this connection. 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.

ssl-enabled

Description Used for SSL security. Boolean indicating whether to use SSL for member communications. A true setting requires the use of locators. This attribute must be consistent across the distributed system.
Default Value false
Property Type connection (boot)
Prefix gemfire.

ssl-protocols

Description Used for SSL security. A space-separated list of the valid SSL protocols for this connection. 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.

ssl-require-authentication

Description Used for SSL security. Boolean indicating whether to require authentication for member communication.
Default Value true
Property Type connection (boot)
Prefix gemfire.

start-locator

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=port1
If 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 SQLFire properties.

If you set start-locator, do not also specify mcast-port.

Default Value not set
Property Type connection (boot)
Prefix gemfire.

statistic-archive-file

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.
Default Value not set
Property Type connection (boot)
Prefix gemfire.

statistic-sample-rate

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.

statistic-sampling-enabled

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.

sync-commits

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) SQLFire 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

sys-disk-dir

Description Specifies the base path of the default disk store. This directory also holds the datadictionary subdirectory, which stores the persistent data dictionary.

Other SQLFire 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 SQLFire working directory.
Property Type connection (boot)
Prefix sqlfire.

tcp-port

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 SQLFire startup.

Valid values are in the range 0..65535.

Default Value 0
Property Type connection (boot)
Prefix gemfire.

udp-fragment-size

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.

udp-recv-buffer-size

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.

udp-send-buffer-size

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.

user

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

writable-working-dir

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.