@malloydata/malloy 0.0.218-dev241122201503 → 0.0.218-dev241127170002

package/dist/lang/malloy-to-ast.d.ts

@@ -140,7 +140,7 @@ export declare class MalloyToAST extends AbstractParseTreeVisitor<ast.MalloyElem
     visitAggregateOrdering(pcx: parse.AggregateOrderingContext): ast.FunctionOrdering;
     visitOrderBySpec(pcx: parse.OrderBySpecContext): ast.OrderBy;
     visitOrdering(pcx: parse.OrderingContext): ast.Ordering;
-    visitTopStatement(pcx: parse.TopStatementContext): ast.Top;
+    visitTopStatement(pcx: parse.TopStatementContext): ast.Limit;
     visitTopLevelQueryDefs(pcx: parse.TopLevelQueryDefsContext): ast.DefineQueryList;
     visitTopLevelQueryDef(pcx: parse.TopLevelQueryDefContext): ast.DefineQuery;
     visitAnonymousQuery(pcx: parse.AnonymousQueryContext): ast.AnonymousQuery;

package/dist/lang/malloy-to-ast.js

@@ -744,25 +744,8 @@ class MalloyToAST extends AbstractParseTreeVisitor_1.AbstractParseTreeVisitor {
         return this.astAt(new ast.Ordering(orderList), pcx);
     }
     visitTopStatement(pcx) {
-        const byCx = pcx.bySpec();
         const topN = this.getNumber(pcx.INTEGER_LITERAL());
-        let top;
-        if (byCx) {
-            this.m4advisory(byCx, 'top-by', 'by clause of top statement unupported. Use order_by instead');
-            const nameCx = byCx.fieldName();
-            if (nameCx) {
-                const name = this.getFieldName(nameCx);
-                top = new ast.Top(topN, name);
-            }
-            const exprCx = byCx.fieldExpr();
-            if (exprCx) {
-                top = new ast.Top(topN, this.getFieldExpr(exprCx));
-            }
-        }
-        if (!top) {
-            top = new ast.Top(topN, undefined);
-        }
-        return this.astAt(top, pcx);
+        return this.astAt(new ast.Limit(topN), pcx);
     }
     visitTopLevelQueryDefs(pcx) {
         const stmts = pcx

package/dist/lang/test/query.spec.js

@@ -784,35 +784,72 @@ describe('query:', () => {
         test('top N', () => {
             expect('run: a->{ top: 5; group_by: astr }').toTranslate();
         });
-        test('top N by field', () => {
-            expect(`##! m4warnings=warn
-        run: a->{top: 5 ${'by astr'}; group_by: astr}`).toLog((0, test_translator_1.warningMessage)('by clause of top statement unupported. Use order_by instead'));
-        });
-        test('top N by expression', () => {
-            expect(`##! m4warnings=warn
-        run: ab->{top: 5 by ai + 1; group_by: ai}`).toLog((0, test_translator_1.warningMessage)('by clause of top statement unupported. Use order_by instead'));
-        });
         test('limit N', () => {
             expect('run: a->{ limit: 5; group_by: astr }').toTranslate();
         });
-        test('order by', () => {
-            expect('run: a->{ order_by: astr; group_by: astr }').toTranslate();
-        });
-        test('order by preserved over refinement', () => {
-            expect(`
-        query: a1 is a -> { group_by: astr }
-        run: a1 + { order_by: astr }
-      `).toTranslate();
-        });
-        test('order by must be in the output space', () => expect('run: a -> { order_by: af; group_by: astr }').toLog((0, test_translator_1.errorMessage)('Unknown field af in output space')));
-        test('order by asc', () => {
-            expect('run: a->{ order_by: astr asc; group_by: astr }').toTranslate();
-        });
-        test('order by desc', () => {
-            expect('run: a->{ order_by: astr desc; group_by: astr }').toTranslate();
-        });
-        test('order by N', () => {
-            expect('run: a->{ order_by: 1 asc; group_by: astr }').toTranslate();
+        describe('order by variations', () => {
+            test('order by', () => {
+                expect('run: a->{ order_by: astr; group_by: astr }').toTranslate();
+            });
+            test('order by preserved over refinement', () => {
+                expect(`
+          query: a1 is a -> { group_by: astr }
+          run: a1 + { order_by: astr }
+        `).toTranslate();
+            });
+            test('order by must be in the output space', () => expect('run: a -> { order_by: af; group_by: astr }').toLog((0, test_translator_1.errorMessage)('Unknown field af in output space')));
+            test('order by asc', () => {
+                expect('run: a->{ order_by: astr asc; group_by: astr }').toTranslate();
+            });
+            test('order by desc', () => {
+                expect('run: a->{ order_by: astr desc; group_by: astr }').toTranslate();
+            });
+            test('order by N', () => {
+                expect('run: a->{ order_by: 1 asc; group_by: astr }').toTranslate();
+            });
+            test('first aggregate used for default ordering', () => {
+                const m = (0, test_translator_1.model) `run: a->{
+          group_by: astr
+          aggregate: t is ai.sum()
+        }`;
+                expect(m).toTranslate();
+                const runStmt = m.translator.getQuery(0);
+                expect(runStmt).toBeDefined();
+                const reduce = runStmt.pipeline[0];
+                expect(reduce.type).toEqual('reduce');
+                if (reduce.type === 'reduce') {
+                    expect(reduce.defaultOrderBy).toBeTruthy();
+                    expect(reduce.orderBy).toEqual([{ field: 't', dir: 'desc' }]);
+                }
+            });
+            test('first temporal used for default ordering', () => {
+                const m = (0, test_translator_1.model) `run: a->{
+          group_by: astr, ats
+        }`;
+                expect(m).toTranslate();
+                const runStmt = m.translator.getQuery(0);
+                expect(runStmt).toBeDefined();
+                const reduce = runStmt.pipeline[0];
+                expect(reduce.type).toEqual('reduce');
+                if (reduce.type === 'reduce') {
+                    expect(reduce.defaultOrderBy).toBeTruthy();
+                    expect(reduce.orderBy).toEqual([{ field: 'ats', dir: 'desc' }]);
+                }
+            });
+            test('first used for ordering when appropriate', () => {
+                const m = (0, test_translator_1.model) `run: a->{
+          group_by: astr, big is upper(astr)
+        }`;
+                expect(m).toTranslate();
+                const runStmt = m.translator.getQuery(0);
+                expect(runStmt).toBeDefined();
+                const reduce = runStmt.pipeline[0];
+                expect(reduce.type).toEqual('reduce');
+                if (reduce.type === 'reduce') {
+                    expect(reduce.defaultOrderBy).toBeTruthy();
+                    expect(reduce.orderBy).toEqual([{ field: 'astr', dir: 'asc' }]);
+                }
+            });
         });
         test('order by multiple', () => {
             expect(`

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, ParameterNode, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SegmentFieldDef, StructDef, StructRef, TurtleDef, FunctionOrderBy, Argument, AggregateExpr, FilterCondition, GenericSQLExpr, FieldnameNode, FunctionCallNode, UngroupNode, SourceReferenceNode, SpreadExpr, FilteredExpr, SourceDef, AtomicFieldDef, BooleanFieldDef, QueryToMaterialize, PrepareResultOptions, CaseExpr } from './malloy_types';
+import { AggregateFunctionType, Annotation, CompiledQuery, Expr, FieldDef, Filtered, FunctionOverloadDef, FunctionParameterDef, JoinRelationship, ModelDef, OrderBy, OutputFieldNode, ParameterNode, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SegmentFieldDef, StructDef, StructRef, TurtleDef, FunctionOrderBy, Argument, AggregateExpr, FilterCondition, GenericSQLExpr, FieldnameNode, FunctionCallNode, UngroupNode, SourceReferenceNode, SpreadExpr, FilteredExpr, SourceDef, AtomicFieldDef, BooleanFieldDef, QueryResultDef, QueryToMaterialize, PrepareResultOptions, CaseExpr } from './malloy_types';
 import { Connection } from '../connection/types';
 import { AndChain } from './utils';
 import { QueryInfo } from '../dialect/dialect';
@@ -224,7 +224,7 @@ declare class QueryTurtle extends QueryField {
  * half translated to the new world of types ..
  */
 export declare class Segment {
-    static nextStructDef(structDef: SourceDef, segment: PipeSegment): SourceDef;
+    static nextStructDef(structDef: SourceDef, segment: PipeSegment): QueryResultDef;
 }
 type StageGroupMaping = {
     fromGroup: number;
@@ -267,7 +267,7 @@ declare class QueryQuery extends QueryField {
     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): SourceDef;
+    getResultStructDef(resultStruct?: FieldInstanceResult, isRoot?: boolean): QueryResultDef;
     generateSQLJoinBlock(stageWriter: StageWriter, ji: JoinInstance): string;
     generateSQLPassthroughKeys(qs: QueryStruct): string;
     generateSQLJoins(stageWriter: StageWriter): string;
@@ -285,14 +285,14 @@ 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: SourceDef;
+        structDef: QueryResultDef;
         pipeOut: any;
     };
     generateComplexSQL(stageWriter: StageWriter): string;
     generateSQL(stageWriter: StageWriter): string;
     generateSQLFromPipeline(stageWriter: StageWriter): {
         lastStageName: string;
-        outputStruct: SourceDef;
+        outputStruct: QueryResultDef;
     };
 }
 /** Structure object as it is used to build a query */

package/dist/model/malloy_query.js

@@ -96,12 +96,13 @@ class StageWriter {
         }
     }
     addUDF(stageWriter, dialect, structDef) {
+        var _a;
         // eslint-disable-next-line prefer-const
         let { sql, lastStageName } = stageWriter.combineStages(true);
         if (lastStageName === undefined) {
             throw new Error('Internal Error: no stage to combine');
         }
-        sql += dialect.sqlCreateFunctionCombineLastStage(lastStageName, getDialectFieldList(structDef));
+        sql += dialect.sqlCreateFunctionCombineLastStage(lastStageName, getDialectFieldList(structDef), (_a = structDef.resultMetadata) === null || _a === void 0 ? void 0 : _a.orderBy);
         const id = `${dialect.udfPrefix}${this.root().udfs.length}`;
         sql = dialect.sqlCreateFunction(id, sql);
         this.root().udfs.push(sql);
@@ -162,12 +163,13 @@ class StageWriter {
         return udfs + pdts + sql + this.withs[lastStageNum];
     }
     generateCoorelatedSubQuery(dialect, structDef) {
+        var _a, _b;
         if (!this.useCTE) {
-            return dialect.sqlCreateFunctionCombineLastStage(`(${this.withs[0]})`, getDialectFieldList(structDef));
+            return dialect.sqlCreateFunctionCombineLastStage(`(${this.withs[0]})`, getDialectFieldList(structDef), (_a = structDef.resultMetadata) === null || _a === void 0 ? void 0 : _a.orderBy);
         }
         else {
             return (this.combineStages(true).sql +
-                dialect.sqlCreateFunctionCombineLastStage(this.getName(this.withs.length - 1), getDialectFieldList(structDef)));
+                dialect.sqlCreateFunctionCombineLastStage(this.getName(this.withs.length - 1), getDialectFieldList(structDef), (_b = structDef.resultMetadata) === null || _b === void 0 ? void 0 : _b.orderBy));
         }
     }
 }
@@ -2876,7 +2878,7 @@ class QueryQueryRaw extends QueryQuery {
         if (!(0, malloy_types_1.isSourceDef)(this.parent.structDef)) {
             throw new Error(`Result cannot by type ${this.parent.structDef.type}`);
         }
-        return this.parent.structDef;
+        return { ...this.parent.structDef, type: 'query_result' };
     }
     getResultMetadata(_fi) {
         return undefined;

package/dist/model/malloy_types.d.ts

@@ -317,9 +317,12 @@ export interface ResultMetadataDef {
     fieldKind: 'measure' | 'dimension' | 'struct';
     referenceId?: string;
 }
-export interface ResultStructMetadataDef extends ResultMetadataDef {
-    limit?: number;
+export interface Ordered {
     orderBy?: OrderBy[];
+    defaultOrderBy?: boolean;
+}
+export interface ResultStructMetadataDef extends ResultMetadataDef, Ordered {
+    limit?: number;
 }
 export interface ResultMetadata {
     resultMetadata?: ResultMetadataDef;
@@ -345,6 +348,7 @@ export declare function isTemporalField(s: string): s is TemporalFieldType;
 export type CastType = 'string' | 'number' | TemporalFieldType | 'boolean' | 'json';
 export type AtomicFieldType = CastType | 'sql native' | 'record' | 'array' | 'error';
 export declare function isAtomicFieldType(s: string): s is AtomicFieldType;
+export declare function canOrderBy(s: string): boolean;
 export declare function isCastType(s: string): s is CastType;
 /**
  * Fields which contain scalar data all inherit from this. The field
@@ -550,13 +554,11 @@ export interface CompositeFieldUsage {
     fields: string[];
     joinedUsage: Record<string, CompositeFieldUsage>;
 }
-export interface QuerySegment extends Filtered {
+export interface QuerySegment extends Filtered, Ordered {
     type: 'reduce' | 'project' | 'partial';
     queryFields: QueryFieldDef[];
     extendSource?: FieldDef[];
     limit?: number;
-    by?: By;
-    orderBy?: OrderBy[];
     queryTimezone?: string;
     alwaysJoins?: string[];
     compositeFieldUsage?: CompositeFieldUsage;

package/dist/model/malloy_types.js

@@ -22,8 +22,8 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isScalarArray = exports.isBaseTable = exports.isSourceDef = exports.sourceBase = exports.isSegmentSQL = exports.isIndexSegment = exports.isRawSegment = exports.isSamplingEnable = exports.isSamplingPercent = exports.isSamplingRows = exports.isQuerySegment = exports.isProjectSegment = exports.isPartialSegment = exports.isReduceSegment = exports.structHasErrors = exports.segmentHasErrors = exports.refIsStructDef = exports.isByExpression = exports.isByName = exports.ValueType = exports.isExtractUnit = exports.isTimestampUnit = exports.isDateUnit = exports.isJoinedSource = exports.isJoined = exports.isJoinable = exports.isMatrixOperation = exports.isRepeatedRecord = exports.arrayEachFields = exports.fieldIsIntrinsic = exports.isCastType = exports.isAtomicFieldType = exports.isTemporalField = exports.hasExpression = exports.maxOfExpressionTypes = exports.maxExpressionType = exports.isExpressionTypeLEQ = exports.expressionIsAnalytic = exports.expressionIsCalculation = exports.expressionInvolvesAggregate = exports.expressionIsUngroupedAggregate = exports.expressionIsAggregate = exports.expressionIsScalar = exports.paramHasValue = exports.isRawCast = exports.mkTemporal = exports.isAsymmetricExpr = exports.exprIsLeaf = exports.exprHasE = exports.exprHasKids = void 0;
-exports.TD = exports.isValueDate = exports.isValueTimestamp = exports.isValueBoolean = exports.isValueNumber = exports.isValueString = exports.getAtomicFields = exports.isAtomic = exports.isTurtleDef = exports.getIdentifier = exports.isLeafAtomic = exports.mergeEvalSpaces = exports.isLiteral = void 0;
+exports.isBaseTable = exports.isSourceDef = exports.sourceBase = exports.isSegmentSQL = exports.isIndexSegment = exports.isRawSegment = exports.isSamplingEnable = exports.isSamplingPercent = exports.isSamplingRows = exports.isQuerySegment = exports.isProjectSegment = exports.isPartialSegment = exports.isReduceSegment = exports.structHasErrors = exports.segmentHasErrors = exports.refIsStructDef = exports.isByExpression = exports.isByName = exports.ValueType = exports.isExtractUnit = exports.isTimestampUnit = exports.isDateUnit = exports.isJoinedSource = exports.isJoined = exports.isJoinable = exports.isMatrixOperation = exports.isRepeatedRecord = exports.arrayEachFields = exports.fieldIsIntrinsic = exports.isCastType = exports.canOrderBy = exports.isAtomicFieldType = exports.isTemporalField = exports.hasExpression = exports.maxOfExpressionTypes = exports.maxExpressionType = exports.isExpressionTypeLEQ = exports.expressionIsAnalytic = exports.expressionIsCalculation = exports.expressionInvolvesAggregate = exports.expressionIsUngroupedAggregate = exports.expressionIsAggregate = exports.expressionIsScalar = exports.paramHasValue = exports.isRawCast = exports.mkTemporal = exports.isAsymmetricExpr = exports.exprIsLeaf = exports.exprHasE = exports.exprHasKids = void 0;
+exports.TD = exports.isValueDate = exports.isValueTimestamp = exports.isValueBoolean = exports.isValueNumber = exports.isValueString = exports.getAtomicFields = exports.isAtomic = exports.isTurtleDef = exports.getIdentifier = exports.isLeafAtomic = exports.mergeEvalSpaces = exports.isLiteral = exports.isScalarArray = void 0;
 function exprHasKids(e) {
     return 'kids' in e;
 }
@@ -167,6 +167,10 @@ function isAtomicFieldType(s) {
     ].includes(s);
 }
 exports.isAtomicFieldType = isAtomicFieldType;
+function canOrderBy(s) {
+    return ['string', 'number', 'date', 'boolean', 'date', 'timestamp'].includes(s);
+}
+exports.canOrderBy = canOrderBy;
 function isCastType(s) {
     return ['string', 'number', 'date', 'timestamp', 'boolean', 'json'].includes(s);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy",
-  "version": "0.0.218-dev241122201503",
+  "version": "0.0.218-dev241127170002",
   "license": "MIT",
   "exports": {
     ".": "./dist/index.js",

package/dist/lang/ast/query-properties/top.d.ts

@@ -1,16 +0,0 @@
-import { By as ModelBy } from '../../../model/malloy_types';
-import { ExpressionDef } from '../types/expression-def';
-import { FieldName, FieldSpace } from '../types/field-space';
-import { MalloyElement } from '../types/malloy-element';
-import { LegalRefinementStage, QueryPropertyInterface } from '../types/query-property-interface';
-type TopInit = FieldName | ExpressionDef;
-export declare class Top extends MalloyElement implements QueryPropertyInterface {
-    readonly limit: number;
-    readonly by?: TopInit | undefined;
-    elementType: string;
-    queryRefinementStage: LegalRefinementStage;
-    forceQueryClass: undefined;
-    constructor(limit: number, by?: TopInit | undefined);
-    getBy(fs: FieldSpace): ModelBy | undefined;
-}
-export {};

package/dist/lang/ast/query-properties/top.js

@@ -1,76 +0,0 @@
-"use strict";
-/*
- * Copyright 2023 Google LLC
- *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files
- * (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge,
- * publish, distribute, sublicense, and/or sell copies of the Software,
- * and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
- * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
- * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Top = void 0;
-const malloy_types_1 = require("../../../model/malloy_types");
-const field_space_1 = require("../types/field-space");
-const malloy_element_1 = require("../types/malloy-element");
-const query_property_interface_1 = require("../types/query-property-interface");
-class Top extends malloy_element_1.MalloyElement {
-    constructor(limit, by) {
-        super();
-        this.limit = limit;
-        this.by = by;
-        this.elementType = 'top';
-        this.queryRefinementStage = query_property_interface_1.LegalRefinementStage.Tail;
-        this.forceQueryClass = undefined;
-        this.has({ by: by });
-    }
-    getBy(fs) {
-        var _a;
-        if (this.by) {
-            if (this.by instanceof field_space_1.FieldName) {
-                if (fs.isQueryFieldSpace()) {
-                    // TODO jump-to-definition now that we can lookup fields in the output space,
-                    // we need to actually add the reference when we do so.
-                    const output = fs.outputSpace();
-                    const entry = this.by.getField(output);
-                    if (entry.error) {
-                        this.by.logError(entry.error.code, entry.error.message);
-                    }
-                    if (!entry.found || !entry.isOutputField) {
-                        this.by.logError('top-by-not-found-in-output', `Unknown field ${this.by.refString} in output space`);
-                    }
-                    if ((0, malloy_types_1.expressionIsAnalytic)((_a = entry.found) === null || _a === void 0 ? void 0 : _a.typeDesc().expressionType)) {
-                        this.by.logError('top-by-analytic', `Illegal order by of analytic field ${this.by.refString}`);
-                    }
-                }
-                return { by: 'name', name: this.by.refString };
-            }
-            else {
-                const byExpr = this.by.getExpression(fs);
-                if ((0, malloy_types_1.expressionIsAggregate)(byExpr.expressionType)) {
-                    this.by.logError('top-by-aggregate', 'top by expression must not be an aggregate');
-                }
-                if (byExpr.evalSpace === 'output') {
-                    this.by.logError('top-by-not-in-output', 'top by expression must be an output expression');
-                }
-                return { by: 'expression', e: byExpr.value };
-            }
-        }
-        return undefined;
-    }
-}
-exports.Top = Top;
-//# sourceMappingURL=top.js.map