Class: Google::Apis::BigqueryV2::JobConfigurationQuery

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

JobConfigurationQuery configures a BigQuery query job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JobConfigurationQuery

Returns a new instance of JobConfigurationQuery.



4966
4967
4968
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4966

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

Instance Attribute Details

#allow_large_results ⇒ Boolean Also known as: allow_large_results?

Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. Corresponds to the JSON property allowLargeResults

Returns:

  • (Boolean) 


4765
4766
4767
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4765

def allow_large_results
  @allow_large_results
end

#clustering ⇒ Google::Apis::BigqueryV2::Clustering

Configures table clustering. Corresponds to the JSON property clustering

Returns:



4771
4772
4773
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4771

def clustering
  @clustering
end

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

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

Returns:



4776
4777
4778
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4776

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) 


4782
4783
4784
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4782

def continuous
  @continuous
end

#create_disposition ⇒ String

Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. Corresponds to the JSON property createDisposition

Returns:

  • (String) 


4793
4794
4795
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4793

def create_disposition
  @create_disposition
end

#create_session ⇒ Boolean Also known as: create_session?

If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a ConnectionProperty value. The session identifier is returned as part of the SessionInfo message within the query statistics. The new session's location will be set to Job. JobReference.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) 


4804
4805
4806
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4804

def create_session
  @create_session
end

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

Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable @@dataset_id achieves the same behavior. See https://cloud.google.com/bigquery/docs/reference/system-variables for more information on system variables. Corresponds to the JSON property defaultDataset

Returns:



4814
4815
4816
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4814

def default_dataset
  @default_dataset
end

#destination_encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys) Corresponds to the JSON property destinationEncryptionConfiguration

Returns:



4819
4820
4821
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4819

def destination_encryption_configuration
  @destination_encryption_configuration
end

#destination_table ⇒ Google::Apis::BigqueryV2::TableReference

Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery. Corresponds to the JSON property destinationTable

Returns:



4827
4828
4829
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4827

def destination_table
  @destination_table
end

#flatten_results ⇒ Boolean Also known as: flatten_results?

Optional. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For GoogleSQL queries, this flag is ignored and results are never flattened. Corresponds to the JSON property flattenResults

Returns:

  • (Boolean) 


4835
4836
4837
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4835

def flatten_results
  @flatten_results
end

#maximum_billing_tier ⇒ Fixnum

Optional. [Deprecated] Maximum billing tier allowed for this query. The billing tier controls the amount of compute resources allotted to the query, and multiplies the on-demand cost of the query accordingly. A query that runs within its allotted resources will succeed and indicate its billing tier in statistics.query.billingTier, but if the query exceeds its allotted resources, it will fail with billingTierLimitExceeded. WARNING: The billed byte amount can be multiplied by an amount up to this number! Most users should not need to alter this setting, and we recommend that you avoid introducing new uses of it. Corresponds to the JSON property maximumBillingTier

Returns:

  • (Fixnum) 


4849
4850
4851
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4849

def maximum_billing_tier
  @maximum_billing_tier
end

#maximum_bytes_billed ⇒ Fixnum

Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. Corresponds to the JSON property maximumBytesBilled

Returns:

  • (Fixnum) 


4856
4857
4858
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4856

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) 


4862
4863
4864
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4862

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) 


4867
4868
4869
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4867

def preserve_nulls
  @preserve_nulls
end

#priority ⇒ String

Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. Corresponds to the JSON property priority

Returns:

  • (String) 


4874
4875
4876
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4874

def priority
  @priority
end

#query ⇒ String

