@malloydata/malloy 0.0.119-dev240123183113 → 0.0.119-dev240124170348

package/dist/model/malloy_query.d.ts

@@ -1,5 +1,5 @@
 import { Dialect, DialectFieldList } from '../dialect';
-import { AggregateFragment, AggregateFunctionType, CompiledQuery, DialectFragment, Expr, FieldDef, FieldFragment, FieldRef, FieldReferenceFragment, Filtered, FilterExpression, FilterFragment, FunctionCallFragment, FunctionOverloadDef, JoinRelationship, ModelDef, OrderBy, OutputFieldFragment, Parameter, ParameterFragment, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SourceReferenceFragment, SpreadFragment, SQLExpressionFragment, SqlStringFragment, StructDef, StructRef, TurtleDef, UngroupFragment } from './malloy_types';
+import { AggregateFragment, AggregateFunctionType, Annotation, CompiledQuery, DialectFragment, Expr, FieldDef, FieldFragment, Filtered, FilterExpression, FilterFragment, FunctionCallFragment, FunctionOverloadDef, JoinRelationship, ModelDef, OrderBy, OutputFieldFragment, Parameter, ParameterFragment, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SourceReferenceFragment, SegmentFieldDef, SpreadFragment, SQLExpressionFragment, SqlStringFragment, StructDef, StructRef, TurtleDef, UngroupFragment } from './malloy_types';
 import { Connection } from '../runtime_types';
 import { AndChain } from './utils';
 import { QueryInfo } from '../dialect/dialect';
@@ -73,17 +73,16 @@ declare class QueryField extends QueryNode {
     private expandFunctionCall;
     generateFunctionCallExpression(resultSet: FieldInstanceResult, context: QueryStruct, frag: FunctionCallFragment, state: GenerateState): string;
     generateSpread(_resultSet: FieldInstanceResult, _context: QueryStruct, _frag: SpreadFragment, _state: GenerateState): string;
-    generateParameterFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: ParameterFragment, state: GenerateState): string;
+    generateParameterFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: ParameterFragment, _state: GenerateState): string;
     generateFilterFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: FilterFragment, state: GenerateState): string;
     generateDimFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: Expr, state: GenerateState): string;
     generateUngroupedFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: UngroupFragment, state: GenerateState): string;
-    generateDistinctKeyIfNecessary(resultSet: FieldInstanceResult, context: QueryStruct, structPath: string | undefined): string | undefined;
+    generateDistinctKeyIfNecessary(resultSet: FieldInstanceResult, context: QueryStruct, structPath: string[] | undefined): string | undefined;
     generateSumFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateFragment, state: GenerateState): string;
     generateSymmetricFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateFragment, state: GenerateState): string;
     generateAvgFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateFragment, state: GenerateState): string;
     generateCountFragment(resultSet: FieldInstanceResult, context: QueryStruct, expr: AggregateFragment, state: GenerateState): string;
     generateDialect(resultSet: FieldInstanceResult, context: QueryStruct, expr: DialectFragment, state: GenerateState): string;
-    generateFieldReference(resultSet: FieldInstanceResult, context: QueryStruct, expr: FieldReferenceFragment, state: GenerateState): string;
     generateSqlString(resultSet: FieldInstanceResult, context: QueryStruct, expr: SqlStringFragment, state: GenerateState): string;
     generateSourceReference(resultSet: FieldInstanceResult, context: QueryStruct, expr: SourceReferenceFragment): string;
     getAnalyticPartitions(resultStruct: FieldInstanceResult): string;
@@ -101,12 +100,6 @@ declare class QueryAtomicField extends QueryField {
 }
 declare class QueryFieldBoolean extends QueryAtomicField {
 }
