@questdb/sql-parser 0.1.0

package/dist/parser/visitor.d.ts

@@ -0,0 +1,191 @@
+import * as AST from "./ast";
+import type { AddUserStatementCstChildren, AdditiveExpressionCstChildren, AlignToClauseCstChildren, AlterGroupStatementCstChildren, AlterMaterializedViewActionCstChildren, AlterMaterializedViewStatementCstChildren, AlterServiceAccountStatementCstChildren, AlterStatementCstChildren, AlterTableActionCstChildren, AlterTableStatementCstChildren, AlterUserActionCstChildren, AlterUserStatementCstChildren, AlterViewStatementCstChildren, AndExpressionCstChildren, ArrayBracketBodyCstChildren, ArrayElementCstChildren, ArrayLiteralCstChildren, ArraySubscriptCstChildren, AssumeServiceAccountStatementCstChildren, BackupStatementCstChildren, BatchClauseCstChildren, BitAndExpressionCstChildren, BitOrExpressionCstChildren, BitXorExpressionCstChildren, BooleanLiteralCstChildren, CancelQueryStatementCstChildren, CaseExpressionCstChildren, CastDefinitionCstChildren, CastExpressionCstChildren, CheckpointStatementCstChildren, ColumnDefinitionCstChildren, ColumnRefCstChildren, CompileViewStatementCstChildren, ConcatExpressionCstChildren, Ipv4ContainmentExpressionCstChildren, ConvertPartitionTargetCstChildren, CopyCancelCstChildren, CopyFromCstChildren, CopyOptionCstChildren, CopyOptionsCstChildren, CopyStatementCstChildren, CopyToCstChildren, CreateGroupStatementCstChildren, CreateMaterializedViewBodyCstChildren, CreateServiceAccountStatementCstChildren, CreateStatementCstChildren, CreateTableBodyCstChildren, CreateUserStatementCstChildren, CreateViewBodyCstChildren, CteDefinitionCstChildren, DataTypeCstChildren, DeclareAssignmentCstChildren, DeclareClauseCstChildren, DedupClauseCstChildren, DropGroupStatementCstChildren, DropMaterializedViewStatementCstChildren, DropServiceAccountStatementCstChildren, DropStatementCstChildren, DropTableStatementCstChildren, DropUserStatementCstChildren, DropViewStatementCstChildren, DurationExpressionCstChildren, EqualityExpressionCstChildren, ExitServiceAccountStatementCstChildren, ExplainStatementCstChildren, ExpressionCstChildren, FillClauseCstChildren, FillValueCstChildren, FromClauseCstChildren, FromToClauseCstChildren, FunctionCallCstChildren, FunctionNameCstChildren, GrantAssumeServiceAccountStatementCstChildren, GrantStatementCstChildren, GrantTableTargetCstChildren, GroupByClauseCstChildren, IdentifierCstChildren, IdentifierExpressionCstChildren, ImplicitSelectBodyCstChildren, ImplicitSelectStatementCstChildren, IndexDefinitionCstChildren, InsertStatementCstChildren, IntervalValueCstChildren, JoinClauseCstChildren, LatestOnClauseCstChildren, LimitClauseCstChildren, LiteralCstChildren, MaterializedViewPartitionCstChildren, MaterializedViewPeriodCstChildren, MaterializedViewRefreshCstChildren, MultiplicativeExpressionCstChildren, NotExpressionCstChildren, OrExpressionCstChildren, OrderByClauseCstChildren, OrderByItemCstChildren, OverClauseCstChildren, PartitionPeriodCstChildren, PermissionListCstChildren, PermissionTokenCstChildren, PivotAggregationCstChildren, PivotBodyCstChildren, PivotForClauseCstChildren, PivotInValueCstChildren, PivotStatementCstChildren, PrimaryExpressionCstChildren, QualifiedNameCstChildren, QualifiedStarCstChildren, ReindexTableStatementCstChildren, RefreshMaterializedViewStatementCstChildren, RelationalExpressionCstChildren, RemoveUserStatementCstChildren, RenameTableStatementCstChildren, ResumeWalStatementCstChildren, RevokeAssumeServiceAccountStatementCstChildren, RevokeStatementCstChildren, SampleByClauseCstChildren, SelectItemCstChildren, SelectListCstChildren, SelectStatementCstChildren, SetClauseCstChildren, SetExpressionCstChildren, SetOperationCstChildren, SetTypeStatementCstChildren, ShowStatementCstChildren, SimpleSelectCstChildren, SnapshotStatementCstChildren, StatementCstChildren, StatementsCstChildren, StringOrIdentifierCstChildren, StringOrQualifiedNameCstChildren, TableFunctionCallCstChildren, TableFunctionNameCstChildren, TableParamCstChildren, TableParamNameCstChildren, TableRefCstChildren, TimeUnitCstChildren, TimeZoneValueCstChildren, TruncateTableStatementCstChildren, TypeCastExpressionCstChildren, UnaryExpressionCstChildren, UpdateStatementCstChildren, VacuumTableStatementCstChildren, ValuesClauseCstChildren, ValuesListCstChildren, WhereClauseCstChildren, WindowFrameBoundCstChildren, WindowFrameClauseCstChildren, WindowJoinBoundCstChildren, WindowPartitionByClauseCstChildren, WithClauseCstChildren, WithStatementCstChildren } from "./cst-types";
+declare const BaseVisitor: new (...args: any[]) => import("chevrotain").ICstVisitor<any, any>;
+declare class QuestDBVisitor extends BaseVisitor {
+    constructor();
+    private tokenImage;
+    statements(ctx: StatementsCstChildren): AST.Statement[];
+    statement(ctx: StatementCstChildren): AST.Statement;
+    withStatement(ctx: WithStatementCstChildren): AST.Statement;
+    selectStatement(ctx: SelectStatementCstChildren): AST.SelectStatement;
+    withClause(ctx: WithClauseCstChildren): AST.CTE[];
+    cteDefinition(ctx: CteDefinitionCstChildren): AST.CTE;
+    simpleSelect(ctx: SimpleSelectCstChildren): AST.SelectStatement;
+    setOperation(ctx: SetOperationCstChildren): AST.SetOperation;
+    selectList(ctx: SelectListCstChildren): AST.SelectItem[];
+    selectItem(ctx: SelectItemCstChildren): AST.SelectItem;
+    qualifiedStar(ctx: QualifiedStarCstChildren): AST.QualifiedName;
+    fromClause(ctx: FromClauseCstChildren): AST.TableRef[];
+    implicitSelectBody(ctx: ImplicitSelectBodyCstChildren): AST.SelectStatement;
+    implicitSelectStatement(ctx: ImplicitSelectStatementCstChildren): AST.SelectStatement;
+    tableRef(ctx: TableRefCstChildren): AST.TableRef;
+    tableFunctionCall(ctx: TableFunctionCallCstChildren): AST.TableFunctionCall;
+    tableFunctionName(_ctx: TableFunctionNameCstChildren): string | undefined;
+    joinClause(ctx: JoinClauseCstChildren): AST.JoinClause;
+    windowJoinBound(ctx: WindowJoinBoundCstChildren): AST.WindowJoinBound;
+    durationExpression(ctx: DurationExpressionCstChildren): string;
+    whereClause(ctx: WhereClauseCstChildren): AST.Expression;
+    sampleByClause(ctx: SampleByClauseCstChildren): AST.SampleByClause;
+    fillClause(ctx: FillClauseCstChildren): string[];
+    fillValue(ctx: FillValueCstChildren): string;
+    alignToClause(ctx: AlignToClauseCstChildren): AST.AlignToClause;
+    fromToClause(ctx: FromToClauseCstChildren): {
+        from?: AST.Expression;
+        to?: AST.Expression;
+    };
+    latestOnClause(ctx: LatestOnClauseCstChildren): AST.LatestOnClause;
+    groupByClause(ctx: GroupByClauseCstChildren): AST.Expression[];
+    orderByClause(ctx: OrderByClauseCstChildren): AST.OrderByItem[];
+    orderByItem(ctx: OrderByItemCstChildren): AST.OrderByItem;
+    limitClause(ctx: LimitClauseCstChildren): AST.LimitClause;
+    insertStatement(ctx: InsertStatementCstChildren): AST.InsertStatement;
+    valuesClause(ctx: ValuesClauseCstChildren): AST.Expression[][];
+    valuesList(ctx: ValuesListCstChildren): AST.Expression[];
+    batchClause(ctx: BatchClauseCstChildren): {
+        size: number;
+        o3MaxLag?: string;
+    };
+    updateStatement(ctx: UpdateStatementCstChildren): AST.UpdateStatement;
+    setClause(ctx: SetClauseCstChildren): AST.SetClause;
+    declareClause(ctx: DeclareClauseCstChildren): AST.DeclareClause;
+    declareAssignment(ctx: DeclareAssignmentCstChildren): AST.DeclareAssignment;
+    createStatement(ctx: CreateStatementCstChildren): AST.Statement;
+    createTableBody(ctx: CreateTableBodyCstChildren): AST.CreateTableStatement;
+    columnDefinition(ctx: ColumnDefinitionCstChildren): AST.ColumnDefinition;
+    castDefinition(ctx: CastDefinitionCstChildren): AST.CastDefinition;
+    indexDefinition(ctx: IndexDefinitionCstChildren): AST.IndexDefinition;
+    tableParamName(ctx: TableParamNameCstChildren): string;
+    tableParam(ctx: TableParamCstChildren): AST.TableParam;
+    createViewBody(ctx: CreateViewBodyCstChildren): AST.CreateViewStatement;
+    createUserStatement(ctx: CreateUserStatementCstChildren): AST.CreateUserStatement;
+    createGroupStatement(ctx: CreateGroupStatementCstChildren): AST.CreateGroupStatement;
+    createServiceAccountStatement(ctx: CreateServiceAccountStatementCstChildren): AST.CreateServiceAccountStatement;
+    createMaterializedViewBody(ctx: CreateMaterializedViewBodyCstChildren): AST.CreateMaterializedViewStatement;
+    materializedViewRefresh(ctx: MaterializedViewRefreshCstChildren): AST.MaterializedViewRefresh;
+    materializedViewPeriod(ctx: MaterializedViewPeriodCstChildren): AST.MaterializedViewPeriod;
+    materializedViewPartition(ctx: MaterializedViewPartitionCstChildren): {
+        partitionBy?: AST.CreateMaterializedViewStatement["partitionBy"];
+        ttl?: AST.CreateMaterializedViewStatement["ttl"];
+    };
+    partitionPeriod(ctx: PartitionPeriodCstChildren): "NONE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR";
+    timeUnit(ctx: TimeUnitCstChildren): string;
+    dedupClause(ctx: DedupClauseCstChildren): string[];
+    alterStatement(ctx: AlterStatementCstChildren): AST.Statement;
+    alterViewStatement(ctx: AlterViewStatementCstChildren): AST.AlterViewStatement;
+    alterGroupStatement(ctx: AlterGroupStatementCstChildren): AST.AlterGroupStatement;
+    alterTableStatement(ctx: AlterTableStatementCstChildren): AST.AlterTableStatement;
+    alterMaterializedViewStatement(ctx: AlterMaterializedViewStatementCstChildren): AST.AlterMaterializedViewStatement;
+    alterMaterializedViewAction(ctx: AlterMaterializedViewActionCstChildren): AST.AlterMaterializedViewAction;
+    alterUserStatement(ctx: AlterUserStatementCstChildren): AST.AlterUserStatement;
+    alterServiceAccountStatement(ctx: AlterServiceAccountStatementCstChildren): AST.AlterServiceAccountStatement;
+    alterUserAction(ctx: AlterUserActionCstChildren): AST.AlterUserAction;
+    alterTableAction(ctx: AlterTableActionCstChildren): AST.AlterTableAction;
+    dropStatement(ctx: DropStatementCstChildren): AST.Statement;
+    dropTableStatement(ctx: DropTableStatementCstChildren): AST.DropTableStatement;
+    dropMaterializedViewStatement(ctx: DropMaterializedViewStatementCstChildren): AST.DropMaterializedViewStatement;
+    dropViewStatement(ctx: DropViewStatementCstChildren): AST.DropViewStatement;
+    dropUserStatement(ctx: DropUserStatementCstChildren): AST.DropUserStatement;
+    dropGroupStatement(ctx: DropGroupStatementCstChildren): AST.DropGroupStatement;
+    dropServiceAccountStatement(ctx: DropServiceAccountStatementCstChildren): AST.DropServiceAccountStatement;
+    truncateTableStatement(ctx: TruncateTableStatementCstChildren): AST.TruncateTableStatement;
+    renameTableStatement(ctx: RenameTableStatementCstChildren): AST.RenameTableStatement;
+    addUserStatement(ctx: AddUserStatementCstChildren): AST.AddUserStatement;
+    removeUserStatement(ctx: RemoveUserStatementCstChildren): AST.RemoveUserStatement;
+    assumeServiceAccountStatement(ctx: AssumeServiceAccountStatementCstChildren): AST.AssumeServiceAccountStatement;
+    exitServiceAccountStatement(ctx: ExitServiceAccountStatementCstChildren): AST.ExitServiceAccountStatement;
+    cancelQueryStatement(ctx: CancelQueryStatementCstChildren): AST.CancelQueryStatement;
+    showStatement(ctx: ShowStatementCstChildren): AST.ShowStatement;
+    explainStatement(ctx: ExplainStatementCstChildren): AST.ExplainStatement;
+    copyStatement(ctx: CopyStatementCstChildren): AST.CopyStatement;
+    copyCancel(ctx: CopyCancelCstChildren): AST.CopyCancelStatement;
+    copyFrom(ctx: CopyFromCstChildren): AST.CopyFromStatement;
+    copyTo(ctx: CopyToCstChildren): AST.CopyToStatement;
+    copyOptions(ctx: CopyOptionsCstChildren): AST.CopyOption[];
+    copyOption(ctx: CopyOptionCstChildren): AST.CopyOption;
+    checkpointStatement(ctx: CheckpointStatementCstChildren): AST.CheckpointStatement;
+    snapshotStatement(ctx: SnapshotStatementCstChildren): AST.SnapshotStatement;
+    backupStatement(ctx: BackupStatementCstChildren): AST.BackupStatement;
+    compileViewStatement(ctx: CompileViewStatementCstChildren): AST.CompileViewStatement;
+    convertPartitionTarget(ctx: ConvertPartitionTargetCstChildren): {
+        partitions?: string[];
+        target: string;
+        where?: AST.Expression;
+    };
+    grantStatement(ctx: GrantStatementCstChildren): AST.GrantStatement;
+    revokeStatement(ctx: RevokeStatementCstChildren): AST.RevokeStatement;
+    permissionList(ctx: PermissionListCstChildren): string[];
+    permissionToken(ctx: PermissionTokenCstChildren): string;
+    grantTableTarget(ctx: GrantTableTargetCstChildren): AST.GrantTableTarget;
+    grantAssumeServiceAccountStatement(ctx: GrantAssumeServiceAccountStatementCstChildren): AST.GrantAssumeServiceAccountStatement;
+    revokeAssumeServiceAccountStatement(ctx: RevokeAssumeServiceAccountStatementCstChildren): AST.RevokeAssumeServiceAccountStatement;
+    vacuumTableStatement(ctx: VacuumTableStatementCstChildren): AST.VacuumTableStatement;
+    resumeWalStatement(ctx: ResumeWalStatementCstChildren): AST.ResumeWalStatement;
+    setTypeStatement(ctx: SetTypeStatementCstChildren): AST.SetTypeStatement;
+    reindexTableStatement(ctx: ReindexTableStatementCstChildren): AST.ReindexTableStatement;
+    refreshMaterializedViewStatement(ctx: RefreshMaterializedViewStatementCstChildren): AST.RefreshMaterializedViewStatement;
+    pivotStatement(ctx: PivotStatementCstChildren): AST.PivotStatement;
+    pivotBody(ctx: PivotBodyCstChildren): {
+        aggregations: AST.PivotAggregation[];
+        pivots: AST.PivotForClause[];
+        groupBy?: AST.Expression[];
+    };
+    pivotAggregation(ctx: PivotAggregationCstChildren): AST.PivotAggregation;
+    pivotForClause(ctx: PivotForClauseCstChildren): AST.PivotForClause;
+    pivotInValue(ctx: PivotInValueCstChildren): AST.PivotInValue;
+    expression(ctx: ExpressionCstChildren): AST.Expression;
+    orExpression(ctx: OrExpressionCstChildren): AST.Expression;
+    andExpression(ctx: AndExpressionCstChildren): AST.Expression;
+    notExpression(ctx: NotExpressionCstChildren): AST.Expression;
+    equalityExpression(ctx: EqualityExpressionCstChildren): AST.Expression;
+    relationalExpression(ctx: RelationalExpressionCstChildren): AST.Expression;
+    setExpression(ctx: SetExpressionCstChildren): AST.Expression;
+    bitOrExpression(ctx: BitOrExpressionCstChildren): AST.Expression;
+    bitXorExpression(ctx: BitXorExpressionCstChildren): AST.Expression;
+    bitAndExpression(ctx: BitAndExpressionCstChildren): AST.Expression;
+    concatExpression(ctx: ConcatExpressionCstChildren): AST.Expression;
+    ipv4ContainmentExpression(ctx: Ipv4ContainmentExpressionCstChildren): AST.Expression;
+    additiveExpression(ctx: AdditiveExpressionCstChildren): AST.Expression;
+    multiplicativeExpression(ctx: MultiplicativeExpressionCstChildren): AST.Expression;
+    unaryExpression(ctx: UnaryExpressionCstChildren): AST.Expression;
+    typeCastExpression(ctx: TypeCastExpressionCstChildren): AST.Expression;
+    arraySubscript(ctx: ArraySubscriptCstChildren): AST.Expression | AST.ArraySlice;
+    /**
+     * Used in implicitSelectBody so that an incomplete clause (e.g. `trades WHERE price >`)
+     * doesn't destroy the entire AST. The fromClause visit succeeds and is kept; the
+     * whereClause visit throws on the empty expression shell and is discarded.
+     * Without this, parseToAst would return ast:[] for any incomplete implicit select.
+     *
+     * See tests in parser.test.ts
+     */
+    private visitSafe;
+    /** Get the startOffset of the first token in a CstNode */
+    private getFirstTokenOffset;
+    primaryExpression(ctx: PrimaryExpressionCstChildren): AST.Expression;
+    arrayLiteral(ctx: ArrayLiteralCstChildren): AST.ArrayLiteral;
+    arrayBracketBody(ctx: ArrayBracketBodyCstChildren): AST.ArrayLiteral;
+    arrayElement(ctx: ArrayElementCstChildren): AST.Expression | AST.ArrayLiteral;
+    castExpression(ctx: CastExpressionCstChildren): AST.CastExpression;
+    dataType(ctx: DataTypeCstChildren): string;
+    caseExpression(ctx: CaseExpressionCstChildren): AST.CaseExpression;
+    functionName(ctx: FunctionNameCstChildren): string;
+    functionCall(ctx: FunctionCallCstChildren): AST.FunctionCall;
+    identifierExpression(ctx: IdentifierExpressionCstChildren): AST.Expression;
+    overClause(ctx: OverClauseCstChildren): AST.WindowSpecification;
+    windowPartitionByClause(ctx: WindowPartitionByClauseCstChildren): AST.Expression[];
+    windowFrameClause(ctx: WindowFrameClauseCstChildren): AST.WindowFrame;
+    windowFrameBound(ctx: WindowFrameBoundCstChildren): AST.WindowFrameBound;
+    literal(ctx: LiteralCstChildren): AST.Literal;
+    booleanLiteral(ctx: BooleanLiteralCstChildren): boolean;
+    stringOrIdentifier(ctx: StringOrIdentifierCstChildren): string;
+    stringOrQualifiedName(ctx: StringOrQualifiedNameCstChildren): AST.QualifiedName;
+    intervalValue(ctx: IntervalValueCstChildren): string;
+    timeZoneValue(ctx: TimeZoneValueCstChildren): string;
+    columnRef(ctx: ColumnRefCstChildren): AST.ColumnRef;
+    qualifiedName(ctx: QualifiedNameCstChildren): AST.QualifiedName;
+    private extractMaybeString;
+    private extractTtl;
+    private extractIdentifierName;
+    identifier(ctx: IdentifierCstChildren): AST.QualifiedName;
+}
+export declare const visitor: QuestDBVisitor;
+export {};

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@questdb/sql-parser",
+  "version": "0.1.0",
+  "description": "SQL parser for QuestDB syntax using Chevrotain",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./grammar": {
+      "import": {
+        "types": "./dist/grammar/index.d.ts",
+        "default": "./dist/grammar/index.js"
+      },
+      "require": {
+        "types": "./dist/grammar/index.d.ts",
+        "default": "./dist/grammar/index.cjs"
+      }
+    }
+  },
+  "packageManager": "yarn@4.9.1",
+  "scripts": {
+    "build": "tsup && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "generate:cst": "node --import jiti/register scripts/generate-cst-types.ts",
+    "clean": "rm -rf dist coverage",
+    "lint": "eslint src/ tests/",
+    "lint:fix": "eslint src/ tests/ --fix",
+    "prepublishOnly": "yarn clean && yarn build"
+  },
+  "keywords": [
+    "questdb",
+    "sql",
+    "parser",
+    "chevrotain",
+    "ast"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/questdb/sql-parser.git"
+  },
+  "homepage": "https://github.com/questdb/sql-parser",
+  "bugs": {
+    "url": "https://github.com/questdb/sql-parser/issues"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "chevrotain": "^11.1.1"
+  },
+  "devDependencies": {
+    "@chevrotain/cst-dts-gen": "^11.1.1",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.2.0",
+    "eslint": "^10.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^17.3.0",
+    "jiti": "^2.6.1",
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.55.0",
+    "vitest": "^4.0.18"
+  }
+}