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

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

Overview

Describes the format of the jobs.query request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryRequest

Returns a new instance of QueryRequest.



7657
7658
7659
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7657

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

Instance Attribute Details

#connection_properties ⇒ Array<Google::Apis::BigqueryV2::ConnectionProperty>

Optional. Connection properties which can modify the query behavior. Corresponds to the JSON property connectionProperties

Returns:



7497
7498
7499
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7497

def connection_properties
  @connection_properties
end

#continuous ⇒ Boolean Also known as: continuous?

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

Returns:

  • (Boolean) 


7503
7504
7505
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7503

def continuous
  @continuous
end

#create_session ⇒ Boolean Also known as: create_session?

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. Corresponds to the JSON property createSession

Returns:

  • (Boolean) 


7513
7514
7515
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7513

def create_session
  @create_session
end

#default_dataset ⇒ Google::Apis::BigqueryV2::DatasetReference

Identifier for a dataset. Corresponds to the JSON property defaultDataset

Returns:



7519
7520
7521
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7519

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) 


7527
7528
7529
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7527

def dry_run
  @dry_run
end

#format_options ⇒ Google::Apis::BigqueryV2::DataFormatOptions

Options for data format adjustments. Corresponds to the JSON property formatOptions

Returns:



7533
7534
7535
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7533

def format_options
  @format_options
end

#job_creation_mode ⇒ String

Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. Preview Corresponds to the JSON property jobCreationMode

Returns:

  • (String) 


7540
7541
7542
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7540

def job_creation_mode
  @job_creation_mode
end

#kind ⇒ String

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

Returns:

  • (String) 


7545
7546
7547
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7545

def kind
  @kind
end

#labels ⇒ Hash<String,String>

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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


7554
7555
7556
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7554

def labels
  @labels
end

#location ⇒ String

The geographic location where the job should run. For more information, see how to specify locations. Corresponds to the JSON property location

Returns:

  • (String) 


7561
7562
7563
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7561

def location
  @location
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) 


7570
7571
7572
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7570

def max_results
  @max_results
end

#maximum_bytes_billed ⇒ Fixnum

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. Corresponds to the JSON property maximumBytesBilled

Returns:

  • (Fixnum) 


7577
7578
7579
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7577

def maximum_bytes_billed
  @maximum_bytes_billed
end

#parameter_mode ⇒ String

GoogleSQL 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) 


7583
7584
7585
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7583

def parameter_mode
  @parameter_mode
end

#preserve_nulls ⇒ Boolean Also known as: preserve_nulls?

This property is deprecated. Corresponds to the JSON property preserveNulls

Returns:

  • (Boolean) 


7588
7589
7590
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7588

def preserve_nulls
  @preserve_nulls
end

#query ⇒ String

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

Returns:

  • (String) 


7595
7596
7597
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7595

def query
  @query
end

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

Query parameters for GoogleSQL queries. Corresponds to the JSON property queryParameters

Returns:



7600
7601
7602
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7600

def query_parameters
  @query_parameters
end

#request_id ⇒ String

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. Corresponds to the JSON property requestId

Returns:

  • (String) 


7623
7624
7625
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7623

def request_id
  @request_id
end

#timeout_ms ⇒ Fixnum

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. Corresponds to the JSON property timeoutMs

Returns:

  • (Fixnum) 


7637
7638
7639
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7637

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 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. Corresponds to the JSON property useLegacySql

Returns:

  • (Boolean) 


7646
7647
7648
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7646

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) 


7654
7655
7656
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7654

def use_query_cache
  @use_query_cache
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7662

def update!(**args)
  @connection_properties = args[:connection_properties] if args.key?(:connection_properties)
  @continuous = args[:continuous] if args.key?(:continuous)
  @create_session = args[:create_session] if args.key?(:create_session)
  @default_dataset = args[:default_dataset] if args.key?(:default_dataset)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @format_options = args[:format_options] if args.key?(:format_options)
  @job_creation_mode = args[:job_creation_mode] if args.key?(:job_creation_mode)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @location = args[:location] if args.key?(:location)
  @max_results = args[:max_results] if args.key?(:max_results)
  @maximum_bytes_billed = args[:maximum_bytes_billed] if args.key?(:maximum_bytes_billed)
  @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)
  @request_id = args[:request_id] if args.key?(:request_id)
  @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