Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
HTTP request
POST https://bigquery.googleapis.com/bigquery/v2/projects/{projectId}/queries
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
projectId |
Required. Project ID of the query request. |
Request body
The request body contains an instance of QueryRequest
.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "kind": string, "schema": { object ( |
Fields | |
---|---|
kind |
The resource type. |
schema |
The schema of the results. Present only when the query completes successfully. |
jobReference |
Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case jobs.getQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (jobs.getQueryResults). |
totalRows |
The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. |
pageToken |
A token used for paging results. |
rows[] |
An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call jobs.getQueryResults and specify the jobReference returned above. |
totalBytesProcessed |
The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. |
jobComplete |
Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. |
errors[] |
Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
cacheHit |
Whether the query result was fetched from the query cache. |
numDmlAffectedRows |
Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/bigquery
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/bigquery.readonly
https://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the Authentication Overview.
QueryRequest
JSON representation | |
---|---|
{ "kind": string, "query": string, "maxResults": number, "defaultDataset": { object ( |
Fields | |
---|---|
kind |
The resource type of the request. |
query |
Required. A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". |
maxResults |
Optional. The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. |
defaultDataset |
Optional. Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. |
timeoutMs |
Optional. How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call jobs.getQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds). |
dryRun |
Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. |
preserveNulls |
This property is deprecated. |
useQueryCache |
Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. |
useLegacySql |
Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
parameterMode |
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
queryParameters[] |
jobs.query parameters for Standard SQL queries. |
location |
The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |