@malloydata/malloy 0.0.195-dev241003204819 → 0.0.195-dev241007154000

package/dist/malloy.d.ts

@@ -2,9 +2,9 @@
 import { RunSQLOptions } from './run_sql_options';
 import { DocumentCompletion as DocumentCompletionDefinition, DocumentSymbol as DocumentSymbolDefinition, LogMessage, MalloyTranslator } from './lang';
 import { DocumentHelpContext } from './lang/parse-tree-walkers/document-help-context-walker';
-import { CompiledQuery, DocumentLocation, DocumentReference, FieldBooleanDef, FieldDateDef, FieldJSONDef, FieldNumberDef, FieldStringDef, FieldTimestampDef, FieldTypeDef, FilterCondition, Query as InternalQuery, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQuery, QueryData, QueryDataRow, QueryResult, SQLBlock, SQLBlockSource, SQLBlockStructDef, SearchIndexResult, SearchValueMapResult, StructDef, TurtleDef, FeldNativeUnsupportedDef, QueryRunStats, ImportLocation, Annotation, QueryToMaterialize } from './model';
+import { CompiledQuery, DocumentLocation, DocumentReference, BooleanFieldDef, JSONFieldDef, NumberFieldDef, StringFieldDef, FilterCondition, Query as InternalQuery, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQuery, QueryData, QueryDataRow, QueryResult, SearchIndexResult, SearchValueMapResult, StructDef, TurtleDef, NativeUnsupportedFieldDef, QueryRunStats, ImportLocation, Annotation, SQLSentence, SQLSourceDef, AtomicFieldDef, DateFieldDef, TimestampFieldDef, SourceDef, QueryToMaterialize } from './model';
 import { EventStream, ModelString, ModelURL, QueryString, QueryURL, URLReader } from './runtime_types';
-import { Connection, InfoConnection, LookupConnection } from './connection/types';
+import { Connection, FetchSchemaOptions, InfoConnection, LookupConnection } from './connection/types';
 import { Tag, TagParse, TagParseSpec, Taggable } from './tags';
 import { Dialect } from './dialect';
 import { PathInfo } from './lang/parse-tree-walkers/find-table-path-walker';
@@ -74,7 +74,16 @@ export declare class Malloy {
         model?: Model;
         replaceMaterializedReferences?: boolean;
     } & CompileOptions & CompileQueryOptions): Promise<Model>;
-    static compileSQLBlock(partialModel: ModelDef | undefined, toCompile: SQLBlockSource, options?: CompileQueryOptions): SQLBlock;
+    /**
+     * A dialect must provide a response for every table, or the translator loop
+     * will never exit. Because there was a time when this happened, we throw
+     * instead of looping forever, but the fix is to correct the dialect.
+     */
+    static safelyFetchTableSchema(connection: InfoConnection, toFetch: Record<string, string>, opts: FetchSchemaOptions): Promise<{
+        schemas: Record<string, import("./model").TableSourceDef>;
+        errors: Record<string, string>;
+    }>;
+    static compileSQLBlock(dialect: string, partialModel: ModelDef | undefined, toCompile: SQLSentence, options?: CompileQueryOptions): SQLSourceDef;
     /**
      * Run a fully-prepared query.
      *
@@ -94,22 +103,22 @@ export declare class Malloy {
     }): Promise<Result>;
     static run(params: {
         connection: Connection;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
         options?: RunSQLOptions;
     }): Promise<Result>;
     static run(params: {
         connections: LookupConnection<Connection>;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
         options?: RunSQLOptions;
     }): Promise<Result>;
     static run(params: {
         connection: Connection;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
         options?: RunSQLOptions;
     }): Promise<Result>;
     static run(params: {
         connections: LookupConnection<Connection>;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
         options?: RunSQLOptions;
     }): Promise<Result>;
     static runStream(params: {
@@ -124,22 +133,12 @@ export declare class Malloy {
     }): AsyncIterableIterator<DataRecord>;
     static runStream(params: {
         connection: Connection;
-        sqlStruct: SQLBlockStructDef;
-        options?: RunSQLOptions;
-    }): AsyncIterableIterator<DataRecord>;
-    static runStream(params: {
-        connections: LookupConnection<Connection>;
-        sqlBlock: SQLBlock;
-        options?: RunSQLOptions;
-    }): AsyncIterableIterator<DataRecord>;
-    static runStream(params: {
-        connection: Connection;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
         options?: RunSQLOptions;
     }): AsyncIterableIterator<DataRecord>;
     static runStream(params: {
         connections: LookupConnection<Connection>;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
         options?: RunSQLOptions;
     }): AsyncIterableIterator<DataRecord>;
     static estimateQueryCost(params: {
@@ -148,7 +147,7 @@ export declare class Malloy {
     }): Promise<QueryRunStats>;
     static estimateQueryCost(params: {
         connections: LookupConnection<Connection>;
-        sqlStruct: SQLBlockStructDef;
+        sqlStruct: SQLSourceDef;
     }): Promise<QueryRunStats>;
 }
 /**
@@ -167,12 +166,11 @@ export declare class MalloyError extends Error {
 export declare class Model implements Taggable {
     private modelDef;
     private queryList;
-    private sqlBlocks;
     readonly problems: LogMessage[];
     readonly fromSources: string[];
     _referenceAt: (location: ModelDocumentPosition) => DocumentReference | undefined;
     _importAt: (location: ModelDocumentPosition) => ImportLocation | undefined;
-    constructor(modelDef: ModelDef, queryList: InternalQuery[], sqlBlocks: SQLBlockStructDef[], problems: LogMessage[], fromSources: string[], referenceAt?: (location: ModelDocumentPosition) => DocumentReference | undefined, importAt?: (location: ModelDocumentPosition) => ImportLocation | undefined);
+    constructor(modelDef: ModelDef, queryList: InternalQuery[], problems: LogMessage[], fromSources: string[], referenceAt?: (location: ModelDocumentPosition) => DocumentReference | undefined, importAt?: (location: ModelDocumentPosition) => ImportLocation | undefined);
     tagParse(spec?: TagParseSpec): TagParse;
     getTaglines(prefix?: RegExp): string[];
     /**
@@ -205,20 +203,6 @@ export declare class Model implements Taggable {
      * @return A prepared query.
      */
     getPreparedQueryByIndex(index: number): PreparedQuery;
