Class QueryRequest
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class QueryRequest : IDirectResponseSchema
Properties
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 |
---|---|
System.Nullable<System.Boolean> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Kind
The resource type of the request.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type | Description |
---|---|
System.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 |
---|---|
System.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 |
---|---|
System.Nullable<System.Int64> |
ParameterMode
Standard SQL 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 |
---|---|
System.String |
PreserveNulls
[Deprecated] This property is deprecated.
Declaration
[JsonProperty("preserveNulls")]
public virtual bool? PreserveNulls { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
Query
[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".
Declaration
[JsonProperty("query")]
public virtual string Query { get; set; }
Property Value
Type | Description |
---|---|
System.String |
QueryParameters
Query parameters for Standard SQL queries.
Declaration
[JsonProperty("queryParameters")]
public virtual IList<QueryParameter> QueryParameters { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<QueryParameter> |
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 GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
Declaration
[JsonProperty("timeoutMs")]
public virtual long? TimeoutMs { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
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.
Declaration
[JsonProperty("useLegacySql")]
public virtual bool? UseLegacySql { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
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 |
---|---|
System.Nullable<System.Boolean> |