@malloydata/malloy 0.0.165-dev240813195925 → 0.0.165-dev240813215606

package/dist/connection/base_connection.d.ts

@@ -0,0 +1,24 @@
+import { MalloyQueryData, QueryRunStats, SQLBlock, StructDef } from '../model/malloy_types';
+import { RunSQLOptions } from '../run_sql_options';
+import { Connection, FetchSchemaOptions, PersistSQLResults, PooledConnection, StreamingConnection } from './types';
+export declare abstract class BaseConnection implements Connection {
+    abstract runSQL(sql: string, options?: RunSQLOptions | undefined): Promise<MalloyQueryData>;
+    abstract get name(): string;
+    abstract get dialectName(): string;
+    abstract fetchSchemaForSQLBlock(block: SQLBlock, options: FetchSchemaOptions): Promise<{
+        structDef: StructDef;
+        error?: undefined;
+    } | {
+        error: string;
+        structDef?: undefined;
+    }>;
+    abstract fetchSchemaForTables(tables: Record<string, string>, options: FetchSchemaOptions): Promise<{
+        schemas: Record<string, StructDef>;
+        errors: Record<string, string>;
+    }>;
+    isPool(): this is PooledConnection;
+    canPersist(): this is PersistSQLResults;
+    canStream(): this is StreamingConnection;
+    close(): Promise<void>;
+    estimateQueryCost(_sqlCommand: string): Promise<QueryRunStats>;
+}

package/dist/connection/base_connection.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseConnection = void 0;
+class BaseConnection {
+    isPool() {
+        return false;
+    }
+    canPersist() {
+        return false;
+    }
+    canStream() {
+        return false;
+    }
+    async close() { }
+    async estimateQueryCost(_sqlCommand) {
+        return {};
+    }
+}
+exports.BaseConnection = BaseConnection;
+//# sourceMappingURL=base_connection.js.map

package/dist/connection/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './base_connection';

package/dist/connection/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./base_connection"), exports);
+//# sourceMappingURL=index.js.map

package/dist/connection/types.d.ts

@@ -0,0 +1,105 @@
+import { RunSQLOptions } from '../run_sql_options';
+import { Annotation, MalloyQueryData, QueryDataRow, QueryRunStats, SQLBlock, StructDef } from '../model/malloy_types';
+import { Dialect } from '../dialect';
+/**
+ * Options passed to fetchSchema methods.
+ */
+export interface FetchSchemaOptions {
+    refreshTimestamp?: number;
+    modelAnnotation?: Annotation;
+}
+/**
+ * An object capable of reading schemas for given table names.
+ */
+export interface InfoConnection {
+    /**
+     * Fetch schemas for multiple tables.
+     *
+     * @param tables The names of tables to fetch schemas for, represented
+     * as a map of keys to table names.
+     * @return A mapping of table keys to schemas.
+     */
+    fetchSchemaForTables(tables: Record<string, string>, options: FetchSchemaOptions): Promise<{
+        schemas: Record<string, StructDef>;
+        errors: Record<string, string>;
+    }>;
+    /**
+     * Fetch schemas an SQL blocks
+     *
+     * @param block The SQL blocks to fetch schemas for.
+     * @return A mapping of SQL block names to schemas.
+     */
+    fetchSchemaForSQLBlock(block: SQLBlock, options: FetchSchemaOptions): Promise<{
+        structDef: StructDef;
+        error?: undefined;
+    } | {
+        error: string;
+        structDef?: undefined;
+    }>;
+    /**
+     * The name of the connection.
+     */
+    get name(): string;
+}
+export type ConnectionParameterValue = string | number | boolean | Array<ConnectionParameterValue>;
+export interface ConnectionParameter {
+    name: string;
+    label: string;
+    type: 'string' | 'number' | 'boolean';
+    isOptional?: boolean;
+    isSecret?: boolean;
+    defaultValue?: ConnectionParameterValue;
+}
+export type ConnectionConfigSchema = ConnectionParameter[];
+export interface ConnectionConfig {
+    name: string;
+    [key: string]: ConnectionParameterValue | undefined;
+}
+export interface ConnectionFactory {
+    connectionName: string;
+    configSchema: ConnectionConfigSchema;
+    createConnection(connectionConfig: ConnectionConfig, dialectRegistrar?: (dialect: Dialect) => void): Connection & TestableConnection;
+}
+/**
+ * An object capable of running SQL.
+ */
+export interface Connection extends InfoConnection {
+    /**
+     * Run some SQL and yield results.
+     *
+     * @param sql The SQL to run.
+     * @param options.pageSize Maximum number of results to return at once.
+     * @return The rows of data resulting from running the given SQL query
+     * and the total number of rows available.
+     */
+    runSQL(sql: string, options?: RunSQLOptions): Promise<MalloyQueryData>;
+    isPool(): this is PooledConnection;
+    canPersist(): this is PersistSQLResults;
+    canStream(): this is StreamingConnection;
+    close(): Promise<void>;
+    estimateQueryCost(sqlCommand: string): Promise<QueryRunStats>;
+    get dialectName(): string;
+}
+export interface TestableConnection extends Connection {
+    test(): Promise<void>;
+}
+export interface PooledConnection extends Connection {
+    drain(): Promise<void>;
+    isPool(): true;
+}
+export interface PersistSQLResults extends Connection {
+    manifestTemporaryTable(sqlCommand: string): Promise<string>;
+}
+export interface StreamingConnection extends Connection {
+    runSQLStream(sqlCommand: string, options?: RunSQLOptions): AsyncIterableIterator<QueryDataRow>;
+}
+/**
+ * A mapping of connection names to connections.
+ */
+export interface LookupConnection<T extends InfoConnection> {
+    /**
+     * @param connectionName The name of the connection for which a `Connection` is required.
+     * @return A promise to a `Connection` for the connection named `connectionName`.
+     */
+    lookupConnection(connectionName?: string): Promise<T>;
+}

