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

sqlf Interactive Commands

sqlf implements an interactive command-line tool that is based on the Apache Derby ij tool. Use sqlf to run scripts or interactive queries against a SQLFire cluster.

Start the interactive sqlf command prompt by using the sqlf or sqlf.bat script without supplying any other options:
The system property sqlf.history specifies a file in which to store all of the commands executed during an interactive sqlf session. For example:
$ export JAVA_ARGS="-Dsqlf.history=/Users/yozie/sqlf-history.sql"
$ sqlf

By default the history file is named .sqlfire.history, and it is stored in the current user's home directory.

sqlf accepts several commands to control its use of JDBC. It recognizes a semicolon as the end of a sqlf or SQL command. It treats semicolons within SQL comments, strings, and delimited identifiers as part of those constructs and not as the end of the command. Semicolons are required at the end of a sqlf or SQL statement.

All sqlf commands, identifiers, and keywords are case-insensitive.

Commands can span multiple lines without using any special escape character for ends of lines. This means that if a string spans a line, the new line contents show up in the value in the string.

sqlf treats any command that it does not recognize as a SQL command that is passed to the underlying connection. This means that any syntactic errors in sqlf commands are handed to the SQL engine and generally result in SQL parsing errors.