data-finder-ts 0.1.3 → 0.1.5

package/dist/datafinder/runner.d.cts

@@ -1,13 +1,22 @@
 import { Attribute } from './attribute.cjs';
-import { RelationalOperationElement, SortOperation } from '../model/relational.cjs';
+import { b as DialectName, S as SqlDialect } from '../dialect-CogGPm_y.cjs';
+import { RelationalOperationElement, SortOperation, Operation } from '../model/relational.cjs';
 
 type Row = unknown[];
+declare const DEFAULT_TIMEOUT_MS = 60000;
+/** Thrown by a QueryRunner when a query runs longer than the timeout set on its FinderResult. */
+declare class QueryTimeoutError extends Error {
+    readonly timeoutMs: number;
+    constructor(timeoutMs: number);
+}
 /** Minimum interface satisfied by both Table (SQL) and GraphQLQuery (GraphQL). */
 interface QueryTarget {
     readonly name: string;
 }
 interface QueryRunner {
-    select(businessDate: Date | null, processingDatetime: Date | null, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op: RelationalOperationElement, orderBy?: SortOperation[], groupBy?: Attribute[], limit?: number): Promise<Row[]>;
+    /** The SQL a runner that executes SQL sends: `toSql()` writes it for this dialect. Postgres when absent. */
+    readonly dialect?: DialectName | SqlDialect;
+    select(businessDate: Date | null, processingDatetime: Date | null, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op: RelationalOperationElement, orderBy?: SortOperation[], groupBy?: Attribute[], limit?: number, timeoutMs?: number, businessDateTo?: Date | null, distinct?: boolean, offset?: number, having?: Operation): Promise<Row[]>;
 }
 declare function registerRunner(runner: QueryRunner): void;
 declare function clearRunner(): void;
@@ -18,16 +27,41 @@ declare class FinderResult {
     private readonly _columns;
     private readonly _table;
     private readonly _op;
+    private readonly _businessDateTo;
     private _orderBy;
     private _groupBy;
     private _limit?;
-    constructor(_businessDate: Date | null, _processingDatetime: Date | null, _columns: (Attribute | RelationalOperationElement)[], _table: QueryTarget, _op: RelationalOperationElement);
-    orderByOp(...sorts: SortOperation[]): this;
-    groupByOp(...attrs: Attribute[]): this;
+    private _distinct;
+    private _offset?;
+    private _having?;
+    private _timeoutMs;
+    constructor(_businessDate: Date | null, _processingDatetime: Date | null, _columns: (Attribute | RelationalOperationElement)[], _table: QueryTarget, _op: RelationalOperationElement, _businessDateTo?: Date | null);
+    /**
+     * Order the rows. Calls accumulate: the sorts of the latest call take priority and earlier ones order the
+     * rows it leaves tied, as in a chain of `sortBy` calls. Sorting a column again replaces its earlier direction.
+     */
+    orderBy(...sorts: SortOperation[]): this;
+    groupBy(...attrs: Attribute[]): this;
     limit(n: number): this;
-    toSql(): string;
+    /** Skip the first `n` rows. Sort the rows first: without an order, which rows are first is not defined. */
+    offset(n: number): this;
+    /** Rows `start` up to but not including `stop`, counting from 0: `offset(start).limit(stop - start)`. */
+    slice(start: number, stop: number): this;
+    /**
+     * Keep the groups for which every condition holds: `HAVING`. A condition tests an aggregate or a grouping column:
+     * `f.findAll(null, null, [f.category(), countAll()]).groupBy(f.category()).having(countAll().gt(1))`.
+     * Calls accumulate, as `and` does.
+     */
+    having(...conditions: Operation[]): this;
+    /** Return each distinct row once: `SELECT DISTINCT`. A sort on a distinct query has to use a selected column. */
+    distinct(): this;
+    /** Abort the query and throw QueryTimeoutError if it runs longer than `milliseconds` (default 60000). */
+    timeout(milliseconds: number): this;
+    /** The query as SQL, in Postgres unless a dialect is given: `toSql('databricks')`. Nothing is run. */
+    toSql(dialect?: DialectName | SqlDialect): string;
     toRows(): Promise<Row[]>;
 }
 declare function convertInputsAndSelect(businessDate: Date | string | null, processingDatetime: Date | string | null, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op?: RelationalOperationElement): FinderResult;
+declare function convertInputsAndSelectForDateRange(businessDateFrom: Date | string, businessDateTo: Date | string, processingDatetime: Date | string, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op?: RelationalOperationElement): FinderResult;
 
-export { FinderResult, type QueryRunner, type QueryTarget, type Row, clearRunner, convertInputsAndSelect, getRunner, registerRunner };
+export { DEFAULT_TIMEOUT_MS, FinderResult, type QueryRunner, type QueryTarget, QueryTimeoutError, type Row, clearRunner, convertInputsAndSelect, convertInputsAndSelectForDateRange, getRunner, registerRunner };

package/dist/datafinder/runner.d.ts

@@ -1,13 +1,22 @@
 import { Attribute } from './attribute.js';
-import { RelationalOperationElement, SortOperation } from '../model/relational.js';
+import { b as DialectName, S as SqlDialect } from '../dialect-aaG1bDi5.js';
+import { RelationalOperationElement, SortOperation, Operation } from '../model/relational.js';
 
 type Row = unknown[];
