Skip to content

Latest commit

 

History

History
1061 lines (640 loc) · 49.4 KB

bigquery_table.md

File metadata and controls

1061 lines (640 loc) · 49.4 KB
Raw
permalink
/bigquery_table/

bigquery_table

bigquery_table represents the google_bigquery_table Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

Fields

fn new

new()

google.bigquery_table.new injects a new google_bigquery_table Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.bigquery_table.new('some_id')

You can get the reference to the id field of the created google.bigquery_table using the reference:

$._ref.google_bigquery_table.some_id.get('id')

This is the same as directly entering "${ google_bigquery_table.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

  • resourceLabel (string): The name label of the block.
  • clustering (list): Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order. When null, the clustering field will be omitted from the resulting object.
  • dataset_id (string): The dataset ID to create the table in. Changing this forces a new resource to be created.
  • deletion_protection (bool): Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. When null, the deletion_protection field will be omitted from the resulting object.
  • description (string): The field description. When null, the description field will be omitted from the resulting object.
  • expiration_time (number): The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. When null, the expiration_time field will be omitted from the resulting object.
  • friendly_name (string): A descriptive name for the table. When null, the friendly_name field will be omitted from the resulting object.
  • labels (obj): A mapping of labels to assign to the resource. When null, the labels field will be omitted from the resulting object.
  • max_staleness (string): The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type. When null, the max_staleness field will be omitted from the resulting object.
  • project (string): The ID of the project in which the resource belongs. When null, the project field will be omitted from the resulting object.
  • schema (string): A JSON schema for the table. When null, the schema field will be omitted from the resulting object.
  • table_id (string): A unique ID for the resource. Changing this forces a new resource to be created.
  • encryption_configuration (list[obj]): Specifies how the table should be encrypted. If left blank, the table will be encrypted with a Google-managed key; that process is transparent to the user. When null, the encryption_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.encryption_configuration.new constructor.
  • external_data_configuration (list[obj]): Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. When null, the external_data_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.new constructor.
  • materialized_view (list[obj]): If specified, configures this table as a materialized view. When null, the materialized_view sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.materialized_view.new constructor.
  • range_partitioning (list[obj]): If specified, configures range-based partitioning for this table. When null, the range_partitioning sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.range_partitioning.new constructor.
  • table_constraints (list[obj]): Defines the primary key and foreign keys. When null, the table_constraints sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.table_constraints.new constructor.
  • time_partitioning (list[obj]): If specified, configures time-based partitioning for this table. When null, the time_partitioning sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.time_partitioning.new constructor.
  • view (list[obj]): If specified, configures this table as a view. When null, the view sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.view.new constructor.

Returns:

  • A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

google.bigquery_table.newAttrs constructs a new object with attributes and blocks configured for the bigquery_table Terraform resource.

Unlike google.bigquery_table.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

  • clustering (list): Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order. When null, the clustering field will be omitted from the resulting object.
  • dataset_id (string): The dataset ID to create the table in. Changing this forces a new resource to be created.
  • deletion_protection (bool): Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. When null, the deletion_protection field will be omitted from the resulting object.
  • description (string): The field description. When null, the description field will be omitted from the resulting object.
  • expiration_time (number): The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. When null, the expiration_time field will be omitted from the resulting object.
  • friendly_name (string): A descriptive name for the table. When null, the friendly_name field will be omitted from the resulting object.
  • labels (obj): A mapping of labels to assign to the resource. When null, the labels field will be omitted from the resulting object.
  • max_staleness (string): The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type. When null, the max_staleness field will be omitted from the resulting object.
  • project (string): The ID of the project in which the resource belongs. When null, the project field will be omitted from the resulting object.
  • schema (string): A JSON schema for the table. When null, the schema field will be omitted from the resulting object.
  • table_id (string): A unique ID for the resource. Changing this forces a new resource to be created.
  • encryption_configuration (list[obj]): Specifies how the table should be encrypted. If left blank, the table will be encrypted with a Google-managed key; that process is transparent to the user. When null, the encryption_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.encryption_configuration.new constructor.
  • external_data_configuration (list[obj]): Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. When null, the external_data_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.new constructor.
  • materialized_view (list[obj]): If specified, configures this table as a materialized view. When null, the materialized_view sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.materialized_view.new constructor.
  • range_partitioning (list[obj]): If specified, configures range-based partitioning for this table. When null, the range_partitioning sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.range_partitioning.new constructor.
  • table_constraints (list[obj]): Defines the primary key and foreign keys. When null, the table_constraints sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.table_constraints.new constructor.
  • time_partitioning (list[obj]): If specified, configures time-based partitioning for this table. When null, the time_partitioning sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.time_partitioning.new constructor.
  • view (list[obj]): If specified, configures this table as a view. When null, the view sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.view.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new bigquery_table resource into the root Terraform configuration.

