feat: query client and basic query execution flow #1542

alvarowolfx · 2025-09-18T16:28:33Z

This PR introduces the new query client with basic query execution flow (no retries yet) covering the 3 use cases:

Running a query using jobs.query and obtaining a Query handler
Running a query using jobs.insert and obtaining a Query handler
Reattaching to a Query handler from a JobReference

Implements long pooling of job status in the background to mark query as complete.

Towards #1541

leahecole

Meta comment that I want to have this be in a branch off of preview-9.x for now because I will be using preview-9.x as a release branch

leahecole · 2025-09-23T19:19:02Z

tsconfig.json

-
+  ],
+  "exclude": [
+    "system-test/fixtures/sample/**/*.ts"


What's the reasoning behind this?

I was getting an error to compile the code, because those fixtures are used for pack-n-play tests.

> @google-cloud/bigquery@0.1.0 compile > tsc -p . && cp -r protos build/ && minifyProtoJson system-test/fixtures/sample/src/index.ts:19:168 - error TS2307: Cannot find module '@google-cloud/bigquery' or its corresponding type declarations. 19 import {DatasetServiceClient, JobServiceClient, ModelServiceClient, ProjectServiceClient, RoutineServiceClient, RowAccessPolicyServiceClient, TableServiceClient} from '@google-cloud/bigquery';

Another thing is failing is that npm run fix is failing because it's missing "eslint-plugin-prettier", I was going to add to package.json too.

I figured out if you remove the added include and the exclude the system tests run fine - I would strongly prefer to not modify this file at all because it's templated. Made suggestion comments

Oooo I see why you included it - lint. Ugh! This should probably get changed at the template level imho

OH I can get what I want - no changes to this file, if we move query.ts to just be under system-test - would you be okay with that?

Another thing is failing is that npm run fix is failing because it's missing "eslint-plugin-prettier", I was going to add to package.json too.

I am not seeing this locally or in CI for other PRs, but I'll keep an eye out for it and try to repro

system-test/query/query.ts

leahecole · 2025-09-23T20:48:39Z

src/query/client.ts

+/**
+ * QueryClient is a client for running queries in BigQuery.
+ */
+export class QueryClient {


I am feeling skeptical about this being a separate client and I need to think more about what I don't like.

One thing I can think of is that if it is going to be its own separate client, I would want to see if defined more similarly to the other clients - where we have it be a class attribute of the bigQueryClient rather than the other way around

leahecole · 2025-09-23T20:49:41Z

src/query/client.ts

+   */
+  constructor(options?: BigQueryClientOptions) {
+    this.client = new BigQueryClient(options);
+    this.projectId = '';


could initializing this to empty string cause an issue later? Would initializing it as undefined be a better choice?

These questions may become obsolete if we structure this client like the other ones

leahecole · 2025-09-23T20:51:37Z

src/query/helper.ts

+    if (this.projectId) {
+      return;
+    }
+    const {jobClient} = this.getBigQueryClient();


Should we be having this instead mess with the underlying job client rather than the centralized one?

Thinking about this though, I do now see why you want the knowledge of the centralized BigQueryClient's existence and how you're going to be using it

leahecole · 2025-09-23T20:54:08Z

src/query/iterator.ts

+   * Asynchronously iterates over the rows in the query result.
+   */
+  async *[Symbol.asyncIterator](): AsyncGenerator<Row> {
+    // TODO: implement iterator


note to make sure there's a tracking bug

leahecole · 2025-09-23T20:56:19Z

src/query/query.ts

+    options?: CallOptions,
+  ): Query {
+    const q = new Query(client);
+    q.location = response.location ?? '';


Is it actually okay if this is undefined? What are the consequences of setting this to empty string?

leahecole · 2025-09-26T19:29:20Z

tsconfig.json

    "test/*.ts",
    "test/**/*.ts",
    "system-test/*.ts",
+    "system-test/**/*.ts",


Suggested change

"system-test/**/*.ts",

leahecole · 2025-09-26T19:29:48Z

tsconfig.json

+  ],
+  "exclude": [
+    "system-test/fixtures/sample/**/*.ts"
  ]


Suggested change

],

"exclude": [

"system-test/fixtures/sample/**/*.ts"

]

]

leahecole · 2025-09-26T19:30:45Z

tsconfig.json

-
+  ],
+  "exclude": [
+    "system-test/fixtures/sample/**/*.ts"


I figured out if you remove the added include and the exclude the system tests run fine - I would strongly prefer to not modify this file at all because it's templated. Made suggestion comments

leahecole · 2025-09-26T19:33:58Z

tsconfig.json

-
+  ],
+  "exclude": [
+    "system-test/fixtures/sample/**/*.ts"


Oooo I see why you included it - lint. Ugh! This should probably get changed at the template level imho

leahecole · 2025-09-26T19:36:55Z

tsconfig.json

-
+  ],
+  "exclude": [
+    "system-test/fixtures/sample/**/*.ts"


OH I can get what I want - no changes to this file, if we move query.ts to just be under system-test - would you be okay with that?

leahecole · 2025-09-26T19:39:02Z

tsconfig.json

-
+  ],
+  "exclude": [
+    "system-test/fixtures/sample/**/*.ts"


Another thing is failing is that npm run fix is failing because it's missing "eslint-plugin-prettier", I was going to add to package.json too.

I am not seeing this locally or in CI for other PRs, but I'll keep an eye out for it and try to repro

leahecole · 2025-09-26T19:41:21Z

src/query/helper.ts

+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import {BigQueryClient, BigQueryClientOptions} from '../bigquery';


Suggested change

import {BigQueryClient, BigQueryClientOptions} from '../bigquery';

import {BigQueryClient} from '../bigquery';

alvarowolfx added 3 commits September 16, 2025 13:32

feat: query client and basic query execution flow

8f79da0

fix: assert job is complete

bda3123

feat: make job pooling happen in the background

6836d67

alvarowolfx requested a review from leahecole September 18, 2025 16:28

alvarowolfx requested review from a team as code owners September 18, 2025 16:28

product-auto-label bot added size: l Pull request size is large. api: bigquery Issues related to the googleapis/nodejs-bigquery API. labels Sep 18, 2025

leahecole reviewed Sep 23, 2025

View reviewed changes

alvarowolfx added 4 commits September 24, 2025 11:31

fix: point TODOs to the right issue

268d301

ci: rollback tsconfig

e7acd90

feat: move query creation to the background and rename client to helper

8eec4df

docs: improve overall method jsdocs

b47a918

leahecole reviewed Sep 26, 2025

View reviewed changes

	import {BigQueryClient, BigQueryClientOptions} from '../bigquery';
	import {BigQueryClient} from '../bigquery';

feat: query client and basic query execution flow #1542

Are you sure you want to change the base?

feat: query client and basic query execution flow #1542

Conversation

alvarowolfx commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

leahecole left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alvarowolfx commented Sep 18, 2025 •

edited

Loading