class Google::Apis::BigqueryV2::QueryRequest

Attributes

default_dataset[RW]
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'. Corresponds to the JSON property `defaultDataset` @return [Google::Apis::BigqueryV2::DatasetReference]

dry_run[RW]
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. Corresponds to the JSON property `dryRun` @return [Boolean]

dry_run?[RW]
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. Corresponds to the JSON property `dryRun` @return [Boolean]

kind[RW]

The resource type of the request. Corresponds to the JSON property `kind` @return [String]

max_results[RW]
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. Corresponds to the JSON property `maxResults` @return [Fixnum]

preserve_nulls[RW]
Deprecated

This property is deprecated.

Corresponds to the JSON property `preserveNulls` @return [Boolean]

preserve_nulls?[RW]
Deprecated

This property is deprecated.

Corresponds to the JSON property `preserveNulls` @return [Boolean]

query[RW]
Required

A query string, following the BigQuery query syntax, of the query

to execute. Example: “SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId] ”. Corresponds to the JSON property `query` @return [String]

timeout_ms[RW]
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). Corresponds to the JSON property `timeoutMs` @return [Fixnum]

use_legacy_sql[RW]
Experimental

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 updated SQL dialect with improved standards compliance. When using BigQuery' s updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. Corresponds to the JSON property `useLegacySql` @return [Boolean]

use_legacy_sql?[RW]
Experimental

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 updated SQL dialect with improved standards compliance. When using BigQuery' s updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. Corresponds to the JSON property `useLegacySql` @return [Boolean]

use_query_cache[RW]
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. Corresponds to the JSON property `useQueryCache` @return [Boolean]

use_query_cache?[RW]
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. Corresponds to the JSON property `useQueryCache` @return [Boolean]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/bigquery_v2/classes.rb, line 1990
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/bigquery_v2/classes.rb, line 1995
def update!(**args)
  @default_dataset = args[:default_dataset] if args.key?(:default_dataset)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @kind = args[:kind] if args.key?(:kind)
  @max_results = args[:max_results] if args.key?(:max_results)
  @preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls)
  @query = args[:query] if args.key?(:query)
  @timeout_ms = args[:timeout_ms] if args.key?(:timeout_ms)
  @use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql)
  @use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache)
end