fn withClustering

withClustering()

google.list.withClustering constructs a mixin object that can be merged into the list Terraform resource block to set or update the clustering field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list): The value to set for the clustering field.

fn withDatasetId

withDatasetId()

google.string.withDatasetId constructs a mixin object that can be merged into the string Terraform resource block to set or update the dataset_id field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the dataset_id field.

fn withDeletionProtection

withDeletionProtection()

google.bool.withDeletionProtection constructs a mixin object that can be merged into the bool Terraform resource block to set or update the deletion_protection field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (bool): The value to set for the deletion_protection field.

fn withDescription

withDescription()

google.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the description field.

fn withEncryptionConfiguration

withEncryptionConfiguration()

google.list[obj].withEncryptionConfiguration constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the encryption_configuration field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withEncryptionConfigurationMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the encryption_configuration field.

fn withEncryptionConfigurationMixin

withEncryptionConfigurationMixin()

google.list[obj].withEncryptionConfigurationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the encryption_configuration field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withEncryptionConfiguration function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the encryption_configuration field.

fn withExpirationTime

withExpirationTime()

google.number.withExpirationTime constructs a mixin object that can be merged into the number Terraform resource block to set or update the expiration_time field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (number): The value to set for the expiration_time field.

fn withExternalDataConfiguration

withExternalDataConfiguration()

google.list[obj].withExternalDataConfiguration constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the external_data_configuration field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withExternalDataConfigurationMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the external_data_configuration field.

fn withExternalDataConfigurationMixin

withExternalDataConfigurationMixin()

google.list[obj].withExternalDataConfigurationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the external_data_configuration field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withExternalDataConfiguration function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the external_data_configuration field.

fn withFriendlyName

withFriendlyName()

google.string.withFriendlyName constructs a mixin object that can be merged into the string Terraform resource block to set or update the friendly_name field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the friendly_name field.

fn withLabels

withLabels()

google.obj.withLabels constructs a mixin object that can be merged into the obj Terraform resource block to set or update the labels field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the labels field.

fn withMaterializedView

withMaterializedView()

google.list[obj].withMaterializedView constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the materialized_view field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withMaterializedViewMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the materialized_view field.

fn withMaterializedViewMixin

withMaterializedViewMixin()

google.list[obj].withMaterializedViewMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the materialized_view field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withMaterializedView function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the materialized_view field.

fn withMaxStaleness

withMaxStaleness()

google.string.withMaxStaleness constructs a mixin object that can be merged into the string Terraform resource block to set or update the max_staleness field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the max_staleness field.

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform resource block to set or update the project field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the project field.

fn withRangePartitioning

withRangePartitioning()

google.list[obj].withRangePartitioning constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the range_partitioning field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withRangePartitioningMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the range_partitioning field.

fn withRangePartitioningMixin

withRangePartitioningMixin()

google.list[obj].withRangePartitioningMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the range_partitioning field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withRangePartitioning function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the range_partitioning field.

fn withSchema

withSchema()

google.string.withSchema constructs a mixin object that can be merged into the string Terraform resource block to set or update the schema field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the schema field.

fn withTableConstraints

withTableConstraints()

google.list[obj].withTableConstraints constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the table_constraints field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withTableConstraintsMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the table_constraints field.

fn withTableConstraintsMixin