-    /**
-     * Retrieve a prepared query by the name of a query at the top level of the model.
-     *
-     * @param queryName Name of the query to retrieve.
-     * @return A prepared query.
-     */
-    getSQLBlockByName(sqlBlockName: string): SQLBlockStructDef;
-    /**
-     * Retrieve a prepared query by the name of a query at the top level of the model.
-     *
-     * @param index Index of the SQL Block to retrieve.
-     * @return A prepared query.
-     */
-    getSQLBlockByIndex(index: number): SQLBlockStructDef;
     /**
      * Retrieve a prepared query for the final unnamed query at the top level of a model.
      *
@@ -598,12 +582,12 @@ export declare class Explore extends Entity implements Taggable {
     getFieldByNameIfExists(fieldName: string): Field | undefined;
     get primaryKey(): string | undefined;
     get parentExplore(): Explore | undefined;
-    get sourceRelationship(): SourceRelationship;
     hasParentExplore(): this is ExploreField;
     get filters(): FilterCondition[];
     get limit(): number | undefined;
     get structDef(): StructDef;
     get queryTimezone(): string | undefined;
+    get sourceStructDef(): SourceDef | undefined;
     toJSON(): SerializedExplore;
     static fromJSON(main_explore: SerializedExplore): Explore;
     get location(): DocumentLocation | undefined;
@@ -619,9 +603,9 @@ export declare enum AtomicFieldType {
     Error = "error"
 }
 export declare class AtomicField extends Entity implements Taggable {
-    protected fieldTypeDef: FieldTypeDef;
+    protected fieldTypeDef: AtomicFieldDef;
     protected parent: Explore;
-    constructor(fieldTypeDef: FieldTypeDef, parent: Explore, source?: AtomicField);
+    constructor(fieldTypeDef: AtomicFieldDef, parent: Explore, source?: AtomicField);
     get type(): AtomicFieldType;
     tagParse(spec?: TagParseSpec): TagParse;
     getTaglines(prefix?: RegExp): string[];
@@ -674,34 +658,34 @@ export declare enum TimestampTimeframe {
 }
 export declare class DateField extends AtomicField {
     private fieldDateDef;
-    constructor(fieldDateDef: FieldDateDef, parent: Explore, source?: AtomicField);
+    constructor(fieldDateDef: DateFieldDef, parent: Explore, source?: AtomicField);
     get timeframe(): DateTimeframe | undefined;
 }
 export declare class TimestampField extends AtomicField {
     private fieldTimestampDef;
-    constructor(fieldTimestampDef: FieldTimestampDef, parent: Explore, source?: AtomicField);
+    constructor(fieldTimestampDef: TimestampFieldDef, parent: Explore, source?: AtomicField);
     get timeframe(): TimestampTimeframe | undefined;
 }
 export declare class NumberField extends AtomicField {
     private fieldNumberDef;
-    constructor(fieldNumberDef: FieldNumberDef, parent: Explore, source?: AtomicField);
+    constructor(fieldNumberDef: NumberFieldDef, parent: Explore, source?: AtomicField);
 }
 export declare class BooleanField extends AtomicField {
     private fieldBooleanDef;
-    constructor(fieldBooleanDef: FieldBooleanDef, parent: Explore, source?: AtomicField);
+    constructor(fieldBooleanDef: BooleanFieldDef, parent: Explore, source?: AtomicField);
 }
 export declare class JSONField extends AtomicField {
     private fieldJSONDef;
-    constructor(fieldJSONDef: FieldJSONDef, parent: Explore, source?: AtomicField);
+    constructor(fieldJSONDef: JSONFieldDef, parent: Explore, source?: AtomicField);
 }
 export declare class UnsupportedField extends AtomicField {
     private fieldUnsupportedDef;
-    constructor(fieldUnsupportedDef: FeldNativeUnsupportedDef, parent: Explore, source?: AtomicField);
+    constructor(fieldUnsupportedDef: NativeUnsupportedFieldDef, parent: Explore, source?: AtomicField);
     get rawType(): string | undefined;
 }
 export declare class StringField extends AtomicField {
     private fieldStringDef;
-    constructor(fieldStringDef: FieldStringDef, parent: Explore, source?: AtomicField);
+    constructor(fieldStringDef: StringFieldDef, parent: Explore, source?: AtomicField);
 }
 export declare class Query extends Entity {
     protected turtleDef: TurtleDef;
@@ -804,26 +788,6 @@ export declare class Runtime {
      * or loading further related objects.
      */
     loadQueryByName(model: ModelURL | ModelString, name: string, options?: ParseOptions & CompileOptions & CompileQueryOptions): QueryMaterializer;
