Class: Google::Apis::BigqueryV2::QueryRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigquery_v2/classes.rb,
generated/google/apis/bigquery_v2/representations.rb,
generated/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ QueryRequest

Returns a new instance of QueryRequest



2272
2273
2274
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2272

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#default_dataset ⇒ Google::Apis::BigqueryV2::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'. Corresponds to the JSON property defaultDataset

Returns:



2195
2196
2197
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2195

def default_dataset
  @default_dataset
end

#dry_run ⇒ Boolean Also known as: 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. Corresponds to the JSON property dryRun

Returns:

  • (Boolean) 


2203
2204
2205
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2203

def dry_run
  @dry_run
end

#kind ⇒ String

The resource type of the request. Corresponds to the JSON property kind

Returns:

  • (String) 


2209
2210
2211
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2209

def kind
  @kind
end

#max_results ⇒ Fixnum

[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

Returns:

  • (Fixnum) 


2218
2219
2220
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2218

def max_results
  @max_results
end

#parameter_mode ⇒ String

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. Corresponds to the JSON property parameterMode

Returns:

  • (String) 


2224
2225
2226
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2224

def parameter_mode
  @parameter_mode
end

#preserve_nulls ⇒ Boolean Also known as: preserve_nulls?

[Deprecated] This property is deprecated. Corresponds to the JSON property preserveNulls

Returns:

  • (Boolean) 


2229
2230
2231
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2229

def preserve_nulls
  @preserve_nulls
end

#query ⇒ String

[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

Returns:

  • (String) 


2237
2238
2239
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2237

def query
  @query
end

#query_parameters ⇒ Array<Google::Apis::BigqueryV2::QueryParameter>

Query parameters for Standard SQL queries. Corresponds to the JSON property queryParameters

Returns:



2242
2243
2244
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2242

def query_parameters
  @query_parameters
end

#timeout_ms ⇒ Fixnum

[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

Returns:

  • (Fixnum) 


2252
2253
2254
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2252

def timeout_ms
  @timeout_ms
end

#use_legacy_sql ⇒ Boolean Also known as: 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 values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false. Corresponds to the JSON property useLegacySql

Returns:

  • (Boolean) 


2261
2262
2263
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2261

def use_legacy_sql
  @use_legacy_sql
end

#use_query_cache ⇒ Boolean Also known as: 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. Corresponds to the JSON property useQueryCache

Returns:

  • (Boolean) 


2269
2270
2271
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2269

def use_query_cache
  @use_query_cache
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2277

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)
  @parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode)
  @preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls)
  @query = args[:query] if args.key?(:query)
  @query_parameters = args[:query_parameters] if args.key?(:query_parameters)
  @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