feat: update constructors and add cancel method

Author: alvarowolfx

src/query/builder.ts

@@ -15,11 +15,11 @@
 import {protos} from '../';
 
 /**
- * QueryFromSQL creates a query configuration from a SQL string.
+ * fromSQL creates a query configuration from a SQL string.
  * @param {string} sql The SQL query.
  * @returns {protos.google.cloud.bigquery.v2.IPostQueryRequest}
  */
-export function queryFromSQL(
+export function fromSQL(
   projectId: string,
   sql: string,
 ): protos.google.cloud.bigquery.v2.IPostQueryRequest {

src/query/client.ts

@@ -15,11 +15,10 @@
 import {
   BigQueryClient,
   BigQueryClientOptions,
-  SubClientOptions,
 } from '../bigquery';
 import {QueryJob, CallOptions} from './job';
 import {protos} from '../';
-import {queryFromSQL as builderQueryFromSQL} from './builder';
+import {fromSQL as builderFromSQL} from './builder';
 
 /**
  * QueryClient is a client for running queries in BigQuery.
@@ -34,9 +33,8 @@ export class QueryClient {
    */
   constructor(
     options?: BigQueryClientOptions,
-    subClientOptions?: SubClientOptions,
   ) {
-    this.client = new BigQueryClient(options, subClientOptions);
+    this.client = new BigQueryClient(options);
     this.projectId = '';
     this.billingProjectId = '';
     void this.initialize();
@@ -80,12 +78,12 @@ export class QueryClient {
   }
 
   /**
-   * QueryFromSQL creates a query configuration from a SQL string.
+   * fromSQL creates a query configuration from a SQL string.
    * @param {string} sql The SQL query.
    * @returns {protos.google.cloud.bigquery.v2.IPostQueryRequest}
    */
-  queryFromSQL(sql: string): protos.google.cloud.bigquery.v2.IPostQueryRequest {
-    const req = builderQueryFromSQL(this.projectId, sql);
+  fromSQL(sql: string): protos.google.cloud.bigquery.v2.IPostQueryRequest {
+    const req = builderFromSQL(this.projectId, sql);
     return req;
   }
 

src/query/index.ts

@@ -16,4 +16,4 @@ export {QueryClient} from './client';
 export {QueryJob} from './job';
 export {Row} from './row';
 export {RowIterator} from './iterator';
-export {queryFromSQL} from './builder';
+export {fromSQL} from './builder';

src/query/job.ts

@@ -29,7 +29,7 @@ export interface CallOptions extends GaxCallOptions {
  */
 export class QueryJob {
   private client: QueryClient;
-  private complete: boolean;
+  private jobComplete: boolean;
   private projectId: string;
   private jobId: string;
   private location: string;
@@ -49,7 +49,7 @@ export class QueryJob {
     this.cachedSchema = {};
     this.cachedPageToken = '';
     this.cachedTotalRows = 0;
-    this.complete = false;
+    this.jobComplete = false;
 
     this.consumeQueryResponse({
       jobComplete: response.jobComplete,
@@ -84,6 +84,10 @@ export class QueryJob {
     return this.cachedSchema;
   }
 
+  get complete(): boolean {
+    return this.jobComplete
+  }
+
   /**
    * Waits for the query to complete.
    *
@@ -103,6 +107,22 @@ export class QueryJob {
     }
   }
 
+  /**
+   * Cancel a running query.
+   *
+   * @param {CallOptions} [options]
+   *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+   */
+  async cancel(options?: CallOptions): Promise<protos.google.cloud.bigquery.v2.IJobCancelResponse> {
+     const {jobClient} = this.client.getBigQueryClient();
+     const [response] = await jobClient.cancelJob({
+      projectId: this.projectId,
+      jobId: this.jobId,
+      location: this.location,      
+     }, options);
+     return response;
+  }
+
   private async waitFor(signal?: AbortSignal): Promise<void> {
     const delay = 1000; // TODO: backoff settings
     return new Promise((resolve, reject) => {
@@ -156,7 +176,7 @@ export class QueryJob {
   private consumeQueryResponse(
     response: protos.google.cloud.bigquery.v2.IGetQueryResultsResponse,
   ) {
-    this.complete = response.jobComplete?.value ?? false;
+    this.jobComplete = response.jobComplete?.value ?? false;
     this.cachedSchema = response.schema!;
     this.cachedPageToken = response.pageToken!;
     this.cachedTotalRows = Number(response.totalRows);

system-test/fixtures/transport.ts

@@ -19,22 +19,14 @@ import { QueryClient } from '../../src/query';
 export const describeWithBothTransports = (title: string, fn: (client: QueryClient) => void) => {
   describe(title, () => {    
     describe("REST", () => {        
-        const client = new query.QueryClient({}, {
-            opts: {
-                fallback: true,
-            }
-        });
+        const client = new query.QueryClient({ fallback: true });
         before(async () => {
             await client.initialize();
         });
         fn(client);
     });
     describe("GRPC", () => {
-        const client = new query.QueryClient({}, {
-            opts: {
-                fallback: false,
-            }
-        });
+        const client = new query.QueryClient({ fallback: false });
         before(async () => {
             await client.initialize();
         });

system-test/query/query.ts

@@ -37,7 +37,7 @@ describeWithBothTransports('Run Query', client => {
   });
 
   it('should run a stateless query', async () => {
-    const req = client.queryFromSQL(
+    const req = client.fromSQL(
       'SELECT CURRENT_TIMESTAMP() as foo, SESSION_USER() as bar',
     );
     req.queryRequest!.jobCreationMode =
@@ -55,7 +55,7 @@ describeWithBothTransports('Run Query', client => {
   });
 
   it('should stop waiting for query to complete', async () => {
-    const req = client.queryFromSQL(
+    const req = client.fromSQL(
       'SELECT num FROM UNNEST(GENERATE_ARRAY(1,1000000)) as num',
     );
     req.queryRequest!.useQueryCache = {value: false};
@@ -78,7 +78,7 @@ describeWithBothTransports('Run Query', client => {
   }).timeout(5000);
 
   it('should read a query job without cache', async () => {
-    const req = client.queryFromSQL(
+    const req = client.fromSQL(
       'SELECT CURRENT_TIMESTAMP() as foo, SESSION_USER() as bar',
     );
     req.queryRequest!.jobCreationMode =

system-test/query/value.ts

@@ -22,7 +22,7 @@ describeWithBothTransports('Read Query Values', client => {
   describe('types', () => {
     for (const tc of queryParameterTestCases()) {
       it(tc.name, async () => {
-        const req = client.queryFromSQL(tc.query);
+        const req = client.fromSQL(tc.query);
         req.queryRequest!.queryParameters = tc.parameters;
 
         const q = await client.startQuery(req);
@@ -40,7 +40,7 @@ describeWithBothTransports('Read Query Values', client => {
   });
 
   it('should read nested objects', async () => {
-    const req = client.queryFromSQL(
+    const req = client.fromSQL(
       "SELECT 40 as age, [STRUCT(STRUCT('1' as a, '2' as b) as object)] as nested",
     );
     const q = await client.startQuery(req);