@malloydata/malloy 0.0.304 → 0.0.305

package/dist/model/malloy_query.d.ts

@@ -1,391 +0,0 @@
-import type * as Malloy from '@malloydata/malloy-interfaces';
-import type { QueryInfo, Dialect, DialectFieldList } from '../dialect';
-import type { AggregateFunctionType, CompiledQuery, Expr, FieldDef, Filtered, FunctionOverloadDef, FunctionParameterDef, JoinRelationship, ModelDef, OrderBy, OutputFieldNode, ParameterNode, PipeSegment, Query, QueryFieldDef, QuerySegment, RefToField, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SegmentFieldDef, StructDef, StructRef, TurtleDef, FunctionOrderBy, Argument, AggregateExpr, FilterCondition, GenericSQLExpr, FieldnameNode, FunctionCallNode, UngroupNode, SourceReferenceNode, SpreadExpr, FilteredExpr, SourceDef, BooleanFieldDef, QueryResultDef, QueryToMaterialize, PrepareResultOptions, CaseExpr, BasicAtomicDef, AtomicFieldDef, FilterMatchExpr } from './malloy_types';
-import type { Connection } from '../connection/types';
-import { AndChain } from './utils';
-import type { EventStream } from '../runtime_types';
-import type { Tag } from '@malloydata/malloy-tag';
-interface TurtleDefPlus extends TurtleDef, Filtered {
-}
-/** Parent from QueryStruct. */
-export declare interface ParentQueryStruct {
-    struct: QueryStruct;
-}
-/** Parent from QueryModel. */
-export declare interface ParentQueryModel {
-    model: QueryModel;
-}
-interface OutputPipelinedSQL {
-    sqlFieldName: string;
-    pipelineSQL: string;
-}
-type UniqueKeyPossibleUse = AggregateFunctionType | 'generic_asymmetric_aggregate';
-declare class UniqueKeyUse extends Set<UniqueKeyPossibleUse> {
-    add_use(k: UniqueKeyPossibleUse | undefined): this | undefined;
-    hasAsymetricFunctions(): boolean;
-}
-declare class StageWriter {
-    parent: StageWriter | undefined;
-    withs: string[];
-    udfs: string[];
-    pdts: string[];
-    dependenciesToMaterialize: Record<string, QueryToMaterialize>;
-    stagePrefix: string;
-    useCTE: boolean;
-    constructor(useCTE: boolean | undefined, parent: StageWriter | undefined);
-    getName(id: number): string;
-    root(): StageWriter;
-    addStage(sql: string): string;
-    addUDF(stageWriter: StageWriter, dialect: Dialect, structDef: StructDef): string;
-    addMaterializedQuery(fieldName: string, query: Query, materializatedTablePrefix?: string): string;
-    addPDT(baseName: string, dialect: Dialect): string;
-    combineStages(includeLastStage: boolean): {
-        sql: string;
-        lastStageName: string | undefined;
-    };
-    /** emit the SQL for all the stages.  */
-    generateSQLStages(): string;
-    generateCoorelatedSubQuery(dialect: Dialect, structDef: StructDef): string;
-}
-declare class GenerateState {
-    whereSQL?: string;
-    applyValue?: string;
-    totalGroupSet: number;
-    withWhere(s?: string): GenerateState;
-    withApply(s: string): GenerateState;
-    withTotal(groupSet: number): GenerateState;
-}
-declare abstract class QueryNode {
-    readonly referenceId: string;
-    constructor(referenceId?: string);
-    abstract getIdentifier(): string;
-    getChildByName(_name: string): QueryField | undefined;
-}
-declare class QueryField extends QueryNode {
-    fieldDef: FieldDef;
-    parent: QueryStruct;
-    constructor(fieldDef: FieldDef, parent: QueryStruct, referenceId?: string);
-    getIdentifier(): string;
-    uniqueKeyPossibleUse(): UniqueKeyPossibleUse | undefined;
-    getJoinableParent(): QueryStruct;
-    isAtomic(): boolean;
-    caseGroup(groupSets: number[], s: string): string;
-    getFullOutputName(): string;
-    generateFieldFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: FieldnameNode, state: GenerateState): string;
-    generateOutputFieldFragment(resultSet: FieldInstanceResult, _context: QueryStruct, frag: OutputFieldNode, _state: GenerateState): string;
-    stringsFromSQLExpression(resultSet: FieldInstanceResult, context: QueryStruct, e: GenericSQLExpr, state: GenerateState): Generator<string, void, unknown>;
-    private getParameterMap;
-    private expandFunctionCall;
-    getFunctionOrderBy(resultSet: FieldInstanceResult, context: QueryStruct, state: GenerateState, orderBy: FunctionOrderBy[], args: Expr[], overload: FunctionOverloadDef): string | undefined;
-    generateAsymmetricStringAggExpression(resultSet: FieldInstanceResult, context: QueryStruct, value: Expr, separator: Expr | undefined, distinctKey: string, orderBy: FunctionOrderBy[] | undefined, dialectName: string, state: GenerateState): string;
-    getParamForArgIndex(params: FunctionParameterDef[], argIndex: number): FunctionParameterDef;
-    generateFunctionCallExpression(resultSet: FieldInstanceResult, context: QueryStruct, frag: FunctionCallNode, state: GenerateState): string;
-    generateSpread(_resultSet: FieldInstanceResult, _context: QueryStruct, _frag: SpreadExpr, _state: GenerateState): string;
-    generateParameterFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: ParameterNode, state: GenerateState): string;
-    generateFilterFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: FilteredExpr, state: GenerateState): string;
-    generateDimFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: Expr, state: GenerateState): string;
-    generateUngroupedFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: UngroupNode, state: GenerateState): string;
-    generateDistinctKeyIfNecessary(resultSet: FieldInstanceResult, context: QueryStruct, structPath: string[] | undefined): string | undefined;
-    generateSumFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateExpr, state: GenerateState): string;
-    generateSymmetricFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateExpr, state: GenerateState): string;
-    generateAvgFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateExpr, state: GenerateState): string;
-    generateCountFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateExpr, state: GenerateState): string;
-    generateSourceReference(resultSet: FieldInstanceResult, context: QueryStruct, expr: SourceReferenceNode): string;
-    getAnalyticPartitions(resultStruct: FieldInstanceResult, extraPartitionFields?: string[]): string[];
-    generateAnalyticFragment(dialect: string, resultStruct: FieldInstanceResult, context: QueryStruct, expr: Expr, overload: FunctionOverloadDef, state: GenerateState, args: Expr[], partitionByFields?: string[], funcOrdering?: string): string;
-    generateCaseSQL(pf: CaseExpr): string;
-    exprToSQL(resultSet: FieldInstanceResult, context: QueryStruct, exprToTranslate: Expr, state?: GenerateState): string;
-    generateAppliedFilter(context: QueryStruct, filterMatchExpr: FilterMatchExpr): string;
-    isNestedInParent(parentDef: FieldDef): boolean;
-    isArrayElement(parentDef: FieldDef): boolean;
-    generateExpression(resultSet: FieldInstanceResult): string;
-    includeInWildcard(): boolean;
-}
-type QueryBasicField = QueryAtomicField<BasicAtomicDef>;
-declare abstract class QueryAtomicField<T extends AtomicFieldDef> extends QueryField {
-    fieldDef: T;
-    constructor(fieldDef: T, parent: QueryStruct, refId?: string);
-    includeInWildcard(): boolean;
-    getFilterList(): FilterCondition[];
-}
-declare class QueryFieldBoolean extends QueryAtomicField<BooleanFieldDef> {
-}
-type FieldUsage = {
-    type: 'result';
-    resultIndex: number;
-} | {
-    type: 'where';
-} | {
-    type: 'dependant';
-};
-type FieldInstanceType = 'field' | 'query';
-interface FieldInstance {
-    type: FieldInstanceType;
-    root(): FieldInstanceResultRoot;
-}
-declare class FieldInstanceField implements FieldInstance {
-    f: QueryField;
-    fieldUsage: FieldUsage;
-    parent: FieldInstanceResult;
-    readonly drillExpression: Malloy.Expression | undefined;
-    type: FieldInstanceType;
-    additionalGroupSets: number[];
-    analyticalSQL: string | undefined;
-    partitionSQL: string | undefined;
-    constructor(f: QueryField, fieldUsage: FieldUsage, parent: FieldInstanceResult, drillExpression: Malloy.Expression | undefined);
-    root(): FieldInstanceResultRoot;
-    getSQL(): string;
-    getAnalyticalSQL(forPartition: boolean): string;
-}
-type RepeatedResultType = 'nested' | 'inline_all_numbers' | 'inline';
-type UngroupSet = {
-    type: 'all' | 'exclude';
-    fields: string[];
-    groupSet: number;
-};
-declare class FieldInstanceResult implements FieldInstance {
-    turtleDef: TurtleDef;
-    parent: FieldInstanceResult | undefined;
-    type: FieldInstanceType;
-    allFields: Map<string, FieldInstance>;
-    groupSet: number;
-    depth: number;
-    childGroups: number[];
-    firstSegment: PipeSegment;
-    hasHaving: boolean;
-    ungroupedSets: Map<string, UngroupSet>;
-    resultUsesUngrouped: boolean;
-    constructor(turtleDef: TurtleDef, parent: FieldInstanceResult | undefined);
-    /**
-     * Information about the query containing this result set. Invented
-     * to pass on timezone information, but maybe more things will
-     * eventually go in here.
-     * @returns QueryInfo
-     */
-    getQueryInfo(): QueryInfo;
-    addField(as: string, field: QueryField, usage: FieldUsage, drillExpression: Malloy.Expression | undefined): void;
-    parentGroupSet(): number;
-    add(name: string, f: FieldInstance): void;
-    hasField(name: string): boolean;
-    getField(name: string): FieldInstanceField;
-    getFieldByNumber(index: number): {
-        name: string;
-        fif: FieldInstanceField;
-    };
-    computeGroups(nextGroupSetNumber: number, depth: number): {
-        nextGroupSetNumber: number;
-        maxDepth: number;
-        children: number[];
-        isComplex: boolean;
-    };
-    fields(fn?: undefined | ((field: FieldInstanceField) => boolean)): FieldInstanceField[];
-    fieldNames(fn: undefined | ((field: FieldInstanceField) => boolean)): string[];
-    getRepeatedResultType(): RepeatedResultType;
-    structs(): FieldInstanceResult[];
-    selectStructs(result: FieldInstanceResult[], fn: (result: FieldInstanceResult) => boolean): FieldInstanceResult[];
-    calculateDefaultOrderBy(): OrderBy[];
-    addStructToJoin(qs: QueryStruct, query: QueryQuery, uniqueKeyPossibleUse: UniqueKeyPossibleUse | undefined, joinStack: string[]): void;
-    findJoins(query: QueryQuery): void;
-    root(): FieldInstanceResultRoot;
-    getUngroupPartitions(ungroupSet: UngroupSet | undefined): FieldInstanceField[];
-    assignFieldsToGroups(): void;
-}
-declare class FieldInstanceResultRoot extends FieldInstanceResult {
-    joins: Map<string, JoinInstance>;
-    havings: AndChain;
-    isComplexQuery: boolean;
-    queryUsesPartitioning: boolean;
-    computeOnlyGroups: number[];
-    elimatedComputeGroups: boolean;
-    constructor(turtleDef: TurtleDef);
-    root(): FieldInstanceResultRoot;
-    eliminateComputeGroupsSQL(): string;
-    calculateSymmetricAggregates(): void;
-}
-declare class JoinInstance {
-    queryStruct: QueryStruct;
-    alias: string;
-    parent: JoinInstance | undefined;
-    uniqueKeyPossibleUses: UniqueKeyUse;
-    makeUniqueKey: boolean;
-    leafiest: boolean;
-    joinFilterConditions?: QueryFieldBoolean[];
-    children: JoinInstance[];
-    constructor(queryStruct: QueryStruct, alias: string, parent: JoinInstance | undefined);
-    parentRelationship(): 'root' | JoinRelationship;
-    forceAllSymmetricCalculations(): boolean;
-    getDialectFieldList(): DialectFieldList;
-}
-/**
- * Used by the translator to get the output StructDef of a pipe segment
- *
- * half translated to the new world of types ..
- */
-export declare class Segment {
-    static nextStructDef(structDef: SourceDef, segment: PipeSegment): QueryResultDef;
-}
-export declare function getResultStructDefForView(source: SourceDef, view: TurtleDef): SourceDef;
-export declare function getResultStructDefForQuery(model: ModelDef, query: Query): SourceDef;
-type StageGroupMaping = {
-    fromGroup: number;
-    toGroup: number;
-};
-type StageOutputContext = {
-    sql: string[];
-    lateralJoinSQLExpressions: string[];
-    dimensionIndexes: number[];
-    fieldIndex: number;
-    groupsAggregated: StageGroupMaping[];
-    outputPipelinedSQL: OutputPipelinedSQL[];
-};
-/** Query builder object. */
-declare class QueryQuery extends QueryField {
-    fieldDef: TurtleDef;
-    firstSegment: PipeSegment;
-    prepared: boolean;
-    maxDepth: number;
-    maxGroupSet: number;
-    rootResult: FieldInstanceResultRoot;
-    resultStage: string | undefined;
-    stageWriter: StageWriter | undefined;
-    isJoinedSubquery: boolean;
-    constructor(fieldDef: TurtleDef, parent: QueryStruct, stageWriter: StageWriter | undefined, isJoinedSubquery: boolean);
-    static makeQuery(fieldDef: TurtleDef, parentStruct: QueryStruct, stageWriter: StageWriter | undefined, isJoinedSubquery: boolean): QueryQuery;
-    inNestedPipeline(): boolean;
-    expandField(f: QueryFieldDef): {
-        as: string;
-        field: QueryField;
-    };
-    addDependantPath(resultStruct: FieldInstanceResult, context: QueryStruct, path: string[], uniqueKeyPossibleUse: UniqueKeyPossibleUse | undefined, joinStack: string[]): void;
-    findRecordAliases(context: QueryStruct, path: string[]): void;
-    addDependantExpr(resultStruct: FieldInstanceResult, context: QueryStruct, e: Expr, joinStack: string[]): void;
-    addDependancies(resultStruct: FieldInstanceResult, field: QueryField): void;
-    getSegmentFields(resultStruct: FieldInstanceResult): SegmentFieldDef[];
-    private getDrillExpression;
-    expandFields(resultStruct: FieldInstanceResult): void;
-    expandFilters(resultStruct: FieldInstanceResult): void;
-    generateSQLFilters(resultStruct: FieldInstanceResult, which: 'where' | 'having'): AndChain;
-    prepare(_stageWriter: StageWriter | undefined): void;
-    addAlwaysJoins(rootResult: FieldInstanceResultRoot): void;
-    getResultMetadata(fi: FieldInstance): ResultStructMetadataDef | ResultMetadataDef | undefined;
-    /**  returns a fields and primary key of a struct for this query */
-    getResultStructDef(resultStruct?: FieldInstanceResult, isRoot?: boolean): QueryResultDef;
-    generateSQLJoinBlock(stageWriter: StageWriter, ji: JoinInstance, depth: number): string;
-    generateSQLPassthroughKeys(qs: QueryStruct): string;
-    generateSQLJoins(stageWriter: StageWriter): string;
-    genereateSQLOrderBy(queryDef: QuerySegment, resultStruct: FieldInstanceResult): string;
-    generateSimpleSQL(stageWriter: StageWriter): string;
-    generatePipelinedStages(outputPipelinedSQL: OutputPipelinedSQL[], lastStageName: string, stageWriter: StageWriter): string;
-    generateStage0Fields(resultSet: FieldInstanceResult, output: StageOutputContext, stageWriter: StageWriter): void;
-    generateSQLWhereChildren(resultStruct: FieldInstanceResult): AndChain;
-    generateSQLWhereTurtled(): string;
-    generateSQLHavingLimit(stageWriter: StageWriter, lastStageName: string): string;
-    generateSQLStage0(stageWriter: StageWriter): string;
-    generateDepthNFields(depth: number, resultSet: FieldInstanceResult, output: StageOutputContext, stageWriter: StageWriter): void;
-    generateSQLDepthN(depth: number, stageWriter: StageWriter, stageName: string): string;
-    genereateSQLCombineTurtles(stageWriter: StageWriter, stage0Name: string): string;
-    buildDialectFieldList(resultStruct: FieldInstanceResult): DialectFieldList;
-    generateTurtleSQL(resultStruct: FieldInstanceResult, stageWriter: StageWriter, sqlFieldName: string, outputPipelinedSQL: OutputPipelinedSQL[]): string;
-    generateTurtlePipelineSQL(fi: FieldInstanceResult, stageWriter: StageWriter, sourceSQLExpression: string): {
-        structDef: QueryResultDef;
-        pipeOut: any;
-        repeatedResultType: RepeatedResultType;
-    };
-    generateComplexSQL(stageWriter: StageWriter): string;
-    generateSQL(stageWriter: StageWriter): string;
-    generateSQLFromPipeline(stageWriter: StageWriter): {
-        lastStageName: string;
-        outputStruct: QueryResultDef;
-    };
-}
-/** Structure object as it is used to build a query */
-declare class QueryStruct {
-    structDef: StructDef;
-    readonly sourceArguments: Record<string, Argument> | undefined;
-    readonly prepareResultOptions: PrepareResultOptions;
-    parent: QueryStruct | undefined;
-    model: QueryModel;
-    nameMap: Map<string, QueryField>;
-    pathAliasMap: Map<string, string>;
-    dialect: Dialect;
-    connectionName: string;
-    recordAlias?: string;
-    constructor(structDef: StructDef, sourceArguments: Record<string, Argument> | undefined, parent: ParentQueryStruct | ParentQueryModel, prepareResultOptions: PrepareResultOptions);
-    private _modelTag;
-    modelCompilerFlags(): Tag;
-    protected findFirstDialect(): string;
-    informOfAliasValue(av: string): void;
-    maybeEmitParameterizedSourceUsage(): void;
-    private resolveParentParameterReferences;
-    private _arguments;
-    arguments(): Record<string, Argument>;
-    private addFieldsFromFieldList;
-    getAliasIdentifier(): string;
-    getSQLIdentifier(): string;
-    sqlChildReference(name: string, expand: {
-        result: FieldInstanceResult;
-        field: QueryField;
-    } | undefined): string;
-    getIdentifier(): string;
-    getFullOutputName(): string;
-    needsSymetricCalculation(resultSet: FieldInstanceResult): boolean;
-    unnestWithNumbers(): boolean;
-    getJoinableParent(): QueryStruct;
-    addFieldToNameMap(as: string, n: QueryField): void;
-    /** the the primary key or throw an error. */
-    getPrimaryKeyField(fieldDef: FieldDef): QueryBasicField;
-    /**
-     * called after all structure has been loaded.  Examine this structure to see
-     * if if it is based on a query and if it is, add the output fields (unless
-     * they exist) to the structure.
-     */
-    resolveQueryFields(): void;
-    getModel(): QueryModel;
-    get eventStream(): EventStream | undefined;
-    setParent(parent: ParentQueryStruct | ParentQueryModel): void;
-    /** makes a new queryable field object from a fieldDef */
-    makeQueryField(field: FieldDef, referenceId?: string): QueryField;
-    structSourceSQL(stageWriter: StageWriter): string;
-    root(): QueryStruct;
-    primaryKey(): QueryBasicField | undefined;
-    getChildByName(name: string): QueryField | undefined;
-    /** convert a path into a field reference */
-    getFieldByName(path: string[]): QueryField;
-    getQueryFieldByName(name: string[]): QueryField;
-    getQueryFieldReference(f: RefToField): QueryField;
-    getDimensionOrMeasureByName(name: string[]): QueryField;
-    /** returns a query object for the given name */
-    getDimensionByName(name: string[]): QueryBasicField;
-    /** returns a query object for the given name */
-    getStructByName(name: string[]): QueryStruct;
-    getDistinctKey(): QueryBasicField;
-    applyStructFiltersToTurtleDef(turtleDef: TurtleDef | TurtleDefPlus): TurtleDef;
-}
-/** the resulting SQL and the shape of the data at each stage of the pipeline */
-interface QueryResults {
-    lastStageName: string;
-    stageWriter: StageWriter;
-    structs: SourceDef[];
-    malloy: string;
-    connectionName: string;
-}
-/** start here */
-export declare class QueryModel {
-    readonly eventStream?: EventStream | undefined;
-    dialect: Dialect;
-    modelDef: ModelDef | undefined;
-    structs: Map<string, QueryStruct>;
-    constructor(modelDef: ModelDef | undefined, eventStream?: EventStream | undefined);
-    loadModelFromDef(modelDef: ModelDef): void;
-    getStructByName(name: string): QueryStruct;
-    getStructFromRef(structRef: StructRef, sourceArguments: Record<string, Argument> | undefined, prepareResultOptions?: PrepareResultOptions): QueryStruct;
-    loadQuery(query: Query, stageWriter: StageWriter | undefined, prepareResultOptions?: PrepareResultOptions, emitFinalStage?: boolean, isJoinedSubquery?: boolean): QueryResults;
-    addDefaultRowLimit(query: Query, defaultRowLimit?: number): {
-        query: Query;
-        addedDefaultRowLimit?: number;
-    };
-    compileQuery(query: Query, prepareResultOptions?: PrepareResultOptions, finalize?: boolean): CompiledQuery;
-    exploreSearchSQLMap: Map<any, any>;
-    searchIndex(connection: Connection, explore: string, searchValue: string, limit?: number, searchField?: string | undefined): Promise<SearchIndexResult[] | undefined>;
-}
-export {};