[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL. Corresponds to the JSON property query

Returns:

  • (String) 


4880
4881
4882
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4880

def query
  @query
end

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

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

Returns:



4885
4886
4887
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4885

def query_parameters
  @query_parameters
end

#range_partitioning ⇒ Google::Apis::BigqueryV2::RangePartitioning

Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. Corresponds to the JSON property rangePartitioning

Returns:



4891
4892
4893
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4891

def range_partitioning
  @range_partitioning
end

#schema_update_options ⇒ Array<String>

Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. Corresponds to the JSON property schemaUpdateOptions

Returns:

  • (Array<String>) 


4903
4904
4905
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4903

def schema_update_options
  @schema_update_options
end

#script_options ⇒ Google::Apis::BigqueryV2::ScriptOptions

Options related to script execution. Corresponds to the JSON property scriptOptions

Returns:



4908
4909
4910
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4908

def script_options
  @script_options
end

#system_variables ⇒ Google::Apis::BigqueryV2::SystemVariables

System variables given to a query. Corresponds to the JSON property systemVariables

Returns:



4913
4914
4915
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4913

def system_variables
  @system_variables
end

#table_definitions ⇒ Hash<String,Google::Apis::BigqueryV2::ExternalDataConfiguration>

Optional. You can specify external table definitions, which operate as ephemeral tables that can be queried. These definitions are configured using a JSON map, where the string key represents the table identifier, and the value is the corresponding external data configuration object. Corresponds to the JSON property tableDefinitions

Returns:



4921
4922
4923
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4921

def table_definitions
  @table_definitions
end

#time_partitioning ⇒ Google::Apis::BigqueryV2::TimePartitioning

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. Corresponds to the JSON property timePartitioning

Returns:



4927
4928
4929
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4927

def time_partitioning
  @time_partitioning
end

#use_legacy_sql ⇒ Boolean Also known as: use_legacy_sql?

Optional. 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) 


4936
4937
4938
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4936

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. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. Corresponds to the JSON property useQueryCache

Returns:

  • (Boolean) 


4945
4946
4947
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4945

def use_query_cache
  @use_query_cache
end

#user_defined_function_resources ⇒ Array<Google::Apis::BigqueryV2::UserDefinedFunctionResource>

Describes user-defined function resources used in the query. Corresponds to the JSON property userDefinedFunctionResources

Returns:



4951
4952
4953
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4951

def user_defined_function_resources
  @user_defined_function_resources
end

#write_disposition ⇒ String

Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. Corresponds to the JSON property writeDisposition

Returns:

  • (String) 


4964
4965
4966
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4964

def write_disposition
  @write_disposition
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4971

def update!(**args)
  @allow_large_results = args[:allow_large_results] if args.key?(:allow_large_results)
  @clustering = args[:clustering] if args.key?(:clustering)
  @connection_properties = args[:connection_properties] if args.key?(:connection_properties)
  @continuous = args[:continuous] if args.key?(:continuous)
  @create_disposition = args[:create_disposition] if args.key?(:create_disposition)
  @create_session = args[:create_session] if args.key?(:create_session)
  @default_dataset = args[:default_dataset] if args.key?(:default_dataset)
  @destination_encryption_configuration = args[:destination_encryption_configuration] if args.key?(:destination_encryption_configuration)
  @destination_table = args[:destination_table] if args.key?(:destination_table)
  @flatten_results = args[:flatten_results] if args.key?(:flatten_results)
  @maximum_billing_tier = args[:maximum_billing_tier] if args.key?(:maximum_billing_tier)
  @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)
  @priority = args[:priority] if args.key?(:priority)
  @query = args[:query] if args.key?(:query)
  @query_parameters = args[:query_parameters] if args.key?(:query_parameters)
  @range_partitioning = args[:range_partitioning] if args.key?(:range_partitioning)
  @schema_update_options = args[:schema_update_options] if args.key?(:schema_update_options)
  @script_options = args[:script_options] if args.key?(:script_options)
  @system_variables = args[:system_variables] if args.key?(:system_variables)
  @table_definitions = args[:table_definitions] if args.key?(:table_definitions)
  @time_partitioning = args[:time_partitioning] if args.key?(:time_partitioning)
  @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)
  @user_defined_function_resources = args[:user_defined_function_resources] if args.key?(:user_defined_function_resources)
  @write_disposition = args[:write_disposition] if args.key?(:write_disposition)
end