package/dist/connection/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export type { LogMessage, TranslateResponse } from './lang';
 export { Model, Malloy, Runtime, AtomicFieldType, ConnectionRuntime, SingleConnectionRuntime, EmptyURLReader, InMemoryURLReader, FixedConnectionMap, MalloyError, JoinRelationship, SourceRelationship, DateTimeframe, TimestampTimeframe, PreparedResult, Result, QueryMaterializer, CSVWriter, JSONWriter, Parse, DataWriter, Explore, } from './malloy';
 export type { PreparedQuery, Field, AtomicField, ExploreField, QueryField, SortableField, DataArray, DataRecord, DataColumn, DataArrayOrRecord, Loggable, ModelMaterializer, DocumentSymbol, ResultJSON, PreparedResultMaterializer, SQLBlockMaterializer, ExploreMaterializer, WriteStream, SerializedExplore, } from './malloy';
 export type { QueryOptionsReader, RunSQLOptions } from './run_sql_options';
-export type { Connection, ConnectionConfig, ConnectionFactory, ConnectionParameter, ConnectionParameterValue, ConnectionConfigSchema, FetchSchemaOptions, InfoConnection, LookupConnection, ModelString, ModelURL, PersistSQLResults, PooledConnection, QueryString, QueryURL, TestableConnection, StreamingConnection, URLReader, } from './runtime_types';
+export type { ModelString, ModelURL, QueryString, QueryURL, URLReader, } from './runtime_types';
+export type { Connection, ConnectionConfig, ConnectionFactory, ConnectionParameter, ConnectionParameterValue, ConnectionConfigSchema, FetchSchemaOptions, InfoConnection, LookupConnection, PersistSQLResults, PooledConnection, TestableConnection, StreamingConnection, } from './connection/types';
 export { toAsyncGenerator } from './connection_utils';
 export { type TagParse, Tag, type TagDict } from './tags';

package/dist/malloy.d.ts

