feat: parse PostgreSQL VACUUM, ANALYZE, CLUSTER and CHECKPOINT with shared utility options (#2890)

PostgreSQL maintenance scripts failed to parse: VACUUM, CLUSTER and
CHECKPOINT had no statement, and ANALYZE accepted only the MySQL form,
so option lists, ANALYZE VERBOSE, column lists and a bare ANALYZE
failed.

Add UtilityOption, one name [value] element of PostgreSQL's
utility_option_list with a typed value, and the shared
UtilityOptionList()/UtilityOptionArgument() productions. VACUUM,
ANALYZE and CLUSTER use them and, like PostgreSQL's grammar, accept any
option name and value but PostgreSQL's reserved words; the server
checks them when it runs the statement, and getKind() maps known names
to each statement's OptionKind. EXPLAIN reads its options through the same production and
accepts no more than before. The unparenthesized keywords (VACUUM FULL,
ANALYZE VERBOSE, CLUSTER VERBOSE) are kept as options with
isParenthesizedOptions() false.

Add VacuumStatement, ClusterStatement (also the pre-8.3 CLUSTER index
ON table) and CheckpointStatement, and extend Analyze with options,
the ANALYSE spelling and MaintenanceTarget tables
([ONLY] t [*] [(columns)]). Analyze keeps its MySQL form with the whole
histogram clause (bucket count, AUTO/MANUAL UPDATE, USING DATA); the
MySQL clauses and the PostgreSQL options and targets exclude each
other, and getTables() is derived from the targets. The statements,
options and targets carry AST nodes spanning their source.

VACUUM and CLUSTER become non-reserved keywords. The PostgreSQL forms
are read with Dialect.POSTGRESQL and without a dialect; other dialects
are unchanged. Wire the statements into the deparser, visitors, table
finder, validation (vacuum, cluster, checkpoint; analyze is now in the
MySQL, MariaDB and PostgreSQL capabilities) and feature analysis.

Signed-off-by: minleejae <mmj9808@gmail.com>

Author: minleejae

README.md

@@ -148,6 +148,7 @@ and missing syntax gets added on demand — [open an issue](https://github.com/J
 | **Oracle vector types** | `VECTOR(*, *)` · `VECTOR(*, FLOAT32)` · `VECTOR(3, *)`, including dense and sparse storage formats |
 | **PostgreSQL ownership** | `DROP OWNED` · `REASSIGN OWNED` |
 | **MySQL table maintenance** | `ANALYZE` · `CHECK` · `CHECKSUM` · `OPTIMIZE` · `REPAIR TABLE` |
+| **PostgreSQL maintenance** | `VACUUM` · `ANALYZE` · `CLUSTER` · `CHECKPOINT` |
 | **MySQL account management** | `CREATE`/`ALTER`/`RENAME USER` · `CREATE ROLE` · `SET ROLE` · `SET DEFAULT ROLE` · `SET PASSWORD` |
 | **Tablespaces** | MySQL and PostgreSQL `CREATE TABLESPACE` · `ALTER TABLESPACE` |
 | **PostgreSQL RLS** | `CREATE POLICY` · `ALTER TABLE … ENABLE`/`DISABLE`/`FORCE`/`NO FORCE ROW LEVEL SECURITY` |

src/main/java/net/sf/jsqlparser/parser/feature/Feature.java

@@ -32,6 +32,9 @@
 import net.sf.jsqlparser.statement.alter.AlterEventTrigger;
 import net.sf.jsqlparser.statement.alter.sequence.AlterSequence;
 import net.sf.jsqlparser.statement.analyze.Analyze;
+import net.sf.jsqlparser.statement.maintenance.CheckpointStatement;
+import net.sf.jsqlparser.statement.maintenance.ClusterStatement;
+import net.sf.jsqlparser.statement.maintenance.VacuumStatement;
 import net.sf.jsqlparser.statement.comment.Comment;
 import net.sf.jsqlparser.statement.create.database.CreateDatabase;
 import net.sf.jsqlparser.statement.create.function.CreateFunction;
@@ -485,6 +488,27 @@ public enum Feature {
      */
     tableMaintenance,
 
+    /**
+     * PostgreSQL "VACUUM" statement is allowed
+     *
+     * @see VacuumStatement
+     */
+    vacuum,
+
+    /**
+     * PostgreSQL "CLUSTER" statement is allowed
+     *
+     * @see ClusterStatement
+     */
+    cluster,
+
+    /**
+     * PostgreSQL "CHECKPOINT" statement is allowed
+     *
+     * @see CheckpointStatement
+     */
+    checkpoint,
+
     /**
      * SQL "TRUNCATE" statement is allowed
      *

src/main/java/net/sf/jsqlparser/statement/StatementFeatureVisitor.java

@@ -99,6 +99,9 @@
 import net.sf.jsqlparser.statement.insert.InsertBulk;
 import net.sf.jsqlparser.statement.load.LoadDataStatement;
 import net.sf.jsqlparser.statement.lock.LockStatement;
+import net.sf.jsqlparser.statement.maintenance.CheckpointStatement;
+import net.sf.jsqlparser.statement.maintenance.ClusterStatement;
+import net.sf.jsqlparser.statement.maintenance.VacuumStatement;
 import net.sf.jsqlparser.statement.merge.Merge;
 import net.sf.jsqlparser.statement.oracle.OracleAssignment;
 import net.sf.jsqlparser.statement.oracle.OracleBlock;
@@ -778,6 +781,30 @@ public <S> Void visit(TableMaintenanceStatement statement, S context) {
         return null;
     }
 
+    @Override
+    public <S> Void visit(VacuumStatement vacuum, S context) {
+        // reclaims storage and, with ANALYZE, rewrites statistics; FULL rewrites the tables
+        analysis.claimTopLevel();
+        analysis.certain(StmtFeature.MODIFIES_SCHEMA, StmtFeature.READS_DATA);
+        return null;
+    }
+
+    @Override
+    public <S> Void visit(ClusterStatement cluster, S context) {
+        // rewrites the table in index order
+        analysis.claimTopLevel();
+        analysis.certain(StmtFeature.MODIFIES_SCHEMA, StmtFeature.READS_DATA);
+        return null;
+    }
+
+    @Override
+    public <S> Void visit(CheckpointStatement checkpoint, S context) {
+        // a server operation like ALTER SYSTEM CHECKPOINT; no data or schema changes
+        analysis.claimTopLevel();
+        analysis.certain(StmtFeature.MODIFIES_SESSION);
+        return null;
+    }
+
     private Void schemaOnly() {
         analysis.claimTopLevel();
         analysis.certain(StmtFeature.MODIFIES_SCHEMA);

src/main/java/net/sf/jsqlparser/statement/StatementVisitor.java

@@ -91,6 +91,9 @@
 import net.sf.jsqlparser.statement.insert.InsertBulk;
 import net.sf.jsqlparser.statement.insert.ParenthesedInsert;
 import net.sf.jsqlparser.statement.lock.LockStatement;
+import net.sf.jsqlparser.statement.maintenance.CheckpointStatement;
+import net.sf.jsqlparser.statement.maintenance.ClusterStatement;
+import net.sf.jsqlparser.statement.maintenance.VacuumStatement;
 import net.sf.jsqlparser.statement.merge.Merge;
 import net.sf.jsqlparser.statement.refresh.RefreshMaterializedViewStatement;
 import net.sf.jsqlparser.statement.reindex.Reindex;
@@ -371,6 +374,30 @@ default void visit(TableMaintenanceStatement statement) {
         this.visit(statement, null);
     }
 
+    default <S> T visit(VacuumStatement vacuum, S context) {
+        return null;
+    }
+
+    default void visit(VacuumStatement vacuum) {
+        this.visit(vacuum, null);
+    }
+
+    default <S> T visit(ClusterStatement cluster, S context) {
+        return null;
+    }
+
+    default void visit(ClusterStatement cluster) {
+        this.visit(cluster, null);
+    }
+
+    default <S> T visit(CheckpointStatement checkpoint, S context) {
+        return null;
+    }
+
+    default void visit(CheckpointStatement checkpoint) {
+        this.visit(checkpoint, null);
+    }
+
     default void visit(Execute execute) {
         this.visit(execute, null);
     }

src/main/java/net/sf/jsqlparser/statement/StatementVisitorAdapter.java

@@ -94,6 +94,9 @@
 import net.sf.jsqlparser.statement.insert.InsertConflictAction;
 import net.sf.jsqlparser.statement.insert.ParenthesedInsert;
 import net.sf.jsqlparser.statement.lock.LockStatement;
+import net.sf.jsqlparser.statement.maintenance.CheckpointStatement;
+import net.sf.jsqlparser.statement.maintenance.ClusterStatement;
+import net.sf.jsqlparser.statement.maintenance.VacuumStatement;
 import net.sf.jsqlparser.statement.merge.Merge;
 import net.sf.jsqlparser.statement.merge.MergeOperationVisitor;
 import net.sf.jsqlparser.statement.merge.MergeOperationVisitorAdapter;
@@ -708,6 +711,21 @@ public <S> T visit(TableMaintenanceStatement statement, S context) {
         return null;
     }
 
+    @Override
+    public <S> T visit(VacuumStatement vacuum, S context) {
+        return null;
+    }
+
+    @Override
+    public <S> T visit(ClusterStatement cluster, S context) {
+        return null;
+    }
+
+    @Override
+    public <S> T visit(CheckpointStatement checkpoint, S context) {
+        return null;
+    }
+
     @Override
     public <S> T visit(SavepointStatement savepointStatement, S context) {
         // @todo: do something usefully here