@uwdata/mosaic-sql 0.19.0 → 0.20.0

package/src/ast/case.ts

@@ -52,17 +52,6 @@ export class CaseNode extends ExprNode {
   else(expr: ExprValue) {
     return new CaseNode(this.expr, this._when, asNode(expr));
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return 'CASE '
-      + (this.expr ? `${this.expr} ` : '')
-      + this._when.join(' ')
-      + (this._else ? ` ELSE ${this._else}` : '')
-      + ' END';
-  }
 }
 
 export class WhenNode extends SQLNode {
@@ -81,11 +70,4 @@ export class WhenNode extends SQLNode {
     this.when = when;
     this.then = then;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `WHEN ${this.when} THEN ${this.then}`;
-  }
 }

package/src/ast/cast.ts

@@ -17,12 +17,4 @@ export class CastNode extends ExprNode {
     this.expr = expr;
     this.cast = type;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    // TODO? could include check to see if parens are necessary
-    return `(${this.expr})::${this.cast}`;
-  }
 }

package/src/ast/collate.ts

@@ -17,11 +17,4 @@ export class CollateNode extends ExprNode {
     this.expr = expr;
     this.collation = collation;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `${this.expr} ${COLLATE} ${this.collation}`;
-  }
 }

package/src/ast/column-ref.ts

@@ -1,6 +1,5 @@
 import type { TableRefNode } from './table-ref.js';
 import { COLUMN_REF } from '../constants.js';
-import { quoteIdentifier } from '../util/string.js';
 import { ExprNode } from './node.js';
 
 /**
@@ -31,16 +30,6 @@ export class ColumnRefNode extends ExprNode {
   get column() {
     return ''; // subclasses to override
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { column, table } = this;
-    const tref = `${table ?? ''}`;
-    const id = column === '*' ? '*' : quoteIdentifier(column);
-    return (tref ? (tref + '.') : '') + id;
-  }
 }
 
 export class ColumnNameRefNode extends ColumnRefNode {

package/src/ast/fragment.ts

@@ -18,11 +18,4 @@ export class FragmentNode extends ExprNode {
     super(FRAGMENT);
     this.spans = spans;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return this.spans.join('');
-  }
 }

package/src/ast/from.ts

@@ -1,11 +1,15 @@
 import type { SampleClauseNode } from './sample.js';
 import { FROM_CLAUSE } from '../constants.js';
-import { quoteIdentifier } from '../util/string.js';
 import { SQLNode } from './node.js';
-import { isQuery } from './query.js';
-import { isTableRef } from './table-ref.js';
 
-export class FromClauseNode extends SQLNode {
+/**
+ * AST node corresponding to a table source which can appear
+ * within a SQL `FROM` clause.
+ */
+export class FromNode extends SQLNode {
+}
+
+export class FromClauseNode extends FromNode {
   /** The from expression. */
   readonly expr: SQLNode;
   /** The output name. */
@@ -27,14 +31,10 @@ export class FromClauseNode extends SQLNode {
   }
 
   /**
-   * Generate a SQL query string for this node.
+   * Create a new from clause node that uses the given alias.
+   * @param string alias
    */
-  toString() {
-    const { expr, alias, sample } = this;
-    const ref = isQuery(expr) ? `(${expr})` : `${expr}`;
-    const from = alias && !(isTableRef(expr) && expr.table.join('.') === alias)
-      ? `${ref} AS ${quoteIdentifier(alias)}`
-      : `${ref}`;
-    return `${from}${sample ? ` TABLESAMPLE ${sample}` : ''}`;
+  as(alias: string) {
+    return new FromClauseNode(this.expr, alias, this.sample);
   }
 }

package/src/ast/function.ts

@@ -17,12 +17,4 @@ export class FunctionNode extends ExprNode {
     this.name = name;
     this.args = args;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { name, args } = this;
-    return `${name}(${args.join(', ')})`;
-  }
 }

package/src/ast/in-op.ts

@@ -17,11 +17,4 @@ export class InOpNode extends ExprNode {
     this.expr = expr;
     this.values = values;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `(${this.expr} IN (${this.values.join(', ')}))`;
-  }
 }

