@uwdata/mosaic-sql 0.18.0 → 0.20.0

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';
@@ -71,6 +71,14 @@ export class Query extends ExprNode {
     return new SetOperation('UNION', queries.flat());
   }
 
+  /**
+   * Create a new UNION BY NAME set operation over the given queries.
+   * @param queries The queries.
+   */
+  static unionByName(...queries: MaybeArray<Query>[]) {
+    return new SetOperation('UNION BY NAME', queries.flat());
+  }
+
   /**
    * Create a new UNION ALL set operation over the given queries.
    * @param queries The queries.
@@ -79,6 +87,14 @@ export class Query extends ExprNode {
     return new SetOperation('UNION ALL', queries.flat());
   }
 
+  /**
+   * Create a new UNION ALL BY NAME set operation over the given queries.
+   * @param queries The queries.
+   */
+  static unionAllByName(...queries: MaybeArray<Query>[]) {
+    return new SetOperation('UNION ALL BY NAME', queries.flat());
+  }
+
   /**
    * Create a new INTERSECT set operation over the given queries.
    * @param queries The queries.
@@ -87,6 +103,14 @@ export class Query extends ExprNode {
     return new SetOperation('INTERSECT', queries.flat());
   }
 
+  /**
+   * Create a new INTERSECT ALL set operation over the given queries.
+   * @param queries The queries.
+   */
+  static intersectAll(...queries: MaybeArray<Query>[]) {
+    return new SetOperation('INTERSECT ALL', queries.flat());
+  }
+
   /**
    * Create a new EXCEPT set operation over the given queries.
    * @param queries The queries.
@@ -95,6 +119,14 @@ export class Query extends ExprNode {
     return new SetOperation('EXCEPT', queries.flat());
   }
 
+  /**
+   * Create a new EXCEPT ALL set operation over the given queries.
+   * @param queries The queries.
+   */
+  static exceptAll(...queries: MaybeArray<Query>[]) {
+    return new SetOperation('EXCEPT ALL', queries.flat());
+  }
+
   /**
    * Create a new describe query for the given input query.
    * @param query The query to describe.
@@ -199,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[] = [];
@@ -229,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;
@@ -298,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)));
@@ -306,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);
@@ -334,7 +370,7 @@ export class SelectQuery extends Query {
    * @param seed The random seed.
    */
   sample(
-    value: number | SampleClauseNode,
+    value?: number | SampleClauseNode | null,
     method?: SampleMethod,
     seed?: number
   ): this {
@@ -346,7 +382,7 @@ export class SelectQuery extends Query {
     } else {
       clause = value;
     }
-    this._sample = clause;
+    this._sample = clause ?? undefined;
     return this;
   }
 