withTableConstraintsMixin()

google.list[obj].withTableConstraintsMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the table_constraints field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withTableConstraints function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the table_constraints field.

fn withTableId

withTableId()

google.string.withTableId constructs a mixin object that can be merged into the string Terraform resource block to set or update the table_id field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the table_id field.

fn withTimePartitioning

withTimePartitioning()

google.list[obj].withTimePartitioning constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the time_partitioning field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withTimePartitioningMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the time_partitioning field.

fn withTimePartitioningMixin

withTimePartitioningMixin()

google.list[obj].withTimePartitioningMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the time_partitioning field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withTimePartitioning function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the time_partitioning field.

fn withView

withView()

google.list[obj].withView constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the view field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withViewMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the view field.

fn withViewMixin

withViewMixin()

google.list[obj].withViewMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the view field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withView function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the view field.

obj encryption_configuration

fn encryption_configuration.new

new()

google.bigquery_table.encryption_configuration.new constructs a new object with attributes and blocks configured for the encryption_configuration Terraform sub block.

Args:

  • kms_key_name (string): The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the google_bigquery_default_service_account datasource and the google_kms_crypto_key_iam_binding resource.

Returns:

  • An attribute object that represents the encryption_configuration sub block.

obj external_data_configuration

fn external_data_configuration.new

new()

google.bigquery_table.external_data_configuration.new constructs a new object with attributes and blocks configured for the external_data_configuration Terraform sub block.

Args:

  • autodetect (bool): Let BigQuery try to autodetect the schema and format of the table.
  • compression (string): The compression type of the data source. Valid values are "NONE" or "GZIP". When null, the compression field will be omitted from the resulting object.
  • connection_id (string): The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "{{project}}.{{location}}.{{connection_id}}" or "projects/{{project}}/locations/{{location}}/connections/{{connection_id}}". When null, the connection_id field will be omitted from the resulting object.
  • file_set_spec_type (string): 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. When null, the file_set_spec_type field will be omitted from the resulting object.
  • ignore_unknown_values (bool): 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. When null, the ignore_unknown_values field will be omitted from the resulting object.
  • max_bad_records (number): The maximum number of bad records that BigQuery can ignore when reading data. When null, the max_bad_records field will be omitted from the resulting object.
  • metadata_cache_mode (string): Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source. When null, the metadata_cache_mode field will be omitted from the resulting object.
  • object_metadata (string): Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted. When null, the object_metadata field will be omitted from the resulting object.
  • reference_file_schema_uri (string): When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. When null, the reference_file_schema_uri field will be omitted from the resulting object.
  • schema (string): A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables. When null, the schema field will be omitted from the resulting object.
  • source_format (string): Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly". When null, the source_format field will be omitted from the resulting object.
  • source_uris (list): A list of the fully-qualified URIs that point to your data in Google Cloud.
  • avro_options (list[obj]): Additional options if source_format is set to "AVRO" When null, the avro_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.avro_options.new constructor.
  • csv_options (list[obj]): Additional properties to set if source_format is set to "CSV". When null, the csv_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.csv_options.new constructor.
  • google_sheets_options (list[obj]): Additional options if source_format is set to "GOOGLE_SHEETS". When null, the google_sheets_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.google_sheets_options.new constructor.
  • hive_partitioning_options (list[obj]): When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification. When null, the hive_partitioning_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.hive_partitioning_options.new constructor.
  • json_options (list[obj]): Additional properties to set if sourceFormat is set to JSON." When null, the json_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.json_options.new constructor.
  • parquet_options (list[obj]): Additional properties to set if sourceFormat is set to PARQUET." When null, the parquet_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.external_data_configuration.parquet_options.new constructor.

Returns:

  • An attribute object that represents the external_data_configuration sub block.

obj external_data_configuration.avro_options

fn external_data_configuration.avro_options.new

new()

google.bigquery_table.external_data_configuration.avro_options.new constructs a new object with attributes and blocks configured for the avro_options Terraform sub block.

Args:

  • use_avro_logical_types (bool): 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).

