@malloydata/malloy 0.0.195-dev241003204905 → 0.0.195-dev241007154000

package/dist/model/malloy_query.d.ts

@@ -1,5 +1,5 @@
 import { Dialect, DialectFieldList } from '../dialect';
-import { AggregateFunctionType, Annotation, CompiledQuery, Expr, FieldDef, Filtered, FunctionOverloadDef, FunctionParameterDef, JoinRelationship, ModelDef, OrderBy, OutputFieldNode, Parameter, ParameterNode, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SegmentFieldDef, StructDef, StructRef, TurtleDef, FunctionOrderBy, Argument, AggregateExpr, FilterCondition, GenericSQLExpr, FieldnameNode, FunctionCallNode, UngroupNode, SourceReferenceNode, PickExpr, SpreadExpr, FilteredExpr, QueryToMaterialize, PrepareResultOptions } from './malloy_types';
+import { AggregateFunctionType, Annotation, CompiledQuery, Expr, FieldDef, Filtered, FunctionOverloadDef, FunctionParameterDef, JoinRelationship, ModelDef, OrderBy, OutputFieldNode, Parameter, ParameterNode, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SegmentFieldDef, StructDef, StructRef, TurtleDef, FunctionOrderBy, Argument, AggregateExpr, FilterCondition, GenericSQLExpr, FieldnameNode, FunctionCallNode, UngroupNode, SourceReferenceNode, PickExpr, SpreadExpr, FilteredExpr, SourceDef, AtomicFieldDef, BooleanFieldDef, QueryToMaterialize, PrepareResultOptions } from './malloy_types';
 import { Connection } from '../connection/types';
 import { AndChain } from './utils';
 import { QueryInfo } from '../dialect/dialect';
