@finos/legend-cube-builder 0.0.2 → 0.0.4

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeEngine.d.ts

@@ -16,7 +16,9 @@
 import { type IR, type ModelContext, type Schema } from '@finos/legend-cube';
 import { V1_EngineServerClient } from '@finos/legend-graph';
 import { type TracerService } from '@finos/legend-shared';
-import { type AccessorPath, type CubeEngine, CubeEngineError, type CubeModelOutline, type CubeResult, type NodeId } from '../../../CubeEngine.js';
+import type { CubeLakehouseEnvironment } from '../../../CubeLakehouseEnvironment.js';
+import { type AccessorPath, type CubeEngine, CubeEngineError, type CubeModelOutline, type CubeParsedExpression, type CubeResult, type NodeId } from '../../../CubeEngine.js';
+import { type V1_CubeIngestDefinitionSource } from './V1_CubeIngestModel.js';
 /** The engine client's configuration, as the host gives it (legend-graph doesn't export its type) */
 export type V1_CubeEngineConfig = ConstructorParameters<typeof V1_EngineServerClient>[0];
 /** The message for a model of a kind this version can't run (PLAN §8.7) */
@@ -29,17 +31,109 @@ export declare const V1_unsupportedModelMessage: (type: string) => string;
  */
 export declare class V1_LegendCubeEngine implements CubeEngine {
     readonly client: V1_EngineServerClient;
-    constructor(config: V1_CubeEngineConfig, tracerService: TracerService);
+    /**
+     * The tables this session has read from direct connections, by connection
+     * and table: picking or re-checking a table reads it again, and typing and
+     * running reuse what was read
+     */
+    private readonly directTables;
+    /** The viewer's lakehouse environment, which data product runs need */
+    private readonly lakehouseEnvironment;
+    /** The warehouse the viewer last picked, for a data product cube without its own */
+    private readonly getRememberedWarehouse;
+    /** The deployed ingest definitions, which ingest cubes read */
+    private readonly ingestDefinitions;
+    constructor(config: V1_CubeEngineConfig, tracerService: TracerService, options?: {
+        lakehouseEnvironment?: CubeLakehouseEnvironment | undefined;
+        getRememberedWarehouse?: (() => string | undefined) | undefined;
+        ingestDefinitions?: V1_CubeIngestDefinitionSource | undefined;
+    });
+    /** An ingest model's settings, or an unsupported-model error naming its problems */
+    private ingestSettingsOf;
+    /**
+     * The definitions the URNs name, read from the host's ingest servers, each
+     * once; a definition that can't be read gives its error instead
+     */
+    private ingestDefinitionsOf;
+    /** A data product model's project, or an unsupported-model error naming its problems */
+    private dataProductProjectOf;
+    /**
+     * Checks a tables cube's model can be sent to the engine: Pure text, or a
+     * project pointer at a released version (PLAN §6.3); else an
+     * unsupported-model error
+     */
+    private checkTablesModel;
     /** The model's Pure text, or an unsupported-model error for any other kind */
     private textOf;
+    /**
+     * A direct-connection model's connection, or an unsupported-model error when
+     * Cube can't use it (an imported cube then shows its saved schemas)
+     */
+    private directConnectionOf;
+    /**
+     * The model a call on a direct-connection cube runs on, holding the tables
+     * it needs, and those its database doesn't have. Tables this session
+     * hasn't read are read in one call; `fresh` reads them all again
+     */
+    private directContextFor;
     loadModel(model: ModelContext): Promise<CubeModelOutline>;
     resolveSchemas(model: ModelContext, accessors: ReadonlyMap<NodeId, AccessorPath>): Promise<Map<NodeId, Schema | CubeEngineError>>;
     typeLambdas(model: ModelContext, lambdas: ReadonlyMap<NodeId, IR>): Promise<Map<NodeId, Schema | CubeEngineError>>;
-    /** Types every lambda in one batch call: one entry per key, whatever fails */
+    /**
+     * Types lambdas on a data product cube: on its project at its saved
+     * version, with no runtime. The open-source engine reads no data product,
+     * so there every lambda fails as the engine says
+     */
+    private typeDataProduct;
+    /**
+     * Types lambdas on an ingest cube: on the definitions they read, as the
+     * ingest servers serve them, with no runtime. A lambda whose data sets
+     * can't be read on the cube, or whose definition can't be fetched, fails
+     * on its own node. The open-source engine reads no ingest definition
+     */
+    private typeIngest;
+    /**
+     * Types lambdas on a direct-connection cube: the tables they use are read
+     * from its database in one call, then typed in one batch on the model built
+     * from them
+     */
+    private typeDirect;
+    /** Types every lambda in one batch call on a text model: one entry per key, whatever fails */
     private typeAll;
+    /** Types every lambda in one batch call on a model context: one entry per key, whatever fails */
+    private typeOn;
     execute(model: ModelContext, executionLambda: IR, options?: {
         abortController?: AbortController | undefined;
     }): Promise<CubeResult>;
+    /**
+     * The model a run on a data product cube runs on (PLAN §6.8): its project at
+     * the saved version, and a lakehouse runtime at Cube's fixed path, in the
+     * viewer's environment, with the cube's warehouse, else the default
+     */
+    private dataProductExecutionContext;
+    /**
+     * The model a run on an ingest cube runs on (PLAN §6.7): the definitions it
+     * reads, as the ingest servers serve them, and a lakehouse runtime at
+     * Cube's fixed path, in the environment of the cube's class, with the
+     * cube's warehouse, else the one the viewer last picked, else the default
+     */
+    private ingestExecutionContext;
+    /**
+     * The model a run on a direct-connection cube runs on: the tables it uses,
+     * read from its database when this session hasn't read them. A run stopped
+     * meanwhile goes no further
+     */
+    private directExecutionContext;
+    /**
+     * The model a run of the lambda runs on: the cube's, or the context its
+     * data products, ingest data sets or direct connection need. A lambda
+     * reading another kind of source is refused first
+     */
+    private executionContextOf;
+    /** The body of a run, or of its plan, as text, so numbers keep every digit */
+    private executionBodyOf;
+    planLambda(model: ModelContext, executionLambda: IR): Promise<void>;
+    parseExpression(code: string, sourceId: string): Promise<CubeParsedExpression>;
     renderPure(lambdaIR: IR): Promise<string>;
 }
 //# sourceMappingURL=V1_LegendCubeEngine.d.ts.map