+declare const DEFAULT_TIMEOUT_MS = 60000;
+/** Thrown by a QueryRunner when a query runs longer than the timeout set on its FinderResult. */
+declare class QueryTimeoutError extends Error {
+    readonly timeoutMs: number;
+    constructor(timeoutMs: number);
+}
 /** Minimum interface satisfied by both Table (SQL) and GraphQLQuery (GraphQL). */
 interface QueryTarget {
     readonly name: string;
 }
 interface QueryRunner {
-    select(businessDate: Date | null, processingDatetime: Date | null, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op: RelationalOperationElement, orderBy?: SortOperation[], groupBy?: Attribute[], limit?: number): Promise<Row[]>;
+    /** The SQL a runner that executes SQL sends: `toSql()` writes it for this dialect. Postgres when absent. */
+    readonly dialect?: DialectName | SqlDialect;
+    select(businessDate: Date | null, processingDatetime: Date | null, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op: RelationalOperationElement, orderBy?: SortOperation[], groupBy?: Attribute[], limit?: number, timeoutMs?: number, businessDateTo?: Date | null, distinct?: boolean, offset?: number, having?: Operation): Promise<Row[]>;
 }
 declare function registerRunner(runner: QueryRunner): void;
 declare function clearRunner(): void;
@@ -18,16 +27,41 @@ declare class FinderResult {
     private readonly _columns;
     private readonly _table;
     private readonly _op;
+    private readonly _businessDateTo;
     private _orderBy;
     private _groupBy;
     private _limit?;
-    constructor(_businessDate: Date | null, _processingDatetime: Date | null, _columns: (Attribute | RelationalOperationElement)[], _table: QueryTarget, _op: RelationalOperationElement);
-    orderByOp(...sorts: SortOperation[]): this;
-    groupByOp(...attrs: Attribute[]): this;
+    private _distinct;
+    private _offset?;
+    private _having?;
+    private _timeoutMs;
+    constructor(_businessDate: Date | null, _processingDatetime: Date | null, _columns: (Attribute | RelationalOperationElement)[], _table: QueryTarget, _op: RelationalOperationElement, _businessDateTo?: Date | null);
+    /**
+     * Order the rows. Calls accumulate: the sorts of the latest call take priority and earlier ones order the
+     * rows it leaves tied, as in a chain of `sortBy` calls. Sorting a column again replaces its earlier direction.
+     */
+    orderBy(...sorts: SortOperation[]): this;
+    groupBy(...attrs: Attribute[]): this;
     limit(n: number): this;
-    toSql(): string;
+    /** Skip the first `n` rows. Sort the rows first: without an order, which rows are first is not defined. */
+    offset(n: number): this;
+    /** Rows `start` up to but not including `stop`, counting from 0: `offset(start).limit(stop - start)`. */
+    slice(start: number, stop: number): this;
+    /**
+     * Keep the groups for which every condition holds: `HAVING`. A condition tests an aggregate or a grouping column:
+     * `f.findAll(null, null, [f.category(), countAll()]).groupBy(f.category()).having(countAll().gt(1))`.
+     * Calls accumulate, as `and` does.
+     */
+    having(...conditions: Operation[]): this;
+    /** Return each distinct row once: `SELECT DISTINCT`. A sort on a distinct query has to use a selected column. */
+    distinct(): this;
+    /** Abort the query and throw QueryTimeoutError if it runs longer than `milliseconds` (default 60000). */
+    timeout(milliseconds: number): this;
+    /** The query as SQL, in Postgres unless a dialect is given: `toSql('databricks')`. Nothing is run. */
+    toSql(dialect?: DialectName | SqlDialect): string;
     toRows(): Promise<Row[]>;
 }
 declare function convertInputsAndSelect(businessDate: Date | string | null, processingDatetime: Date | string | null, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op?: RelationalOperationElement): FinderResult;
+declare function convertInputsAndSelectForDateRange(businessDateFrom: Date | string, businessDateTo: Date | string, processingDatetime: Date | string, columns: (Attribute | RelationalOperationElement)[], table: QueryTarget, op?: RelationalOperationElement): FinderResult;
 
-export { FinderResult, type QueryRunner, type QueryTarget, type Row, clearRunner, convertInputsAndSelect, getRunner, registerRunner };
+export { DEFAULT_TIMEOUT_MS, FinderResult, type QueryRunner, type QueryTarget, QueryTimeoutError, type Row, clearRunner, convertInputsAndSelect, convertInputsAndSelectForDateRange, getRunner, registerRunner };

package/dist/datafinder/runner.js

@@ -1,19 +1,25 @@
 import {
+  DEFAULT_TIMEOUT_MS,
   FinderResult,
+  QueryTimeoutError,
   clearRunner,
   convertInputsAndSelect,
+  convertInputsAndSelectForDateRange,
   getRunner,
   registerRunner
-} from "../chunk-6QTCGJWX.js";
-import "../chunk-DFYZVBII.js";
-import "../chunk-EYXBYV2X.js";
-import "../chunk-5K2Z3YDY.js";
-import "../chunk-V647VNMY.js";
-import "../chunk-3SSWFES4.js";
+} from "../chunk-KAK75RVS.js";
+import "../chunk-BKPWV3OF.js";
+import "../chunk-GPHWC533.js";
+import "../chunk-MGEL5RWM.js";
+import "../chunk-BGEX377Q.js";
+import "../chunk-PF6EJZHB.js";
 export {
+  DEFAULT_TIMEOUT_MS,
   FinderResult,
+  QueryTimeoutError,
   clearRunner,
   convertInputsAndSelect,
+  convertInputsAndSelectForDateRange,
   getRunner,
   registerRunner
 };