Skip to content

Commit b51359a

Browse files
alvarowolfxalvarowolfx
authored
feat: job creation mode GA (#1480)
1 parent 8151e72 commit b51359a

File tree

6 files changed

+58
-48
lines changed

6 files changed

+58
-48
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/nodejs-bigquery/tr
153153
| Query Dry Run | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryDryRun.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryDryRun.js,samples/README.md) |
154154
| Query External GCS Perm | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryExternalGCSPerm.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryExternalGCSPerm.js,samples/README.md) |
155155
| Query External GCS Temp | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryExternalGCSTemp.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryExternalGCSTemp.js,samples/README.md) |
156+
| Query Job Optional | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryJobOptional.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryJobOptional.js,samples/README.md) |
156157
| Query Legacy | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryLegacy.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryLegacy.js,samples/README.md) |
157158
| Query Legacy Large Results | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryLegacyLargeResults.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryLegacyLargeResults.js,samples/README.md) |
158159
| Query Pagination | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryPagination.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryPagination.js,samples/README.md) |
@@ -163,7 +164,6 @@ Samples are in the [`samples/`](https://github.com/googleapis/nodejs-bigquery/tr
163164
| Query Params Positional Types | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryParamsPositionalTypes.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryParamsPositionalTypes.js,samples/README.md) |
164165
| Query Params Structs | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryParamsStructs.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryParamsStructs.js,samples/README.md) |
165166
| Query Params Timestamps | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryParamsTimestamps.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryParamsTimestamps.js,samples/README.md) |
166-
| Query Short Mode | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryShortMode.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryShortMode.js,samples/README.md) |
167167
| Query Stack Overflow | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryStackOverflow.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryStackOverflow.js,samples/README.md) |
168168
| Quickstart | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
169169
| Relax Column | [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/relaxColumn.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/relaxColumn.js,samples/README.md) |

‎samples/README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@
8686
* [Query Dry Run](#query-dry-run)
8787
* [Query External GCS Perm](#query-external-gcs-perm)
8888
* [Query External GCS Temp](#query-external-gcs-temp)
89+
* [Query Job Optional](#query-job-optional)
8990
* [Query Legacy](#query-legacy)
9091
* [Query Legacy Large Results](#query-legacy-large-results)
9192
* [Query Pagination](#query-pagination)
@@ -96,7 +97,6 @@
9697
* [Query Params Positional Types](#query-params-positional-types)
9798
* [Query Params Structs](#query-params-structs)
9899
* [Query Params Timestamps](#query-params-timestamps)
99-
* [Query Short Mode](#query-short-mode)
100100
* [Query Stack Overflow](#query-stack-overflow)
101101
* [Quickstart](#quickstart)
102102
* [Relax Column](#relax-column)
@@ -1408,6 +1408,23 @@ __Usage:__
14081408

14091409

14101410

1411+
### Query Job Optional
1412+
1413+
View the [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryJobOptional.js).
1414+
1415+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryJobOptional.js,samples/README.md)
1416+
1417+
__Usage:__
1418+
1419+
1420+
`node samples/queryJobOptional.js`
1421+
1422+
1423+
-----
1424+
1425+
1426+
1427+
14111428
### Query Legacy
14121429

14131430
View the [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryLegacy.js).
@@ -1578,23 +1595,6 @@ __Usage:__
15781595

15791596

15801597

1581-
### Query Short Mode
1582-
1583-
View the [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryShortMode.js).
1584-
1585-
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-bigquery&page=editor&open_in_editor=samples/queryShortMode.js,samples/README.md)
1586-
1587-
__Usage:__
1588-
1589-
1590-
`node samples/queryShortMode.js`
1591-
1592-
1593-
-----
1594-
1595-
1596-
1597-
15981598
### Query Stack Overflow
15991599

16001600
View the [source code](https://github.com/googleapis/nodejs-bigquery/blob/main/samples/queryStackOverflow.js).

‎samples/queryShortMode.js‎ renamed to ‎samples/queryJobOptional.js‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,17 @@
1515
'use strict';
1616

1717
function main() {
18-
// [START bigquery_query_shortmode]
18+
// [START bigquery_query_job_optional]
1919
// Demonstrates issuing a query that may be run in short query mode.
20-
// To enable the short query mode preview feature, the QUERY_PREVIEW_ENABLED
21-
// environmental variable should be set to `TRUE`.
2220

2321
// Import the Google Cloud client library
2422
const {BigQuery} = require('@google-cloud/bigquery');
25-
const bigquery = new BigQuery();
23+
const bigquery = new BigQuery({
24+
// default behavior is to create jobs when using the jobs.query API
25+
defaultJobCreationMode: 'JOB_CREATION_REQUIRED',
26+
});
2627

27-
async function queryShortMode() {
28+
async function queryJobOptional() {
2829
// SQL query to run.
2930

3031
const sqlQuery = `
@@ -35,7 +36,11 @@ function main() {
3536
LIMIT 10`;
3637

3738
// Run the query
38-
const [rows, , res] = await bigquery.query(sqlQuery);
39+
const [rows, , res] = await bigquery.query({
40+
query: sqlQuery,
41+
// Skip job creation to enable short mode.
42+
jobCreationMode: 'JOB_CREATION_OPTIONAL',
43+
});
3944

4045
if (!res.jobReference) {
4146
console.log(`Query was run in short mode. Query ID: ${res.queryId}`);
@@ -50,7 +55,7 @@ function main() {
5055
console.log('Rows:');
5156
rows.forEach(row => console.log(row));
5257
}
53-
// [END bigquery_query_shortmode]
54-
queryShortMode();
58+
// [END bigquery_query_job_optional]
59+
queryJobOptional();
5560
}
5661
main(...process.argv.slice(2));

‎samples/test/queries.test.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ describe('Queries', () => {
7070
assert.match(output, /name/);
7171
});
7272

73-
it('should run a query in short mode', async () => {
74-
const output = execSync('node queryShortMode.js');
73+
it('should run a query stateless mode', async () => {
74+
const output = execSync('node queryJobOptional.js');
7575
assert.match(output, /Rows:/);
7676
assert.match(output, /name/);
7777
});

‎src/bigquery.ts‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ export type SimpleQueryRowsCallback = ResourceCallback<
105105
bigquery.IJob
106106
>;
107107

108+
type JobCreationMode = bigquery.IQueryRequest['jobCreationMode'];
109+
108110
export type Query = JobRequest<bigquery.IJobConfigurationQuery> & {
109111
destination?: Table;
110112
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -119,6 +121,8 @@ export type Query = JobRequest<bigquery.IJobConfigurationQuery> & {
119121
pageToken?: string;
120122
wrapIntegers?: boolean | IntegerTypeCastOptions;
121123
parseJSON?: boolean;
124+
// Overrides default job creation mode set on the client.
125+
jobCreationMode?: JobCreationMode;
122126
};
123127

124128
export type QueryParamTypeStruct = {
@@ -271,6 +275,13 @@ export interface BigQueryOptions extends GoogleAuthOptions {
271275
* Defaults to `googleapis.com`.
272276
*/
273277
universeDomain?: string;
278+
279+
/**
280+
* Controls the job creation mode used when executing queries that can be
281+
* accelerated via the jobs.Query API. Users may experience performance
282+
* improvements by leveraging the JOB_CREATION_OPTIONAL mode.
283+
*/
284+
defaultJobCreationMode?: JobCreationMode;
274285
}
275286

276287
export interface IntegerTypeCastOptions {
@@ -320,12 +331,6 @@ export const PROTOCOL_REGEX = /^(\w*):\/\//;
320331
* We will create a table with the correct schema, import the public CSV file
321332
* into that table, and query it for data.
322333
*
323-
* This client supports enabling query-related preview features via environmental
324-
* variables. By setting the environment variable QUERY_PREVIEW_ENABLED to the string
325-
* "TRUE", the client will enable preview features, though behavior may still be
326-
* controlled via the bigquery service as well. Currently, the feature(s) in scope
327-
* include: stateless queries (query execution without corresponding job metadata).
328-
*
329334
* @class
330335
*
331336
* See {@link https://cloud.google.com/bigquery/what-is-bigquery| What is BigQuery?}
@@ -362,7 +367,7 @@ export const PROTOCOL_REGEX = /^(\w*):\/\//;
362367
export class BigQuery extends Service {
363368
location?: string;
364369
private _universeDomain: string;
365-
private _enableQueryPreview: boolean;
370+
private _defaultJobCreationMode: JobCreationMode;
366371

367372
createQueryStream(options?: Query | string): ResourceStream<RowMetadata> {
368373
// placeholder body, overwritten in constructor
@@ -421,12 +426,8 @@ export class BigQuery extends Service {
421426

422427
super(config, options);
423428

424-
const QUERY_PREVIEW_ENABLED = process.env.QUERY_PREVIEW_ENABLED;
425-
this._enableQueryPreview = false;
426-
if (typeof QUERY_PREVIEW_ENABLED === 'string') {
427-
if (QUERY_PREVIEW_ENABLED.toUpperCase() === 'TRUE') {
428-
this._enableQueryPreview = true;
429-
}
429+
if (options.defaultJobCreationMode) {
430+
this._defaultJobCreationMode = options.defaultJobCreationMode;
430431
}
431432

432433
this._universeDomain = universeDomain;
@@ -2338,7 +2339,7 @@ export class BigQuery extends Service {
23382339
query: queryObj.query,
23392340
useLegacySql: false,
23402341
requestId: randomUUID(),
2341-
jobCreationMode: 'JOB_CREATION_OPTIONAL',
2342+
jobCreationMode: this._defaultJobCreationMode,
23422343
reservation: queryObj.reservation,
23432344
continuous: queryObj.continuous,
23442345
destinationEncryptionConfiguration:
@@ -2347,8 +2348,9 @@ export class BigQuery extends Service {
23472348
connectionProperties: queryObj.connectionProperties,
23482349
preserveNulls: queryObj.preserveNulls,
23492350
};
2350-
if (!this._enableQueryPreview) {
2351-
delete req.jobCreationMode;
2351+
if (queryObj.jobCreationMode) {
2352+
// override default job creation mode
2353+
req.jobCreationMode = queryObj.jobCreationMode;
23522354
}
23532355
const {parameterMode, params} = this.buildQueryParams_(
23542356
queryObj.params,

‎test/bigquery.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,10 @@ describe('BigQuery', () => {
189189
beforeEach(() => {
190190
Object.assign(fakeUtil, originalFakeUtil);
191191
BigQuery = Object.assign(BigQuery, BigQueryCached);
192-
bq = new BigQuery({projectId: PROJECT_ID});
193-
bq._enableQueryPreview = true;
192+
bq = new BigQuery({
193+
projectId: PROJECT_ID,
194+
defaultJobCreationMode: 'JOB_CREATION_OPTIONAL',
195+
});
194196
});
195197

196198
after(() => {
@@ -3360,6 +3362,7 @@ describe('BigQuery', () => {
33603362
labels: {
33613363
key: 'value',
33623364
},
3365+
jobCreationMode: 'JOB_CREATION_REQUIRED',
33633366
};
33643367
const req = bq.buildQueryRequest_(q, {});
33653368
for (const key in req) {
@@ -3392,7 +3395,7 @@ describe('BigQuery', () => {
33923395
labels: {
33933396
key: 'value',
33943397
},
3395-
jobCreationMode: 'JOB_CREATION_OPTIONAL',
3398+
jobCreationMode: 'JOB_CREATION_REQUIRED',
33963399
formatOptions: {
33973400
useInt64Timestamp: true,
33983401
},

0 commit comments

Comments
 (0)