Returns:

  • An attribute object that represents the avro_options sub block.

obj external_data_configuration.csv_options

fn external_data_configuration.csv_options.new

new()

google.bigquery_table.external_data_configuration.csv_options.new constructs a new object with attributes and blocks configured for the csv_options Terraform sub block.

Args:

  • allow_jagged_rows (bool): Indicates if BigQuery should accept rows that are missing trailing optional columns. When null, the allow_jagged_rows field will be omitted from the resulting object.
  • allow_quoted_newlines (bool): Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. When null, the allow_quoted_newlines field will be omitted from the resulting object.
  • encoding (string): The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. When null, the encoding field will be omitted from the resulting object.
  • field_delimiter (string): The separator for fields in a CSV file. When null, the field_delimiter field will be omitted from the resulting object.
  • quote (string): The value that is used to quote data sections in a CSV file. 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 allow_quoted_newlines property to true. The API-side default is ", specified in Terraform escaped as ". Due to limitations with Terraform default values, this value is required to be explicitly set.
  • skip_leading_rows (number): The number of rows at the top of a CSV file that BigQuery will skip when reading the data. When null, the skip_leading_rows field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the csv_options sub block.

obj external_data_configuration.google_sheets_options

fn external_data_configuration.google_sheets_options.new

new()

google.bigquery_table.external_data_configuration.google_sheets_options.new constructs a new object with attributes and blocks configured for the google_sheets_options Terraform sub block.

Args:

  • range (string): Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: "sheet_name!top_left_cell_id:bottom_right_cell_id" For example: "sheet1!A1:B20" When null, the range field will be omitted from the resulting object.
  • skip_leading_rows (number): The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set. When null, the skip_leading_rows field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the google_sheets_options sub block.

obj external_data_configuration.hive_partitioning_options

fn external_data_configuration.hive_partitioning_options.new

new()

google.bigquery_table.external_data_configuration.hive_partitioning_options.new constructs a new object with attributes and blocks configured for the hive_partitioning_options Terraform sub block.

Args:

  • mode (string): When set, what mode of hive partitioning to use when reading data. When null, the mode field will be omitted from the resulting object.
  • require_partition_filter (bool): If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. When null, the require_partition_filter field will be omitted from the resulting object.
  • source_uri_prefix (string): When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins. When null, the source_uri_prefix field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the hive_partitioning_options sub block.

obj external_data_configuration.json_options

fn external_data_configuration.json_options.new

new()

google.bigquery_table.external_data_configuration.json_options.new constructs a new object with attributes and blocks configured for the json_options Terraform sub block.

Args:

  • encoding (string): The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. When null, the encoding field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the json_options sub block.

obj external_data_configuration.parquet_options

fn external_data_configuration.parquet_options.new

new()

google.bigquery_table.external_data_configuration.parquet_options.new constructs a new object with attributes and blocks configured for the parquet_options Terraform sub block.

Args:

  • enable_list_inference (bool): Indicates whether to use schema inference specifically for Parquet LIST logical type. When null, the enable_list_inference field will be omitted from the resulting object.
  • enum_as_string (bool): Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. When null, the enum_as_string field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the parquet_options sub block.

obj materialized_view

fn materialized_view.new

new()

google.bigquery_table.materialized_view.new constructs a new object with attributes and blocks configured for the materialized_view Terraform sub block.

Args:

  • allow_non_incremental_definition (bool): Allow non incremental materialized view definition. The default value is false. When null, the allow_non_incremental_definition field will be omitted from the resulting object.
  • enable_refresh (bool): Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true. When null, the enable_refresh field will be omitted from the resulting object.
  • query (string): A query whose result is persisted.
  • refresh_interval_ms (number): Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000 When null, the refresh_interval_ms field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the materialized_view sub block.

obj range_partitioning

fn range_partitioning.new

new()

google.bigquery_table.range_partitioning.new constructs a new object with attributes and blocks configured for the range_partitioning Terraform sub block.

Args:

  • field (string): The field used to determine how to create a range-based partition.
  • range (list[obj]): Information required to partition based on ranges. Structure is documented below. When null, the range sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.range_partitioning.range.new constructor.

