bigquery  v2
Properties | List of all members
Google.Apis.Bigquery.v2.Data.JobConfigurationQuery Class Reference
Inheritance diagram for Google.Apis.Bigquery.v2.Data.JobConfigurationQuery:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual System.Nullable< bool > AllowLargeResults [get, set]
 [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. More...
 
virtual Clustering Clustering [get, set]
 [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. More...
 
virtual string CreateDisposition [get, set]
 [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. More...
 
virtual DatasetReference DefaultDataset [get, set]
 [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. More...
 
virtual EncryptionConfiguration DestinationEncryptionConfiguration [get, set]
 Custom encryption configuration (e.g., Cloud KMS keys). More...
 
virtual TableReference DestinationTable [get, set]
 [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. More...
 
virtual System.Nullable< bool > FlattenResults [get, set]
 [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. More...
 
virtual System.Nullable< int > MaximumBillingTier [get, set]
 [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. More...
 
virtual System.Nullable< long > MaximumBytesBilled [get, set]
 [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. More...
 
virtual string ParameterMode [get, set]
 Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named () query parameters in this query. More...
 
virtual System.Nullable< bool > PreserveNulls [get, set]
 [Deprecated] This property is deprecated. More...
 
virtual string Priority [get, set]
 [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. More...
 
virtual string Query [get, set]
 [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. More...
 
virtual System.Collections.Generic.IList< QueryParameterQueryParameters [get, set]
 Query parameters for standard SQL queries. More...
 
virtual RangePartitioning RangePartitioning [get, set]
 [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. More...
 
virtual System.Collections.Generic.IList< string > SchemaUpdateOptions [get, set]
 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. More...
 
virtual System.Collections.Generic.IDictionary< string, ExternalDataConfigurationTableDefinitions [get, set]
 [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. More...
 
virtual TimePartitioning TimePartitioning [get, set]
 Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. More...
 
virtual System.Nullable< bool > UseLegacySql [get, set]
 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. More...
 
virtual System.Nullable< bool > UseQueryCache [get, set]
 [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. More...
 
virtual System.Collections.Generic.IList< UserDefinedFunctionResourceUserDefinedFunctionResources [get, set]
 Describes user-defined function resources used in the query. More...
 
virtual string WriteDisposition [get, set]
 [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. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Property Documentation

◆ AllowLargeResults

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.AllowLargeResults
getset

[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.

◆ Clustering

virtual Clustering Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.Clustering
getset

[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.

◆ CreateDisposition

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.CreateDisposition
getset

[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.

◆ DefaultDataset

virtual DatasetReference Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.DefaultDataset
getset

[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.

◆ DestinationEncryptionConfiguration

virtual EncryptionConfiguration Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.DestinationEncryptionConfiguration
getset

Custom encryption configuration (e.g., Cloud KMS keys).

◆ DestinationTable

virtual TableReference Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.DestinationTable
getset

[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.

◆ ETag

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.ETag
getset

The ETag of the item.

◆ FlattenResults

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.FlattenResults
getset

[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.

◆ MaximumBillingTier

virtual System.Nullable<int> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.MaximumBillingTier
getset

[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.

◆ MaximumBytesBilled

virtual System.Nullable<long> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.MaximumBytesBilled
getset

[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.

◆ ParameterMode

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.ParameterMode
getset

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named () query parameters in this query.

◆ PreserveNulls

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.PreserveNulls
getset

[Deprecated] This property is deprecated.

◆ Priority

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.Priority
getset

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

◆ Query

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.Query
getset

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

◆ QueryParameters

virtual System.Collections.Generic.IList<QueryParameter> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.QueryParameters
getset

Query parameters for standard SQL queries.

◆ RangePartitioning

virtual RangePartitioning Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.RangePartitioning
getset

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

◆ SchemaUpdateOptions

virtual System.Collections.Generic.IList<string> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.SchemaUpdateOptions
getset

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.

◆ TableDefinitions

virtual System.Collections.Generic.IDictionary<string,ExternalDataConfiguration> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.TableDefinitions
getset

[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.

◆ TimePartitioning

virtual TimePartitioning Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.TimePartitioning
getset

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

◆ UseLegacySql

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.UseLegacySql
getset

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.

◆ UseQueryCache

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.UseQueryCache
getset

[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.

◆ UserDefinedFunctionResources

virtual System.Collections.Generic.IList<UserDefinedFunctionResource> Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.UserDefinedFunctionResources
getset

Describes user-defined function resources used in the query.

◆ WriteDisposition

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationQuery.WriteDisposition
getset

[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.


The documentation for this class was generated from the following file: