FoundationDB SQL Parser

Overview

The FoundationDB SQL Parser is a complete, production-quality Java parser for the SQL language. It defines the SQL grammar as implemented by the FoundationDB SQL Layer, but can be used independently. It is derived from the Apache Derby parser.

Building From Source

Maven is used to build, test, and deploy.

Run tests and create jars:

mvn package

The resulting jar files are in the target directory.

Generate the documentation:

mvn javadoc:javadoc

The resulting Javadoc HTML files are in target/site/apidocs.

Using From Maven

The FoundationDB SQL Parser is in the standard Maven Central repository. Any Maven project can use it directly by adding the appropriate entries to the dependencies section of its pom.xml file:

Note

This project was recently renamed from akiban-sql-parser and can be found as such in Maven Central until the next release.

<dependencies>
  <dependency>
    <groupId>com.akiban</groupId>
    <artifactId>akiban-sql-parser</artifactId>
    <version>1.0.16</version>
  </dependency>
</dependencies>

Installing From Binaries

Pre-built jars can be downloaded directly from the release page <https://github.com/foundationdb/sql-parser/releases>. Expand the package into a into a convenient directory using the appropriate utility (e.g. unzip or tar).

Review the LICENSE.txt file located in the root of the installation directory. The Akiban SQL Parser is licensed under the Apache License, Version 2.0. By installing, copying or otherwise using the Software contained in the distribution kit, you agree to be bound by the terms of the license agreement. If you do not agree to these terms, remove and destroy all copies of the software in your possession immediately.

Working with the Akiban SQL Parser

The following example demonstrates the simplest usage:

import com.foundationdb.sql.parser.SQLParser;
import com.foundationdb.sql.parser.StatementNode;

public class ParserHello {
    public static void main(String[] args) throws Exception {
        SQLParser parser = new SQLParser();
        for(String s : args) {
            StatementNode stmt = parser.parseStatement(s);
            stmt.treePrint();
        }
    }
}

A new SQLParser is instantiated and each command line argument is parsed and printed to standard output. The result is a debug dump of all nodes in the underlying Abstract Syntax Tree. More advanced usages will generally parse a statement and then pass a custom Visitor to the accept() method.

To compile and run the example from the command line, copy the code into a file named ParserHello.java and ensure the parser jar file, found in the root directory of the binary package, is in your classpath:

$ export CLASSPATH="fdb-sql-parser-1.0.16.jar:."

Compile:

$ javac ParserHello.java

Run (output trimmed for simplicity):

$ java ParserHello "SELECT a FROM b"
com.foundationdb.sql.parser.CursorNode@5889dee2
statementType: SELECT
resultSet:
    com.foundationdb.sql.parser.SelectNode@4387f4d7
    resultColumns:
        [0]:
        com.foundationdb.sql.parser.ResultColumn@5123968
        name: a
        expression:
            com.foundationdb.sql.parser.ColumnReference@6f76dd71
            columnName: a
    fromList:
        [0]:
        com.foundationdb.sql.parser.FromBaseTable@18317b1d
        tableName: b

More Information

For more information, visit our Q&A site at community.foundationdb.com or hop on the #foundationdb channel on irc.freenode.net