chore: add Jobs samples, add backoff to table update sample (#1524)

leahecole · web-flow · commit d5222221eb63 · 2025-08-29T14:49:54.000-04:00
* chore: fix owlbot configs, regenerate * Apply suggestions from code review * WIP - two different ways * don't overwrite handwritten methods * change to sync file read * chore: periodic regen * run postprocessor * upgrade dependencies to node 18 * Revert "upgrade dependencies to node 18" This reverts commit b7ca3fc. * periodic regeneration + update to node 18 on autogen branch * fix lint errors * more lint fixes * listJobs sample * getJob request * createJob sample * cancel job sample * fix lint * fix license year * fix - add backoff to table update sample test * change to 5 seconds for backoff polling because of bq defaults * use async list jobs method, limit iterations * address alvaro comment * lint * fix indentation
diff --git a/samples/jobs/cancelJob.js b/samples/jobs/cancelJob.js
@@ -0,0 +1,46 @@
+/**
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId = 'my-project-id', jobId = 'existing-job-id') {
+  // [START bigquery_cancel_job]
+  // Import the Google Cloud client library
+  const {BigQueryClient} = require('@google-cloud/bigquery');
+  const bigqueryClient = new BigQueryClient();
+
+  async function cancelJob() {
+    // Attempts to cancel a job.
+
+    /**
+     * TODO(developer): Uncomment the following lines before running the sample.
+     */
+    // const jobId = "existing-job-id";
+
+    const request = {
+      projectId,
+      jobId,
+    };
+
+    // Attempt to cancel job
+    const [response] = await bigqueryClient.cancelJob(request);
+
+    console.log(response.job.status);
+  }
+  // [END bigquery_cancel_job]
+  cancelJob();
+}
+main(...process.argv.slice(2));
diff --git a/samples/jobs/createJob.js b/samples/jobs/createJob.js
@@ -0,0 +1,75 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+function main(projectId = 'my-project') {
+  // [START bigquery_create_job]
+  // Import the Google Cloud client library and create a client
+  const {BigQueryClient} = require('@google-cloud/bigquery');
+  const {setInterval} = require('node:timers/promises');
+
+  const bigquery = new BigQueryClient();
+
+  async function createJob() {
+    // Run a BigQuery query job.
+
+    const query = `SELECT country_name 
+            FROM 
+              bigquery-public-data.utility_us.country_code_iso 
+            LIMIT 10`;
+
+    const request = {
+      projectId: projectId,
+      job: {
+        configuration: {
+          query: {
+            query: query,
+            useLegacySql: {value: false},
+          },
+          labels: {'example-label': 'example-value'},
+        },
+      },
+    };
+
+    // Make API request.
+    const [job] = await bigquery.insertJob(request);
+    const jobReference = job.jobReference;
+    const jobId = jobReference.jobId;
+    const getQueryResultsRequest = {
+      projectId: projectId,
+      jobId: jobId,
+      location: jobReference.location.value,
+    };
+    // poll the job status every 3 seconds until complete
+    // eslint-disable-next-line
+    for await (const t of setInterval(3000)) { // no-unused-vars - this is the syntax for promise based setInterval
+      const [resp] = await bigquery.jobClient.getQueryResults(
+        getQueryResultsRequest,
+      );
+      if (resp.errors.length !== 0) {
+        throw new Error('Something failed in job creation');
+      }
+      if (resp.jobComplete.value) {
+        const rows = resp.rows;
+        console.log('Rows:');
+        rows.forEach(row => console.log(JSON.stringify(row)));
+        break;
+      }
+    }
+  }
+  // [END bigquery_create_job]
+  createJob();
+}
+main(...process.argv.slice(2));
diff --git a/samples/jobs/getJob.js b/samples/jobs/getJob.js
@@ -0,0 +1,46 @@
+/**
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId = 'my_project', jobId = 'existing-job-id') {
+  // [START bigquery_get_job]
+  // Import the Google Cloud client library
+  const {BigQueryClient} = require('@google-cloud/bigquery');
+  const bigquery = new BigQueryClient();
+
+  async function getJob() {
+    // Get job properties.
+
+    /**
+     * TODO(developer): Uncomment the following lines before running the sample.
+     */
+    // const projectId = "my_project";
+    // const jobId = "existing-job-id";
+
+    const request = {
+      projectId,
+      jobId,
+      location: 'US',
+    };
+    const [job] = await bigquery.getJob(request);
+
+    console.log(`Job ${job.id} status: ${job.status.state}`);
+  }
+  // [END bigquery_get_job]
+  getJob();
+}
+main(...process.argv.slice(2));
diff --git a/samples/jobs/listJobs.js b/samples/jobs/listJobs.js
@@ -0,0 +1,44 @@
+/**
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId = 'my_project') {
+  // [START bigquery_list_jobs]
+  // Import the Google Cloud client library
+  const {BigQueryClient} = require('@google-cloud/bigquery');
+  const bigquery = new BigQueryClient();
+
+  async function listJobs() {
+    // Lists all jobs in current GCP project.
+    const request = {projectId: projectId};
+    // limit results to 10
+    const maxResults = 10;
+    const iterable = bigquery.listJobsAsync(request);
+    console.log('Jobs:');
+    let i = 0;
+    for await (const job of iterable) {
+      if (i >= maxResults) {
+        break;
+      }
+      console.log(job.id);
+      i++;
+    }
+  }
+  // [END bigquery_list_jobs]
+  listJobs();
+}
+main(...process.argv.slice(2));
diff --git a/samples/models/listModelsStreaming.js b/samples/models/listModelsStreaming.js
@@ -13,7 +13,6 @@
 // limitations under the License.
 
 'use strict';
-//TODO(coleleah): update
 
 // sample-metadata:
 //   title: BigQuery List Models Streaming
diff --git a/samples/test/jobs.test.js b/samples/test/jobs.test.js
@@ -0,0 +1,154 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+const {BigQueryClient} = require('@google-cloud/bigquery');
+const {assert} = require('chai');
+const {describe, it, before, after} = require('mocha');
+const {randomUUID} = require('crypto');
+const {setInterval} = require('node:timers/promises');
+
+const cp = require('child_process');
+
+const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
+
+const bigquery = new BigQueryClient();
+let jobId;
+const GCLOUD_TESTS_PREFIX = 'nodejs_samples_tests_jobs';
+
+// the GCLOUD_PROJECT environment variable is set as part of test harness setup
+const projectId = process.env.GCLOUD_PROJECT;
+
+describe('Jobs', () => {
+  const datasetId = `${GCLOUD_TESTS_PREFIX}_${randomUUID()}`.replace(
+    /-/gi,
+    '_',
+  );
+  const query = `SELECT country_name 
+                FROM \`bigquery-public-data.utility_us.country_code_iso\` 
+                LIMIT 10`;
+  const insertJobRequest = {
+    projectId: projectId,
+    job: {
+      configuration: {
+        query: {
+          query: query,
+          useLegacySql: {value: false},
+        },
+      },
+    },
+  };
+
+  before(async () => {
+    if (projectId === undefined) {
+      throw Error(
+        'GCLOUD_PROJECT must be defined as an environment variable before tests can be run',
+      );
+    }
+    const datasetObject = {
+      datasetReference: {
+        datasetId: datasetId,
+      },
+      location: 'US',
+    };
+    const datasetRequest = {
+      projectId: projectId,
+      dataset: datasetObject,
+    };
+    const [datasetResponse] = await bigquery.insertDataset(datasetRequest);
+    assert.ok(datasetResponse);
+  });
+  after(async () => {
+    const deleteRequest = {
+      projectId: projectId,
+      datasetId: datasetId,
+      deleteContents: true,
+    };
+    await bigquery.deleteDataset(deleteRequest);
+    const getDatasetRequest = {
+      projectId: projectId,
+      datasetId: datasetId,
+    };
+    try {
+      await bigquery.getDataset(getDatasetRequest);
+    } catch (err) {
+      assert.strictEqual(
+        err.details,
+        `Not found: Dataset ${projectId}:${datasetId}`,
+      );
+    }
+  });
+
+  describe('get + list jobs', () => {
+    before('create a job to get/list', async () => {
+      // Run query to create a job
+      const [job] = await bigquery.insertJob(insertJobRequest);
+      assert.ok(job);
+      const jobReference = job.jobReference;
+      const getQueryResultsRequest = {
+        projectId: projectId,
+        jobId: jobReference.jobId,
+        location: jobReference.location.value,
+      };
+      jobId = getQueryResultsRequest.jobId;
+      // poll the job status every 3 seconds until complete
+      // eslint-disable-next-line
+      for await (const t of setInterval(3000)) { // no-unused-vars - this is the syntax for promise based setInterval
+        const [resp] = await bigquery.jobClient.getQueryResults(
+          getQueryResultsRequest,
+        );
+        if (resp.errors.length !== 0) {
+          throw new Error('Something failed in job creation');
+        }
+        if (resp.jobComplete.value) {
+          break;
+        }
+      }
+    });
+
+    it('should list jobs', async () => {
+      const output = execSync(`node jobs/listJobs.js ${projectId}`);
+      assert.match(output, /Jobs:/);
+      assert.include(output, jobId);
+    });
+
+    it('should retrieve a job', async () => {
+      const output = execSync(`node jobs/getJob.js ${projectId} ${jobId}`);
+      assert.include(output, `Job ${projectId}:US.${jobId}`);
+    });
+  });
+
+  describe('create + cancel jobs', () => {
+    let jobId;
+    before('create a job to cancel', async () => {
+      // Run query to create a job
+      const [job] = await bigquery.insertJob(insertJobRequest);
+      assert.ok(job);
+      jobId = job.jobReference.jobId;
+    });
+    it('should attempt to cancel a job', async () => {
+      assert.exists(jobId);
+      const output = execSync(`node jobs/cancelJob.js ${projectId} ${jobId}`);
+      assert.include(output, 'state:');
+      assert.include(output, 'errorResult: null');
+    });
+
+    it('should create a job', async () => {
+      const output = execSync(`node jobs/createJob.js ${projectId}`);
+      assert.include(output, 'Rows:');
+      assert.include(output, 'Tromelin Island');
+    });
+  });
+});
diff --git a/samples/test/tables.test.js b/samples/test/tables.test.js