@@ -3,7 +3,8 @@ 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, FilterExpression, Query as InternalQuery, ModelDef, DocumentPosition as ModelDocumentPosition, NamedQuery, QueryData, QueryDataRow, QueryResult, SQLBlock, SQLBlockSource, SQLBlockStructDef, SearchIndexResult, SearchValueMapResult, StructDef, TurtleDef, FeldNativeUnsupportedDef, QueryRunStats, ImportLocation, Annotation } from './model';
-import { Connection, InfoConnection, LookupConnection, ModelString, ModelURL, QueryString, QueryURL, URLReader } from './runtime_types';
+import { ModelString, ModelURL, QueryString, QueryURL, URLReader } from './runtime_types';
+import { Connection, InfoConnection, LookupConnection } from './connection/types';
 import { Tag, TagParse, TagParseSpec, Taggable } from './tags';
 import { Dialect } from './dialect';
 export interface Loggable {

package/dist/model/malloy_query.d.ts

@@ -1,6 +1,6 @@
 import { Dialect, DialectFieldList } from '../dialect';
 import { AggregateFragment, AggregateFunctionType, Annotation, CompiledQuery, DialectFragment, Expr, FieldDef, FieldFragment, Filtered, FilterExpression, FilterFragment, FunctionCallFragment, FunctionOverloadDef, FunctionParameterDef, JoinRelationship, ModelDef, OrderBy, OutputFieldFragment, Parameter, ParameterFragment, PipeSegment, Query, QueryFieldDef, QuerySegment, ResultMetadataDef, ResultStructMetadataDef, SearchIndexResult, SourceReferenceFragment, SegmentFieldDef, SpreadFragment, SQLExpressionFragment, SqlStringFragment, StructDef, StructRef, TurtleDef, UngroupFragment, FunctionOrderBy, Argument } from './malloy_types';
-import { Connection } from '../runtime_types';
+import { Connection } from '../connection/types';
 import { AndChain } from './utils';
 import { QueryInfo } from '../dialect/dialect';
 interface TurtleDefPlus extends TurtleDef, Filtered {

package/dist/runtime_types.d.ts

@@ -1,6 +1,3 @@
-import { RunSQLOptions } from './run_sql_options';
-import { Annotation, MalloyQueryData, QueryDataRow, QueryRunStats, SQLBlock, StructDef } from './model/malloy_types';
-import { Dialect } from './dialect';
 /**
  * The contents of a Malloy query document.
  */
@@ -29,105 +26,3 @@ export interface URLReader {
      */
     readURL: (url: URL) => Promise<string>;
 }
-/**
- * Options passed to fetchSchema methods.
- */
-export interface FetchSchemaOptions {
-    refreshTimestamp?: number;
-    modelAnnotation?: Annotation;
-}
-/**
- * An object capable of reading schemas for given table names.
- */
-export interface InfoConnection {
-    /**
-     * Fetch schemas for multiple tables.
-     *
-     * @param tables The names of tables to fetch schemas for, represented
-     * as a map of keys to table names.
-     * @return A mapping of table keys to schemas.
-     */
-    fetchSchemaForTables(tables: Record<string, string>, options: FetchSchemaOptions): Promise<{
-        schemas: Record<string, StructDef>;
-        errors: Record<string, string>;
-    }>;
-    /**
-     * Fetch schemas an SQL blocks
-     *
-     * @param block The SQL blocks to fetch schemas for.
-     * @return A mapping of SQL block names to schemas.
-     */
-    fetchSchemaForSQLBlock(block: SQLBlock, options: FetchSchemaOptions): Promise<{
-        structDef: StructDef;
-        error?: undefined;
-    } | {
-        error: string;
-        structDef?: undefined;
-    }>;
-    /**
-     * The name of the connection.
-     */
-    get name(): string;
-}
-export type ConnectionParameterValue = string | number | boolean | Array<ConnectionParameterValue>;
-export interface ConnectionParameter {
-    name: string;
-    label: string;
-    type: 'string' | 'number' | 'boolean';
-    isOptional?: boolean;
-    isSecret?: boolean;
-    defaultValue?: ConnectionParameterValue;
-}
-export type ConnectionConfigSchema = ConnectionParameter[];
-export interface ConnectionConfig {
-    name: string;
-    [key: string]: ConnectionParameterValue | undefined;
-}
-export interface ConnectionFactory {
-    connectionName: string;
-    configSchema: ConnectionConfigSchema;
-    createConnection(connectionConfig: ConnectionConfig, dialectRegistrar?: (dialect: Dialect) => void): Connection & TestableConnection;
-}
-/**
- * An object capable of running SQL.
- */
-export interface Connection extends InfoConnection {
-    /**
-     * Run some SQL and yield results.
-     *
-     * @param sql The SQL to run.
-     * @param options.pageSize Maximum number of results to return at once.
-     * @return The rows of data resulting from running the given SQL query
-     * and the total number of rows available.
-     */
-    runSQL(sql: string, options?: RunSQLOptions): Promise<MalloyQueryData>;
-    isPool(): this is PooledConnection;
-    canPersist(): this is PersistSQLResults;
-    canStream(): this is StreamingConnection;
-    close(): Promise<void>;
-    estimateQueryCost(sqlCommand: string): Promise<QueryRunStats>;
-    get dialectName(): string;
-}
-export interface TestableConnection extends Connection {
-    test(): Promise<void>;
-}
-export interface PooledConnection extends Connection {
-    drain(): Promise<void>;
-    isPool(): true;
-}
-export interface PersistSQLResults extends Connection {
-    manifestTemporaryTable(sqlCommand: string): Promise<string>;
-}
-export interface StreamingConnection extends Connection {
-    runSQLStream(sqlCommand: string, options?: RunSQLOptions): AsyncIterableIterator<QueryDataRow>;
-}
-/**
- * A mapping of connection names to connections.
- */
-export interface LookupConnection<T extends InfoConnection> {
-    /**
-     * @param connectionName The name of the connection for which a `Connection` is required.
-     * @return A promise to a `Connection` for the connection named `connectionName`.
-     */
-    lookupConnection(connectionName?: string): Promise<T>;
-}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@malloydata/malloy",
-  "version": "0.0.165-dev240813195925",
+  "version": "0.0.165-dev240813215606",
   "license": "MIT",
   "exports": {
     ".": "./dist/index.js",
-    "./test": "./dist/test/index.js"
+    "./test": "./dist/test/index.js",
+    "./connection": "./dist/connection/index.js"
   },
   "typesVersions": {
     "*": {
@@ -13,6 +14,9 @@
       ],
       "test": [
         "./dist/test/index.d.ts"
+      ],
+      "connection": [
+        "./dist/connection/index.d.ts"
       ]
     }
   },