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.

sqlf Launcher Commands

Use the sqlf command-line utility to launch SQLFire utilities.


Syntax

To display a full list of sqlf commands and options:

sqlf --help

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

sqlf <utility> --help

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

sqlf
To specify a system property for an interactive sqlf session, you must define the JAVA_ARGS environment variable before starting sqlf. For example, sqlf uses the sqlf.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="-Dsqlf.history=/Users/yozie/sqlf-history.sql"
$ sqlf

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

sqlf <utility> <arguments for specified utility>

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

Utility name Description
server

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

locator

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

agent

Starts and stops a GemFire JMX Agent, and provides status of a running one.

version

Prints SQLFire product version information.

stats

Prints statistic values from a statistic archive.

merge-logs

Merges multiple logs files into a single log.

license

Prints any current SQLFire licenses and information needed to obtain a new license.

encrypt-password

Encrypts a password for use in the sqlfire.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 SQLFire 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 sqlf utility, use -J-Dproperty_name=property_value argument.

Description

In addition to launching various utilities provided with SQLFire, when launched without any arguments, sqlf starts an interactive command shell that you can use to connect to a SQLFire 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 sqlf script.

Note: The JAVA_ARGS environment variable does not apply to the sqlf server, sqlf locator, and sqlf agent 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 SQLF_JAVA environment variable to point to the desired Java executable. (note the supported JRE versions in Supported Configurations and System Requirements).