JSqlParserでSQLをJavaの構文木として扱う

JSqlParserの機能概要

JSqlParserはSQLテキストを受け取り、ステートメントの各部分を表すJavaオブジェクトのツリーを生成します。READMEでは「select 1 from dual where a=b」をPlainSelectオブジェクトに解析し、選択項目、FROMテーブル、WHERE句を型付きオブジェクトとしてアクセスする例を示しています。ツリーはVisitorパターンで走査できます。同じオブジェクトモデルは逆方向でも機能し、JavaからフルエントAPIを使用してステートメントを構築し、SQLテキストとしてレンダリングできます。

JSqlParserのインストール

READMEは、現在の開発ラインから継続的にリリースされている安定したManticoreビルドを使用するようユーザーに指示しています。Maven座標はcom.manticore-projects.jsqlformatter:jsqlparserで、バージョン範囲は5.3.218から始まります。Maven Centralの古いcom.github.jsqlparserリリースはかなり古いと説明されています。スナップショット座標とリポジトリ設定はビルド依存関係ページを参照していますが、READMEには含まれていません。

JSqlParserのパフォーマンスとベンチマーク

READMEは、現在のラインがバージョン5.3より11倍高速であると報告し、最新バージョンの7.6ミリ秒/操作、5.3の84.7ミリ秒/操作を示すベンチマーク表を示しています。また、テストされたパーサーの中で実世界のSQLに対して最速であると主張し、SQLGlotやpolyglot-sqlとのクロスパーサー比較を行っています。ベンチマーク方法と完全な結果は別のリポジトリjsqlparser-benchにあります。これらの数値はプロジェクト自身の主張であり、独立して検証されたものではありません。

JSqlParserのサポートされるSQLと方言

JSqlParserは、単一の文法でSQL標準と主要なRDBMSすべてをカバーすることを目指しています。READMEにはBigQuery、Snowflake、DuckDB、Redshift、Oracle、MS SQL Server、Sybase、PostgreSQL、MySQL、MariaDB、DB2、H2、HSQLDB、Derby、SQLiteがリストされています。サポートされるステートメントには、WITHおよびPiped SQLを伴うSELECT、INSERT、UPDATE、UPSERT、MERGE、DELETE、TRUNCATE TABLEなどのDML、CREATE、ALTER、DROPなどのDDLが含まれます。また、PostgreSQL RLS、Salesforce SOQL、ネストされたサブセレクト、バインドパラメータ、ウィンドウ関数、Oracleヒント、T-SQLブラケットの曖昧さもカバーしています。完全なリファレンスは構文ページにあります。

JSqlParserのPiped SQLサポート

Piped SQLのサポートは進行中です。Piped SQLは、従来の順序ではなく実行順にクエリを記述します。READMEでは、FROM、WHERE、AGGREGATE、ORDER BYをパイプフローで使用する例を示しています。Starlake.aiがPiped SQLサポートとBigQuery、Redshift、Databricks、DuckDB向けの多くのテストケースを提供したと謝辞を述べています。背景資料としてGoogle研究論文とベンダー文書へのリンクが提供されています。

JSqlParserのJavaバージョンとビルド要件

READMEには表が含まれています：JSqlParser 4.9はJDK 8互換の最後のリリースです。5.0以降はランタイムにJDK 11が必要で、AST Visitorに破壊的な変更が導入されます。5.1以降はビルドにJDK 17ツールチェーンが必要です。5.4以降はJavaCC 8を使用してパーサーを生成します。リポジトリメタデータは、デフォルトのmasterブランチに5,953スター、1,418フォーク、84のオープンイシューを示しています。

JSqlParserの関連プロジェクトとライセンス

READMEには2つの姉妹プロジェクトがリストされています：SQLテキストのプリティプリントとフォーマットのためのJSQLFormatter、方言固有の書き換え、列解決、リネージのためのJSQLTranspiler（Starlake.aiが開発）。JOOQは手書きパーサーとクロス方言翻訳を備えたデュアルライセンスの代替として言及されています。READMEはJSqlParserがLGPL 2.1またはApache 2.0のデュアルライセンスであると述べていますが、リポジトリメタデータはApache-2.0とリストしています。提供されたライセンス抜粋にはLICENSEファイルが含まれておらず、正確なライセンステキストはソース資料から入手できません。

JSqlParserを組み込むときの成果物は、SQL文字列そのものではなく、解析結果として得られるJavaクラス階層である。アプリケーションはその階層をVisitor Patternで巡回できるため、テーブル名や条件句の検査、書き換え、方言に応じた分岐を実装しやすい。一方で、解析できることと実行先データベースが受け付けることは別であり、READMEの対応表を実際のSQL方言へそのまま広げてはいけない。導入後はSELECT、INSERT、JOIN、CTE、DDL、コメント、バインド変数を含む代表文を用意し、解析木の期待値をテストする。Piped SQLを使う場合は入力の区切りとエラー位置を別に確認し、ベンチマークを測る場合は文の長さ、反復数、JVM、ライブラリ版を固定する。

Visitorを実装する際は、必要なノードだけを処理したつもりでも、SQLの別名、括弧、サブクエリ、集合演算によって別の階層が現れる点を確認する。解析木を文字列へ戻す処理を使う場合も、元の空白やコメントが完全に保存されるとは決めつけない。Maven Centralなどの配布座標とリポジトリのビルド手順を対象版で照合し、アプリケーションのJava版と衝突しないことを確かめる。READMEのベンチマークは相対比較の材料として読み、実SQLのレイテンシやメモリ上限を推定する根拠にはしない。

編集部の結論

JSqlParserは、JavaアプリケーションでSQLを解析し、文の構造をVisitor Patternで検査・変換したい開発者に向く。READMEのベンチマーク数値や対応方言は、利用するSQLの構文とバージョンを代表するとは限らない。まず対象バージョンを固定し、MavenまたはGradleで導入して、実際のSQL、方言指定、Piped SQL、Visitor処理、構文エラー、Javaの最低要件をテストする。

公式情報源

1. Official documentation
2. Official README
3. Project repository
4. Release notes