changwei0708/jsqlparser

JSqlParser parses an SQL statement and translate it into a hierarchy of Java classes. The generated hierarchy can be navigated using the Visitor Pattern

JSqlParser

Look here for more information and examples: https://github.com/JSQLParser/JSqlParser/wiki.

License

JSqlParser is dual licensed under LGPL V2.1 or Apache Software License, Version 2.0.

Discussion

Please provide feedback on:

• API changes: extend visitor with return values (JSQLParser#901)

News

• Released version 3.1 of JSqlParser
• Released version 3.0 of JSqlParser
• The array parsing is the default behaviour. Square bracket quotation has to be enabled using a parser flag (CCJSqlParser.withSquareBracketQuotation).
• due to an API change the version will be 3.0
• JSqlParser uses now Java 8 at the minimum
• Released version 2.1 of JSqlParser
• Released version 2.0 of JSqlParser
• breaking API change: to support chained functions attribute type was changed to Expression
• Released version 1.4 of JSqlParser
• Released version 1.3 of JSqlParser
• Changed behaviour of dotted multipart names for user variables, tables and columns to accept e.g. ORM class names. To achieve this some behaviour of name parsing had to be changed. Before this the parser would fail missing databasenames for SqlServer queries (server..schema.table). But this is allowed for the schema (server.database..table). Now the parser accepts missing inner names per se to avoid some very complicated parsing rules.
• Released version 1.2 of JSqlParser
• breaking API change: merge of within group and over (window expressions)
• Released version 1.1 of JSqlParser.
• JSqlParser has now a build in checkstyle configuration to introduce source code conventions.
• Released first major version 1.0 of JSqlParser.

More news can be found here: https://github.com/JSQLParser/JSqlParser/wiki/News.

Alternatives to JSqlParser?

General SQL Parser looks pretty good, with extended SQL syntax (like PL/SQL and T-SQL) and java + .NET APIs. The tool is commercial (license available online), with a free download option.

JSqlParser

JSqlParser is a SQL statement parser. It translates SQLs in a traversable hierarchy of Java classes. JSqlParser is not limited to one database but provides support for a lot of specials of Oracle, SqlServer, MySQL, PostgreSQL ... To name some, it has support for Oracles join syntax using (+), PostgreSQLs cast syntax using ::, relational operators like != and so on.

Support

If you need help using JSqlParser feel free to file an issue or contact me.

Contributions

To help JSqlParser's development you are encouraged to provide

• feedback
• bugreports
• pull requests for new features
• improvement requests
• fund new features or sponsor JSqlParser (Sponsor)

Please write in English, since it's the language most of the dev team knows.

Also I would like to know about needed examples or documentation stuff.

Extensions in the latest SNAPSHOT version 3.2

• allow VALIDATE as column name
• first support for CREATE SCHEMA and DROP SCHEMA
• allow ON as a value in a set statement (SET myvalue = ON)
• support for ALTER TABLE ONLY mytable ...
• allow foreign key definition in alter statements without referenced columns specification
• allow datatype binary for column definitions
• support for ALTER TABLE COLUMN DROP NOT NULL
• allow order as column name
• support for table function in IN expression
• allow complex expressions within all of a case when statement
• support for parameters in create index statement
• support for integer parameters for ->> and -> JSON expressions
• support for more keywords in following parts of multipart object names (e.g. mytab.select, mytab.create, ...)
• support for OUTER APPLY
• support for WITH(NOLOCK)
• support for VIEW as object name
• functions hold now multipart names
• support for DISABLE as object name
• API change in ColumnDefinition.setColumnSpecStrings to ColumnDefinition.setColumnSpecs to better allow the merge between AlterExpression.ColumnDataType and ColumnDefinition

Extensions of JSqlParser releases

• Release Notes
• Modifications before GitHub's release tagging are listed in the Older Releases page.

Building from the sources

As the project is a Maven project, building is rather simple by running:

mvn package

The project requires the following to build:

• Maven
• JDK 8 or later. The jar will target JDK 8, but the version of the maven-compiler-plugin that JsqlParser uses requires JDK 8+

This will produce the jsqlparser-VERSION.jar file in the target/ directory.

To build this project without using Maven, one has to build the parser by JavaCC using the CLI options it provides.

Debugging through problems

Refer to the Visualize Parsing section to learn how to run the parser in debug mode.

Source Code conventions

Recently a checkstyle process was integrated into the build process. JSqlParser follows the sun java format convention. There are no TABs allowed. Use spaces.

public void setUsingSelect(SubSelect usingSelect) {
    this.usingSelect = usingSelect;
    if (this.usingSelect != null) {
        this.usingSelect.setUseBrackets(false);
    }
}

This is a valid piece of source code:

• blocks without braces are not allowed
• after control statements (if, while, for) a whitespace is expected
• the opening brace should be in the same line as the control statement

Maven Repository

JSQLParser is deployed at sonatypes open source maven repository. Starting from now I will deploy there. The first snapshot version there will be 0.8.5-SNAPSHOT. To use it this is the repository configuration:

<repositories>
     <repository>
         <id>jsqlparser-snapshots</id>
         <snapshots>
             <enabled>true</enabled>
         </snapshots>
         <url>https://oss.sonatype.org/content/groups/public/</url>
     </repository>
</repositories>

This repositories releases will be synched to maven central. Snapshots remain at sonatype.

And this is the dependency declaration in your pom:

<dependency>
	<groupId>com.github.jsqlparser</groupId>
	<artifactId>jsqlparser</artifactId>
	<version>3.1</version>
</dependency>