googleBigqueryJob

Jobs are actions that BigQuery runs on your behalf to load data, export data, query data, or copy data. Once a BigQuery job is created, it cannot be changed or deleted.

To get more information about Job, see:

• API documentation
• How-to Guides
• BigQuery Jobs Intro

Example Usage - Bigquery Job Query

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleBigqueryDatasetBar = new google.bigqueryDataset.BigqueryDataset(
  this,
  "bar",
  {
    dataset_id: "job_query_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  }
);
const googleBigqueryTableFoo = new google.bigqueryTable.BigqueryTable(
  this,
  "foo",
  {
    dataset_id: googleBigqueryDatasetBar.datasetId,
    deletion_protection: false,
    table_id: "job_query_table",
  }
);
new google.bigqueryJob.BigqueryJob(this, "job", {
  job_id: "job_query",
  labels: [
    {
      "example-label": "example-value",
    },
  ],
  query: [
    {
      allow_large_results: true,
      destination_table: [
        {
          dataset_id: googleBigqueryTableFoo.datasetId,
          project_id: googleBigqueryTableFoo.project,
          table_id: googleBigqueryTableFoo.tableId,
        },
      ],
      flatten_results: true,
      query: "SELECT state FROM [lookerdata:cdc.project_tycho_reports]",
      script_options: [
        {
          key_result_statement: "LAST",
        },
      ],
    },
  ],
});

Example Usage - Bigquery Job Query Table Reference

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleBigqueryDatasetBar = new google.bigqueryDataset.BigqueryDataset(
  this,
  "bar",
  {
    dataset_id: "job_query_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  }
);
const googleBigqueryTableFoo = new google.bigqueryTable.BigqueryTable(
  this,
  "foo",
  {
    dataset_id: googleBigqueryDatasetBar.datasetId,
    deletion_protection: false,
    table_id: "job_query_table",
  }
);
new google.bigqueryJob.BigqueryJob(this, "job", {
  job_id: "job_query",
  labels: [
    {
      "example-label": "example-value",
    },
  ],
  query: [
    {
      allow_large_results: true,
      default_dataset: [
        {
          dataset_id: googleBigqueryDatasetBar.id,
        },
      ],
      destination_table: [
        {
          table_id: googleBigqueryTableFoo.id,
        },
      ],
      flatten_results: true,
      query: "SELECT state FROM [lookerdata:cdc.project_tycho_reports]",
      script_options: [
        {
          key_result_statement: "LAST",
        },
      ],
    },
  ],
});

Example Usage - Bigquery Job Load

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleBigqueryDatasetBar = new google.bigqueryDataset.BigqueryDataset(
  this,
  "bar",
  {
    dataset_id: "job_load_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  }
);
const googleBigqueryTableFoo = new google.bigqueryTable.BigqueryTable(
  this,
  "foo",
  {
    dataset_id: googleBigqueryDatasetBar.datasetId,
    deletion_protection: false,
    table_id: "job_load_table",
  }
);
new google.bigqueryJob.BigqueryJob(this, "job", {
  job_id: "job_load",
  labels: [
    {
      my_job: "load",
    },
  ],
  load: [
    {
      autodetect: true,
      destination_table: [
        {
          dataset_id: googleBigqueryTableFoo.datasetId,
          project_id: googleBigqueryTableFoo.project,
          table_id: googleBigqueryTableFoo.tableId,
        },
      ],
      schema_update_options: ["ALLOW_FIELD_RELAXATION", "ALLOW_FIELD_ADDITION"],
      skip_leading_rows: 1,
      source_uris: [
        "gs://cloud-samples-data/bigquery/us-states/us-states-by-date.csv",
      ],
      write_disposition: "WRITE_APPEND",
    },
  ],
});

Example Usage - Bigquery Job Load Geojson

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const project = "my-project-name";
const googleBigqueryDatasetBar = new google.bigqueryDataset.BigqueryDataset(
  this,
  "bar",
  {
    dataset_id: "job_load_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  }
);
const googleBigqueryTableFoo = new google.bigqueryTable.BigqueryTable(
  this,
  "foo",
  {
    dataset_id: googleBigqueryDatasetBar.datasetId,
    deletion_protection: false,
    table_id: "job_load_table",
  }
);
const googleStorageBucketBucket = new google.storageBucket.StorageBucket(
  this,
  "bucket",
  {
    location: "US",
    name: `\${${project}}-bq-geojson-sample`,
    uniform_bucket_level_access: true,
  }
);
const googleStorageBucketObjectObject =
  new google.storageBucketObject.StorageBucketObject(this, "object", {
    bucket: googleStorageBucketBucket.name,
    content:
      '{"type":"Feature","properties":{"continent":"Europe","region":"Scandinavia"},"geometry":{"type":"Polygon","coordinates":[[[-30.94,53.33],[33.05,53.33],[33.05,71.86],[-30.94,71.86],[-30.94,53.33]]]}}\n{"type":"Feature","properties":{"continent":"Africa","region":"West Africa"},"geometry":{"type":"Polygon","coordinates":[[[-23.91,0],[11.95,0],[11.95,18.98],[-23.91,18.98],[-23.91,0]]]}}\n',
    name: "geojson-data.jsonl",
  });
new google.bigqueryJob.BigqueryJob(this, "job", {
  depends_on: ["google_storage_bucket_object.object"],
  job_id: "job_load",
  labels: [
    {
      my_job: "load",
    },
  ],
  load: [
    {
      autodetect: true,
      destination_table: [
        {
          dataset_id: googleBigqueryTableFoo.datasetId,
          project_id: googleBigqueryTableFoo.project,
          table_id: googleBigqueryTableFoo.tableId,
        },
      ],
      json_extension: "GEOJSON",
      source_format: "NEWLINE_DELIMITED_JSON",
      source_uris: [
        `gs://\${${googleStorageBucketObjectObject.bucket}}/\${${googleStorageBucketObjectObject.name}}`,
      ],
      write_disposition: "WRITE_TRUNCATE",
    },
  ],
});

Example Usage - Bigquery Job Copy

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleBigqueryDatasetDest = new google.bigqueryDataset.BigqueryDataset(
  this,
  "dest",
  {
    dataset_id: "job_copy_dest_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  }
);
const googleBigqueryDatasetSource = new google.bigqueryDataset.BigqueryDataset(
  this,
  "source",
  {
    dataset_id: "job_copy_${count.index}_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  }
);
/*In most cases loops should be handled in the programming language context and 
not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input
you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source
you need to keep this like it is.*/
googleBigqueryDatasetSource.addOverride("count", 2);
const googleBigqueryTableSource = new google.bigqueryTable.BigqueryTable(
  this,
  "source_2",
  {
    dataset_id: `\${${googleBigqueryDatasetSource.fqn}[count.index].dataset_id}`,
    deletion_protection: false,
    schema:
      '[\n  {\n    "name": "name",\n    "type": "STRING",\n    "mode": "NULLABLE"\n  },\n  {\n    "name": "post_abbr",\n    "type": "STRING",\n    "mode": "NULLABLE"\n  },\n  {\n    "name": "date",\n    "type": "DATE",\n    "mode": "NULLABLE"\n  }\n]\n',
    table_id: "job_copy_${count.index}_table",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
googleBigqueryTableSource.overrideLogicalId("source");
/*In most cases loops should be handled in the programming language context and 
not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input
you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source
you need to keep this like it is.*/
googleBigqueryTableSource.addOverride(
  "count",
  `\${length(${googleBigqueryDatasetSource.fqn})}`
);
const googleKmsKeyRingKeyRing = new google.kmsKeyRing.KmsKeyRing(
  this,
  "key_ring",
  {
    location: "global",
    name: "example-keyring",
  }
);
const dataGoogleProjectProject = new google.dataGoogleProject.DataGoogleProject(
  this,
  "project",
  {
    project_id: "my-project-name",
  }
);
const googleKmsCryptoKeyCryptoKey = new google.kmsCryptoKey.KmsCryptoKey(
  this,
  "crypto_key",
  {
    key_ring: googleKmsKeyRingKeyRing.id,
    name: "example-key",
  }
);
new google.projectIamMember.ProjectIamMember(this, "encrypt_role", {
  member: `serviceAccount:bq-\${${dataGoogleProjectProject.number}}@bigquery-encryption.iam.gserviceaccount.com`,
  project: dataGoogleProjectProject.projectId,
  role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
});
const googleBigqueryTableDest = new google.bigqueryTable.BigqueryTable(
  this,
  "dest_7",
  {
    dataset_id: googleBigqueryDatasetDest.datasetId,
    deletion_protection: false,
    depends_on: ["google_project_iam_member.encrypt_role"],
    encryption_configuration: [
      {
        kms_key_name: googleKmsCryptoKeyCryptoKey.id,
      },
    ],
    schema:
      '[\n  {\n    "name": "name",\n    "type": "STRING",\n    "mode": "NULLABLE"\n  },\n  {\n    "name": "post_abbr",\n    "type": "STRING",\n    "mode": "NULLABLE"\n  },\n  {\n    "name": "date",\n    "type": "DATE",\n    "mode": "NULLABLE"\n  }\n]\n',
    table_id: "job_copy_dest_table",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
googleBigqueryTableDest.overrideLogicalId("dest");
new google.bigqueryJob.BigqueryJob(this, "job", {
  copy: [
    {
      destination_encryption_configuration: [
        {
          kms_key_name: googleKmsCryptoKeyCryptoKey.id,
        },
      ],
      destination_table: [
        {
          dataset_id: googleBigqueryTableDest.datasetId,
          project_id: googleBigqueryTableDest.project,
          table_id: googleBigqueryTableDest.tableId,
        },
      ],
      source_tables: [
        {
          dataset_id: `\${${googleBigqueryTableSource.fqn}.0.dataset_id}`,
          project_id: `\${${googleBigqueryTableSource.fqn}.0.project}`,
          table_id: `\${${googleBigqueryTableSource.fqn}.0.table_id}`,
        },
        {
          dataset_id: `\${${googleBigqueryTableSource.fqn}.1.dataset_id}`,
          project_id: `\${${googleBigqueryTableSource.fqn}.1.project}`,
          table_id: `\${${googleBigqueryTableSource.fqn}.1.table_id}`,
        },
      ],
    },
  ],
  depends_on: ["google_project_iam_member.encrypt_role"],
  job_id: "job_copy",
});

Example Usage - Bigquery Job Extract

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleBigqueryDatasetSourceOne =
  new google.bigqueryDataset.BigqueryDataset(this, "source-one", {
    dataset_id: "job_extract_dataset",
    description: "This is a test description",
    friendly_name: "test",
    location: "US",
  });
const googleBigqueryTableSourceOne = new google.bigqueryTable.BigqueryTable(
  this,
  "source-one_1",
  {
    dataset_id: googleBigqueryDatasetSourceOne.datasetId,
    deletion_protection: false,
    schema:
      '[\n  {\n    "name": "name",\n    "type": "STRING",\n    "mode": "NULLABLE"\n  },\n  {\n    "name": "post_abbr",\n    "type": "STRING",\n    "mode": "NULLABLE"\n  },\n  {\n    "name": "date",\n    "type": "DATE",\n    "mode": "NULLABLE"\n  }\n]\n',
    table_id: "job_extract_table",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
googleBigqueryTableSourceOne.overrideLogicalId("source-one");
const googleStorageBucketDest = new google.storageBucket.StorageBucket(
  this,
  "dest",
  {
    force_destroy: true,
    location: "US",
    name: "job_extract_bucket",
  }
);
new google.bigqueryJob.BigqueryJob(this, "job", {
  extract: [
    {
      compression: "GZIP",
      destination_format: "NEWLINE_DELIMITED_JSON",
      destination_uris: [`\${${googleStorageBucketDest.url}}/extract`],
      source_table: [
        {
          dataset_id: googleBigqueryTableSourceOne.datasetId,
          project_id: googleBigqueryTableSourceOne.project,
          table_id: googleBigqueryTableSourceOne.tableId,
        },
      ],
    },
  ],
  job_id: "job_extract",
});

Argument Reference

The following arguments are supported:

• jobId - (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.

The query block supports:

• query - (Required) SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. NOTE: queries containing DML language (delete, update, merge, insert) must specify createDisposition = "" and writeDisposition = "".

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

• userDefinedFunctionResources - (Optional) Describes user-defined function resources used in the query. Structure is documented below.

• createDisposition - (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. Creation, truncation and append actions occur as one atomic update upon job completion Default value is createIfNeeded. Possible values are createIfNeeded and createNever.

• writeDisposition - (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. 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. Default value is writeEmpty. Possible values are writeTruncate, writeAppend, and writeEmpty.

• defaultDataset - (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. Structure is documented below.

• priority - (Optional) Specifies a priority for the query. Default value is interactive. Possible values are interactive and batch.

• allowLargeResults - (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.

• useQueryCache - (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.

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

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

• maximumBytesBilled - (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.

• useLegacySql - (Optional) Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL.

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

• schemaUpdateOptions - (Optional) 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.

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

• scriptOptions - (Optional) Options controlling the execution of scripts. Structure is documented below.

The destinationTable block supports:

• projectId - (Optional) The ID of the project containing this table.

• datasetId - (Optional) The ID of the dataset containing this table.

• tableId - (Required) The table. Can be specified {{tableId}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{datasetId}}/tables/{{tableId}} if not.

The userDefinedFunctionResources block supports:

• resourceUri - (Optional) A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

• inlineCode - (Optional) An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

The defaultDataset block supports:

• datasetId - (Required) The dataset. Can be specified {{datasetId}} if projectId is also set, or of the form projects/{{project}}/datasets/{{datasetId}} if not.

• projectId - (Optional) The ID of the project containing this table.

The destinationEncryptionConfiguration block supports:

• kmsKeyName - (Required) 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.

• kmsKeyVersion - (Output) Describes the Cloud KMS encryption key version used to protect destination BigQuery table.

The scriptOptions block supports:

• statementTimeoutMs - (Optional) Timeout period for each statement in a script.

• statementByteBudget - (Optional) Limit on the number of bytes billed per statement. Exceeding this budget results in an error.

• keyResultStatement - (Optional) Determines which statement in the script represents the "key result", used to populate the schema and query results of the script job. Possible values are last and firstSelect.

The load block supports:

• sourceUris - (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.

• destinationTable - (Required) The destination table to load the data into. Structure is documented below.

• createDisposition - (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. Creation, truncation and append actions occur as one atomic update upon job completion Default value is createIfNeeded. Possible values are createIfNeeded and createNever.

• writeDisposition - (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. 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. Default value is writeEmpty. Possible values are writeTruncate, writeAppend, and writeEmpty.

• nullMarker - (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.

• fieldDelimiter - (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 (',').

• skipLeadingRows - (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. When autodetect is on, the behavior is the following: skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

• encoding - (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.

• quote - (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.

• maxBadRecords - (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. The default value is 0, which requires that all records are valid.

• allowQuotedNewlines - (Optional) Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

• sourceFormat - (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". [Beta] For Bigtable, specify "BIGTABLE". The default value is CSV.

• jsonExtension - (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.

• allowJaggedRows - (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.

• ignoreUnknownValues - (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

• projectionFields - (Optional) 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.

• autodetect - (Optional) Indicates if we should automatically infer the options and schema for CSV and JSON sources.

• schemaUpdateOptions - (Optional) 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.

• timePartitioning - (Optional) Time-based partitioning specification for the destination table. Structure is documented below.

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

The destinationTable block supports:

• projectId - (Optional) The ID of the project containing this table.

• datasetId - (Optional) The ID of the dataset containing this table.

• tableId - (Required) The table. Can be specified {{tableId}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{datasetId}}/tables/{{tableId}} if not.

The timePartitioning block supports:

• type - (Required) The only type supported is DAY, which will generate one partition per day. Providing an empty string used to cause an error, but in OnePlatform the field will be treated as unset.

• expirationMs - (Optional) Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.

• field - (Optional) If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.

The destinationEncryptionConfiguration block supports:

• kmsKeyName - (Required) 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.

• kmsKeyVersion - (Output) Describes the Cloud KMS encryption key version used to protect destination BigQuery table.

The copy block supports:

• sourceTables - (Required) Source tables to copy. Structure is documented below.

• destinationTable - (Optional) The destination table. Structure is documented below.

• createDisposition - (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. Creation, truncation and append actions occur as one atomic update upon job completion Default value is createIfNeeded. Possible values are createIfNeeded and createNever.

• writeDisposition - (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. 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. Default value is writeEmpty. Possible values are writeTruncate, writeAppend, and writeEmpty.

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

The sourceTables block supports:

• projectId - (Optional) The ID of the project containing this table.

• datasetId - (Optional) The ID of the dataset containing this table.

• tableId - (Required) The table. Can be specified {{tableId}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{datasetId}}/tables/{{tableId}} if not.

The destinationTable block supports:

• projectId - (Optional) The ID of the project containing this table.

• datasetId - (Optional) The ID of the dataset containing this table.

• tableId - (Required) The table. Can be specified {{tableId}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{datasetId}}/tables/{{tableId}} if not.

The destinationEncryptionConfiguration block supports:

• kmsKeyName - (Required) 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.

• kmsKeyVersion - (Output) Describes the Cloud KMS encryption key version used to protect destination BigQuery table.

The extract block supports:

• destinationUris - (Required) A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

• printHeader - (Optional) Whether to print out a header row in the results. Default is true.

• fieldDelimiter - (Optional) When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','

• destinationFormat - (Optional) The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO for tables and SAVED_MODEL 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 SAVED_MODEL.

• compression - (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.

• useAvroLogicalTypes - (Optional) Whether to use logical types when extracting to AVRO format.

• sourceTable - (Optional) A reference to the table being exported. Structure is documented below.

• sourceModel - (Optional) A reference to the model being exported. Structure is documented below.

The sourceTable block supports:

• projectId - (Optional) The ID of the project containing this table.

• datasetId - (Optional) The ID of the dataset containing this table.

• tableId - (Required) The table. Can be specified {{tableId}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{datasetId}}/tables/{{tableId}} if not.

The sourceModel block supports:

• projectId - (Required) The ID of the project containing this model.

• datasetId - (Required) The ID of the dataset containing this model.

• modelId - (Required) The ID of the model.

• jobTimeoutMs - (Optional) Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

• labels - (Optional) The labels associated with this job. You can use these to organize and group your jobs.

• query - (Optional) Configures a query job. Structure is documented below.

• load - (Optional) Configures a load job. Structure is documented below.

• copy - (Optional) Copies a table. Structure is documented below.

• extract - (Optional) Configures an extract job. Structure is documented below.

• location - (Optional) The geographic location of the job. The default value is US.

• project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

• id - an identifier for the resource with format projects/{{project}}/jobs/{{jobId}}

• userEmail - Email address of the user who ran the job.

• jobType - (Output) The type of the job.

• status - The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. Structure is documented below.

The status block contains:

• errorResult - (Output) Final error result of the job. If present, indicates that the job has completed and was unsuccessful. Structure is documented below.

• errors - (Output) The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has not completed or was unsuccessful. Structure is documented below.

• state - (Output) Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.

The errorResult block contains:

• reason - (Optional) A short error code that summarizes the error.

• location - (Optional) Specifies where the error occurred, if present.

• message - (Optional) A human-readable description of the error.

The errors block contains:

• reason - (Optional) A short error code that summarizes the error.

• location - (Optional) Specifies where the error occurred, if present.

• message - (Optional) A human-readable description of the error.

Timeouts

This resource provides the following Timeouts configuration options:

• create - Default is 20 minutes.
• delete - Default is 20 minutes.

Import

Job can be imported using any of these accepted formats:

$ terraform import google_bigquery_job.default projects/{{project}}/jobs/{{job_id}}/location/{{location}}
$ terraform import google_bigquery_job.default projects/{{project}}/jobs/{{job_id}}
$ terraform import google_bigquery_job.default {{project}}/{{job_id}}/{{location}}
$ terraform import google_bigquery_job.default {{job_id}}/{{location}}
$ terraform import google_bigquery_job.default {{project}}/{{job_id}}
$ terraform import google_bigquery_job.default {{job_id}}

User Project Overrides

This resource supports User Project Overrides.