@@ -418,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 {
@@ -499,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 {
@@ -550,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 {
@@ -613,6 +557,14 @@ class WithClause {
     return Query.union(...queries).with(...this._with);
   }
 
+  /**
+   * Create a new UNION BY NAME set operation over the given queries.
+   * @param queries The queries.
+   */
+  unionByName(...queries: Query[]) {
+    return Query.unionByName(...queries).with(...this._with);
+  }
+
   /**
    * Create a new UNION ALL set operation over the given queries.
    * @param queries The queries.
@@ -621,6 +573,14 @@ class WithClause {
     return Query.unionAll(...queries).with(...this._with);
   }
 
+  /**
+   * Create a new UNION ALL BY NAME set operation over the given queries.
+   * @param queries The queries.
+   */
+  unionAllByName(...queries: Query[]) {
+    return Query.unionAllByName(...queries).with(...this._with);
+  }
+
   /**
    * Create a new INTERSECT set operation over the given queries.
    * @param queries The queries.
@@ -629,6 +589,14 @@ class WithClause {
     return Query.intersect(...queries).with(...this._with);
   }
 
+  /**
+   * Create a new INTERSECT ALL set operation over the given queries.
+   * @param queries The queries.
+   */
+  intersectAll(...queries: Query[]) {
+    return Query.intersectAll(...queries).with(...this._with);
+  }
+
   /**
    * Create a new EXCEPT set operation over the given queries.
    * @param queries The queries.
@@ -636,4 +604,12 @@ class WithClause {
   except(...queries: Query[]) {
     return Query.except(...queries).with(...this._with);
   }
+
+  /**
+   * Create a new EXCEPT ALL set operation over the given queries.
+   * @param queries The queries.
+   */
+  exceptAll(...queries: Query[]) {
+    return Query.exceptAll(...queries).with(...this._with);
+  }
 }

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

@@ -0,0 +1,22 @@
+import { UNNEST } from '../constants.js';
+import { ExprNode } from './node.js';
+
+export class UnnestNode extends ExprNode {
+  /** An expression that resolves to a list or a struct */
+  readonly expr: ExprNode;
+  readonly recursive: boolean;
+  readonly maxDepth: number;
+
+  /**
+   * Instantiate an Unnest node.
+   * @param expr
+   * @param recursive
+   * @param maxDepth
+   */
+  constructor(expr: ExprNode, recursive = false, maxDepth = 0) {
+    super(UNNEST);
+    this.expr = expr;
+    this.recursive = recursive;
+    this.maxDepth = 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;
-  }
 }

package/src/ast/window-frame.ts

@@ -1,7 +1,7 @@
 import { WINDOW_EXTENT_EXPR, WINDOW_FRAME } from '../constants.js';
 import { type ParamLike } from '../types.js';
 import { isParamLike } from '../util/type-check.js';
-import { type ExprNode, isNode, SQLNode } from './node.js';
+import { type ExprNode, SQLNode } from './node.js';
 import { ParamNode } from './param.js';
 
 export type FrameValue =  ExprNode | number | null;
@@ -42,27 +42,6 @@ export class WindowFrameNode extends SQLNode {
     this.extent = isParamLike(extent) ? new ParamNode(extent) : extent;
     this.exclude = exclude;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { frameType, exclude, extent } = this;
-    const [prev, next] = isNode(extent)
-      ? extent.value as [unknown, unknown]
-      : extent;
-    const a = asFrameExpr(prev, PRECEDING);
-    const b = asFrameExpr(next, FOLLOWING);
-    return `${frameType} BETWEEN ${a} AND ${b}${exclude ? ` ${exclude}` : ''}`;
-  }
-}
-
-function asFrameExpr(value: unknown, scope: string) {
-  return value instanceof WindowFrameExprNode ? value
-    : value != null && typeof value !== 'number' ? `${value} ${scope}`
-    : value === 0 ? CURRENT_ROW
-    : !(value && Number.isFinite(value)) ? `${UNBOUNDED} ${scope}`
-    : `${Math.abs(value)} ${scope}`;
 }
 
 export class WindowFrameExprNode extends SQLNode {
@@ -84,14 +63,4 @@ export class WindowFrameExprNode extends SQLNode {
     this.scope = scope;
     this.expr = expr;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { scope, expr } = this;
-    return scope === CURRENT_ROW
-      ? scope
-      : `${expr ?? UNBOUNDED} ${scope}`;
-  }
 }

package/src/ast/window.ts

@@ -3,7 +3,6 @@ import type { AggregateNode } from './aggregate.js';
 import type { WindowFrameNode } from './window-frame.js';
 import { WINDOW, WINDOW_CLAUSE, WINDOW_DEF, WINDOW_FUNCTION } from '../constants.js';
 import { nodeList } from '../util/function.js';
-import { quoteIdentifier } from '../util/string.js';
 import { ExprNode, SQLNode } from './node.js';
 
 export class WindowClauseNode extends SQLNode {
@@ -22,13 +21,6 @@ export class WindowClauseNode extends SQLNode {
     this.name = name;
     this.def = def;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `${quoteIdentifier(this.name)} AS ${this.def}`;
-  }
 }
 
 export class WindowNode extends ExprNode {
@@ -84,13 +76,6 @@ export class WindowNode extends ExprNode {
   frame(framedef: WindowFrameNode) {
     return new WindowNode(this.func, this.def.frame(framedef));
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    return `${this.func} OVER ${this.def}`;
-  }
 }
 
 export class WindowFunctionNode extends ExprNode {
@@ -123,19 +108,6 @@ export class WindowFunctionNode extends ExprNode {
     this.ignoreNulls = ignoreNulls;
     this.order = nodeList([argOrder]);
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { name, args, ignoreNulls, order } = this;
-    const arg = [
-      args.join(', '),
-      order.length ? `ORDER BY ${order.join(', ')}` : '',
-      ignoreNulls ? 'IGNORE NULLS' : ''
-    ].filter(x => x).join(' ');
-    return `${name}(${arg})`;
-  }
 }
 
 export class WindowDefNode extends SQLNode {
@@ -203,21 +175,6 @@ export class WindowDefNode extends SQLNode {
   frame(framedef: WindowFrameNode) {
     return deriveDef(this, { framedef });
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const { name, partition, order, framedef } = this;
-    const base = name && quoteIdentifier(name);
-    const def = [
-      base,
-      partition?.length && `PARTITION BY ${partition.join(', ')}`,
-      order?.length && `ORDER BY ${order.join(', ')}`,
-      framedef
-    ].filter(x => x);
-    return base && def.length < 2 ? base : `(${def.join(' ')})`;
-  }
 }
 
 interface DeriveDefOptions {

package/src/ast/with.ts

@@ -29,15 +29,4 @@ export class WithClauseNode extends SQLNode {
     this.query = query;
     this.materialized = materialized;
   }
-
-  /**
-   * Generate a SQL query string for this node.
-   */
-  toString() {
-    const flag = this.materialized;
-    const mat = flag === true ? ' MATERIALIZED'
-      : flag === false ? ' NOT MATERIALIZED'
-      : '';
-    return `"${this.name}" AS${mat} (${this.query})`;
-  }
 }

package/src/constants.ts

@@ -3,6 +3,8 @@ export const COLUMN_PARAM = 'COLUMN_PARAM';
 export const TABLE_REF = 'TABLE_REF';
 export const LITERAL = 'LITERAL';
 export const INTERVAL = 'INTERVAL';
+export const LIST = 'LIST';
+export const UNNEST = 'UNNEST';
 
 export const ORDER_BY = 'ORDER_BY';
 export const CAST = 'CAST';
@@ -25,6 +27,7 @@ export const WINDOW_FUNCTION = 'WINDOW_FUNCTION';
 export const WINDOW_DEF = 'WINDOW_DEF';
 export const WINDOW_FRAME = 'WINDOW_FRAME';
 export const WINDOW_EXTENT_EXPR = 'WINDOW_EXTENT_EXPR';
+export const CUSTOM = 'CUSTOM';
 
 export const EXPRESSION = 'EXPRESSION';
 export const FRAGMENT = 'FRAGMENT';
@@ -35,6 +38,7 @@ export const WITH_CLAUSE = 'WITH_CLAUSE';
 export const WINDOW_CLAUSE = 'WINDOW_CLAUSE';
 export const SELECT_CLAUSE = 'SELECT_CLAUSE';
 export const FROM_CLAUSE = 'FROM_CLAUSE';
+export const JOIN_CLAUSE = 'JOIN_CLAUSE';
 export const SAMPLE_CLAUSE = 'SAMPLE_CLAUSE';
 
 export const SELECT_QUERY = 'SELECT_QUERY';

package/src/functions/from.ts

@@ -0,0 +1,18 @@
+import { FromClauseNode } from "../ast/from.js";
+import { SampleClauseNode } from "../ast/sample.js";
+import { TableRefNode } from "../ast/table-ref.js";
+import { asTableRef } from "../util/ast.js";
+
+/**
+ * Create a new table FROM reference, applicable in a query or join.
+ * @param table The table.
+ * @param alias An optional table alias.
+ * @param sample An optional table sample to apply.
+ */
+export function from(
+  table: string | string[] | TableRefNode,
+  alias?: string,
+  sample?: SampleClauseNode
+) {
+  return new FromClauseNode(asTableRef(table)!, alias, sample);
+}