Run BigQuery Job Query - BlinkOps Documentation

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

External DocumentationTo learn more, visit the GCP documentation.

Basic Parameters

Parameter	Description
Project ID	Project ID of the project billed for the query.
Query	[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: “SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]”.

Advanced Parameters

Parameter	Description
Create Session	If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
Default Dataset Dataset ID	[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Default Dataset Project ID	[Optional] The ID of the project containing this dataset.
Dry Run	[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.
Kind	The resource type of the request.
Labels	The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
Location	The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Max Results	[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.
Maximum Bytes Billed	[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
Parameter Mode	Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
Query Parameters	Query parameters for Standard SQL queries.
Request ID	A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don’t affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.
Timeout Ms	[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 GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
Use Legacy Sql	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.
Use Query Cache	[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.

Example Output

{
	"kind": "<string>",
	"schema": {
		"fields": [
			{
				"name": "<string>",
				"type": "<string>",
				"mode": "<string>"
			}
		]
	},
	"jobReference": {
		"projectId": "<string>",
		"jobId": "<string>",
		"location": "<string>"
	},
	"totalRows": "<string>",
	"rows": [
		{
			"f": [
				{
					"v": "<string>"
				}
			]
		}
	],
	"totalBytesProcessed": "<string>",
	"jobComplete": false,
	"cacheHit": false,
	"queryId": "<string>",
	"jobCreationReason": {
		"code": "<string>"
	},
	"totalBytesBilled": "<string>",
	"totalSlotMs": "<string>",
	"location": "<string>",
	"creationTime": "<string>",
	"startTime": "<string>",
	"endTime": "<string>"
}