Class JobQuery

Inheritance

System.Object

JobQuery

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.BigQuery.Outputs

Assembly: Pulumi.Gcp.dll

Syntax

public sealed class JobQuery

Fields

AllowLargeResults

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.

Declaration

public readonly bool? AllowLargeResults

Field Value

Type	Description
System.Nullable<System.Boolean>

CreateDisposition

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. Creation, truncation and append actions occur as one atomic update upon job completion

Declaration

public readonly string CreateDisposition

Field Value

Type	Description
System.String

DefaultDataset

Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. Structure is documented below.

Declaration

public readonly JobQueryDefaultDataset DefaultDataset

Field Value

Type	Description
JobQueryDefaultDataset

DestinationEncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys) Structure is documented below.

Declaration

public readonly JobQueryDestinationEncryptionConfiguration DestinationEncryptionConfiguration

Field Value

Type	Description
JobQueryDestinationEncryptionConfiguration

DestinationTable

The destination table. Structure is documented below.

Declaration

public readonly JobQueryDestinationTable DestinationTable

Field Value

Type	Description
JobQueryDestinationTable

FlattenResults

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.

Declaration

public readonly bool? FlattenResults

Field Value

Type	Description
System.Nullable<System.Boolean>

MaximumBillingTier

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.

Declaration

public readonly int? MaximumBillingTier

Field Value

Type	Description
System.Nullable<System.Int32>

MaximumBytesBilled

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.

Declaration

public readonly string MaximumBytesBilled

Field Value

Type	Description
System.String

ParameterMode

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

Declaration

public readonly string ParameterMode

Field Value

Type	Description
System.String

Priority

Specifies a priority for the query.

Declaration

public readonly string Priority

Field Value

Type	Description
System.String

Query

Configures a query job. Structure is documented below.

Declaration

public readonly string Query

Field Value

Type	Description
System.String

SchemaUpdateOptions

Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.

Declaration

public readonly ImmutableArray<string> SchemaUpdateOptions

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<System.String>

ScriptOptions

Options controlling the execution of scripts. Structure is documented below.

Declaration

public readonly JobQueryScriptOptions ScriptOptions

Field Value

Type	Description
JobQueryScriptOptions

UseLegacySql

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.

Declaration

public readonly bool? UseLegacySql

Field Value

Type	Description
System.Nullable<System.Boolean>

UseQueryCache

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.

Declaration

public readonly bool? UseQueryCache

Field Value

Type	Description
System.Nullable<System.Boolean>

UserDefinedFunctionResources

Describes user-defined function resources used in the query. Structure is documented below.

Declaration

public readonly ImmutableArray<JobQueryUserDefinedFunctionResource> UserDefinedFunctionResources

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<JobQueryUserDefinedFunctionResource>

WriteDisposition

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

Declaration

public readonly string WriteDisposition

Field Value

Type	Description
System.String