postgresparser
基於 ANTLR 的 PostgreSQL 查詢解析器,適用於 Go 語言,可提取表格、欄位、JOIN、CTE、參數、DDL 動作及完整的欄位使用後設資料。
postgresparser 是什麼?
基於 ANTLR 的 PostgreSQL 查詢解析器,適用於 Go 語言,能從 SQL 中提取表格、欄位、JOIN、CTE、參數、DDL 動作及完整的欄位使用後設資料至結構化 IR。
postgresparser 概覽
這是什麼
postgresparser 是一個純 Go 語言的 PostgreSQL SQL 解析器,不需要 cgo 或 C 工具鏈。它能將 SQL 解析成結構化的中間表示 (IR),從中提取資料表、欄位、JOIN、篩選條件、CTE、子查詢及其他後設資料,而不需實際執行 SQL。
主要功能
- 解析 DML(SELECT、INSERT、UPDATE、DELETE、MERGE)與 DDL(CREATE TABLE、ALTER TABLE、DROP TABLE/INDEX、CREATE INDEX、TRUNCATE、COMMENT ON),並提供完整的 IR 提取 - 支援 CTE(包含 RECURSIVE)、JOIN(INNER、LEFT、RIGHT、FULL、CROSS、NATURAL、LATERAL)、子查詢、集合操作(UNION、INTERSECT、EXCEPT)、Upsert(ON CONFLICT)、JSONB 運算子、視窗函數、型別轉換以及參數($1、$2 等) - 提供多種解析 API:ParseSQL(僅第一個陳述式)、ParseSQLAll(所有陳述式)、ParseSQLStrict(恰好一個陳述式),以及 WithOptions 變體以支援可選的提取旗標 - 包含分析子套件,可進行欄位使用分析(篩選、JOIN、投影、分組、排序)、WHERE 條件提取(含綱要解析)、佔位符角色偵測,以及具綱要感知的 JOIN 關聯偵測 - 效能:使用 SLL 預測模式時,大多數查詢可在 70–350 µs 內解析完成
使用情境
- 查詢 linting:偵測 DELETE 缺少 WHERE、標記 SELECT *、強制命名慣例 - 依賴提取:繪製查詢觸及的資料表與欄位,建立血緣圖 - 遷移工具:解析 DDL 以了解綱要變更,比對 CREATE 陳述式 - 稽核日誌:以結構化後設資料(資料表、操作類型、篩選欄位)標記日誌條目 - 查詢改寫:注入租戶篩選器、新增稽核欄位,在執行前轉換 SQL - 索引建議:分析欄位使用模式以建議最佳索引
快速開始
bash go get github.com/valkdb/postgresparser
授權與價格
授權為 Apache-2.0。此專案為開放原始碼。
內容整理自該專案公開的 README 與儲存庫資訊。