gfxd Launcher Commands

Use the gfxd command-line utility to launch GemFire XD utilities.

Syntax

Note: Although GemFire XD introduces the gfxd utility to replace the earlier sqlf utility, "sqlf" is still provided and supported as an optional syntax in this release for convenience.

To display a full list of gfxd commands and options:

gfxd --help

The command form to display a particular utility's usage is:

gfxd <utility> --help

With no arguments, gfxd starts an interactive SQL command shell:

gfxd
To specify a system property for an interactive gfxd session, you must define the JAVA_ARGS environment variable before starting gfxd. For example, gfxd uses the gfxd.history system property to define the file that stores a list of the commands that are executed during an interactive session. To change this property, you would define it as part of the JAVA_ARGS variable:
$ export JAVA_ARGS="-Dgfxd.history=/Users/yozie/gfxd-history.sql"
$ gfxd

To launch and exit a gfxd utility (rather than start an interactive gfxd shell) use the syntax:

gfxd <utility> <arguments for specified utility>

In this command form, <utility> is one of the following.

Utility name Description
server

Starts and stops a GemFire XD Server member, and provides status of a running one.

locator

Starts and stops a GemFire XD Locator member, and provides status of a running one.

version

Prints GemFire XD product version information.

stats

Prints statistic values from a statistic archive.

merge-logs

Merges multiple logs files into a single log.

license

Prints information needed to obtain a new license.

encrypt-password

Encrypts a password for use in the gemfirexd.properties file when using BUILTIN authentication, or for use with external data sources using an AsyncEventListener implementation or DBSynchronizer.

validate-disk-store

Confirms whether files of a disk store are valid.

version

Displays GemFire XD product version information.

compact-disk-store

Compacts an offline disk store to remove all unneeded records from the persistent files.

compact-all-disk-stores

Asks all the distributed system members to compact their disk stores.

revoke-missing-disk-store

Asks the distributed system members to stop waiting for the specified disk store.

list-missing-disk-stores

Prints disk stores that are currently missing from the distributed system.

shut-down-all

Asks all data store and accessor system members to shut down.

backup

Asks all the distributed system members to back up their persistent data.

To specify a system property when launching a gfxd utility, use -J-Dproperty_name=property_value argument.

Description

In addition to launching various utilities provided with GemFire XD, when launched without any arguments, gfxd starts an interactive command shell that you can use to connect to a GemFire XD system and execute various commands, including SQL statements.

The launcher honors the current CLASSPATH environment variable and adds it to the CLASSPATH of the utility or command shell being launched. To pass additional arguments to the JVM, set the JAVA_ARGS environment variable when invoking the gfxd script.

Note: The JAVA_ARGS environment variable does not apply to the gfxd server and gfxd locator tools that launch a separate background process. To pass Java properties to those tools, use the -J option as described in the help for those tools.

The launcher uses the java executable that is found in the PATH. To override this behavior, set the GFXD_JAVA environment variable to point to the desired Java executable. (note the supported JRE versions in Supported Configurations and System Requirements).