-declare class QueryFieldStruct extends QueryAtomicField {
-    primaryKey: string;
-    constructor(fieldDef: FieldDef, parent: QueryStruct, primaryKey: string);
-    getName(): string;
-    getAsJoinedStructDef(foreignKeyName: string): StructDef;
-}
 type FieldUsage = {
     type: 'result';
     resultIndex: number;
@@ -243,17 +236,14 @@ declare class QueryQuery extends QueryField {
     constructor(fieldDef: TurtleDef, parent: QueryStruct, stageWriter: StageWriter | undefined, isJoinedSubquery: boolean);
     static makeQuery(fieldDef: TurtleDef, parentStruct: QueryStruct, stageWriter: StageWriter | undefined, isJoinedSubquery: boolean): QueryQuery;
     inNestedPipeline(): boolean;
-    getFieldList(): QueryFieldDef[];
     expandField(f: QueryFieldDef): {
-        as: any;
+        as: string;
         field: QuerySomething;
     };
-    expandDependantField(resultStruct: FieldInstanceResult, fieldRef: FieldRef): void;
-    expandWildCardStruct(struct: QueryStruct, expandChildren: boolean, filter?: ((qf: QueryNode) => boolean) | undefined): string[];
-    expandWildCards(fields: QueryFieldDef[], filter?: ((qf: QueryNode) => boolean) | undefined): QueryFieldDef[];
-    addDependantPath(resultStruct: FieldInstanceResult, context: QueryStruct, path: string, uniqueKeyPossibleUse: UniqueKeyPossibleUse | undefined, joinStack: string[]): void;
+    addDependantPath(resultStruct: FieldInstanceResult, context: QueryStruct, path: string[], uniqueKeyPossibleUse: UniqueKeyPossibleUse | undefined, joinStack: string[]): void;
     addDependantExpr(resultStruct: FieldInstanceResult, context: QueryStruct, e: Expr, joinStack: string[]): void;
     addDependancies(resultStruct: FieldInstanceResult, field: QueryField): void;
+    getSegmentFields(resultStruct: FieldInstanceResult): SegmentFieldDef[];
     expandFields(resultStruct: FieldInstanceResult): void;
     expandFilters(resultStruct: FieldInstanceResult): void;
     generateSQLFilters(resultStruct: FieldInstanceResult, which: 'where' | 'having', filterList?: FilterExpression[] | undefined): AndChain;
@@ -301,7 +291,6 @@ declare class QueryStruct extends QueryNode {
     parameters(): Record<string, Parameter>;
     addFieldsFromFieldList(fields: FieldDef[]): void;
     getAliasIdentifier(): string;
-    getAsQueryField(): QueryFieldStruct;
     getSQLIdentifier(): string;
     getIdentifier(): string;
     getFullOutputName(): string;
@@ -310,7 +299,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): any;
+    getPrimaryKeyField(fieldDef: FieldDef): QueryAtomicField;
     /**
      * 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
@@ -321,26 +310,19 @@ declare class QueryStruct extends QueryNode {
     setParent(parent: ParentQueryStruct | ParentQueryModel): void;
     /** makes a new queryable field object from a fieldDef */
     makeQueryField(field: FieldDef): QueryField;
-    /**
-     * return a field if it exists, make one if we are passed a field definition.
-     */
-    getOrMakeField(fieldRef: FieldRef): QuerySomething;
-    /** returns a dimension for the given name  or make one. */
-    getOrMakeDimension(fieldRef: FieldRef): QueryAtomicField;
     structSourceSQL(stageWriter: StageWriter): string;
     root(): QueryStruct;
     primaryKey(): QueryAtomicField | undefined;
-    /** get the componennts of a field path */
-    static resolvePath(name: string): string[];
     getChildByName(name: string): QuerySomething | undefined;
-    /** convert a name into a field reference */
-    getFieldByName(name: string): QuerySomething;
-    getQueryFieldByName(name: string): QuerySomething;
-    getDimensionOrMeasureByName(name: string): QueryAtomicField;
+    /** 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;
     /** returns a query object for the given name */
-    getDimensionByName(name: string): QueryAtomicField;
+    getDimensionByName(name: string[]): QueryAtomicField;
     /** returns a query object for the given name */
-    getStructByName(name: string): QueryStruct;
+    getStructByName(name: string[]): QueryStruct;
     getDistinctKey(): QueryAtomicField;
     applyStructFiltersToTurtleDef(turtleDef: TurtleDef | TurtleDefPlus): TurtleDef;
 }
@@ -359,10 +341,6 @@ export declare class QueryModel {
     structs: Map<string, QueryStruct>;
     constructor(modelDef: ModelDef | undefined);
     loadModelFromDef(modelDef: ModelDef): void;
-    parseQueryPath(name: string): {
-        struct: QueryStruct;
-        queryName: string;
-    };
     getStructByName(name: string): QueryStruct;
     getStructFromRef(structRef: StructRef): QueryStruct;
     loadQuery(query: Query, stageWriter: StageWriter | undefined, emitFinalStage?: boolean, isJoinedSubquery?: boolean): QueryResults;