Class QueryRequest

Describes the format of the jobs.query request.

Inheritance
object
QueryRequest
Implements
Inherited Members
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class QueryRequest : IDirectResponseSchema

Properties

ConnectionProperties

Optional. Connection properties which can modify the query behavior.

Declaration
[JsonProperty("connectionProperties")]
public virtual IList<ConnectionProperty> ConnectionProperties { get; set; }
Property Value
Type Description
IList<ConnectionProperty>

Continuous

[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.

Declaration
[JsonProperty("continuous")]
public virtual bool? Continuous { get; set; }
Property Value
Type Description
bool?

CreateSession

Optional. If true, creates a new session using a randomly generated session_id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. The session location will be set to QueryRequest.location if it is present, otherwise it's set to the default location based on existing routing logic.

Declaration
[JsonProperty("createSession")]
public virtual bool? CreateSession { get; set; }
Property Value
Type Description
bool?

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'.

Declaration
[JsonProperty("defaultDataset")]
public virtual DatasetReference DefaultDataset { get; set; }
Property Value
Type Description
DatasetReference

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.

Declaration
[JsonProperty("dryRun")]
public virtual bool? DryRun { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FormatOptions

Optional. Output format adjustments.

Declaration
[JsonProperty("formatOptions")]
public virtual DataFormatOptions FormatOptions { get; set; }
Property Value
Type Description
DataFormatOptions

JobCreationMode

Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. Preview

Declaration
[JsonProperty("jobCreationMode")]
public virtual string JobCreationMode { get; set; }
Property Value
Type Description
string

Kind

The resource type of the request.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

Labels

Optional. The labels associated with this query. Labels can be used to organize and group query 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 keys must start with a letter and each label in the list must have a different key.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Location

The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Declaration
[JsonProperty("location")]
public virtual string Location { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("maxResults")]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
long?

MaximumBytesBilled

Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used.

Declaration
[JsonProperty("maximumBytesBilled")]
public virtual long? MaximumBytesBilled { get; set; }
Property Value
Type Description
long?

ParameterMode

GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

Declaration
[JsonProperty("parameterMode")]
public virtual string ParameterMode { get; set; }
Property Value
Type Description
string

PreserveNulls

This property is deprecated.

Declaration
[JsonProperty("preserveNulls")]
public virtual bool? PreserveNulls { get; set; }
Property Value
Type Description
bool?

Query

Required. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: "SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId".

Declaration
[JsonProperty("query")]
public virtual string Query { get; set; }
Property Value
Type Description
string

QueryParameters

Query parameters for GoogleSQL queries.

Declaration
[JsonProperty("queryParameters")]
public virtual IList<QueryParameter> QueryParameters { get; set; }
Property Value
Type Description
IList<QueryParameter>

RequestId

Optional. 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 another request, all parameters in the request that may affect the result 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.

Declaration
[JsonProperty("requestId")]
public virtual string RequestId { get; set; }
Property Value
Type Description
string

TimeoutMs

Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.

Declaration
[JsonProperty("timeoutMs")]
public virtual long? TimeoutMs { get; set; }
Property Value
Type Description
long?

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 GoogleSQL: 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.

Declaration
[JsonProperty("useLegacySql")]
public virtual bool? UseLegacySql { get; set; }
Property Value
Type Description
bool?

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.

Declaration
[JsonProperty("useQueryCache")]
public virtual bool? UseQueryCache { get; set; }
Property Value
Type Description
bool?

Implements