@@ -56,16 +56,16 @@ declare class GenerateState {
     withTotal(groupSet: number): GenerateState;
 }
 declare abstract class QueryNode {
-    fieldDef: FieldDef;
-    constructor(fieldDef: FieldDef);
-    getIdentifier(): string;
+    readonly referenceId: string;
+    constructor(referenceId?: string);
+    abstract getIdentifier(): string;
     getChildByName(_name: string): QuerySomething | undefined;
 }
 declare class QueryField extends QueryNode {
     fieldDef: FieldDef;
     parent: QueryStruct;
-    readonly referenceId: string;
     constructor(fieldDef: FieldDef, parent: QueryStruct, referenceId?: string);
+    getIdentifier(): string;
     uniqueKeyPossibleUse(): UniqueKeyPossibleUse | undefined;
     getJoinableParent(): QueryStruct;
     caseGroup(groupSets: number[], s: string): string;
@@ -94,17 +94,21 @@ declare class QueryField extends QueryNode {
     generateAnalyticFragment(dialect: string, resultStruct: FieldInstanceResult, context: QueryStruct, expr: Expr, overload: FunctionOverloadDef, state: GenerateState, args: Expr[], partitionByFields?: string[], funcOrdering?: string): string;
     generatePickSQL(pf: PickExpr): string;
     exprToSQL(resultSet: FieldInstanceResult, context: QueryStruct, exprToTranslate: Expr, state?: GenerateState): string;
+    isNestedInParent(parentDef: FieldDef): boolean;
+    isArrayElement(parentDef: FieldDef): boolean;
     getExpr(): Expr;
     generateExpression(resultSet: FieldInstanceResult): string;
 }
-declare class QueryAtomicField extends QueryField {
+declare class QueryAtomicField<T extends AtomicFieldDef> extends QueryField {
+    fieldDef: T;
+    constructor(fieldDef: T, parent: QueryStruct, refId?: string);
     includeInWildcard(): boolean;
     isCalculated(): boolean;
     isAggregate(): boolean;
     getFilterList(): FilterCondition[];
     hasExpression(): boolean;
 }
-declare class QueryFieldBoolean extends QueryAtomicField {
+declare class QueryFieldBoolean extends QueryAtomicField<BooleanFieldDef> {
 }
 type FieldUsage = {
     type: 'result';
@@ -220,7 +224,7 @@ declare class QueryTurtle extends QueryField {
  * half translated to the new world of types ..
  */
 export declare class Segment {
-    static nextStructDef(structDef: StructDef, segment: PipeSegment): StructDef;
+    static nextStructDef(structDef: SourceDef, segment: PipeSegment): SourceDef;
 }
 type StageGroupMaping = {
     fromGroup: number;
@@ -262,7 +266,7 @@ declare class QueryQuery extends QueryField {
     prepare(_stageWriter: StageWriter | undefined): void;
     getResultMetadata(fi: FieldInstance): ResultStructMetadataDef | ResultMetadataDef | undefined;
     /**  returns a fields and primary key of a struct for this query */
-    getResultStructDef(resultStruct?: FieldInstanceResult, isRoot?: boolean): StructDef;
+    getResultStructDef(resultStruct?: FieldInstanceResult, isRoot?: boolean): SourceDef;
     generateSQLJoinBlock(stageWriter: StageWriter, ji: JoinInstance): string;
     generateSQLPassthroughKeys(qs: QueryStruct): string;
     generateSQLJoins(stageWriter: StageWriter): string;
@@ -280,30 +284,28 @@ declare class QueryQuery extends QueryField {
     buildDialectFieldList(resultStruct: FieldInstanceResult): DialectFieldList;
     generateTurtleSQL(resultStruct: FieldInstanceResult, stageWriter: StageWriter, sqlFieldName: string, outputPipelinedSQL: OutputPipelinedSQL[]): string;
     generateTurtlePipelineSQL(fi: FieldInstanceResult, stageWriter: StageWriter, sourceSQLExpression: string): {
-        structDef: StructDef;
+        structDef: SourceDef;
         pipeOut: any;
     };
     generateComplexSQL(stageWriter: StageWriter): string;
     generateSQL(stageWriter: StageWriter): string;
-    toMalloy(): string;
     generateSQLFromPipeline(stageWriter: StageWriter): {
         lastStageName: string;
-        outputStruct: StructDef;
+        outputStruct: SourceDef;
     };
 }
 /** Structure object as it is used to build a query */
 declare class QueryStruct extends QueryNode {
+    structDef: StructDef;
     readonly sourceArguments: Record<string, Argument> | undefined;
-    readonly prepareResultOptions?: PrepareResultOptions | undefined;
-    fieldDef: StructDef;
+    readonly prepareResultOptions: PrepareResultOptions;
     parent: QueryStruct | undefined;
     model: QueryModel;
     nameMap: Map<string, QuerySomething>;
     pathAliasMap: Map<string, string>;
     dialect: Dialect;
     connectionName: string;
-    readonly stacki: string;
-    constructor(fieldDef: StructDef, sourceArguments: Record<string, Argument> | undefined, parent: ParentQueryStruct | ParentQueryModel, prepareResultOptions?: PrepareResultOptions | undefined);
+    constructor(structDef: StructDef, sourceArguments: Record<string, Argument> | undefined, parent: ParentQueryStruct | ParentQueryModel, prepareResultOptions: PrepareResultOptions, referenceId?: string);
     maybeEmitParameterizedSourceUsage(): void;
     resolveParentParameterReferences(param: Parameter): Parameter;
     private _arguments;
@@ -318,7 +320,7 @@ declare class QueryStruct extends QueryNode {
     getJoinableParent(): QueryStruct;
     addFieldToNameMap(as: string, n: QuerySomething): void;
     /** the the primary key or throw an error. */
-    getPrimaryKeyField(fieldDef: FieldDef): QueryAtomicField;
+    getPrimaryKeyField(fieldDef: FieldDef): QueryAtomicField<AtomicFieldDef>;
     /**
      * 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
@@ -332,25 +334,25 @@ declare class QueryStruct extends QueryNode {
     makeQueryField(field: FieldDef, referenceId?: string): QueryField;
     structSourceSQL(stageWriter: StageWriter): string;
     root(): QueryStruct;
-    primaryKey(): QueryAtomicField | undefined;
+    primaryKey(): QueryAtomicField<AtomicFieldDef> | undefined;
     getChildByName(name: string): QuerySomething | undefined;
     /** convert a path into a field reference */
     getFieldByName(path: string[]): QuerySomething;
     getQueryFieldByName(name: string[]): QuerySomething;
-    getQueryFieldReference(name: string[], refAnnoatation: Annotation | undefined): QuerySomething;
-    getDimensionOrMeasureByName(name: string[]): QueryAtomicField;
+    getQueryFieldReference(name: string[], annotation: Annotation | undefined): QuerySomething;
+    getDimensionOrMeasureByName(name: string[]): QueryAtomicField<AtomicFieldDef>;
     /** returns a query object for the given name */
-    getDimensionByName(name: string[]): QueryAtomicField;
+    getDimensionByName(name: string[]): QueryAtomicField<AtomicFieldDef>;
     /** returns a query object for the given name */
     getStructByName(name: string[]): QueryStruct;
-    getDistinctKey(): QueryAtomicField;
+    getDistinctKey(): QueryAtomicField<AtomicFieldDef>;
     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: StructDef[];
+    structs: SourceDef[];
     malloy: string;
     connectionName: string;
 }