-    /**
-     * Load a SQL block by the URL or contents of a Malloy model document
-     * and the name of a query contained in the model.
-     *
-     * @param model The model URL or contents to load and (eventually) compile to retrieve the requested query.
-     * @param name The name of the sql block to use within the model.
-     * @return A `SQLBlockMaterializer` capable of materializing the requested query, running it,
-     * or loading further related objects.
-     */
-    loadSQLBlockByName(model: ModelURL | ModelString, name: string, options?: ParseOptions & CompileOptions & CompileQueryOptions): SQLBlockMaterializer;
-    /**
-     * Load a SQL block by the URL or contents of a Malloy model document
-     * and the name of a query contained in the model.
-     *
-     * @param model The model URL or contents to load and (eventually) compile to retrieve the requested query.
-     * @param index The index of the SQL block to use within the model. Note: named blocks are indexable, too.
-     * @return A `SQLBlockMaterializer` capable of materializing the requested query, running it,
-     * or loading further related objects.
-     */
-    loadSQLBlockByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions & CompileOptions): SQLBlockMaterializer;
     /**
      * Compile a Malloy model by URL or contents.
      *
@@ -856,24 +820,6 @@ export declare class Runtime {
      * @return A promise of a compiled `PreparedQuery`.
      */
     getQueryByName(model: ModelURL | ModelString, name: string, options?: ParseOptions & CompileOptions): Promise<PreparedQuery>;
