Method: jobs.query

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization Scopes
• QueryRequest
  • JSON representation
• Try it!

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	string 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 (TableSchema) }, "jobReference": { object (JobReference) }, "totalRows": string, "pageToken": string, "rows": [ { object } ], "totalBytesProcessed": string, "jobComplete": boolean, "errors": [ { object (ErrorProto) } ], "cacheHit": boolean, "numDmlAffectedRows": string }

Fields
kind	string The resource type.
schema	object (TableSchema) The schema of the results. Present only when the query completes successfully.
jobReference	object (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	string (UInt64Value format) 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	string A token used for paging results.
rows[]	object (Struct format) 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	string (Int64Value format) 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	boolean 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[]	object (ErrorProto) 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	boolean Whether the query result was fetched from the query cache.
numDmlAffectedRows	string (Int64Value format) 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 (DatasetReference) }, "timeoutMs": number, "dryRun": boolean, "preserveNulls": boolean, "useQueryCache": boolean, "useLegacySql": boolean, "parameterMode": string, "queryParameters": [ { object (QueryParameter) } ], "location": string }

Fields
kind	string The resource type of the request.
query	string Required. A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".
maxResults	number 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	object (DatasetReference) 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	number 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	boolean 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 (deprecated)	boolean This item is deprecated! This property is deprecated.
useQueryCache	boolean 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	boolean 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	string Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
queryParameters[]	object (QueryParameter) jobs.query parameters for Standard SQL queries.
location	string The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Try it!