Method: googleapis.bigquery.v2.jobs.query
Stay organized with collections
Save and categorize content based on your preferences.
Runs a BigQuery SQL query synchronously and returns query results if the
query completes within a specified timeout.
For example, you can create a workflow that runs multiple BigQuery query jobs in
parallel.
Arguments
Parameters |
projectId |
string
Required. Project ID of the project billed for the query
|
body |
object (QueryRequest)
Required.
|
Raised exceptions
Exceptions |
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of QueryResponse
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation.
YAML
- query:
call: googleapis.bigquery.v2.jobs.query
args:
projectId: ...
body:
connectionProperties: ...
createSession: ...
defaultDataset:
datasetId: ...
projectId: ...
dryRun: ...
kind: ...
labels: ...
location: ...
maxResults: ...
maximumBytesBilled: ...
parameterMode: ...
preserveNulls: ...
query: ...
queryParameters: ...
requestId: ...
timeoutMs: ...
useLegacySql: ...
useQueryCache: ...
result: queryResult
JSON
[
{
"query": {
"call": "googleapis.bigquery.v2.jobs.query",
"args": {
"projectId": "...",
"body": {
"connectionProperties": "...",
"createSession": "...",
"defaultDataset": {
"datasetId": "...",
"projectId": "..."
},
"dryRun": "...",
"kind": "...",
"labels": "...",
"location": "...",
"maxResults": "...",
"maximumBytesBilled": "...",
"parameterMode": "...",
"preserveNulls": "...",
"query": "...",
"queryParameters": "...",
"requestId": "...",
"timeoutMs": "...",
"useLegacySql": "...",
"useQueryCache": "..."
}
},
"result": "queryResult"
}
}
]
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Method: googleapis.bigquery.v2.jobs.query\n\nRuns a BigQuery SQL query synchronously and returns query results if the\nquery completes within a specified timeout.\n\nFor example, you can [create a workflow that runs multiple BigQuery query jobs in\nparallel](/workflows/docs/tutorials/bigquery-parallel-jobs).\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`QueryResponse`](/workflows/docs/reference/googleapis/bigquery/v2/Overview#QueryResponse).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query). \n\n### YAML\n\n```yaml\n- query:\n call: googleapis.bigquery.v2.jobs.query\n args:\n projectId: ...\n body:\n connectionProperties: ...\n createSession: ...\n defaultDataset:\n datasetId: ...\n projectId: ...\n dryRun: ...\n kind: ...\n labels: ...\n location: ...\n maxResults: ...\n maximumBytesBilled: ...\n parameterMode: ...\n preserveNulls: ...\n query: ...\n queryParameters: ...\n requestId: ...\n timeoutMs: ...\n useLegacySql: ...\n useQueryCache: ...\n result: queryResult\n```\n\n### JSON\n\n```json\n[\n {\n \"query\": {\n \"call\": \"googleapis.bigquery.v2.jobs.query\",\n \"args\": {\n \"projectId\": \"...\",\n \"body\": {\n \"connectionProperties\": \"...\",\n \"createSession\": \"...\",\n \"defaultDataset\": {\n \"datasetId\": \"...\",\n \"projectId\": \"...\"\n },\n \"dryRun\": \"...\",\n \"kind\": \"...\",\n \"labels\": \"...\",\n \"location\": \"...\",\n \"maxResults\": \"...\",\n \"maximumBytesBilled\": \"...\",\n \"parameterMode\": \"...\",\n \"preserveNulls\": \"...\",\n \"query\": \"...\",\n \"queryParameters\": \"...\",\n \"requestId\": \"...\",\n \"timeoutMs\": \"...\",\n \"useLegacySql\": \"...\",\n \"useQueryCache\": \"...\"\n }\n },\n \"result\": \"queryResult\"\n }\n }\n]\n```"]]