@malloydata/db-bigquery 0.0.424 → 0.0.426

package/dist/bigquery_connection.d.ts

@@ -100,7 +100,7 @@ export declare class BigQueryConnection extends BaseConnection implements Connec
     private createBigQueryJobAndGetResults;
     private createBigQueryJob;
     initiateJobAndGetLinkToConsole(sqlCommand: string, dryRun?: boolean): Promise<string>;
-    runSQLStream(sqlCommand: string, { rowLimit, abortSignal }?: RunSQLOptions): AsyncIterableIterator<QueryRecord>;
+    runSQLStream(sqlCommand: string, { rowLimit, abortSignal, queryMetadata }?: RunSQLOptions): AsyncIterableIterator<QueryRecord>;
     fetchTableMetadata(tablePath: string): Promise<TableMetadata>;
     close(): Promise<void>;
 }

package/dist/bigquery_connection.js

@@ -43,6 +43,35 @@ const googleCommon = __importStar(require("@google-cloud/common"));
 const gaxios_1 = require("gaxios");
 const malloy_1 = require("@malloydata/malloy");
 const connection_1 = require("@malloydata/malloy/connection");
+// BigQuery label grammar: keys and values are lowercase, <=63 chars, and
+// [a-z0-9_-]; keys must start with a lowercase letter. Values are transformed
+// to fit (lowercase, disallowed chars -> '_', truncate); a key that can't be
+// made valid (e.g. it starts with a digit) is dropped. BigQuery's 64-label cap
+// needs no check here: the contract allows fewer properties than that.
+const BQ_MAX_LEN = 63;
+function sanitizeBigQueryValue(value) {
+    return value
+        .toLowerCase()
+        .replace(/[^a-z0-9_-]/g, '_')
+        .slice(0, BQ_MAX_LEN);
+}
+function sanitizeBigQueryKey(key) {
+    const sanitized = sanitizeBigQueryValue(key);
+    return /^[a-z]/.test(sanitized) ? sanitized : undefined;
+}
+/** Render a query's metadata as BigQuery job labels, in BQ's grammar. */
+function toBigQueryLabels(labels) {
+    if (labels === undefined)
+        return undefined;
+    const out = {};
+    for (const [key, value] of Object.entries(labels)) {
+        const sanitizedKey = sanitizeBigQueryKey(key);
+        if (sanitizedKey === undefined)
+            continue; // can't be a valid BQ key; drop
+        out[sanitizedKey] = sanitizeBigQueryValue(value);
+    }
+    return Object.keys(out).length > 0 ? out : undefined;
+}
 // BigQuery SDK apparently throws various authentication errors from Gaxios (https://github.com/googleapis/gaxios) and from
 // @google-cloud/common (https://www.npmjs.com/package/@google-cloud/common)
 // catching and rewriting here a single kind of authentication error we can consistently catch further up the stack
@@ -153,16 +182,18 @@ class BigQueryConnection extends connection_1.BaseConnection {
     get supportsNesting() {
         return true;
     }
-    async _runSQL(sqlCommand, { rowLimit, abortSignal } = {}, rowIndex = 0) {
+    async _runSQL(sqlCommand, options = {}, rowIndex = 0) {
         var _a, _b, _c;
+        const { rowLimit, abortSignal } = options;
         const defaultOptions = this.readQueryOptions();
         const pageSize = rowLimit !== null && rowLimit !== void 0 ? rowLimit : defaultOptions.rowLimit;
+        const perCallLabels = toBigQueryLabels(this.queryMetadataBag(options.queryMetadata));
         try {
             const queryResultsOptions = {
                 maxResults: pageSize,
                 startIndex: rowIndex.toString(),
             };
-            const jobResult = await this.createBigQueryJobAndGetResults(sqlCommand, undefined, queryResultsOptions, abortSignal);
+            const jobResult = await this.createBigQueryJobAndGetResults(sqlCommand, perCallLabels ? { labels: perCallLabels } : undefined, queryResultsOptions, abortSignal);
             const totalRows = +(((_a = jobResult[2]) === null || _a === void 0 ? void 0 : _a.totalRows)
                 ? jobResult[2].totalRows
                 : '0');
@@ -581,7 +612,8 @@ class BigQueryConnection extends connection_1.BaseConnection {
         const url = `https://console.cloud.google.com/bigquery?project=${this.billingProjectId}&j=bq:${job.location}:${job.id}&page=queryresults`;
         return url;
     }
-    runSQLStream(sqlCommand, { rowLimit, abortSignal } = {}) {
+    runSQLStream(sqlCommand, { rowLimit, abortSignal, queryMetadata } = {}) {
+        const labels = toBigQueryLabels(this.queryMetadataBag(queryMetadata));
         const streamBigQuery = (onError, onData, onEnd) => {
             let index = 0;
             function handleData(rowMetadata) {
@@ -592,8 +624,9 @@ class BigQueryConnection extends connection_1.BaseConnection {
                     this.end();
                 }
             }
+            const query = this.prependSetupSQL(sqlCommand);
             this.bigQuery
-                .createQueryStream(this.prependSetupSQL(sqlCommand))
+                .createQueryStream(labels ? { query, labels } : query)
                 .on('error', onError)
                 .on('data', handleData)
                 .on('end', onEnd);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/db-bigquery",
-  "version": "0.0.424",
+  "version": "0.0.426",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
     "@google-cloud/bigquery": "7.9.4",
     "@google-cloud/common": "5.0.2",
     "@google-cloud/paginator": "5.0.2",
-    "@malloydata/malloy": "0.0.424",
+    "@malloydata/malloy": "0.0.426",
     "gaxios": "^4.2.0"
   }
 }