package/lib/graph-manager/protocol/pure/v1/V1_LegendCubeEngine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"V1_LegendCubeEngine.d.ts","sourceRoot":"","sources":["../../../../../src/graph-manager/protocol/pure/v1/V1_LegendCubeEngine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAEL,KAAK,EAAE,EAEP,KAAK,YAAY,EACjB,KAAK,MAAM,EAEZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAkB,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,eAAe,EAEf,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,MAAM,EACZ,MAAM,wBAAwB,CAAC;AAahC,qGAAqG;AACrG,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,CACrD,OAAO,qBAAqB,CAC7B,CAAC,CAAC,CAAC,CAAC;AAiBL,2EAA2E;AAC3E,eAAO,MAAM,0BAA0B,GAAI,MAAM,MAAM,KAAG,MACD,CAAC;AAE1D;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,UAAU;IACpD,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;gBAE3B,MAAM,EAAE,mBAAmB,EAAE,aAAa,EAAE,aAAa;IAMrE,8EAA8E;IAC9E,OAAO,CAAC,MAAM;IAWR,SAAS,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAW/D,cAAc,CACZ,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,GAC3C,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC;IAejD,WAAW,CACT,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,GAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC;IAIjD,8EAA8E;YAChE,OAAO;IA0Ef,OAAO,CACX,KAAK,EAAE,YAAY,EACnB,eAAe,EAAE,EAAE,EACnB,OAAO,CAAC,EAAE;QAAE,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,GAC1D,OAAO,CAAC,UAAU,CAAC;IA8ChB,UAAU,CAAC,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAchD"}
+{"version":3,"file":"V1_LegendCubeEngine.d.ts","sourceRoot":"","sources":["../../../../../src/graph-manager/protocol/pure/v1/V1_LegendCubeEngine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAEL,KAAK,EAAE,EAEP,KAAK,YAAY,EACjB,KAAK,MAAM,EAEZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAkB,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAML,KAAK,aAAa,EACnB,MAAM,sBAAsB,CAAC;AAoB9B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAWrF,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,eAAe,EAEf,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,MAAM,EACZ,MAAM,wBAAwB,CAAC;AAUhC,OAAO,EAKL,KAAK,6BAA6B,EAGnC,MAAM,yBAAyB,CAAC;AA2BjC,qGAAqG;AACrG,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,CACrD,OAAO,qBAAqB,CAC7B,CAAC,CAAC,CAAC,CAAC;AA4FL,2EAA2E;AAC3E,eAAO,MAAM,0BAA0B,GAAI,MAAM,MAAM,KAAG,MACD,CAAC;AAsD1D;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,UAAU;IACpD,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IACvC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyC;IAEtE,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAuC;IAC5E,oFAAoF;IACpF,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA2B;IAClE,+DAA+D;IAC/D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA4C;gBAG5E,MAAM,EAAE,mBAAmB,EAC3B,aAAa,EAAE,aAAa,EAC5B,OAAO,CAAC,EAAE;QACR,oBAAoB,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;QAC5D,sBAAsB,CAAC,EAAE,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;QAChE,iBAAiB,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;KAC/D;IAWH,oFAAoF;IACpF,OAAO,CAAC,gBAAgB;IAexB;;;OAGG;YACW,mBAAmB;IAsCjC,wFAAwF;IACxF,OAAO,CAAC,oBAAoB;IAe5B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAexB,8EAA8E;IAC9E,OAAO,CAAC,MAAM;IAWd;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;OAIG;YACW,gBAAgB;IAqDxB,SAAS,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAsD/D,cAAc,CACZ,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,GAC3C,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC;IA6B3C,WAAW,CACf,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,GAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC;IAiCjD;;;;OAIG;YACW,eAAe;IAsB7B;;;;;OAKG;YACW,UAAU;IA2ExB;;;;OAIG;YACW,UAAU;IAsExB,8FAA8F;YAChF,OAAO;IAmBrB,iGAAiG;YACnF,MAAM;IAyEd,OAAO,CACX,KAAK,EAAE,YAAY,EACnB,eAAe,EAAE,EAAE,EACnB,OAAO,CAAC,EAAE;QAAE,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,GAC1D,OAAO,CAAC,UAAU,CAAC;IA6CtB;;;;OAIG;YACW,2BAA2B;IAuCzC;;;;;OAKG;YACW,sBAAsB;IAiDpC;;;;OAIG;YACW,sBAAsB;IAmDpC;;;;OAIG;YACW,kBAAkB;IA6BhC,8EAA8E;IAC9E,OAAO,CAAC,eAAe;IAoBjB,UAAU,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBnE,eAAe,CACnB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,CAAC;IA4B1B,UAAU,CAAC,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAchD"}