@malloydata/malloy 0.0.96-dev231025215721 → 0.0.96

package/dist/malloy.d.ts

@@ -14,6 +14,9 @@ export interface Loggable {
 export interface ParseOptions {
     importBaseURL?: URL;
 }
+export interface CompileOptions {
+    refreshSchemaCache?: boolean | number;
+}
 export declare class Malloy {
     static get version(): string;
     private static _log;
@@ -53,11 +56,12 @@ export declare class Malloy {
      * @param model A compiled model to build upon (optional).
      * @return A (promise of a) compiled `Model`.
      */
-    static compile({ urlReader, connections, parse, model, }: {
+    static compile({ urlReader, connections, parse, model, refreshSchemaCache, }: {
         urlReader: URLReader;
         connections: LookupConnection<InfoConnection>;
         parse: Parse;
         model?: Model;
+        refreshSchemaCache?: boolean | number;
     }): Promise<Model>;
     private static compileSQLBlock;
     /**
@@ -710,7 +714,7 @@ export declare class Runtime {
      * @return A `ModelMaterializer` capable of materializing the requested model,
      * or loading further related objects.
      */
-    loadModel(source: ModelURL | ModelString, options?: ParseOptions): ModelMaterializer;
+    loadModel(source: ModelURL | ModelString, options?: ParseOptions & CompileOptions): ModelMaterializer;
     _loadModelFromModelDef(modelDef: ModelDef): ModelMaterializer;
     /**
      * Load a Malloy query by URL or contents.
@@ -719,7 +723,7 @@ export declare class Runtime {
      * @return A `QueryMaterializer` capable of materializing the requested query, running it,
      * or loading further related objects.
      */
-    loadQuery(query: QueryURL | QueryString, options?: ParseOptions): QueryMaterializer;
+    loadQuery(query: QueryURL | QueryString, options?: ParseOptions & CompileOptions): QueryMaterializer;
     /**
      * Load a Malloy query by the URL or contents of a Malloy model document
      * and the index of an unnamed query contained in the model.
@@ -729,7 +733,7 @@ export declare class Runtime {
      * @return A `QueryMaterializer` capable of materializing the requested query, running it,
      * or loading further related objects.
      */
-    loadQueryByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions): QueryMaterializer;
+    loadQueryByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions & CompileOptions): QueryMaterializer;
     /**
      * Load a Malloy query by the URL or contents of a Malloy model document
      * and the name of a query contained in the model.
@@ -739,7 +743,7 @@ export declare class Runtime {
      * @return A `QueryMaterializer` capable of materializing the requested query, running it,
      * or loading further related objects.
      */
-    loadQueryByName(model: ModelURL | ModelString, name: string, options?: ParseOptions): QueryMaterializer;
+    loadQueryByName(model: ModelURL | ModelString, name: string, options?: ParseOptions & CompileOptions): 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.
@@ -749,7 +753,7 @@ export declare class Runtime {
      * @return A `SQLBlockMaterializer` capable of materializing the requested query, running it,
      * or loading further related objects.
      */
-    loadSQLBlockByName(model: ModelURL | ModelString, name: string, options?: ParseOptions): SQLBlockMaterializer;
+    loadSQLBlockByName(model: ModelURL | ModelString, name: string, options?: ParseOptions & CompileOptions): 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.
@@ -759,21 +763,21 @@ export declare class Runtime {
      * @return A `SQLBlockMaterializer` capable of materializing the requested query, running it,
      * or loading further related objects.
      */
-    loadSQLBlockByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions): SQLBlockMaterializer;
+    loadSQLBlockByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions & CompileOptions): SQLBlockMaterializer;
     /**
      * Compile a Malloy model by URL or contents.
      *
      * @param source The URL or contents of a Malloy model document to compile.
      * @return A promise of a compiled `Model`.
      */
-    getModel(source: ModelURL | ModelString, options?: ParseOptions): Promise<Model>;
+    getModel(source: ModelURL | ModelString, options?: ParseOptions & CompileOptions): Promise<Model>;
     /**
      * Compile a Malloy query by URL or contents.
      *
      * @param query The URL or contents of a Malloy query document to compile.
      * @return A promise of a compiled `PreparedQuery`.
      */
-    getQuery(query: QueryURL | QueryString, options?: ParseOptions): Promise<PreparedQuery>;
+    getQuery(query: QueryURL | QueryString, options?: ParseOptions & CompileOptions): Promise<PreparedQuery>;
     /**
      * Compile a Malloy query by the URL or contents of a model document
      * and the index of an unnamed query contained within the model.
@@ -782,7 +786,7 @@ export declare class Runtime {
      * @param index The index of an unnamed query contained within the model.
      * @return A promise of a compiled `PreparedQuery`.
      */
-    getQueryByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions): Promise<PreparedQuery>;
+    getQueryByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions & CompileOptions): Promise<PreparedQuery>;
     /**
      * Compile a Malloy query by the URL or contents of a model document
      * and the name of a query contained within the model.
@@ -791,7 +795,7 @@ export declare class Runtime {
      * @param name The name of a query contained within the model.
      * @return A promise of a compiled `PreparedQuery`.
      */
-    getQueryByName(model: ModelURL | ModelString, name: string, options?: ParseOptions): Promise<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.
@@ -800,7 +804,7 @@ export declare class Runtime {
      * @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): Promise<SQLBlockStructDef>;
+    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.
@@ -809,7 +813,7 @@ export declare class Runtime {
      * @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): Promise<SQLBlockStructDef>;
+    getSQLBlockByIndex(model: ModelURL | ModelString, index: number, options?: ParseOptions & CompileOptions): Promise<SQLBlockStructDef>;
 }
 export declare class ConnectionRuntime extends Runtime {
     readonly rawConnections: Connection[];
@@ -870,7 +874,7 @@ export declare class ModelMaterializer extends FluentState<Model> {
      * @return A `QueryMaterializer` capable of materializing the requested query, running it,
      * or loading further related objects.
      */
-    loadQuery(query: QueryString | QueryURL, options?: ParseOptions): QueryMaterializer;
+    loadQuery(query: QueryString | QueryURL, options?: ParseOptions & CompileOptions): QueryMaterializer;
     /**
      * Extend a Malloy model by URL or contents.
      *
@@ -878,7 +882,7 @@ export declare class ModelMaterializer extends FluentState<Model> {
      * @return A `ModelMaterializer` capable of materializing the requested model,
      * or loading further related objects.
      */
-    extendModel(query: QueryString | QueryURL, options?: ParseOptions): ModelMaterializer;
+    extendModel(query: QueryString | QueryURL, options?: ParseOptions & CompileOptions): ModelMaterializer;
     search(sourceName: string, searchTerm: string, limit?: number, searchField?: string | undefined): Promise<SearchIndexResult[] | undefined>;
     searchValueMap(sourceName: string, limit?: number, options?: ParseOptions): Promise<SearchValueMapResult[] | undefined>;
     /**

package/dist/malloy.js

@@ -77,7 +77,14 @@ class Malloy {
      * @param model A compiled model to build upon (optional).
      * @return A (promise of a) compiled `Model`.
      */
-    static async compile({ urlReader, connections, parse, model, }) {
+    static async compile({ urlReader, connections, parse, model, refreshSchemaCache, }) {
+        let refreshTimestamp;
+        if (refreshSchemaCache) {
+            refreshTimestamp =
+                typeof refreshSchemaCache === 'number'
+                    ? refreshSchemaCache
+                    : Date.now();
+        }
         const translator = parse._translator;
         // eslint-disable-next-line no-constant-condition
         while (true) {
@@ -132,7 +139,9 @@ class Malloy {
                             // TODO detect if the union of `Object.keys(tables)` and `Object.keys(errors)` is not the same
                             //      as `Object.keys(tablePathByKey)`, i.e. that all tables are accounted for. Otherwise
                             //      the translator runs into an infinite loop fetching tables.
-                            const { schemas: tables, errors } = await connection.fetchSchemaForTables(tablePathByKey);
+                            const { schemas: tables, errors } = await connection.fetchSchemaForTables(tablePathByKey, {
+                                refreshTimestamp,
+                            });
                             translator.update({ tables, errors: { tables: errors } });
                         }
                         catch (error) {
@@ -154,7 +163,9 @@ class Malloy {
                     try {
                         const conn = await connections.lookupConnection(connectionName);
                         const expanded = Malloy.compileSQLBlock(result.partialModel, toCompile);
-                        const resolved = await conn.fetchSchemaForSQLBlock(expanded);
+                        const resolved = await conn.fetchSchemaForSQLBlock(expanded, {
+                            refreshTimestamp,
+                        });
                         if (resolved.error) {
                             translator.update({
                                 errors: { compileSQL: { [expanded.name]: resolved.error } },
@@ -1514,6 +1525,7 @@ class Runtime {
                 urlReader: this.urlReader,
                 connections: this.connections,
                 parse,
+                refreshSchemaCache: options === null || options === void 0 ? void 0 : options.refreshSchemaCache,
             });
         });
     }
@@ -1778,6 +1790,7 @@ class ModelMaterializer extends FluentState {
                 connections,
                 parse,
                 model,
+                refreshSchemaCache: options === null || options === void 0 ? void 0 : options.refreshSchemaCache,
             });
             return queryModel.preparedQuery;
         });
@@ -1809,6 +1822,7 @@ class ModelMaterializer extends FluentState {
                 connections,
                 parse,
                 model,
+                refreshSchemaCache: options === null || options === void 0 ? void 0 : options.refreshSchemaCache,
             });
             return queryModel;
         });

package/dist/runtime_types.d.ts

@@ -29,6 +29,12 @@ export interface URLReader {
      */
     readURL: (url: URL) => Promise<string>;
 }
+/**
+ * Options passed to fetchSchema methods.
+ */
+export interface FetchSchemaOptions {
+    refreshTimestamp?: number;
+}
 /**
  * An object capable of reading schemas for given table names.
  */
@@ -40,7 +46,7 @@ export interface InfoConnection {
      * as a map of keys to table names.
      * @return A mapping of table keys to schemas.
      */
-    fetchSchemaForTables(tables: Record<string, string>): Promise<{
+    fetchSchemaForTables(tables: Record<string, string>, options: FetchSchemaOptions): Promise<{
         schemas: Record<string, StructDef>;
         errors: Record<string, string>;
     }>;
@@ -50,7 +56,7 @@ export interface InfoConnection {
      * @param block The SQL blocks to fetch schemas for.
      * @return A mapping of SQL block names to schemas.
      */
-    fetchSchemaForSQLBlock(block: SQLBlock): Promise<{
+    fetchSchemaForSQLBlock(block: SQLBlock, options: FetchSchemaOptions): Promise<{
         structDef: StructDef;
         error?: undefined;
     } | {
@@ -109,9 +115,7 @@ export interface PersistSQLResults extends Connection {
     manifestTemporaryTable(sqlCommand: string): Promise<string>;
 }
 export interface StreamingConnection extends Connection {
-    runSQLStream(sqlCommand: string, options?: {
-        rowLimit?: number;
-    }): AsyncIterableIterator<QueryDataRow>;
+    runSQLStream(sqlCommand: string, options?: RunSQLOptions): AsyncIterableIterator<QueryDataRow>;
 }
 /**
  * A mapping of connection names to connections.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/malloy",
-  "version": "0.0.96-dev231025215721",
+  "version": "0.0.96",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",