Returns:

  • An attribute object that represents the range_partitioning sub block.

obj range_partitioning.range

fn range_partitioning.range.new

new()

google.bigquery_table.range_partitioning.range.new constructs a new object with attributes and blocks configured for the range Terraform sub block.

Args:

  • end (number): End of the range partitioning, exclusive.
  • interval (number): The width of each range within the partition.
  • start (number): Start of the range partitioning, inclusive.

Returns:

  • An attribute object that represents the range sub block.

obj table_constraints

fn table_constraints.new

new()

google.bigquery_table.table_constraints.new constructs a new object with attributes and blocks configured for the table_constraints Terraform sub block.

Args:

  • foreign_keys (list[obj]): Present only if the table has a foreign key. The foreign key is not enforced. When null, the foreign_keys sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.table_constraints.foreign_keys.new constructor.
  • primary_key (list[obj]): Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced. When null, the primary_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.table_constraints.primary_key.new constructor.

Returns:

  • An attribute object that represents the table_constraints sub block.

obj table_constraints.foreign_keys

fn table_constraints.foreign_keys.new

new()

google.bigquery_table.table_constraints.foreign_keys.new constructs a new object with attributes and blocks configured for the foreign_keys Terraform sub block.

Args:

  • name (string): Set only if the foreign key constraint is named. When null, the name field will be omitted from the resulting object.
  • column_references (list[obj]): The pair of the foreign key column and primary key column. When null, the column_references sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.table_constraints.foreign_keys.column_references.new constructor.
  • referenced_table (list[obj]): The table that holds the primary key and is referenced by this foreign key. When null, the referenced_table sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.bigquery_table.table_constraints.foreign_keys.referenced_table.new constructor.

Returns:

  • An attribute object that represents the foreign_keys sub block.

obj table_constraints.foreign_keys.column_references

fn table_constraints.foreign_keys.column_references.new

new()

google.bigquery_table.table_constraints.foreign_keys.column_references.new constructs a new object with attributes and blocks configured for the column_references Terraform sub block.

Args:

  • referenced_column (string): The column in the primary key that are referenced by the referencingColumn.
  • referencing_column (string): The column that composes the foreign key.

Returns:

  • An attribute object that represents the column_references sub block.

obj table_constraints.foreign_keys.referenced_table

fn table_constraints.foreign_keys.referenced_table.new

new()

google.bigquery_table.table_constraints.foreign_keys.referenced_table.new constructs a new object with attributes and blocks configured for the referenced_table Terraform sub block.

Args:

  • dataset_id (string): The ID of the dataset containing this table.
  • project_id (string): The ID of the project containing this table.
  • table_id (string): The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as sample_table$20190123.

Returns:

  • An attribute object that represents the referenced_table sub block.

obj table_constraints.primary_key

fn table_constraints.primary_key.new

new()

google.bigquery_table.table_constraints.primary_key.new constructs a new object with attributes and blocks configured for the primary_key Terraform sub block.

Args:

  • columns (list): The columns that are composed of the primary key constraint.

Returns:

  • An attribute object that represents the primary_key sub block.

obj time_partitioning

fn time_partitioning.new

new()

google.bigquery_table.time_partitioning.new constructs a new object with attributes and blocks configured for the time_partitioning Terraform sub block.

Args:

  • expiration_ms (number): Number of milliseconds for which to keep the storage for a partition. When null, the expiration_ms field will be omitted from the resulting object.
  • field (string): The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time. When null, the field field will be omitted from the resulting object.
  • require_partition_filter (bool): If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. When null, the require_partition_filter field will be omitted from the resulting object.
  • type (string): The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.

Returns:

  • An attribute object that represents the time_partitioning sub block.

obj view

fn view.new

new()

google.bigquery_table.view.new constructs a new object with attributes and blocks configured for the view Terraform sub block.

Args:

  • query (string): A query that BigQuery executes when the view is referenced.
  • use_legacy_sql (bool): Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL When null, the use_legacy_sql field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the view sub block.