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

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) ⇒ JobConfigurationQuery

Returns a new instance of JobConfigurationQuery



1867
1868
1869
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1867

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 standard SQL 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) 


1715
1716
1717
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1715

def allow_large_results
  @allow_large_results
end

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

[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. Corresponds to the JSON property clustering

Returns:



1723
1724
1725
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1723

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


1733
1734
1735
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1733

def create_disposition
  @create_disposition
end

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

[Optional] Specifies the default dataset to use for unqualified table names in the query. Corresponds to the JSON property defaultDataset

Returns:



1739
1740
1741
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1739

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:



1744
1745
1746
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1744

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. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size. Corresponds to the JSON property destinationTable

Returns:



1751
1752
1753
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1751

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 standard SQL queries, this flag is ignored and results are never flattened. Corresponds to the JSON property flattenResults

Returns:

  • (Boolean) 


1759
1760
1761
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1759

def flatten_results
  @flatten_results
end

#maximum_billing_tier ⇒ Fixnum

[Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. Corresponds to the JSON property maximumBillingTier

Returns:

  • (Fixnum) 


1767
1768
1769
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1767

def maximum_billing_tier
  @maximum_billing_tier
end

#maximum_bytes_billed ⇒ Fixnum

[Optional] 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) 


1774
1775
1776
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1774

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


1780
1781
1782
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1780

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) 


1785
1786
1787
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1785

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) 


1792
1793
1794
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1792

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 standard SQL. Corresponds to the JSON property query

Returns:

  • (String) 


1798
1799
1800
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1798

def query
  @query
end

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

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

Returns:



1803
1804
1805
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1803

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


1815
1816
1817
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1815

def schema_update_options
  @schema_update_options
end

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

[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. Corresponds to the JSON property tableDefinitions

Returns:



1823
1824
1825
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1823

def table_definitions
  @table_definitions
end

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

Time-based partitioning specification for the destination table. Corresponds to the JSON property timePartitioning

Returns:



1828
1829
1830
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1828

def time_partitioning
  @time_partitioning
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 value of flattenResults is ignored; query will be run as if flattenResults is false. Corresponds to the JSON property useLegacySql

Returns:

  • (Boolean) 


1837
1838
1839
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1837

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) 


1846
1847
1848
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1846

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:



1852
1853
1854
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1852

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 table data 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) 


1865
1866
1867
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1865

def write_disposition
  @write_disposition
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1872

def update!(**args)
  @allow_large_results = args[:allow_large_results] if args.key?(:allow_large_results)
  @clustering = args[:clustering] if args.key?(:clustering)
  @create_disposition = args[:create_disposition] if args.key?(:create_disposition)
  @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)
  @schema_update_options = args[:schema_update_options] if args.key?(:schema_update_options)
  @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