Defining Google BigQuery Tables

The following properties are applicable to a Google BigQuery Table object.

Tab

Property

Description

Additional Information
  Physical Name Specifies the physical name of the table The maximum length for physical name is 254
  Dataset Specifies the dataset to which the table belongs  
  Use Replace Syntax Specifies whether the REPLACE syntax is used Selecting this option replaces the syntax with the new DDL that is generated during Forward Engineering
  If Not Exists Specifies that if the table already exists, no exception is thrown, and no action happens  
  Table Type Specifies the table type

Base: Indicates a standard table

Clone: Indicates that a standard table is restored from table snapshot

Copy: Indicates that a table is created with the same metadata and data from another table

External: Indicates that the table's data is stored in an external data source

Like: Indicates that the table is created based on another table and has the same metadata of the specified table

Snapshot: Indicates that the table is snapshot of a base table at a given timestamp

Temp: Indicates that the table is temporary
  Generate Specifies whether a DDL statement is generated for the table during forward engineering  
General Label List Specifies an array of labels for the dataset, expressed as key-value pairs

 
Clustering Column List Specifies the comma-separated list of columns based on which the table’s data is organized for a clustered table

 
Physical Name Specifies the physical name of the table

 
Friendly Name Specifies the user-friendly name for the table, enclosed in quotation marks

 
Expiration Timestamp Specifies the exact time when this table expires, in milliseconds, enclosed in quotation marks

 
Partition Expiration in Days Specifies the number of days after which a table partition is deleted

 
KMS Key Name Specifies the Cloud KMS key for encrypting table data in the dataset, enclosed in quotation marks

 
Require Partition Filter Specifies whether the table requires a partition filter that can be used for partition elimination to be specified

 
Allow Jagged Rows Specifies whether the table accepts rows in CSV files that are missing trailing optional columns Available when Table Type is set to External
Allow Quoted Newlines Specifies whether the table allows quoted data sections that contain newline characters in a CSV file Available when Table Type is set to External
Compression Specifies the compressed CSV or JSON data, enclosed in quotation marks Available when Table Type is set to External
Decimal Target Types Specifies how to convert a Decimal type

For example, ["NUMERIC", "BIGNUMERIC"]

Available when Table Type is set to External
Enable Logical Types Specifies the converted Avro logical types into their corresponding SQL types

Applies only to Avro data

Available when Table Type is set to External
Encoding Specifies CSV files with data encoded in ISO-8859-1 (also known as Latin-1) format, enclosed in quotation marks

Supported values are UTF8 (or UTF-8) and ISO_8859_1 (or ISO-8859-1)

Available when Table Type is set to External
Field Delimiter Specifies the separator for fields in a CSV file, enclosed in quotation marks

For example, any single-byte character

Available when Table Type is set to External
Format Specifies the format of the external data, enclosed in quotation marks

Supported values are AVRO, CSV, DATASTORE_BACKUP, GOOGLE_SHEETS, NEWLINE_DELIMITED_JSON (or JSON), ORC, and PARQUET

Available when Table Type is set to External
Hive Partition URI Prefix Specifies a common prefix for all source URIs before the partition key encoding begins

Applies to Avro, CSV, JSON, Parquet, and ORC data

Available when Table Type is set to External
Ignore Unknown Values Specifies whether to allow and ignore extra, unrecognized values in CSV or JSON data Available when Table Type is set to External
JSON Extension Specifies the JSON extension, enclosed in quotation marks
Max Bad Records Specifies the maximum number of bad records to ignore when reading the data in CSV, JSON, and Sheets data
Null Marker Specifies the string that represents NULL values in a CSV file, enclosed in quotation marks
Projection Fields Specifies list of entity properties to load in Datastore data, enclosed in quotation marks
Quote Specifies the string used to quote data sections in a CSV file, enclosed in quotation marks
Require Hive Partition Filter Specifies whether all queries of table require a partition filter that can be used to eliminate partitions when reading data in Avro, CSV, JSON, Parquet, and ORC data, enclosed in quotation marks

Applies only to hive-partitioned external tables

Available when Table Type is set to External
Sheet Range Specifies range of a Sheets spreadsheet to query from, enclosed in quotation marks

For example, “sheet1!A1:B20”

Available when Table Type is set to External
Skip Leading Rows Specifies the number of rows at the top of a file to skip when reading the data in CSV and Sheets data Available when Table Type is set to External
URIs Specifies an array of fully qualified URIs for the external data locations Available when Table Type is set to External
Source Table Specifies a standard table Available when Table Type is set to Clone, Copy, Like, or Snapshot
Query Statement   Specifies a valid standalone SQL statement to execute  
Partitions Column Specifies the list of available columns for partition

 
Physical Data Type Specifies the physical data type for the selected column  
Ingestion Options Specifies the type of pre-defined partition

 
Scheme Specifies how the table is partitioned DATE: Indicates partition by ingestion time with daily partition

DATE_TRUNC: Indicates partition by a DATE column with the specified partitioning type

TIMESTAMP_TRUNC: Indicates partition by ingestion time with the specified partitioning type

DATETIME_TRUNC: Indicates partition by a DATETIME column with the specified partitioning type

RANGE_BUCKET: Indicates partition by an integer column with the specified range
Schema Options Specifies the option to partition table via schema
Start Specifies the start of range partitioning Available when Scheme is set to Range Bucket
End Specifies the end of range partitioning Available when Scheme is set to Range Bucket
Interval Specifies the width of each range within the partition Available when Scheme is set to Range Bucket
Partition Expression Specifies an expression that determines how to partition the table

 

If the value of an object property is of the Function type, do not enclose the value in quotation marks.