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.

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:

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

sqlf backup
Creates a backup of disk stores for all members running in the distributed system. Each member with persistent data creates a backup of its own configuration and disk stores.

sqlf encrypt-password
Generates an encrypted password string for use in the sqlfire.properties file when configuring BUILTIN authentication, or when accessing an external data source with an AsyncEventListener implementation or DBsynchronizer configuration.

sqlf install-jar
Installs a JAR file and automatically loads the JAR file classes into the SQLFire class loader. This makes the JAR classes available to all members of the distributed system (including members that join the system at a later time).

sqlf replace-jar
Replaces an installed JAR file with the contents of a new JAR file. The classes in the new JAR file are automatically loaded into the SQLFire class loader and they replace any classes that were previously installed for the same JAR identifier. SQLFire also recompiles objects that depend on the JAR file, such as installed listener implementations.

sqlf run
Connects to a SQLFire distributed system and executes the contents of a SQL command file. All commands in the specified file must be compatible with the interactive sqlf shell.

sqlf server
A SQLFire server is the main server side component in a SQLFire system that provides connectivity to other servers, peers, and clients in the cluster. It can host data. A server is started using the server utility of the sqlf launcher.

sqlf write-data-dtd-to-file
Creates a Document Type Definition (DTD) file that specifies the layout of an XML data file created using sqlf write-data-to-xml.

sqlf write-data-to-db
Inserts data into a database using one or more data XML files (created with sqlf write-data-to-xml), and having the database schema defined in one or more schema XML files (created with sqlf write-schema-to-xml). This command is generally used with a SQLFire cluster to export table data, but it can also be used with other JDBC datasources.

sqlf write-data-to-xml
Writes the data of all of the tables in a database to an XML file. (You can use the sqlf write-data-dtd-to-file command to create a Document Type Definition (DTD) file that describes the layout of data in the XML file.) The resulting XML file can be used to re-load the data into the tables, either in SQLFire or in another database management system. This command is generally used with a SQLFire cluster to export table data, but it can also be used with other JDBC datasources.

sqlf write-schema-to-db
Creates a schema in a database by using the contents of a one or more schema XML files (see sqlf write-schema-to-xml). This command is generally used with a SQLFire cluster to export the schema, but it can also be used with other JDBC datasources.

sqlf write-schema-to-sql
Writes the schema of a database to a file as SQL commands. You can use the resulting file to recreate the schema in SQLFire, or in another database management system. This command is generally used with a SQLFire cluster to export the schema, but it can also be used with other JDBC datasources.

sqlf write-schema-to-xml
Writes the schema of a database to an XML file. You can use the resulting XML file to recreate the schema in SQLFire, or in another database management system. This command is generally used with a SQLFire cluster to export the schema, but it can also be used with other JDBC datasources.