@malloydata/db-publisher 0.0.270-dev250429163414

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublisherConnection = void 0;
+var publisher_connection_1 = require("./publisher_connection");
+Object.defineProperty(exports, "PublisherConnection", { enumerable: true, get: function () { return publisher_connection_1.PublisherConnection; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+DAA2D;AAAnD,2HAAA,mBAAmB,OAAA"}

package/dist/publisher_connection.d.ts

@@ -0,0 +1,29 @@
+import type { Connection, MalloyQueryData, PersistSQLResults, PooledConnection, QueryDataRow, QueryRunStats, StreamingConnection, SQLSourceDef, SQLSourceRequest, TableSourceDef, RunSQLOptions, TestableConnection } from '@malloydata/malloy';
+import { BaseConnection } from '@malloydata/malloy/connection';
+interface PublisherConnectionOptions {
+    connectionUri: string;
+    accessToken?: string;
+}
+export declare class PublisherConnection extends BaseConnection implements Connection, StreamingConnection, TestableConnection, PersistSQLResults {
+    readonly name: string;
+    readonly projectName: string;
+    private connectionsApi;
+    private connectionAttributes;
+    private accessToken;
+    static create(name: string, options: PublisherConnectionOptions): Promise<PublisherConnection>;
+    private static getAuthHeaders;
+    private constructor();
+    get dialectName(): string;
+    isPool(): this is PooledConnection;
+    canPersist(): this is PersistSQLResults;
+    canStream(): this is StreamingConnection;
+    fetchTableSchema(tableKey: string, tablePath: string): Promise<TableSourceDef>;
+    fetchSelectSchema(sqlRef: SQLSourceRequest): Promise<SQLSourceDef>;
+    estimateQueryCost(_sqlCommand: string): Promise<QueryRunStats>;
+    runSQL(sql: string, options?: RunSQLOptions): Promise<MalloyQueryData>;
+    runSQLStream(sqlCommand: string, options?: RunSQLOptions): AsyncIterableIterator<QueryDataRow>;
+    test(): Promise<void>;
+    manifestTemporaryTable(sqlCommand: string): Promise<string>;
+    close(): Promise<void>;
+}
+export {};

package/dist/publisher_connection.js

@@ -0,0 +1,119 @@
+"use strict";
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublisherConnection = void 0;
+const connection_1 = require("@malloydata/malloy/connection");
+const client_1 = require("./client");
+class PublisherConnection extends connection_1.BaseConnection {
+    static async create(name, options) {
+        const url = new URL(options.connectionUri);
+        const urlParts = url.pathname.split('/');
+        if (urlParts.length !== 7) {
+            const fmt = '/api/v0/projects/{projectName}/connections/{connectionName}';
+            throw new Error(`Invalid connection URI: ${options.connectionUri}. Expected format: ${fmt}`);
+        }
+        const apiTag = urlParts[1];
+        const versionTag = urlParts[2];
+        const projectName = urlParts[4];
+        const connectionName = urlParts[6];
+        if (name !== connectionName) {
+            throw new Error(`Connection name mismatch: ${name} !== ${connectionName}. Connection name must match the URI path.`);
+        }
+        const apiUrl = `${url.origin}/${apiTag}/${versionTag}`;
+        const configuration = new client_1.Configuration({
+            basePath: apiUrl,
+        });
+        const connectionsApi = new client_1.ConnectionsApi(configuration);
+        const response = await connectionsApi.getConnection(projectName, name, {
+            headers: PublisherConnection.getAuthHeaders(options.accessToken),
+        });
+        const connectionAttributes = response.data
+            .attributes;
+        const connection = new PublisherConnection(name, projectName, connectionsApi, connectionAttributes, options.accessToken);
+        await connection.test();
+        return connection;
+    }
+    static getAuthHeaders(accessToken) {
+        return {
+            ...(accessToken && { Authorization: `Bearer ${accessToken}` }),
+        };
+    }
+    constructor(name, projectName, connectionsApi, connectionAttributes, accessToken) {
+        super();
+        this.name = name;
+        this.projectName = projectName;
+        this.connectionsApi = connectionsApi;
+        this.connectionAttributes = connectionAttributes;
+        this.accessToken = accessToken;
+    }
+    get dialectName() {
+        return this.connectionAttributes.dialectName;
+    }
+    isPool() {
+        return this.connectionAttributes.isPool;
+    }
+    canPersist() {
+        return this.connectionAttributes.canPersist;
+    }
+    canStream() {
+        return this.connectionAttributes.canStream;
+    }
+    async fetchTableSchema(tableKey, tablePath) {
+        const response = await this.connectionsApi.getTablesource(this.projectName, this.name, tableKey, tablePath, {
+            headers: PublisherConnection.getAuthHeaders(this.accessToken),
+        });
+        return JSON.parse(response.data.source);
+    }
+    async fetchSelectSchema(sqlRef) {
+        const response = await this.connectionsApi.getSqlsource(this.projectName, this.name, sqlRef.selectStr, {
+            headers: PublisherConnection.getAuthHeaders(this.accessToken),
+        });
+        return JSON.parse(response.data.source);
+    }
+    async estimateQueryCost(_sqlCommand) {
+        // Most connection types don't support cost estimation.
+        return {};
+    }
+    async runSQL(sql, options = {}) {
+        // TODO: Add support for abortSignal.
+        options.abortSignal = undefined;
+        const response = await this.connectionsApi.getQuerydata(this.projectName, this.name, sql, JSON.stringify(options), {
+            headers: PublisherConnection.getAuthHeaders(this.accessToken),
+        });
+        return JSON.parse(response.data.data);
+    }
+    async *runSQLStream(sqlCommand, options = {}) {
+        // TODO: Add support for abortSignal.
+        options.abortSignal = undefined;
+        // TODO: Add real streaming support to publisher API.
+        const response = await this.connectionsApi.getQuerydata(this.projectName, this.name, sqlCommand, JSON.stringify(options), {
+            headers: PublisherConnection.getAuthHeaders(this.accessToken),
+        });
+        const queryData = JSON.parse(response.data.data);
+        for (const row of queryData.rows) {
+            yield row;
+        }
+    }
+    async test() {
+        await this.connectionsApi.getTest(this.projectName, this.name, {
+            headers: PublisherConnection.getAuthHeaders(this.accessToken),
+        });
+    }
+    async manifestTemporaryTable(sqlCommand) {
+        const response = await this.connectionsApi.getTemporarytable(this.projectName, this.name, sqlCommand, {
+            headers: PublisherConnection.getAuthHeaders(this.accessToken),
+        });
+        return response.data.table;
+    }
+    async close() {
+        // Can't close the remote connection.
+        return;
+    }
+}
+exports.PublisherConnection = PublisherConnection;
+//# sourceMappingURL=publisher_connection.js.map

package/dist/publisher_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publisher_connection.js","sourceRoot":"","sources":["../src/publisher_connection.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAgBH,8DAA6D;AAE7D,qCAAuD;AAOvD,MAAa,mBACX,SAAQ,2BAAc;IAatB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,OAAmC;QACnE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,6DAA6D,CAAC;YAC1E,MAAM,IAAI,KAAK,CACb,2BAA2B,OAAO,CAAC,aAAa,sBAAsB,GAAG,EAAE,CAC5E,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEnC,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,6BAA6B,IAAI,QAAQ,cAAc,4CAA4C,CACpG,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,IAAI,MAAM,IAAI,UAAU,EAAE,CAAC;QACvD,MAAM,aAAa,GAAG,IAAI,sBAAa,CAAC;YACtC,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,IAAI,uBAAc,CAAC,aAAa,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,EAAE;YACrE,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC;SACjE,CAAC,CAAC;QACH,MAAM,oBAAoB,GAAG,QAAQ,CAAC,IAAI;aACvC,UAAkC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,mBAAmB,CACxC,IAAI,EACJ,WAAW,EACX,cAAc,EACd,oBAAoB,EACpB,OAAO,CAAC,WAAW,CACpB,CAAC;QACF,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,MAAM,CAAC,cAAc,CAC3B,WAA+B;QAE/B,OAAO;YACL,GAAG,CAAC,WAAW,IAAI,EAAC,aAAa,EAAE,UAAU,WAAW,EAAE,EAAC,CAAC;SAC7D,CAAC;IACJ,CAAC;IAED,YACE,IAAY,EACZ,WAAmB,EACnB,cAA8B,EAC9B,oBAA0C,EAC1C,WAA+B;QAE/B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAqB,CAAC;IACzD,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAiB,CAAC;IACrD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,oBAAoB,CAAC,UAAqB,CAAC;IACzD,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAoB,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAC3B,QAAgB,EAChB,SAAiB;QAEjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CACvD,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,IAAI,EACT,QAAQ,EACR,SAAS,EACT;YACE,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC;SAC9D,CACF,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAgB,CAAmB,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,MAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CACrD,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,IAAI,EACT,MAAM,CAAC,SAAS,EAChB;YACE,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC;SAC9D,CACF,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAgB,CAAiB,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,WAAmB;QAChD,uDAAuD;QACvD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,KAAK,CAAC,MAAM,CACjB,GAAW,EACX,UAAyB,EAAE;QAE3B,qCAAqC;QACrC,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CACrD,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,IAAI,EACT,GAAG,EACH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EACvB;YACE,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC;SAC9D,CACF,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAc,CAAoB,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,CAAC,YAAY,CACxB,UAAkB,EAClB,UAAyB,EAAE;QAE3B,qCAAqC;QACrC,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;QAChC,qDAAqD;QACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CACrD,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,IAAI,EACT,UAAU,EACV,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EACvB;YACE,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC;SAC9D,CACF,CAAC;QACF,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,QAAQ,CAAC,IAAI,CAAC,IAAc,CACV,CAAC;QACrB,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;YACjC,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE;YAC7D,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,UAAkB;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAC1D,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,IAAI,EACT,UAAU,EACV;YACE,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC;SAC9D,CACF,CAAC;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAe,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,qCAAqC;QACrC,OAAO;IACT,CAAC;CACF;AAhMD,kDAgMC"}

package/dist/publisher_connection.spec.d.ts

@@ -0,0 +1 @@
+export {};