-    /**
-     * Get a SQL block by the URL or contents of a Malloy model document
-     * and the name of a SQL block contained in the model.
-     *
-     * @param model The model URL or contents to load and (eventually) compile to retrieve the requested query.
-     * @param name The name of the sql block to use within the model.
-     * @return A promise of a `CompiledSQLBlock`.
-     */
-    getSQLBlockByName(model: ModelURL | ModelString, name: string, options?: ParseOptions & CompileOptions): Promise<SQLBlockStructDef>;
-    /**
-     * Get a SQL block by the URL or contents of a Malloy model document
-     * and the name of a query contained in the model.
-     *
-     * @param model The model URL or contents to load and (eventually) compile to retrieve the requested query.
-     * @param index The index of the SQL block to use within the model. Note: named blocks are indexable, too.
-     * @return A promise of a `SQLBlock`.
-     */
-    getSQLBlockByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions & CompileOptions): Promise<SQLBlockStructDef>;
 }
 export declare class ConnectionRuntime extends Runtime {
     readonly rawConnections: Connection[];
@@ -901,8 +847,6 @@ declare class FluentState<T> {
     protected makeQueryMaterializer(materialize: () => Promise<PreparedQuery>, options?: CompileQueryOptions): QueryMaterializer;
     protected makeExploreMaterializer(materialize: () => Promise<Explore>, options?: CompileQueryOptions): ExploreMaterializer;
     protected makePreparedResultMaterializer(materialize: () => Promise<PreparedResult>): PreparedResultMaterializer;
-    protected makeSQLBlockMaterializer(materialize: () => Promise<SQLBlockStructDef>): SQLBlockMaterializer;
-    get eventStream(): EventStream | undefined;
 }
 /**
  * An object representing the task of loading a `Model`, capable of
@@ -954,24 +898,6 @@ export declare class ModelMaterializer extends FluentState<Model> {
     extendModel(query: QueryString | QueryURL, options?: ParseOptions & CompileOptions & CompileQueryOptions): ModelMaterializer;
     search(sourceName: string, searchTerm: string, limit?: number, searchField?: string | undefined, eventStream?: EventStream): Promise<SearchIndexResult[] | undefined>;
     searchValueMap(sourceName: string, limit?: number, options?: ParseOptions): Promise<SearchValueMapResult[] | undefined>;
-    /**
-     * Load a SQL Block by name.
-     *
-     * @param name The name of the SQL Block to load.
-     * @return A `SQLBlockMaterializer` capable of materializing the requested sql block, running it,
-     * or loading further related objects.
-     */
-    loadSQLBlockByName(name: string): SQLBlockMaterializer;
-    /**
-     * Load a SQL Block by index.
-     *
-     * @param index The index of the SQL Block to load. Note: named SQL blocks are indexable, too.
-     * @return A `SQLBlockMaterializer` capable of materializing the requested sql block, running it,
-     * or loading further related objects.
-     *
-     * TODO feature-sql-block Should named SQL blocks be indexable? This is not the way unnamed queries work.
-     */
-    loadSQLBlockByIndex(index: number): SQLBlockMaterializer;
     /**
      * Materialize the final query contained within this loaded `Model`.
      *
@@ -999,22 +925,6 @@ export declare class ModelMaterializer extends FluentState<Model> {
      * @return A promise to a prepared query.
      */
     getQuery(query: QueryString | QueryURL, options?: ParseOptions): Promise<PreparedQuery>;
-    /**
-     * Get a SQL Block by name.
-     *
-     * @param name The name of the SQL Block to load.
-     * @return A promise of a `SQLBlock`.
-     */
-    getSQLBlockByName(name: string): Promise<SQLBlockStructDef>;
-    /**
-     * Get a SQL Block by index.
-     *
-     * @param index The index of the SQL Block to load. Note: named SQL blocks are indexable, too.
-     * @return A promise of a `SQLBlock`.
-     *
-     * TODO feature-sql-block Should named SQL blocks be indexable? This is not the way unnamed queries work.
-     */
-    getSQLBlockByIndex(index: number): Promise<SQLBlockStructDef>;
     _loadQueryFromQueryDef(query: InternalQuery, options?: CompileQueryOptions): QueryMaterializer;
     /**
      * Load an explore contained within this loaded `Model` by name.
@@ -1085,6 +995,7 @@ export declare class QueryMaterializer extends FluentState<PreparedQuery> {
      * @return The estimated cost of running this loaded query.
      */
     estimateQueryCost(options?: CompileQueryOptions): Promise<QueryRunStats>;
+    get eventStream(): EventStream | undefined;
 }
 /**
  * An object representing the task of loading a `PreparedResult`, capable of
@@ -1114,35 +1025,6 @@ export declare class PreparedResultMaterializer extends FluentState<PreparedResu
      */
     getSQL(): Promise<string>;
 }
-/**
- * An object representing the task of loading a `SQLBlock`, capable of
- * materializing the SQLBlock (via `getSQLBlock()`) or extending the task run
- * the query.
- */
-export declare class SQLBlockMaterializer extends FluentState<SQLBlockStructDef> {
-    /**
-     * Run this SQL block.
-     *
-     * @return A promise to the query result data.
-     */
-    run(options?: RunSQLOptions): Promise<Result>;
-    runStream(options?: {
-        rowLimit?: number;
-    }): AsyncIterableIterator<DataRecord>;
-    /**
-     * Materialize this loaded SQL block.
-     *
-     * @return A promise of a SQL block.
-     */
-    getSQLBlock(): Promise<SQLBlockStructDef>;
-    /**
-     * Materialize the SQL of this loaded SQL block.
-     *
-     * @return A promise to the SQL string.
-     */
-    getSQL(): Promise<string>;
-    estimateQueryCost(): Promise<QueryRunStats>;
-}
 /**
  * An object representing the task of loading an `Explore`, capable of
  * materializing the explore (via `getExplore()`) or extending the task to produce