package/src/ast/interval.ts

@@ -17,11 +17,4 @@ export class IntervalNode extends ExprNode {
     this.name = name;
     this.steps = steps;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `INTERVAL ${this.steps} ${this.name}`;
-  }
 }

package/src/ast/join.ts

@@ -0,0 +1,66 @@
+import type { SampleClauseNode } from './sample.js';
+import { JOIN_CLAUSE } from '../constants.js';
+import { ColumnRefNode } from './column-ref.js';
+import { FromNode } from './from.js';
+import { ExprNode } from './node.js';
+import { TableRefNode } from './table-ref.js';
+
+/** The join variant. Determines what kind of join is performed. */
+export type JoinVariant = 'REGULAR' | 'CROSS' | 'NATURAL' | 'POSITIONAL' | 'ASOF';
+
+/** The join type. Determines which values are included in the join output. */
+export type JoinType = 'INNER' | 'LEFT' | 'RIGHT' | 'FULL' | 'SEMI' | 'ANTI';
+
+export class JoinNode extends FromNode {
+  /** The left table to join. */
+  readonly left: FromNode | TableRefNode;
+  /** The right table to join. */
+  readonly right: FromNode | TableRefNode;
+  /** The join variant (REGULAR, CROSS, NATURAL, POSITIONAL, ASOF). */
+  readonly joinVariant: JoinVariant;
+  /** The join type (INNER, LEFT, RIGHT, FULL, SEMI, ANTI). */
+  readonly joinType: JoinType;
+  /**
+   * The join condition as a boolean expression.
+   * If specified, *using* should be `undefined`.
+   */
+  readonly condition?: ExprNode;
+  /**
+   * The join condition as shared columns to match on.
+   * If specified, *condition* should be `undefined`.
+   */
+  readonly using?: ColumnRefNode[];
+  /** A table sample to apply to join output. */
+  readonly sample?: SampleClauseNode;
+
+  /**
+   * Instantiate a join node.
+   * @param left The left table to join.
+   * @param right The right table to join.
+   * @param variant The join variant (REGULAR, CROSS, NATURAL, POSITIONAL, ASOF).
+   * @param type The join type (INNER, LEFT, RIGHT, FULL, SEMI, ANTI).
+   * @param condition The join condition as a boolean expression.
+   *  If specified, *using* should be `undefined`.
+   * @param using The join condition as shared columns to match on.
+   *  If specified, *condition* should be `undefined`.
+   * @param sample A table sample to apply to join output.
+   */
+  constructor(
+    left: FromNode | TableRefNode,
+    right: FromNode | TableRefNode,
+    variant: JoinVariant = 'NATURAL',
+    type: JoinType = 'INNER',
+    condition?: ExprNode,
+    using?: ColumnRefNode[],
+    sample?: SampleClauseNode
+  ) {
+    super(JOIN_CLAUSE);
+    this.left = left;
+    this.right = right;
+    this.joinVariant = variant;
+    this.joinType = type;
+    this.condition = condition;
+    this.using = using;
+    this.sample = sample;
+  }
+}

package/src/ast/list.ts

@@ -13,11 +13,4 @@ export class ListNode extends ExprNode {
     super(LIST);
     this.values = values;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `[${this.values.join(', ')}]`;
-  }
 }

package/src/ast/literal.ts

