Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.bigquery/v2.Job
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Starts a new asynchronous job. Requires the Can View project role. Auto-naming is currently not supported for this resource.
Create Job Resource
new Job(name: string, args?: JobArgs, opts?: CustomResourceOptions);
@overload
def Job(resource_name: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[JobConfigurationArgs] = None,
job_reference: Optional[JobReferenceArgs] = None,
project: Optional[str] = None,
source: Optional[Union[pulumi.Asset, pulumi.Archive]] = None)
@overload
def Job(resource_name: str,
args: Optional[JobArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewJob(ctx *Context, name string, args *JobArgs, opts ...ResourceOption) (*Job, error)
public Job(string name, JobArgs? args = null, CustomResourceOptions? opts = null)
type: google-native:bigquery/v2:Job
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Job Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Job resource accepts the following input properties:
- Configuration
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration [Required] Describes the job configuration.
- Job
Reference Pulumi.Google Native. Big Query. V2. Inputs. Job Reference [Optional] Reference describing the unique-per-user name of the job.
- Project string
- Source
Asset
Or Archive
- Configuration
Job
Configuration Args [Required] Describes the job configuration.
- Job
Reference JobReference Args [Optional] Reference describing the unique-per-user name of the job.
- Project string
- Source
pulumi.
Asset Or Archive
- configuration
Job
Configuration [Required] Describes the job configuration.
- job
Reference JobReference [Optional] Reference describing the unique-per-user name of the job.
- project String
- source
Asset
Or Archive
- configuration
Job
Configuration [Required] Describes the job configuration.
- job
Reference JobReference [Optional] Reference describing the unique-per-user name of the job.
- project string
- source
pulumi.asset.
Asset | pulumi.asset. Archive
- configuration
Job
Configuration Args [Required] Describes the job configuration.
- job_
reference JobReference Args [Optional] Reference describing the unique-per-user name of the job.
- project str
- source
Union[pulumi.
Asset, pulumi. Archive]
- configuration Property Map
[Required] Describes the job configuration.
- job
Reference Property Map [Optional] Reference describing the unique-per-user name of the job.
- project String
- source Asset
Outputs
All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:
- Etag string
A hash of this resource.
- Id string
The provider-assigned unique ID for this managed resource.
- Job
Creation objectReason If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- Kind string
The type of the resource.
- Self
Link string A URL that can be used to access this resource again.
- Statistics
Pulumi.
Google Native. Big Query. V2. Outputs. Job Statistics Response Information about the job, including starting time and ending time of the job.
- Status
Pulumi.
Google Native. Big Query. V2. Outputs. Job Status Response The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- User
Email string Email address of the user who ran the job.
- Etag string
A hash of this resource.
- Id string
The provider-assigned unique ID for this managed resource.
- Job
Creation interface{}Reason If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- Kind string
The type of the resource.
- Self
Link string A URL that can be used to access this resource again.
- Statistics
Job
Statistics Response Information about the job, including starting time and ending time of the job.
- Status
Job
Status Response The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- User
Email string Email address of the user who ran the job.
- etag String
A hash of this resource.
- id String
The provider-assigned unique ID for this managed resource.
- job
Creation ObjectReason If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind String
The type of the resource.
- self
Link String A URL that can be used to access this resource again.
- statistics
Job
Statistics Response Information about the job, including starting time and ending time of the job.
- status
Job
Status Response The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- user
Email String Email address of the user who ran the job.
- etag string
A hash of this resource.
- id string
The provider-assigned unique ID for this managed resource.
- job
Creation anyReason If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind string
The type of the resource.
- self
Link string A URL that can be used to access this resource again.
- statistics
Job
Statistics Response Information about the job, including starting time and ending time of the job.
- status
Job
Status Response The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- user
Email string Email address of the user who ran the job.
- etag str
A hash of this resource.
- id str
The provider-assigned unique ID for this managed resource.
- job_
creation_ Anyreason If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind str
The type of the resource.
- self_
link str A URL that can be used to access this resource again.
- statistics
Job
Statistics Response Information about the job, including starting time and ending time of the job.
- status
Job
Status Response The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- user_
email str Email address of the user who ran the job.
- etag String
A hash of this resource.
- id String
The provider-assigned unique ID for this managed resource.
- job
Creation AnyReason If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind String
The type of the resource.
- self
Link String A URL that can be used to access this resource again.
- statistics Property Map
Information about the job, including starting time and ending time of the job.
- status Property Map
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- user
Email String Email address of the user who ran the job.
Supporting Types
BiEngineReasonResponse, BiEngineReasonResponseArgs
BiEngineStatisticsResponse, BiEngineStatisticsResponseArgs
- Acceleration
Mode string Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine stringMode Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine List<Pulumi.Reasons Google Native. Big Query. V2. Inputs. Bi Engine Reason Response> In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- Acceleration
Mode string Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine stringMode Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine []BiReasons Engine Reason Response In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration
Mode String Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine StringMode Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine List<BiReasons Engine Reason Response> In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration
Mode string Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine stringMode Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine BiReasons Engine Reason Response[] In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration_
mode str Specifies which mode of BI Engine acceleration was performed (if any).
- bi_
engine_ strmode Specifies which mode of BI Engine acceleration was performed (if any).
- bi_
engine_ Sequence[Bireasons Engine Reason Response] In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration
Mode String Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine StringMode Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine List<Property Map>Reasons In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
BigQueryModelTrainingResponse, BigQueryModelTrainingResponseArgs
- Current
Iteration int [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- Expected
Total stringIterations [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- Current
Iteration int [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- Expected
Total stringIterations [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current
Iteration Integer [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected
Total StringIterations [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current
Iteration number [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected
Total stringIterations [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current_
iteration int [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected_
total_ striterations [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current
Iteration Number [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected
Total StringIterations [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
Clustering, ClusteringArgs
- Fields List<string>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- Fields []string
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields List<String>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields string[]
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields Sequence[str]
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields List<String>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
ClusteringResponse, ClusteringResponseArgs
- Fields List<string>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- Fields []string
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields List<String>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields string[]
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields Sequence[str]
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields List<String>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
ConnectionProperty, ConnectionPropertyArgs
ConnectionPropertyResponse, ConnectionPropertyResponseArgs
DataMaskingStatisticsResponse, DataMaskingStatisticsResponseArgs
- Data
Masking boolApplied [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- Data
Masking boolApplied [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data
Masking BooleanApplied [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data
Masking booleanApplied [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data_
masking_ boolapplied [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data
Masking BooleanApplied [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
DatasetReference, DatasetReferenceArgs
- dataset_
id str [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project str
[Optional] The ID of the project containing this dataset.
DatasetReferenceResponse, DatasetReferenceResponseArgs
- dataset_
id str [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project str
[Optional] The ID of the project containing this dataset.
DestinationTableProperties, DestinationTablePropertiesArgs
- Description string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- Expiration
Time string [Internal] This field is for Google internal use only.
- Friendly
Name string [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- Labels Dictionary<string, string>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- Description string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- Expiration
Time string [Internal] This field is for Google internal use only.
- Friendly
Name string [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- Labels map[string]string
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description String
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time String [Internal] This field is for Google internal use only.
- friendly
Name String [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels Map<String,String>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time string [Internal] This field is for Google internal use only.
- friendly
Name string [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels {[key: string]: string}
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description str
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration_
time str [Internal] This field is for Google internal use only.
- friendly_
name str [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels Mapping[str, str]
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description String
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time String [Internal] This field is for Google internal use only.
- friendly
Name String [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels Map<String>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
DestinationTablePropertiesResponse, DestinationTablePropertiesResponseArgs
- Description string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- Expiration
Time string [Internal] This field is for Google internal use only.
- Friendly
Name string [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- Labels Dictionary<string, string>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- Description string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- Expiration
Time string [Internal] This field is for Google internal use only.
- Friendly
Name string [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- Labels map[string]string
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description String
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time String [Internal] This field is for Google internal use only.
- friendly
Name String [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels Map<String,String>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time string [Internal] This field is for Google internal use only.
- friendly
Name string [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels {[key: string]: string}
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description str
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration_
time str [Internal] This field is for Google internal use only.
- friendly_
name str [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels Mapping[str, str]
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description String
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time String [Internal] This field is for Google internal use only.
- friendly
Name String [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels Map<String>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
DmlStatisticsResponse, DmlStatisticsResponseArgs
- Deleted
Row stringCount Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- Inserted
Row stringCount Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- Updated
Row stringCount Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- Deleted
Row stringCount Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- Inserted
Row stringCount Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- Updated
Row stringCount Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted
Row StringCount Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted
Row StringCount Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated
Row StringCount Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted
Row stringCount Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted
Row stringCount Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated
Row stringCount Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted_
row_ strcount Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted_
row_ strcount Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated_
row_ strcount Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted
Row StringCount Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted
Row StringCount Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated
Row StringCount Number of updated Rows. Populated by DML UPDATE and MERGE statements.
EncryptionConfiguration, EncryptionConfigurationArgs
- Kms
Key stringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- Kms
Key stringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key StringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key stringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms_
key_ strname Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key StringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
EncryptionConfigurationResponse, EncryptionConfigurationResponseArgs
- Kms
Key stringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- Kms
Key stringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key StringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key stringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms_
key_ strname Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key StringName Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
ErrorProtoResponse, ErrorProtoResponseArgs
- debug_
info str Debugging information. This property is internal to Google and should not be used.
- location str
Specifies where the error occurred, if present.
- message str
A human-readable description of the error.
- reason str
A short error code that summarizes the error.
ExplainQueryStageResponse, ExplainQueryStageResponseArgs
- Completed
Parallel stringInputs Number of parallel input segments completed.
- Compute
Ms stringAvg Milliseconds the average shard spent on CPU-bound tasks.
- Compute
Ms stringMax Milliseconds the slowest shard spent on CPU-bound tasks.
- Compute
Ratio doubleAvg Relative amount of time the average shard spent on CPU-bound tasks.
- Compute
Ratio doubleMax Relative amount of time the slowest shard spent on CPU-bound tasks.
- End
Ms string Stage end time represented as milliseconds since epoch.
- Input
Stages List<string> IDs for stages that are inputs to this stage.
- Name string
Human-readable name for stage.
- Parallel
Inputs string Number of parallel input segments to be processed.
- Read
Ms stringAvg Milliseconds the average shard spent reading input.
- Read
Ms stringMax Milliseconds the slowest shard spent reading input.
- Read
Ratio doubleAvg Relative amount of time the average shard spent reading input.
- Read
Ratio doubleMax Relative amount of time the slowest shard spent reading input.
- Records
Read string Number of records read into the stage.
- Records
Written string Number of records written by the stage.
- Shuffle
Output stringBytes Total number of bytes written to shuffle.
- Shuffle
Output stringBytes Spilled Total number of bytes written to shuffle and spilled to disk.
- Slot
Ms string Slot-milliseconds used by the stage.
- Start
Ms string Stage start time represented as milliseconds since epoch.
- Status string
Current status for the stage.
- Steps
List<Pulumi.
Google Native. Big Query. V2. Inputs. Explain Query Step Response> List of operations within the stage in dependency order (approximately chronological).
- Wait
Ms stringAvg Milliseconds the average shard spent waiting to be scheduled.
- Wait
Ms stringMax Milliseconds the slowest shard spent waiting to be scheduled.
- Wait
Ratio doubleAvg Relative amount of time the average shard spent waiting to be scheduled.
- Wait
Ratio doubleMax Relative amount of time the slowest shard spent waiting to be scheduled.
- Write
Ms stringAvg Milliseconds the average shard spent on writing output.
- Write
Ms stringMax Milliseconds the slowest shard spent on writing output.
- Write
Ratio doubleAvg Relative amount of time the average shard spent on writing output.
- Write
Ratio doubleMax Relative amount of time the slowest shard spent on writing output.
- Completed
Parallel stringInputs Number of parallel input segments completed.
- Compute
Ms stringAvg Milliseconds the average shard spent on CPU-bound tasks.
- Compute
Ms stringMax Milliseconds the slowest shard spent on CPU-bound tasks.
- Compute
Ratio float64Avg Relative amount of time the average shard spent on CPU-bound tasks.
- Compute
Ratio float64Max Relative amount of time the slowest shard spent on CPU-bound tasks.
- End
Ms string Stage end time represented as milliseconds since epoch.
- Input
Stages []string IDs for stages that are inputs to this stage.
- Name string
Human-readable name for stage.
- Parallel
Inputs string Number of parallel input segments to be processed.
- Read
Ms stringAvg Milliseconds the average shard spent reading input.
- Read
Ms stringMax Milliseconds the slowest shard spent reading input.
- Read
Ratio float64Avg Relative amount of time the average shard spent reading input.
- Read
Ratio float64Max Relative amount of time the slowest shard spent reading input.
- Records
Read string Number of records read into the stage.
- Records
Written string Number of records written by the stage.
- Shuffle
Output stringBytes Total number of bytes written to shuffle.
- Shuffle
Output stringBytes Spilled Total number of bytes written to shuffle and spilled to disk.
- Slot
Ms string Slot-milliseconds used by the stage.
- Start
Ms string Stage start time represented as milliseconds since epoch.
- Status string
Current status for the stage.
- Steps
[]Explain
Query Step Response List of operations within the stage in dependency order (approximately chronological).
- Wait
Ms stringAvg Milliseconds the average shard spent waiting to be scheduled.
- Wait
Ms stringMax Milliseconds the slowest shard spent waiting to be scheduled.
- Wait
Ratio float64Avg Relative amount of time the average shard spent waiting to be scheduled.
- Wait
Ratio float64Max Relative amount of time the slowest shard spent waiting to be scheduled.
- Write
Ms stringAvg Milliseconds the average shard spent on writing output.
- Write
Ms stringMax Milliseconds the slowest shard spent on writing output.
- Write
Ratio float64Avg Relative amount of time the average shard spent on writing output.
- Write
Ratio float64Max Relative amount of time the slowest shard spent on writing output.
- completed
Parallel StringInputs Number of parallel input segments completed.
- compute
Ms StringAvg Milliseconds the average shard spent on CPU-bound tasks.
- compute
Ms StringMax Milliseconds the slowest shard spent on CPU-bound tasks.
- compute
Ratio DoubleAvg Relative amount of time the average shard spent on CPU-bound tasks.
- compute
Ratio DoubleMax Relative amount of time the slowest shard spent on CPU-bound tasks.
- end
Ms String Stage end time represented as milliseconds since epoch.
- input
Stages List<String> IDs for stages that are inputs to this stage.
- name String
Human-readable name for stage.
- parallel
Inputs String Number of parallel input segments to be processed.
- read
Ms StringAvg Milliseconds the average shard spent reading input.
- read
Ms StringMax Milliseconds the slowest shard spent reading input.
- read
Ratio DoubleAvg Relative amount of time the average shard spent reading input.
- read
Ratio DoubleMax Relative amount of time the slowest shard spent reading input.
- records
Read String Number of records read into the stage.
- records
Written String Number of records written by the stage.
- shuffle
Output StringBytes Total number of bytes written to shuffle.
- shuffle
Output StringBytes Spilled Total number of bytes written to shuffle and spilled to disk.
- slot
Ms String Slot-milliseconds used by the stage.
- start
Ms String Stage start time represented as milliseconds since epoch.
- status String
Current status for the stage.
- steps
List<Explain
Query Step Response> List of operations within the stage in dependency order (approximately chronological).
- wait
Ms StringAvg Milliseconds the average shard spent waiting to be scheduled.
- wait
Ms StringMax Milliseconds the slowest shard spent waiting to be scheduled.
- wait
Ratio DoubleAvg Relative amount of time the average shard spent waiting to be scheduled.
- wait
Ratio DoubleMax Relative amount of time the slowest shard spent waiting to be scheduled.
- write
Ms StringAvg Milliseconds the average shard spent on writing output.
- write
Ms StringMax Milliseconds the slowest shard spent on writing output.
- write
Ratio DoubleAvg Relative amount of time the average shard spent on writing output.
- write
Ratio DoubleMax Relative amount of time the slowest shard spent on writing output.
- completed
Parallel stringInputs Number of parallel input segments completed.
- compute
Ms stringAvg Milliseconds the average shard spent on CPU-bound tasks.
- compute
Ms stringMax Milliseconds the slowest shard spent on CPU-bound tasks.
- compute
Ratio numberAvg Relative amount of time the average shard spent on CPU-bound tasks.
- compute
Ratio numberMax Relative amount of time the slowest shard spent on CPU-bound tasks.
- end
Ms string Stage end time represented as milliseconds since epoch.
- input
Stages string[] IDs for stages that are inputs to this stage.
- name string
Human-readable name for stage.
- parallel
Inputs string Number of parallel input segments to be processed.
- read
Ms stringAvg Milliseconds the average shard spent reading input.
- read
Ms stringMax Milliseconds the slowest shard spent reading input.
- read
Ratio numberAvg Relative amount of time the average shard spent reading input.
- read
Ratio numberMax Relative amount of time the slowest shard spent reading input.
- records
Read string Number of records read into the stage.
- records
Written string Number of records written by the stage.
- shuffle
Output stringBytes Total number of bytes written to shuffle.
- shuffle
Output stringBytes Spilled Total number of bytes written to shuffle and spilled to disk.
- slot
Ms string Slot-milliseconds used by the stage.
- start
Ms string Stage start time represented as milliseconds since epoch.
- status string
Current status for the stage.
- steps
Explain
Query Step Response[] List of operations within the stage in dependency order (approximately chronological).
- wait
Ms stringAvg Milliseconds the average shard spent waiting to be scheduled.
- wait
Ms stringMax Milliseconds the slowest shard spent waiting to be scheduled.
- wait
Ratio numberAvg Relative amount of time the average shard spent waiting to be scheduled.
- wait
Ratio numberMax Relative amount of time the slowest shard spent waiting to be scheduled.
- write
Ms stringAvg Milliseconds the average shard spent on writing output.
- write
Ms stringMax Milliseconds the slowest shard spent on writing output.
- write
Ratio numberAvg Relative amount of time the average shard spent on writing output.
- write
Ratio numberMax Relative amount of time the slowest shard spent on writing output.
- completed_
parallel_ strinputs Number of parallel input segments completed.
- compute_
ms_ stravg Milliseconds the average shard spent on CPU-bound tasks.
- compute_
ms_ strmax Milliseconds the slowest shard spent on CPU-bound tasks.
- compute_
ratio_ floatavg Relative amount of time the average shard spent on CPU-bound tasks.
- compute_
ratio_ floatmax Relative amount of time the slowest shard spent on CPU-bound tasks.
- end_
ms str Stage end time represented as milliseconds since epoch.
- input_
stages Sequence[str] IDs for stages that are inputs to this stage.
- name str
Human-readable name for stage.
- parallel_
inputs str Number of parallel input segments to be processed.
- read_
ms_ stravg Milliseconds the average shard spent reading input.
- read_
ms_ strmax Milliseconds the slowest shard spent reading input.
- read_
ratio_ floatavg Relative amount of time the average shard spent reading input.
- read_
ratio_ floatmax Relative amount of time the slowest shard spent reading input.
- records_
read str Number of records read into the stage.
- records_
written str Number of records written by the stage.
- shuffle_
output_ strbytes Total number of bytes written to shuffle.
- shuffle_
output_ strbytes_ spilled Total number of bytes written to shuffle and spilled to disk.
- slot_
ms str Slot-milliseconds used by the stage.
- start_
ms str Stage start time represented as milliseconds since epoch.
- status str
Current status for the stage.
- steps
Sequence[Explain
Query Step Response] List of operations within the stage in dependency order (approximately chronological).
- wait_
ms_ stravg Milliseconds the average shard spent waiting to be scheduled.
- wait_
ms_ strmax Milliseconds the slowest shard spent waiting to be scheduled.
- wait_
ratio_ floatavg Relative amount of time the average shard spent waiting to be scheduled.
- wait_
ratio_ floatmax Relative amount of time the slowest shard spent waiting to be scheduled.
- write_
ms_ stravg Milliseconds the average shard spent on writing output.
- write_
ms_ strmax Milliseconds the slowest shard spent on writing output.
- write_
ratio_ floatavg Relative amount of time the average shard spent on writing output.
- write_
ratio_ floatmax Relative amount of time the slowest shard spent on writing output.
- completed
Parallel StringInputs Number of parallel input segments completed.
- compute
Ms StringAvg Milliseconds the average shard spent on CPU-bound tasks.
- compute
Ms StringMax Milliseconds the slowest shard spent on CPU-bound tasks.
- compute
Ratio NumberAvg Relative amount of time the average shard spent on CPU-bound tasks.
- compute
Ratio NumberMax Relative amount of time the slowest shard spent on CPU-bound tasks.
- end
Ms String Stage end time represented as milliseconds since epoch.
- input
Stages List<String> IDs for stages that are inputs to this stage.
- name String
Human-readable name for stage.
- parallel
Inputs String Number of parallel input segments to be processed.
- read
Ms StringAvg Milliseconds the average shard spent reading input.
- read
Ms StringMax Milliseconds the slowest shard spent reading input.
- read
Ratio NumberAvg Relative amount of time the average shard spent reading input.
- read
Ratio NumberMax Relative amount of time the slowest shard spent reading input.
- records
Read String Number of records read into the stage.
- records
Written String Number of records written by the stage.
- shuffle
Output StringBytes Total number of bytes written to shuffle.
- shuffle
Output StringBytes Spilled Total number of bytes written to shuffle and spilled to disk.
- slot
Ms String Slot-milliseconds used by the stage.
- start
Ms String Stage start time represented as milliseconds since epoch.
- status String
Current status for the stage.
- steps List<Property Map>
List of operations within the stage in dependency order (approximately chronological).
- wait
Ms StringAvg Milliseconds the average shard spent waiting to be scheduled.
- wait
Ms StringMax Milliseconds the slowest shard spent waiting to be scheduled.
- wait
Ratio NumberAvg Relative amount of time the average shard spent waiting to be scheduled.
- wait
Ratio NumberMax Relative amount of time the slowest shard spent waiting to be scheduled.
- write
Ms StringAvg Milliseconds the average shard spent on writing output.
- write
Ms StringMax Milliseconds the slowest shard spent on writing output.
- write
Ratio NumberAvg Relative amount of time the average shard spent on writing output.
- write
Ratio NumberMax Relative amount of time the slowest shard spent on writing output.
ExplainQueryStepResponse, ExplainQueryStepResponseArgs
HivePartitioningOptions, HivePartitioningOptionsArgs
- Mode string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- Require
Partition boolFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- Source
Uri stringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- Mode string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- Require
Partition boolFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- Source
Uri stringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- mode String
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition BooleanFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri StringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- mode string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition booleanFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri stringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- mode str
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require_
partition_ boolfilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source_
uri_ strprefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- mode String
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition BooleanFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri StringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
HivePartitioningOptionsResponse, HivePartitioningOptionsResponseArgs
- Fields List<string>
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- Mode string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- Require
Partition boolFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- Source
Uri stringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- Fields []string
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- Mode string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- Require
Partition boolFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- Source
Uri stringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields List<String>
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode String
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition BooleanFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri StringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields string[]
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition booleanFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri stringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields Sequence[str]
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode str
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require_
partition_ boolfilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source_
uri_ strprefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields List<String>
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode String
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition BooleanFilter [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri StringPrefix [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
IndexUnusedReasonResponse, IndexUnusedReasonResponseArgs
- Base
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response Specifies the base table involved in the reason that no search index was used.
- Code string
Specifies the high-level reason for the scenario when no search index was used.
- Index
Name string Specifies the name of the unused search index, if available.
- Message string
Free form human-readable reason for the scenario when no search index was used.
- Base
Table TableReference Response Specifies the base table involved in the reason that no search index was used.
- Code string
Specifies the high-level reason for the scenario when no search index was used.
- Index
Name string Specifies the name of the unused search index, if available.
- Message string
Free form human-readable reason for the scenario when no search index was used.
- base
Table TableReference Response Specifies the base table involved in the reason that no search index was used.
- code String
Specifies the high-level reason for the scenario when no search index was used.
- index
Name String Specifies the name of the unused search index, if available.
- message String
Free form human-readable reason for the scenario when no search index was used.
- base
Table TableReference Response Specifies the base table involved in the reason that no search index was used.
- code string
Specifies the high-level reason for the scenario when no search index was used.
- index
Name string Specifies the name of the unused search index, if available.
- message string
Free form human-readable reason for the scenario when no search index was used.
- base_
table TableReference Response Specifies the base table involved in the reason that no search index was used.
- code str
Specifies the high-level reason for the scenario when no search index was used.
- index_
name str Specifies the name of the unused search index, if available.
- message str
Free form human-readable reason for the scenario when no search index was used.
- base
Table Property Map Specifies the base table involved in the reason that no search index was used.
- code String
Specifies the high-level reason for the scenario when no search index was used.
- index
Name String Specifies the name of the unused search index, if available.
- message String
Free form human-readable reason for the scenario when no search index was used.
IterationResultResponse, IterationResultResponseArgs
- Duration
Ms string Time taken to run the iteration in milliseconds.
- Eval
Loss double Loss computed on the eval data at the end of iteration.
- Index int
Index of the iteration, 0 based.
- Learn
Rate double Learn rate used for this iteration.
- Training
Loss double Loss computed on the training data at the end of iteration.
- Duration
Ms string Time taken to run the iteration in milliseconds.
- Eval
Loss float64 Loss computed on the eval data at the end of iteration.
- Index int
Index of the iteration, 0 based.
- Learn
Rate float64 Learn rate used for this iteration.
- Training
Loss float64 Loss computed on the training data at the end of iteration.
- duration
Ms String Time taken to run the iteration in milliseconds.
- eval
Loss Double Loss computed on the eval data at the end of iteration.
- index Integer
Index of the iteration, 0 based.
- learn
Rate Double Learn rate used for this iteration.
- training
Loss Double Loss computed on the training data at the end of iteration.
- duration
Ms string Time taken to run the iteration in milliseconds.
- eval
Loss number Loss computed on the eval data at the end of iteration.
- index number
Index of the iteration, 0 based.
- learn
Rate number Learn rate used for this iteration.
- training
Loss number Loss computed on the training data at the end of iteration.
- duration_
ms str Time taken to run the iteration in milliseconds.
- eval_
loss float Loss computed on the eval data at the end of iteration.
- index int
Index of the iteration, 0 based.
- learn_
rate float Learn rate used for this iteration.
- training_
loss float Loss computed on the training data at the end of iteration.
- duration
Ms String Time taken to run the iteration in milliseconds.
- eval
Loss Number Loss computed on the eval data at the end of iteration.
- index Number
Index of the iteration, 0 based.
- learn
Rate Number Learn rate used for this iteration.
- training
Loss Number Loss computed on the training data at the end of iteration.
JobConfiguration, JobConfigurationArgs
- Copy
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Table Copy [Pick one] Copies a table.
- Dry
Run bool [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- Extract
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Extract [Pick one] Configures an extract job.
- Job
Timeout stringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- Labels Dictionary<string, string>
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- Load
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Load [Pick one] Configures a load job.
- Query
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Query [Pick one] Configures a query job.
- Copy
Job
Configuration Table Copy [Pick one] Copies a table.
- Dry
Run bool [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- Extract
Job
Configuration Extract [Pick one] Configures an extract job.
- Job
Timeout stringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- Labels map[string]string
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- Load
Job
Configuration Load [Pick one] Configures a load job.
- Query
Job
Configuration Query [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy [Pick one] Copies a table.
- dry
Run Boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
Job
Configuration Extract [Pick one] Configures an extract job.
- job
Timeout StringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- labels Map<String,String>
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
Job
Configuration Load [Pick one] Configures a load job.
- query
Job
Configuration Query [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy [Pick one] Copies a table.
- dry
Run boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
Job
Configuration Extract [Pick one] Configures an extract job.
- job
Timeout stringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- labels {[key: string]: string}
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
Job
Configuration Load [Pick one] Configures a load job.
- query
Job
Configuration Query [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy [Pick one] Copies a table.
- dry_
run bool [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
Job
Configuration Extract [Pick one] Configures an extract job.
- job_
timeout_ strms [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- labels Mapping[str, str]
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
Job
Configuration Load [Pick one] Configures a load job.
- query
Job
Configuration Query [Pick one] Configures a query job.
- copy Property Map
[Pick one] Copies a table.
- dry
Run Boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract Property Map
[Pick one] Configures an extract job.
- job
Timeout StringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- labels Map<String>
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load Property Map
[Pick one] Configures a load job.
- query Property Map
[Pick one] Configures a query job.
JobConfigurationExtract, JobConfigurationExtractArgs
- Compression string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- Destination
Format string [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- Destination
Uri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- Destination
Uris List<string> [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- Print
Header bool [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- Source
Model Pulumi.Google Native. Big Query. V2. Inputs. Model Reference A reference to the model being exported.
- Source
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference A reference to the table being exported.
- Use
Avro boolLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- Compression string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- Destination
Format string [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- Destination
Uri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- Destination
Uris []string [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- Print
Header bool [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- Source
Model ModelReference A reference to the model being exported.
- Source
Table TableReference A reference to the table being exported.
- Use
Avro boolLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression String
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format String [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri String [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris List<String> [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter String [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header Boolean [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model ModelReference A reference to the model being exported.
- source
Table TableReference A reference to the table being exported.
- use
Avro BooleanLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format string [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris string[] [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header boolean [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model ModelReference A reference to the model being exported.
- source
Table TableReference A reference to the table being exported.
- use
Avro booleanLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression str
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination_
format str [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination_
uri str [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination_
uris Sequence[str] [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field_
delimiter str [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print_
header bool [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source_
model ModelReference A reference to the model being exported.
- source_
table TableReference A reference to the table being exported.
- use_
avro_ boollogical_ types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression String
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format String [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri String [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris List<String> [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter String [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header Boolean [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model Property Map A reference to the model being exported.
- source
Table Property Map A reference to the table being exported.
- use
Avro BooleanLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
JobConfigurationExtractResponse, JobConfigurationExtractResponseArgs
- Compression string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- Destination
Format string [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- Destination
Uri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- Destination
Uris List<string> [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- Print
Header bool [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- Source
Model Pulumi.Google Native. Big Query. V2. Inputs. Model Reference Response A reference to the model being exported.
- Source
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response A reference to the table being exported.
- Use
Avro boolLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- Compression string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- Destination
Format string [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- Destination
Uri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- Destination
Uris []string [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- Print
Header bool [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- Source
Model ModelReference Response A reference to the model being exported.
- Source
Table TableReference Response A reference to the table being exported.
- Use
Avro boolLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression String
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format String [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri String [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris List<String> [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter String [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header Boolean [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model ModelReference Response A reference to the model being exported.
- source
Table TableReference Response A reference to the table being exported.
- use
Avro BooleanLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format string [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri string [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris string[] [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter string [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header boolean [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model ModelReference Response A reference to the model being exported.
- source
Table TableReference Response A reference to the table being exported.
- use
Avro booleanLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression str
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination_
format str [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination_
uri str [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination_
uris Sequence[str] [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field_
delimiter str [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print_
header bool [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source_
model ModelReference Response A reference to the model being exported.
- source_
table TableReference Response A reference to the table being exported.
- use_
avro_ boollogical_ types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression String
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format String [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri String [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris List<String> [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter String [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header Boolean [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model Property Map A reference to the model being exported.
- source
Table Property Map A reference to the table being exported.
- use
Avro BooleanLogical Types [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
JobConfigurationLoad, JobConfigurationLoadArgs
- Allow
Jagged boolRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- Allow
Quoted boolNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Autodetect bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- Clustering
Pulumi.
Google Native. Big Query. V2. Inputs. 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.
- Connection
Properties List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property> Connection properties.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- Decimal
Target List<string>Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference [Required] The destination table to load the data into.
- Destination
Table Pulumi.Properties Google Native. Big Query. V2. Inputs. Destination Table Properties [Beta] [Optional] Properties with which to create the destination table if it is new.
- Encoding string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- Field
Delimiter string [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- File
Set stringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning Pulumi.Options Google Native. Big Query. V2. Inputs. Hive Partitioning Options [Optional] Options to configure hive partitioning support.
- Ignore
Unknown boolValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- Json
Extension string [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- Max
Bad intRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- Null
Marker string [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- Parquet
Options Pulumi.Google Native. Big Query. V2. Inputs. Parquet Options [Optional] Options to configure parquet support.
- Preserve
Ascii boolControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- Projection
Fields List<string> If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- Quote string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- Range
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File stringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
Pulumi.
Google Native. Big Query. V2. Inputs. Table Schema [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- Schema
Inline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline stringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- Schema
Update List<string>Options 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.
- Skip
Leading intRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- Source
Format string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- Source
Uris List<string> [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- Time
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro boolLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- Allow
Jagged boolRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- Allow
Quoted boolNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Autodetect bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- Clustering 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.
- Connection
Properties []ConnectionProperty Connection properties.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- Decimal
Target []stringTypes [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- Destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table TableReference [Required] The destination table to load the data into.
- Destination
Table DestinationProperties Table Properties [Beta] [Optional] Properties with which to create the destination table if it is new.
- Encoding string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- Field
Delimiter string [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- File
Set stringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning HiveOptions Partitioning Options [Optional] Options to configure hive partitioning support.
- Ignore
Unknown boolValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- Json
Extension string [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- Max
Bad intRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- Null
Marker string [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- Parquet
Options ParquetOptions [Optional] Options to configure parquet support.
- Preserve
Ascii boolControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- Projection
Fields []string If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- Quote string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- Range
Partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File stringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
Table
Schema [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- Schema
Inline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline stringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- Schema
Update []stringOptions 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.
- Skip
Leading intRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- Source
Format string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- Source
Uris []string [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- Time
Partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro boolLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- allow
Jagged BooleanRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted BooleanNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect Boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering 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.
- connection
Properties List<ConnectionProperty> Connection properties.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target List<String>Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference [Required] The destination table to load the data into.
- destination
Table DestinationProperties Table Properties [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding String
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter String [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set StringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning HiveOptions Partitioning Options [Optional] Options to configure hive partitioning support.
- ignore
Unknown BooleanValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension String [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad IntegerRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker String [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options ParquetOptions [Optional] Options to configure parquet support.
- preserve
Ascii BooleanControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields List<String> If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote String
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File StringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline String [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline StringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema
Update List<String>Options 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.
- skip
Leading IntegerRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format String [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris List<String> [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro BooleanLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- allow
Jagged booleanRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted booleanNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering 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.
- connection
Properties ConnectionProperty[] Connection properties.
- 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.
- create
Session boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target string[]Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference [Required] The destination table to load the data into.
- destination
Table DestinationProperties Table Properties [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter string [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set stringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning HiveOptions Partitioning Options [Optional] Options to configure hive partitioning support.
- ignore
Unknown booleanValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension string [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad numberRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker string [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options ParquetOptions [Optional] Options to configure parquet support.
- preserve
Ascii booleanControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields string[] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File stringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline stringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema
Update string[]Options 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.
- skip
Leading numberRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris string[] [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro booleanLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- allow_
jagged_ boolrows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow_
quoted_ boolnewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering 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.
- connection_
properties Sequence[ConnectionProperty] Connection properties.
- create_
disposition str [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.
- create_
session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal_
target_ Sequence[str]types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination_
encryption_ Encryptionconfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table TableReference [Required] The destination table to load the data into.
- destination_
table_ Destinationproperties Table Properties [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding str
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field_
delimiter str [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file_
set_ strspec_ type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive_
partitioning_ Hiveoptions Partitioning Options [Optional] Options to configure hive partitioning support.
- ignore_
unknown_ boolvalues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json_
extension str [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max_
bad_ intrecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null_
marker str [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet_
options ParquetOptions [Optional] Options to configure parquet support.
- preserve_
ascii_ boolcontrol_ characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection_
fields Sequence[str] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote str
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range_
partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference_
file_ strschema_ uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema_
inline str [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema_
inline_ strformat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema_
update_ Sequence[str]options 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.
- skip_
leading_ introws [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source_
format str [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source_
uris Sequence[str] [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time_
partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
avro_ boollogical_ types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- write_
disposition str [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. 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_APPEND. 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.
- allow
Jagged BooleanRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted BooleanNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect Boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering Property Map
[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.
- connection
Properties List<Property Map> Connection properties.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target List<String>Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption Property MapConfiguration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table Property Map [Required] The destination table to load the data into.
- destination
Table Property MapProperties [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding String
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter String [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set StringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning Property MapOptions [Optional] Options to configure hive partitioning support.
- ignore
Unknown BooleanValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension String [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad NumberRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker String [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options Property Map [Optional] Options to configure parquet support.
- preserve
Ascii BooleanControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields List<String> If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote String
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning Property Map [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File StringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema Property Map
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline String [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline StringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema
Update List<String>Options 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.
- skip
Leading NumberRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format String [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris List<String> [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning Property Map Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro BooleanLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
JobConfigurationLoadResponse, JobConfigurationLoadResponseArgs
- Allow
Jagged boolRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- Allow
Quoted boolNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Autodetect bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- Clustering
Pulumi.
Google Native. Big Query. V2. Inputs. Clustering Response [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.
- Connection
Properties List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property Response> Connection properties.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- Decimal
Target List<string>Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response [Required] The destination table to load the data into.
- Destination
Table Pulumi.Properties Google Native. Big Query. V2. Inputs. Destination Table Properties Response [Beta] [Optional] Properties with which to create the destination table if it is new.
- Encoding string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- Field
Delimiter string [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- File
Set stringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning Pulumi.Options Google Native. Big Query. V2. Inputs. Hive Partitioning Options Response [Optional] Options to configure hive partitioning support.
- Ignore
Unknown boolValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- Json
Extension string [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- Max
Bad intRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- Null
Marker string [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- Parquet
Options Pulumi.Google Native. Big Query. V2. Inputs. Parquet Options Response [Optional] Options to configure parquet support.
- Preserve
Ascii boolControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- Projection
Fields List<string> If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- Quote string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- Range
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File stringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
Pulumi.
Google Native. Big Query. V2. Inputs. Table Schema Response [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- Schema
Inline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline stringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- Schema
Update List<string>Options 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.
- Skip
Leading intRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- Source
Format string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- Source
Uris List<string> [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- Time
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro boolLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- Allow
Jagged boolRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- Allow
Quoted boolNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Autodetect bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- Clustering
Clustering
Response [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.
- Connection
Properties []ConnectionProperty Response Connection properties.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- Decimal
Target []stringTypes [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- Destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table TableReference Response [Required] The destination table to load the data into.
- Destination
Table DestinationProperties Table Properties Response [Beta] [Optional] Properties with which to create the destination table if it is new.
- Encoding string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- Field
Delimiter string [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- File
Set stringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning HiveOptions Partitioning Options Response [Optional] Options to configure hive partitioning support.
- Ignore
Unknown boolValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- Json
Extension string [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- Max
Bad intRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- Null
Marker string [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- Parquet
Options ParquetOptions Response [Optional] Options to configure parquet support.
- Preserve
Ascii boolControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- Projection
Fields []string If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- Quote string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- Range
Partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File stringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
Table
Schema Response [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- Schema
Inline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline stringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- Schema
Update []stringOptions 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.
- Skip
Leading intRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- Source
Format string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- Source
Uris []string [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- Time
Partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro boolLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- allow
Jagged BooleanRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted BooleanNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect Boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
Clustering
Response [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.
- connection
Properties List<ConnectionProperty Response> Connection properties.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target List<String>Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference Response [Required] The destination table to load the data into.
- destination
Table DestinationProperties Table Properties Response [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding String
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter String [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set StringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning HiveOptions Partitioning Options Response [Optional] Options to configure hive partitioning support.
- ignore
Unknown BooleanValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension String [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad IntegerRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker String [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options ParquetOptions Response [Optional] Options to configure parquet support.
- preserve
Ascii BooleanControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields List<String> If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote String
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File StringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema Response [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline String [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline StringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema
Update List<String>Options 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.
- skip
Leading IntegerRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format String [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris List<String> [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro BooleanLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- allow
Jagged booleanRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted booleanNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
Clustering
Response [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.
- connection
Properties ConnectionProperty Response[] Connection properties.
- 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.
- create
Session boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target string[]Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference Response [Required] The destination table to load the data into.
- destination
Table DestinationProperties Table Properties Response [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter string [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set stringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning HiveOptions Partitioning Options Response [Optional] Options to configure hive partitioning support.
- ignore
Unknown booleanValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension string [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad numberRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker string [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options ParquetOptions Response [Optional] Options to configure parquet support.
- preserve
Ascii booleanControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields string[] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File stringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema Response [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline string [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline stringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema
Update string[]Options 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.
- skip
Leading numberRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format string [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris string[] [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro booleanLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
- allow_
jagged_ boolrows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow_
quoted_ boolnewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
Clustering
Response [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.
- connection_
properties Sequence[ConnectionProperty Response] Connection properties.
- create_
disposition str [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.
- create_
session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal_
target_ Sequence[str]types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination_
encryption_ Encryptionconfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table TableReference Response [Required] The destination table to load the data into.
- destination_
table_ Destinationproperties Table Properties Response [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding str
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field_
delimiter str [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file_
set_ strspec_ type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive_
partitioning_ Hiveoptions Partitioning Options Response [Optional] Options to configure hive partitioning support.
- ignore_
unknown_ boolvalues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json_
extension str [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max_
bad_ intrecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null_
marker str [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet_
options ParquetOptions Response [Optional] Options to configure parquet support.
- preserve_
ascii_ boolcontrol_ characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection_
fields Sequence[str] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote str
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range_
partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference_
file_ strschema_ uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema Response [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema_
inline str [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema_
inline_ strformat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema_
update_ Sequence[str]options 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.
- skip_
leading_ introws [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source_
format str [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source_
uris Sequence[str] [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time_
partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
avro_ boollogical_ types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- write_
disposition str [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. 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_APPEND. 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.
- allow
Jagged BooleanRows [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted BooleanNewlines Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect Boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering Property Map
[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.
- connection
Properties List<Property Map> Connection properties.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target List<String>Types [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption Property MapConfiguration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table Property Map [Required] The destination table to load the data into.
- destination
Table Property MapProperties [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding String
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter String [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set StringSpec Type [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning Property MapOptions [Optional] Options to configure hive partitioning support.
- ignore
Unknown BooleanValues [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension String [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad NumberRecords [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker String [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options Property Map [Optional] Options to configure parquet support.
- preserve
Ascii BooleanControl Characters [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields List<String> If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote String
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning Property Map [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File StringSchema Uri User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema Property Map
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline String [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline StringFormat [Deprecated] The format of the schemaInline property.
[Deprecated] The format of the schemaInline property.
- schema
Update List<String>Options 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.
- skip
Leading NumberRows [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format String [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris List<String> [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning Property Map Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro BooleanLogical Types [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- 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. 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_APPEND. 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.
JobConfigurationQuery, JobConfigurationQueryArgs
- Allow
Large boolResults [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
Pulumi.
Google Native. Big Query. V2. Inputs. 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.
- Connection
Properties List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property> Connection properties.
- Continuous bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- Default
Dataset Pulumi.Google Native. Big Query. V2. Inputs. Dataset Reference [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.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference [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.
- Flatten
Results bool [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.
- Maximum
Billing intTier [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.
- Maximum
Bytes stringBilled [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.
- 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.
- Preserve
Nulls bool [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- Priority string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- Query
Parameters List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter> Query parameters for standard SQL queries.
- Range
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update List<string>Options 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.
- Table
Definitions Dictionary<string, string> [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.
- Time
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy boolSql 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.
- Use
Query boolCache [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.
- User
Defined List<Pulumi.Function Resources Google Native. Big Query. V2. Inputs. User Defined Function Resource> Describes user-defined function resources used in the query.
- 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.
- Allow
Large boolResults [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 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.
- Connection
Properties []ConnectionProperty Connection properties.
- Continuous bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- Default
Dataset DatasetReference [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.
- Destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table 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.
- Flatten
Results bool [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.
- Maximum
Billing intTier [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.
- Maximum
Bytes stringBilled [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.
- 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.
- Preserve
Nulls bool [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- Priority string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- Query
Parameters []QueryParameter Query parameters for standard SQL queries.
- Range
Partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update []stringOptions 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.
- Table
Definitions map[string]string [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.
- Time
Partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy boolSql 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.
- Use
Query boolCache [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.
- User
Defined []UserFunction Resources Defined Function Resource Describes user-defined function resources used in the query.
- 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.
- allow
Large BooleanResults [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 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.
- connection
Properties List<ConnectionProperty> Connection properties.
- continuous Boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset DatasetReference [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.
- destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table 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.
- flatten
Results Boolean [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.
- maximum
Billing IntegerTier [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.
- maximum
Bytes StringBilled [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.
- 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.
- preserve
Nulls Boolean [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority String
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- query
Parameters List<QueryParameter> Query parameters for standard SQL queries.
- range
Partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update List<String>Options 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.
- table
Definitions Map<String,String> [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.
- time
Partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy BooleanSql 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.
- use
Query BooleanCache [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.
- user
Defined List<UserFunction Resources Defined Function Resource> Describes user-defined function resources used in the query.
- 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.
- allow
Large booleanResults [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 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.
- connection
Properties ConnectionProperty[] Connection properties.
- continuous boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- create
Session boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset DatasetReference [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.
- destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table 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.
- flatten
Results boolean [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.
- maximum
Billing numberTier [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.
- maximum
Bytes stringBilled [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.
- 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.
- preserve
Nulls boolean [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- query
Parameters QueryParameter[] Query parameters for standard SQL queries.
- range
Partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update string[]Options 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.
- table
Definitions {[key: string]: string} [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.
- time
Partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy booleanSql 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.
- use
Query booleanCache [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.
- user
Defined UserFunction Resources Defined Function Resource[] Describes user-defined function resources used in the query.
- 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.
- allow_
large_ boolresults [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 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.
- connection_
properties Sequence[ConnectionProperty] Connection properties.
- continuous bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create_
disposition str [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.
- create_
session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default_
dataset DatasetReference [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.
- destination_
encryption_ Encryptionconfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table 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.
- flatten_
results bool [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.
- maximum_
billing_ inttier [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.
- maximum_
bytes_ strbilled [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.
- parameter_
mode str Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- preserve_
nulls bool [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority str
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- query str
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- query_
parameters Sequence[QueryParameter] Query parameters for standard SQL queries.
- range_
partitioning RangePartitioning [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema_
update_ Sequence[str]options 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.
- table_
definitions Mapping[str, str] [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.
- time_
partitioning TimePartitioning Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
legacy_ boolsql 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.
- use_
query_ boolcache [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.
- user_
defined_ Sequence[Userfunction_ resources Defined Function Resource] Describes user-defined function resources used in the query.
- write_
disposition str [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.
- allow
Large BooleanResults [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 Property Map
[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.
- connection
Properties List<Property Map> Connection properties.
- continuous Boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset Property Map [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.
- destination
Encryption Property MapConfiguration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table Property Map [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.
- flatten
Results Boolean [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.
- maximum
Billing NumberTier [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.
- maximum
Bytes StringBilled [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.
- 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.
- preserve
Nulls Boolean [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority String
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- query
Parameters List<Property Map> Query parameters for standard SQL queries.
- range
Partitioning Property Map [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update List<String>Options 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.
- table
Definitions Map<String> [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.
- time
Partitioning Property Map Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy BooleanSql 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.
- use
Query BooleanCache [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.
- user
Defined List<Property Map>Function Resources Describes user-defined function resources used in the query.
- 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.
JobConfigurationQueryResponse, JobConfigurationQueryResponseArgs
- Allow
Large boolResults [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
Pulumi.
Google Native. Big Query. V2. Inputs. Clustering Response [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.
- Connection
Properties List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property Response> Connection properties.
- Continuous bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- Default
Dataset Pulumi.Google Native. Big Query. V2. Inputs. Dataset Reference Response [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.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response [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.
- Flatten
Results bool [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.
- Maximum
Billing intTier [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.
- Maximum
Bytes stringBilled [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.
- 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.
- Preserve
Nulls bool [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- Priority string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- Query
Parameters List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Response> Query parameters for standard SQL queries.
- Range
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update List<string>Options 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.
- Table
Definitions Dictionary<string, string> [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.
- Time
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy boolSql 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.
- Use
Query boolCache [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.
- User
Defined List<Pulumi.Function Resources Google Native. Big Query. V2. Inputs. User Defined Function Resource Response> Describes user-defined function resources used in the query.
- 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.
- Allow
Large boolResults [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
Clustering
Response [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.
- Connection
Properties []ConnectionProperty Response Connection properties.
- Continuous bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- Create
Session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- Default
Dataset DatasetReference Response [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.
- Destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table TableReference Response [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.
- Flatten
Results bool [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.
- Maximum
Billing intTier [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.
- Maximum
Bytes stringBilled [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.
- 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.
- Preserve
Nulls bool [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- Priority string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- Query
Parameters []QueryParameter Response Query parameters for standard SQL queries.
- Range
Partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update []stringOptions 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.
- Table
Definitions map[string]string [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.
- Time
Partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy boolSql 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.
- Use
Query boolCache [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.
- User
Defined []UserFunction Resources Defined Function Resource Response Describes user-defined function resources used in the query.
- 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.
- allow
Large BooleanResults [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
Clustering
Response [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.
- connection
Properties List<ConnectionProperty Response> Connection properties.
- continuous Boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset DatasetReference Response [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.
- destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference Response [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.
- flatten
Results Boolean [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.
- maximum
Billing IntegerTier [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.
- maximum
Bytes StringBilled [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.
- 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.
- preserve
Nulls Boolean [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority String
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- query
Parameters List<QueryParameter Response> Query parameters for standard SQL queries.
- range
Partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update List<String>Options 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.
- table
Definitions Map<String,String> [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.
- time
Partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy BooleanSql 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.
- use
Query BooleanCache [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.
- user
Defined List<UserFunction Resources Defined Function Resource Response> Describes user-defined function resources used in the query.
- 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.
- allow
Large booleanResults [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
Clustering
Response [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.
- connection
Properties ConnectionProperty Response[] Connection properties.
- continuous boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- create
Session boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset DatasetReference Response [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.
- destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference Response [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.
- flatten
Results boolean [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.
- maximum
Billing numberTier [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.
- maximum
Bytes stringBilled [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.
- 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.
- preserve
Nulls boolean [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- query
Parameters QueryParameter Response[] Query parameters for standard SQL queries.
- range
Partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update string[]Options 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.
- table
Definitions {[key: string]: string} [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.
- time
Partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy booleanSql 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.
- use
Query booleanCache [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.
- user
Defined UserFunction Resources Defined Function Resource Response[] Describes user-defined function resources used in the query.
- 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.
- allow_
large_ boolresults [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
Clustering
Response [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.
- connection_
properties Sequence[ConnectionProperty Response] Connection properties.
- continuous bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create_
disposition str [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.
- create_
session bool If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default_
dataset DatasetReference Response [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.
- destination_
encryption_ Encryptionconfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table TableReference Response [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.
- flatten_
results bool [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.
- maximum_
billing_ inttier [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.
- maximum_
bytes_ strbilled [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.
- parameter_
mode str Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- preserve_
nulls bool [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority str
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- query str
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- query_
parameters Sequence[QueryParameter Response] Query parameters for standard SQL queries.
- range_
partitioning RangePartitioning Response [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema_
update_ Sequence[str]options 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.
- table_
definitions Mapping[str, str] [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.
- time_
partitioning TimePartitioning Response Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
legacy_ boolsql 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.
- use_
query_ boolcache [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.
- user_
defined_ Sequence[Userfunction_ resources Defined Function Resource Response] Describes user-defined function resources used in the query.
- write_
disposition str [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.
- allow
Large BooleanResults [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 Property Map
[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.
- connection
Properties List<Property Map> Connection properties.
- continuous Boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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.
- create
Session Boolean If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset Property Map [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.
- destination
Encryption Property MapConfiguration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table Property Map [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.
- flatten
Results Boolean [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.
- maximum
Billing NumberTier [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.
- maximum
Bytes StringBilled [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.
- 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.
- preserve
Nulls Boolean [Deprecated] This property is deprecated.
[Deprecated] This property is deprecated.
- priority String
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- 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.
- query
Parameters List<Property Map> Query parameters for standard SQL queries.
- range
Partitioning Property Map [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update List<String>Options 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.
- table
Definitions Map<String> [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.
- time
Partitioning Property Map Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy BooleanSql 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.
- use
Query BooleanCache [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.
- user
Defined List<Property Map>Function Resources Describes user-defined function resources used in the query.
- 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.
JobConfigurationResponse, JobConfigurationResponseArgs
- Copy
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Table Copy Response [Pick one] Copies a table.
- Dry
Run bool [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- Extract
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Extract Response [Pick one] Configures an extract job.
- Job
Timeout stringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- Job
Type string The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- Labels Dictionary<string, string>
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- Load
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Load Response [Pick one] Configures a load job.
- Query
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Query Response [Pick one] Configures a query job.
- Copy
Job
Configuration Table Copy Response [Pick one] Copies a table.
- Dry
Run bool [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- Extract
Job
Configuration Extract Response [Pick one] Configures an extract job.
- Job
Timeout stringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- Job
Type string The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- Labels map[string]string
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- Load
Job
Configuration Load Response [Pick one] Configures a load job.
- Query
Job
Configuration Query Response [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy Response [Pick one] Copies a table.
- dry
Run Boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
Job
Configuration Extract Response [Pick one] Configures an extract job.
- job
Timeout StringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job
Type String The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels Map<String,String>
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
Job
Configuration Load Response [Pick one] Configures a load job.
- query
Job
Configuration Query Response [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy Response [Pick one] Copies a table.
- dry
Run boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
Job
Configuration Extract Response [Pick one] Configures an extract job.
- job
Timeout stringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job
Type string The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels {[key: string]: string}
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
Job
Configuration Load Response [Pick one] Configures a load job.
- query
Job
Configuration Query Response [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy Response [Pick one] Copies a table.
- dry_
run bool [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
Job
Configuration Extract Response [Pick one] Configures an extract job.
- job_
timeout_ strms [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job_
type str The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels Mapping[str, str]
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
Job
Configuration Load Response [Pick one] Configures a load job.
- query
Job
Configuration Query Response [Pick one] Configures a query job.
- copy Property Map
[Pick one] Copies a table.
- dry
Run Boolean [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract Property Map
[Pick one] Configures an extract job.
- job
Timeout StringMs [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job
Type String The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels Map<String>
The labels associated with this job. You can use these to organize and group your 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 values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load Property Map
[Pick one] Configures a load job.
- query Property Map
[Pick one] Configures a query job.
JobConfigurationTableCopy, JobConfigurationTableCopyArgs
- 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.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration objectTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference [Required] The destination table
- Operation
Type string [Optional] Supported operation types in table copy job.
- Source
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference [Pick one] Source table to copy.
- Source
Tables List<Pulumi.Google Native. Big Query. V2. Inputs. Table Reference> [Pick one] Source tables to copy.
- 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. 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.
- 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.
- Destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration interface{}Time [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table TableReference [Required] The destination table
- Operation
Type string [Optional] Supported operation types in table copy job.
- Source
Table TableReference [Pick one] Source table to copy.
- Source
Tables []TableReference [Pick one] Source tables to copy.
- 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. 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.
- 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.
- destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration ObjectTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table TableReference [Required] The destination table
- operation
Type String [Optional] Supported operation types in table copy job.
- source
Table TableReference [Pick one] Source table to copy.
- source
Tables List<TableReference> [Pick one] Source tables to copy.
- 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. 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.
- 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.
- destination
Encryption EncryptionConfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration anyTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table TableReference [Required] The destination table
- operation
Type string [Optional] Supported operation types in table copy job.
- source
Table TableReference [Pick one] Source table to copy.
- source
Tables TableReference[] [Pick one] Source tables to copy.
- 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. 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.
- create_
disposition str [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.
- destination_
encryption_ Encryptionconfiguration Configuration Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
expiration_ Anytime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination_
table TableReference [Required] The destination table
- operation_
type str [Optional] Supported operation types in table copy job.
- source_
table TableReference [Pick one] Source table to copy.
- source_
tables Sequence[TableReference] [Pick one] Source tables to copy.
- write_
disposition str [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. 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.
- 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.
- destination
Encryption Property MapConfiguration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration AnyTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table Property Map [Required] The destination table
- operation
Type String [Optional] Supported operation types in table copy job.
- source
Table Property Map [Pick one] Source table to copy.
- source
Tables List<Property Map> [Pick one] Source tables to copy.
- 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. 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.
JobConfigurationTableCopyResponse, JobConfigurationTableCopyResponseArgs
- 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.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration objectTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response [Required] The destination table
- Operation
Type string [Optional] Supported operation types in table copy job.
- Source
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response [Pick one] Source table to copy.
- Source
Tables List<Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response> [Pick one] Source tables to copy.
- 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. 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.
- 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.
- Destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration interface{}Time [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table TableReference Response [Required] The destination table
- Operation
Type string [Optional] Supported operation types in table copy job.
- Source
Table TableReference Response [Pick one] Source table to copy.
- Source
Tables []TableReference Response [Pick one] Source tables to copy.
- 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. 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.
- 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.
- destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration ObjectTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table TableReference Response [Required] The destination table
- operation
Type String [Optional] Supported operation types in table copy job.
- source
Table TableReference Response [Pick one] Source table to copy.
- source
Tables List<TableReference Response> [Pick one] Source tables to copy.
- 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. 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.
- 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.
- destination
Encryption EncryptionConfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration anyTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table TableReference Response [Required] The destination table
- operation
Type string [Optional] Supported operation types in table copy job.
- source
Table TableReference Response [Pick one] Source table to copy.
- source
Tables TableReference Response[] [Pick one] Source tables to copy.
- 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. 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.
- create_
disposition str [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.
- destination_
encryption_ Encryptionconfiguration Configuration Response Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
expiration_ Anytime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination_
table TableReference Response [Required] The destination table
- operation_
type str [Optional] Supported operation types in table copy job.
- source_
table TableReference Response [Pick one] Source table to copy.
- source_
tables Sequence[TableReference Response] [Pick one] Source tables to copy.
- write_
disposition str [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. 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.
- 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.
- destination
Encryption Property MapConfiguration Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration AnyTime [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table Property Map [Required] The destination table
- operation
Type String [Optional] Supported operation types in table copy job.
- source
Table Property Map [Pick one] Source table to copy.
- source
Tables List<Property Map> [Pick one] Source tables to copy.
- 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. 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.
JobReference, JobReferenceArgs
- Job
Id string [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- Location string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- Project string
[Required] The ID of the project containing this job.
- Job
Id string [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- Location string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- Project string
[Required] The ID of the project containing this job.
- job
Id String [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location String
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project String
[Required] The ID of the project containing this job.
- job
Id string [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project string
[Required] The ID of the project containing this job.
- job_
id str [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location str
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project str
[Required] The ID of the project containing this job.
- job
Id String [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location String
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project String
[Required] The ID of the project containing this job.
JobReferenceResponse, JobReferenceResponseArgs
- Job
Id string [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- Location string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- Project string
[Required] The ID of the project containing this job.
- Job
Id string [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- Location string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- Project string
[Required] The ID of the project containing this job.
- job
Id String [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location String
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project String
[Required] The ID of the project containing this job.
- job
Id string [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project string
[Required] The ID of the project containing this job.
- job_
id str [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location str
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project str
[Required] The ID of the project containing this job.
- job
Id String [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location String
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project String
[Required] The ID of the project containing this job.
JobStatistics2ReservationUsageItemResponse, JobStatistics2ReservationUsageItemResponseArgs
JobStatistics2Response, JobStatistics2ResponseArgs
- Bi
Engine Pulumi.Statistics Google Native. Big Query. V2. Inputs. Bi Engine Statistics Response BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- Billing
Tier int [Output only] Billing tier for the job.
- Cache
Hit bool [Output only] Whether the query result was fetched from the query cache.
- Ddl
Affected stringRow Access Policy Count [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- Ddl
Destination Pulumi.Table Google Native. Big Query. V2. Inputs. Table Reference Response [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- Ddl
Operation stringPerformed The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- Ddl
Target Pulumi.Dataset Google Native. Big Query. V2. Inputs. Dataset Reference Response [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- Ddl
Target Pulumi.Routine Google Native. Big Query. V2. Inputs. Routine Reference Response The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- Ddl
Target Pulumi.Row Access Policy Google Native. Big Query. V2. Inputs. Row Access Policy Reference Response [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- Ddl
Target Pulumi.Table Google Native. Big Query. V2. Inputs. Table Reference Response [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- Dml
Stats Pulumi.Google Native. Big Query. V2. Inputs. Dml Statistics Response [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- Estimated
Bytes stringProcessed [Output only] The original estimate of bytes processed for the job.
- Ml
Statistics Pulumi.Google Native. Big Query. V2. Inputs. Ml Statistics Response [Output only] Statistics of a BigQuery ML training job.
- Model
Training Pulumi.Google Native. Big Query. V2. Inputs. Big Query Model Training Response [Output only, Beta] Information about create model query job progress.
- Model
Training intCurrent Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- Model
Training stringExpected Total Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- Num
Dml stringAffected Rows [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- Query
Plan List<Pulumi.Google Native. Big Query. V2. Inputs. Explain Query Stage Response> [Output only] Describes execution plan for the query.
- Referenced
Routines List<Pulumi.Google Native. Big Query. V2. Inputs. Routine Reference Response> [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- Referenced
Tables List<Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response> [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- Reservation
Usage List<Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics2Reservation Usage Item Response> [Output only] Job resource usage breakdown by reservation.
- Schema
Pulumi.
Google Native. Big Query. V2. Inputs. Table Schema Response [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- Search
Statistics Pulumi.Google Native. Big Query. V2. Inputs. Search Statistics Response [Output only] Search query specific statistics.
- Spark
Statistics Pulumi.Google Native. Big Query. V2. Inputs. Spark Statistics Response [Output only] Statistics of a Spark procedure job.
- Statement
Type string The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- Timeline
List<Pulumi.
Google Native. Big Query. V2. Inputs. Query Timeline Sample Response> [Output only] [Beta] Describes a timeline of job execution.
- Total
Bytes stringBilled [Output only] Total bytes billed for the job.
- Total
Bytes stringProcessed [Output only] Total bytes processed for the job.
- Total
Bytes stringProcessed Accuracy [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- Total
Partitions stringProcessed [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- Total
Slot stringMs [Output only] Slot-milliseconds for the job.
- Transferred
Bytes string Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- Undeclared
Query List<Pulumi.Parameters Google Native. Big Query. V2. Inputs. Query Parameter Response> Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- Bi
Engine BiStatistics Engine Statistics Response BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- Billing
Tier int [Output only] Billing tier for the job.
- Cache
Hit bool [Output only] Whether the query result was fetched from the query cache.
- Ddl
Affected stringRow Access Policy Count [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- Ddl
Destination TableTable Reference Response [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- Ddl
Operation stringPerformed The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- Ddl
Target DatasetDataset Reference Response [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- Ddl
Target RoutineRoutine Reference Response The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- Ddl
Target RowRow Access Policy Access Policy Reference Response [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- Ddl
Target TableTable Reference Response [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- Dml
Stats DmlStatistics Response [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- Estimated
Bytes stringProcessed [Output only] The original estimate of bytes processed for the job.
- Ml
Statistics MlStatistics Response [Output only] Statistics of a BigQuery ML training job.
- Model
Training BigQuery Model Training Response [Output only, Beta] Information about create model query job progress.
- Model
Training intCurrent Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- Model
Training stringExpected Total Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- Num
Dml stringAffected Rows [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- Query
Plan []ExplainQuery Stage Response [Output only] Describes execution plan for the query.
- Referenced
Routines []RoutineReference Response [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- Referenced
Tables []TableReference Response [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- Reservation
Usage []JobStatistics2Reservation Usage Item Response [Output only] Job resource usage breakdown by reservation.
- Schema
Table
Schema Response [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- Search
Statistics SearchStatistics Response [Output only] Search query specific statistics.
- Spark
Statistics SparkStatistics Response [Output only] Statistics of a Spark procedure job.
- Statement
Type string The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- Timeline
[]Query
Timeline Sample Response [Output only] [Beta] Describes a timeline of job execution.
- Total
Bytes stringBilled [Output only] Total bytes billed for the job.
- Total
Bytes stringProcessed [Output only] Total bytes processed for the job.
- Total
Bytes stringProcessed Accuracy [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- Total
Partitions stringProcessed [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- Total
Slot stringMs [Output only] Slot-milliseconds for the job.
- Transferred
Bytes string Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- Undeclared
Query []QueryParameters Parameter Response Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi
Engine BiStatistics Engine Statistics Response BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing
Tier Integer [Output only] Billing tier for the job.
- cache
Hit Boolean [Output only] Whether the query result was fetched from the query cache.
- ddl
Affected StringRow Access Policy Count [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl
Destination TableTable Reference Response [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl
Operation StringPerformed The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- ddl
Target DatasetDataset Reference Response [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl
Target RoutineRoutine Reference Response The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl
Target RowRow Access Policy Access Policy Reference Response [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl
Target TableTable Reference Response [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml
Stats DmlStatistics Response [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated
Bytes StringProcessed [Output only] The original estimate of bytes processed for the job.
- ml
Statistics MlStatistics Response [Output only] Statistics of a BigQuery ML training job.
- model
Training BigQuery Model Training Response [Output only, Beta] Information about create model query job progress.
- model
Training IntegerCurrent Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- model
Training StringExpected Total Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- num
Dml StringAffected Rows [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query
Plan List<ExplainQuery Stage Response> [Output only] Describes execution plan for the query.
- referenced
Routines List<RoutineReference Response> [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced
Tables List<TableReference Response> [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation
Usage List<JobStatistics2Reservation Usage Item Response> [Output only] Job resource usage breakdown by reservation.
- schema
Table
Schema Response [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search
Statistics SearchStatistics Response [Output only] Search query specific statistics.
- spark
Statistics SparkStatistics Response [Output only] Statistics of a Spark procedure job.
- statement
Type String The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
List<Query
Timeline Sample Response> [Output only] [Beta] Describes a timeline of job execution.
- total
Bytes StringBilled [Output only] Total bytes billed for the job.
- total
Bytes StringProcessed [Output only] Total bytes processed for the job.
- total
Bytes StringProcessed Accuracy [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total
Partitions StringProcessed [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total
Slot StringMs [Output only] Slot-milliseconds for the job.
- transferred
Bytes String Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared
Query List<QueryParameters Parameter Response> Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi
Engine BiStatistics Engine Statistics Response BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing
Tier number [Output only] Billing tier for the job.
- cache
Hit boolean [Output only] Whether the query result was fetched from the query cache.
- ddl
Affected stringRow Access Policy Count [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl
Destination TableTable Reference Response [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl
Operation stringPerformed The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- ddl
Target DatasetDataset Reference Response [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl
Target RoutineRoutine Reference Response The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl
Target RowRow Access Policy Access Policy Reference Response [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl
Target TableTable Reference Response [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml
Stats DmlStatistics Response [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated
Bytes stringProcessed [Output only] The original estimate of bytes processed for the job.
- ml
Statistics MlStatistics Response [Output only] Statistics of a BigQuery ML training job.
- model
Training BigQuery Model Training Response [Output only, Beta] Information about create model query job progress.
- model
Training numberCurrent Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- model
Training stringExpected Total Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- num
Dml stringAffected Rows [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query
Plan ExplainQuery Stage Response[] [Output only] Describes execution plan for the query.
- referenced
Routines RoutineReference Response[] [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced
Tables TableReference Response[] [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation
Usage JobStatistics2Reservation Usage Item Response[] [Output only] Job resource usage breakdown by reservation.
- schema
Table
Schema Response [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search
Statistics SearchStatistics Response [Output only] Search query specific statistics.
- spark
Statistics SparkStatistics Response [Output only] Statistics of a Spark procedure job.
- statement
Type string The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
Query
Timeline Sample Response[] [Output only] [Beta] Describes a timeline of job execution.
- total
Bytes stringBilled [Output only] Total bytes billed for the job.
- total
Bytes stringProcessed [Output only] Total bytes processed for the job.
- total
Bytes stringProcessed Accuracy [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total
Partitions stringProcessed [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total
Slot stringMs [Output only] Slot-milliseconds for the job.
- transferred
Bytes string Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared
Query QueryParameters Parameter Response[] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi_
engine_ Bistatistics Engine Statistics Response BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing_
tier int [Output only] Billing tier for the job.
- cache_
hit bool [Output only] Whether the query result was fetched from the query cache.
- ddl_
affected_ strrow_ access_ policy_ count [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl_
destination_ Tabletable Reference Response [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl_
operation_ strperformed The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- ddl_
target_ Datasetdataset Reference Response [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl_
target_ Routineroutine Reference Response The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl_
target_ Rowrow_ access_ policy Access Policy Reference Response [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl_
target_ Tabletable Reference Response [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml_
stats DmlStatistics Response [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated_
bytes_ strprocessed [Output only] The original estimate of bytes processed for the job.
- ml_
statistics MlStatistics Response [Output only] Statistics of a BigQuery ML training job.
- model_
training BigQuery Model Training Response [Output only, Beta] Information about create model query job progress.
- model_
training_ intcurrent_ iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- model_
training_ strexpected_ total_ iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- num_
dml_ straffected_ rows [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query_
plan Sequence[ExplainQuery Stage Response] [Output only] Describes execution plan for the query.
- referenced_
routines Sequence[RoutineReference Response] [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced_
tables Sequence[TableReference Response] [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation_
usage Sequence[JobStatistics2Reservation Usage Item Response] [Output only] Job resource usage breakdown by reservation.
- schema
Table
Schema Response [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search_
statistics SearchStatistics Response [Output only] Search query specific statistics.
- spark_
statistics SparkStatistics Response [Output only] Statistics of a Spark procedure job.
- statement_
type str The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
Sequence[Query
Timeline Sample Response] [Output only] [Beta] Describes a timeline of job execution.
- total_
bytes_ strbilled [Output only] Total bytes billed for the job.
- total_
bytes_ strprocessed [Output only] Total bytes processed for the job.
- total_
bytes_ strprocessed_ accuracy [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total_
partitions_ strprocessed [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total_
slot_ strms [Output only] Slot-milliseconds for the job.
- transferred_
bytes str Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared_
query_ Sequence[Queryparameters Parameter Response] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi
Engine Property MapStatistics BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing
Tier Number [Output only] Billing tier for the job.
- cache
Hit Boolean [Output only] Whether the query result was fetched from the query cache.
- ddl
Affected StringRow Access Policy Count [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl
Destination Property MapTable [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl
Operation StringPerformed The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- ddl
Target Property MapDataset [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl
Target Property MapRoutine The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl
Target Property MapRow Access Policy [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl
Target Property MapTable [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml
Stats Property Map [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated
Bytes StringProcessed [Output only] The original estimate of bytes processed for the job.
- ml
Statistics Property Map [Output only] Statistics of a BigQuery ML training job.
- model
Training Property Map [Output only, Beta] Information about create model query job progress.
- model
Training NumberCurrent Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- model
Training StringExpected Total Iteration [Output only, Beta] Deprecated; do not use.
[Output only, Beta] Deprecated; do not use.
- num
Dml StringAffected Rows [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query
Plan List<Property Map> [Output only] Describes execution plan for the query.
- referenced
Routines List<Property Map> [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced
Tables List<Property Map> [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation
Usage List<Property Map> [Output only] Job resource usage breakdown by reservation.
- schema Property Map
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search
Statistics Property Map [Output only] Search query specific statistics.
- spark
Statistics Property Map [Output only] Statistics of a Spark procedure job.
- statement
Type String The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline List<Property Map>
[Output only] [Beta] Describes a timeline of job execution.
- total
Bytes StringBilled [Output only] Total bytes billed for the job.
- total
Bytes StringProcessed [Output only] Total bytes processed for the job.
- total
Bytes StringProcessed Accuracy [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total
Partitions StringProcessed [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total
Slot StringMs [Output only] Slot-milliseconds for the job.
- transferred
Bytes String Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared
Query List<Property Map>Parameters Standard SQL only: list of undeclared query parameters detected during a dry run validation.
JobStatistics3Response, JobStatistics3ResponseArgs
- Bad
Records string The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- Input
File stringBytes Number of bytes of source data in a load job.
- Input
Files string Number of source files in a load job.
- Output
Bytes string Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- Output
Rows string Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- Bad
Records string The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- Input
File stringBytes Number of bytes of source data in a load job.
- Input
Files string Number of source files in a load job.
- Output
Bytes string Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- Output
Rows string Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- bad
Records String The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- input
File StringBytes Number of bytes of source data in a load job.
- input
Files String Number of source files in a load job.
- output
Bytes String Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- output
Rows String Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- bad
Records string The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- input
File stringBytes Number of bytes of source data in a load job.