@@ -13,13 +13,6 @@ export class LiteralNode extends ExprNode {
     super(LITERAL);
     this.value = value;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return literalToSQL(this.value);
-  }
 }
 
 export function literalToSQL(value: unknown) {

package/src/ast/logical-op.ts

@@ -17,16 +17,6 @@ export class LogicalOpNode<T extends ExprNode> extends ExprNode {
     this.op = op;
     this.clauses = clauses;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const c = this.clauses;
-    return c.length === 0 ? ''
-      : c.length === 1 ? `${c[0]}`
-      : `(${c.join(` ${this.op} `)})`;
-  }
 }
 
 export class AndNode<T extends ExprNode> extends LogicalOpNode<T> {

package/src/ast/node.ts

@@ -1,3 +1,5 @@
+import type { SQLCodeGenerator } from '../visit/codegen/sql.js';
+
 /**
  * Check if a value is a SQL AST node.
  * @param value The value to check.
@@ -6,6 +8,16 @@ export function isNode(value: unknown): value is SQLNode {
   return value instanceof SQLNode;
 }
 
+let _defaultVisitor: SQLCodeGenerator | undefined;
+
+/**
+ * Set the default visitor for toString operations.
+ * This is used when no visitor is explicitly provided.
+ */
+export function setDefaultVisitor(visitor: SQLCodeGenerator) {
+  _defaultVisitor = visitor;
+}
+
 export class SQLNode {
   /** The SQL AST node type. */
   readonly type: string;
@@ -23,13 +35,28 @@ export class SQLNode {
    * @returns The shallow clone node.
    */
   clone(): this {
-    // @ts-expect-error use constructor
-    const clone = new this.constructor();
+    // @ts-expect-error use constructor with type
+    const clone = new this.constructor(this.type);
     for (const key in this) {
-      clone[key] = this[key];
+      if (key !== 'type') { // Skip type since it's already set by constructor
+        clone[key] = this[key];
+      }
     }
     return clone;
   }
+
+  /**
+   * Generate a SQL query string for this node using a specific dialect visitor.
+   * @param visitor Optional SQL visitor to use for string generation.
+   *  If not provided, uses the default visitor.
+   * @returns The SQL string representation.
+   */
+  toString(visitor: SQLCodeGenerator | undefined = _defaultVisitor): string {
+    if (!visitor) {
+      throw new Error('No visitor provided and no default visitor set.');
+    }
+    return visitor.toString(this);
+  }
 }
 
 /**

package/src/ast/order-by.ts

@@ -21,18 +21,4 @@ export class OrderByNode extends ExprNode {
     this.desc = desc;
     this.nullsFirst = nullsFirst;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { expr, desc, nullsFirst } = this;
-    const dir = desc ? ' DESC'
-      : desc === false ? ' ASC'
-      : '';
-    const nf = nullsFirst ? ' NULLS FIRST'
-      : nullsFirst === false ? ' NULLS LAST'
-      : '';
-    return `${expr}${dir}${nf}`;
-  }
 }

package/src/ast/param.ts

@@ -1,6 +1,5 @@
 import type { ParamLike } from '../types.js';
 import { PARAM } from '../constants.js';
-import { literalToSQL } from './literal.js';
 import { ExprNode } from './node.js';
 
 export class ParamNode extends ExprNode {
@@ -22,11 +21,4 @@ export class ParamNode extends ExprNode {
   get value() {
     return this.param.value;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return literalToSQL(this.value);
-  }
 }

package/src/ast/query.ts

@@ -6,7 +6,7 @@ import { exprList, nodeList } from '../util/function.js';
 import { unquote } from '../util/string.js';
 import { isArray, isString } from '../util/type-check.js';
 import { isColumnRef } from './column-ref.js';
-import { FromClauseNode } from './from.js';
+import { FromClauseNode, FromNode } from './from.js';
 import { ExprNode, SQLNode, isNode } from './node.js';
 import { SampleClauseNode } from './sample.js';
 import { SelectClauseNode } from './select.js';
@@ -231,7 +231,7 @@ export class Query extends ExprNode {
 
 export class SelectQuery extends Query {
   _select: SelectClauseNode[] = [];
-  _from: FromClauseNode[] = [];
+  _from: FromNode[] = [];
   _where: ExprNode[] = [];
   _sample?: SampleClauseNode;
   _groupby: ExprNode[] = [];
@@ -261,13 +261,17 @@ export class SelectQuery extends Query {
 
     // extract subqueries in FROM clause
     // unused CTEs will be ignored
+    // WARNING: does not recurse into join inputs!
     const queries: Query[] = [];
-    this._from.forEach(({ expr }) => {
-      if (isQuery(expr)) {
-        queries.push(expr);
-      } else if (isTableRef(expr)) {
-        const subq = cte[expr.name];
-        if (subq) queries.push(subq);
+    this._from.forEach(node => {
+      if (node instanceof FromClauseNode) {
+        const { expr } = node;
+        if (isQuery(expr)) {
+          queries.push(expr);
+        } else if (isTableRef(expr)) {
+          const subq = cte[expr.name];
+          if (subq) queries.push(subq);
+        }
       }
     });
     return queries;
@@ -330,7 +334,7 @@ export class SelectQuery extends Query {
    * @param expr Expressions to add.
    */
   from(...expr: FromExpr[]): this {
-    const list: FromClauseNode[] = [];
+    const list: FromNode[] = [];
 
     const add = (v: string | string[] | SQLNode, as?: string) => {
       list.push(new FromClauseNode(maybeTableRef(v), unquote(as)));
@@ -338,7 +342,7 @@ export class SelectQuery extends Query {
 
     expr.flat().forEach(e => {
       if (e == null) return;
-      else if (e instanceof FromClauseNode) list.push(e);
+      else if (e instanceof FromNode) list.push(e);
       else if (isString(e)) add(e, e);
       else if (isTableRef(e)) add(e, e.name);
       else if (isNode(e)) add(e);
@@ -450,66 +454,6 @@ export class SelectQuery extends Query {
     this._qualify = this._qualify.concat(exprList(expr, asVerbatim));
     return this;
   }
-
-  /**
-   * Generate a SQL query string.
-   */
-  toString() {
-    const {
-      _with, _select, _distinct, _from, _sample, _where, _groupby,
-      _having, _window, _qualify, _orderby, _limitPerc, _limit, _offset
-    } = this;
-    const sql = [];
-
-    // WITH
-    if (_with.length) sql.push(`WITH ${_with.join(', ')}`);
-
-    // SELECT
-    sql.push(`SELECT${_distinct ? ' DISTINCT' : ''} ${_select.join(', ')}`);
-
-    // FROM
-    if (_from.length) sql.push(`FROM ${_from.join(', ')}`);
-
-    // WHERE
-    if (_where.length) {
-      const clauses = _where.map(String).filter(x => x).join(' AND ');
-      if (clauses) sql.push(`WHERE ${clauses}`);
-    }
-
-    // SAMPLE
-    if (_sample) sql.push(`USING SAMPLE ${_sample}`);
-
-    // GROUP BY
-    if (_groupby.length) {
-      sql.push(`GROUP BY ${_groupby.join(', ')}`);
-    }
-
-    // HAVING
-    if (_having.length) {
-      const clauses = _having.map(String).filter(x => x).join(' AND ');
-      if (clauses) sql.push(`HAVING ${clauses}`);
-    }
-
-    // WINDOW
-    if (_window.length) sql.push(`WINDOW ${_window.join(', ')}`);
-
-    // QUALIFY
-    if (_qualify.length) {
-      const clauses = _qualify.map(String).filter(x => x).join(' AND ');
-      if (clauses) sql.push(`QUALIFY ${clauses}`);
-    }
-
-    // ORDER BY
-    if (_orderby.length) sql.push(`ORDER BY ${_orderby.join(', ')}`);
-
-    // LIMIT
-    if (_limit) sql.push(`LIMIT ${_limit}${_limitPerc ? '%' : ''}`);
-
-    // OFFSET
-    if (_offset) sql.push(`OFFSET ${_offset}`);
-
-    return sql.join(' ');
-  }
 }
 
 export class DescribeQuery extends SQLNode {
@@ -531,13 +475,6 @@ export class DescribeQuery extends SQLNode {
     // @ts-expect-error creates describe query
     return new DescribeQuery(this.query.clone());
   }
-
-  /**
-   * Generate a SQL query string.
-   */
-  toString() {
-    return `DESCRIBE ${this.query}`;
-  }
 }
 
 export class SetOperation extends Query {
@@ -582,31 +519,6 @@ export class SetOperation extends Query {
     // @ts-expect-error creates set operation
     return Object.assign(new SetOperation(op, queries), rest);
   }
-
-  /**
-   * Generate a SQL query string.
-   */
-  toString() {
-    const { op, queries, _with, _orderby, _limitPerc, _limit, _offset } = this;
-    const sql = [];
-
-    // WITH
-    if (_with.length) sql.push(`WITH ${_with.join(', ')}`);
-
-    // SUBQUERIES
-    sql.push(queries.join(` ${op} `));
-
-    // ORDER BY
-    if (_orderby.length) sql.push(`ORDER BY ${_orderby.join(', ')}`);
-
-    // LIMIT
-    if (_limit) sql.push(`LIMIT ${_limit}${_limitPerc ? '%' : ''}`);
-
-    // OFFSET
-    if (_offset) sql.push(`OFFSET ${_offset}`);
-
-    return sql.join(' ');
-  }
 }
 
 class WithClause {

package/src/ast/sample.ts

@@ -34,14 +34,4 @@ export class SampleClauseNode extends SQLNode {
     this.method = method;
     this.seed = seed;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { size, perc, method, seed } = this;
-    const m = method ? `${method} ` : '';
-    const s = seed != null ? ` REPEATABLE (${seed})` : '';
-    return `${m}(${size}${perc ? '%' : ' ROWS'})${s}`;
-  }
 }

package/src/ast/select.ts

@@ -1,7 +1,5 @@
 import type { ExprNode } from './node.js';
 import { SELECT_CLAUSE } from '../constants.js';
-import { quoteIdentifier } from '../util/string.js';
-import { ColumnRefNode } from './column-ref.js';
 import { SQLNode } from './node.js';
 
 export class SelectClauseNode extends SQLNode {
@@ -20,20 +18,4 @@ export class SelectClauseNode extends SQLNode {
     this.expr = expr;
     this.alias = alias;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { expr, alias } = this;
-    return !alias || isColumnRefFor(expr, alias)
-      ? `${expr}`
-      : `${expr} AS ${quoteIdentifier(alias)}`;
-  }
-}
-
-function isColumnRefFor(expr: unknown, name: string): expr is ColumnRefNode {
-  return expr instanceof ColumnRefNode
-    && expr.table == null
-    && expr.column === name;
 }

package/src/ast/subquery.ts

@@ -14,11 +14,4 @@ export class ScalarSubqueryNode extends ExprNode {
     super(SCALAR_SUBQUERY);
     this.subquery = subquery;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `(${this.subquery})`;
-  }
 }

package/src/ast/table-ref.ts

@@ -1,5 +1,4 @@
 import { TABLE_REF } from '../constants.js';
-import { quoteIdentifier } from '../util/string.js';
 import { ExprNode } from './node.js';
 
 /**
@@ -29,11 +28,4 @@ export class TableRefNode extends ExprNode {
   get name() {
     return this.table[this.table.length - 1];
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return this.table.map(t => quoteIdentifier(t)).join('.');
-  }
 }

package/src/ast/unary-op.ts

@@ -29,13 +29,6 @@ export class UnaryOpNode extends AbstractUnaryOpNode {
   constructor(op: string, expr: ExprNode) {
     super(UNARY_OPERATOR, op, expr);
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `(${this.op} ${this.expr})`;
-  }
 }
 
 export class UnaryPostfixOpNode extends AbstractUnaryOpNode {
@@ -47,11 +40,4 @@ export class UnaryPostfixOpNode extends AbstractUnaryOpNode {
   constructor(op: string, expr: ExprNode) {
     super(UNARY_POSTFIX_OPERATOR, op, expr);
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `(${this.expr} ${this.op})`;
-  }
 }

package/src/ast/unnest.ts

@@ -19,13 +19,4 @@ export class UnnestNode extends ExprNode {
     this.recursive = recursive;
     this.maxDepth = maxDepth;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const recursive = this.recursive ? ', recursive := true' : '';
-    const maxDepth = this.maxDepth > 0 ? `, max_depth := ${this.maxDepth}` : '';
-    return `UNNEST(${this.expr}${recursive}${maxDepth})`;
-  }
 }

package/src/ast/verbatim.ts

@@ -17,11 +17,4 @@ export class VerbatimNode extends ExprNode {
     this.value = value;
     this.hint = hint;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return this.value;
-  }
 }