Using Data Definition Language Statements

Data definition language (DDL) statements allow you to create and modify BigQuery resources using standard SQL query syntax. Currently, you can use DDL commands in BigQuery to:

• Create tables and views
• Alter tables
• Delete tables and views

CREATE TABLE statement

To create a table in BigQuery, use the CREATE TABLE DDL statement.

Syntax

{CREATE TABLE | CREATE TABLE IF NOT EXISTS | CREATE OR REPLACE TABLE}
table_name
[(
  column_name column_schema[, ...]
)]
[PARTITION BY partition_expression]
[CLUSTER BY clustering_column_list]
[OPTIONS(table_option_list)]
[AS query_statement]

Where:

{CREATE TABLE | CREATE TABLE IF NOT EXISTS | CREATE OR REPLACE TABLE} is one of the following statements:

• CREATE TABLE — creates a new table.
• CREATE TABLE IF NOT EXISTS — creates a new table only if the table does not currently exist in the specified dataset.
• CREATE OR REPLACE TABLE — creates a table and replaces an existing table with the same name in the specified dataset.

CREATE TABLE statements must comply with the following rules:

• Only one CREATE statement is allowed.
• Either the column list, the as query_statement clause, or both must be present.
• When both the column list and the as query_statement clause are present, BigQuery ignores the names in the as query_statement clause and matches the columns with the column list by position.
• When the as query_statement clause is present and the column list is absent, BigQuery determines the column names and types from the as query_statement clause.
• Column names must be specified either through the column list or as query_statement clause.
• Duplicate column names are not allowed.

table_name

table_name is the name of the table you're creating. The table name must be unique per dataset. The table name can:

• Contain up to 1,024 characters
• Contain letters (upper or lower case), numbers, and underscores

column_name and column_schema

(column_name column_schema[, ...]) contains the table's schema information in a comma-separated list:

• column_name is the name of the column. A column name:
  • Must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_)
  • Must start with a letter or underscore
  • Can be up to 128 characters
• column_schema is similar to a data type, but supports an optional NOT NULL constraint for types other than ARRAY. column_schema also supports options on top-level columns and STRUCT fields.

column_schema :=
   {simple_type [NOT NULL] |
    STRUCT<field_list> [NOT NULL] |
    ARRAY<array_element_schema>}
   [OPTIONS(column_option_list)]

field_list := field_name column_schema [, ...]

array_element_schema := {simple_type | STRUCT<field_list>} [NOT NULL]

simple_type is any supported data type aside from STRUCT and ARRAY.

field_name is the name of the struct field. Struct field names have the same restrictions as column names.

When the NOT NULL constraint is present for a column or field, the column or field is created with REQUIRED mode. Conversely, when the NOT NULL constraint is absent, the column or field is created with NULLABLE mode.

Columns and fields of ARRAY type do not support the NOT NULL modifier. For example, a column_schema of ARRAY<INT64> NOT NULL is invalid, since ARRAY columns have REPEATED mode and can be empty but cannot be NULL. An array element in a table can never be NULL, regardless of whether the NOT NULL constraint is specified. For example, ARRAY<INT64> is equivalent to ARRAY<INT64 NOT NULL>.

The NOT NULL attribute of a table's column_schema does not propagate through queries over the table. If table T contains a column declared as x INT64 NOT NULL, for example, CREATE TABLE dataset.newtable AS SELECT x FROM T creates a table named dataset.newtable in which x is NULLABLE.

column_schema can be used only in the column definition list of CREATE TABLE statements. It cannot be used as a type in expressions. For example, CAST(1 AS INT64 NOT NULL) is not valid.

partition_expression

PARTITION BY is an optional clause that controls table partitioning. partition_expression is an expression that determines how to partition the table. The partition expression can contain the following values:

• PARTITION BY DATE(_PARTITIONTIME) — partitions the table using the date-based timestamp in the _PARTITIONTIME pseudo column. This syntax is only supported with CREATE TABLE without the AS query_statement clause.
• PARTITION BY DATE(<timestamp_column>) — partitions the table using the date of the TIMESTAMP column
• PARTITION BY <date_column> — partitions the table using the DATE column

clustering_column_list

Note: Support for table clustering is currently in beta.

CLUSTER BY is an optional clause that controls table clustering. clustering_column_list is a comma-separated list that determines how to cluster the table. The clustering column list can contain a list of up to four clustering columns.

table_option_list

The option list allows you to set table options such as a label and an expiration time. You can include multiple options using a comma-separated list.

Specify a table option list in the following format:

NAME=VALUE, ...

NAME and VALUE must be one of the following combinations:

NAME	VALUE	Details
expiration_timestamp	TIMESTAMP	Example: expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC" This property is equivalent to the expirationTime table resource property.
partition_expiration_days	FLOAT64	Example: partition_expiration_days=7 This property is equivalent to the timePartitioning.expirationMs table resource property but uses days instead of milliseconds. One day is equivalent to 86400000 milliseconds, or 24 hours. This property can only be set if the table is partitioned.
require_partition_filter	BOOL	Example: require_partition_filter=true This property is equivalent to the timePartitioning.requirePartitionFilter table resource property. This property can only be set if the table is partitioned.
kms_key_name	STRING	Example: kms_key_name="projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" This property is equivalent to the encryptionConfiguration.kmsKeyName table resource property. See more details about Protecting Data with Cloud KMS Keys.
friendly_name	STRING	Example: friendly_name="my_table" This property is equivalent to the friendlyName table resource property.
description	STRING	Example: description="a table that expires in 2020" This property is equivalent to the description table resource property.
labels	ARRAY<STRUCT<STRING, STRING>>	Example: labels=[("org_unit", "development")] This property is equivalent to the labels table resource property.

VALUE is a constant expression containing only literals, query parameters, and scalar functions. If the constant expression evaluates to null, the corresponding option NAME is ignored.

The constant expression cannot contain:

• A reference to a table
• Subqueries or SQL statements such as SELECT, CREATE, and UPDATE
• User-defined functions, aggregate functions, or analytic functions
• The following scalar functions:
  • ARRAY_TO_STRING
  • REPLACE
  • REGEXP_REPLACE
  • RAND
  • FORMAT
  • LPAD
  • RPAD
  • REPEAT
  • SESSION_USER
  • GENERATE_ARRAY
  • GENERATE_DATE_ARRAY

column_option_list

The column_option_list in column_schema allows you to specify optional column or field options. Column options have the same syntax and requirements as table options but with a different list of NAMEs and VALUEs:

NAME	VALUE	Details
description	STRING	Example: description="a unique id" This property is equivalent to the schema.fields[].description table resource property.

query_statement

The AS query_statement clause specifies the query from which the table should be created. See the SQL syntax reference for the supported form of query_statement.

Known limitations:

• It is not possible to create an ingestion-time partitioned table from the result of a query. Instead, use a CREATE TABLE DDL statement to create the table, and then use an INSERT DML statement to insert data into it.
• It is not possible to use the OR REPLACE modifier to replace a table with a different kind of partitioning. Instead, DROP the table, and then use a CREATE TABLE ... AS SELECT ... statement to recreate it.

CREATE TABLE Examples

Creating a new table

The CREATE TABLE DDL statement creates a table with the specified options. If the table name exists in the dataset, the following error is returned:

Already Exists: [PROJECT]:[DATASET].[TABLE]

The following example creates a partitioned table named newtable in mydataset. If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.newtable`.

The table uses the following partition_expression to partition the table: PARTITION BY DATE(_PARTITIONTIME). This expression partitions the table using the date-based timestamp in the _PARTITIONTIME pseudo column.

The table schema contains 2 columns:

• x — an integer, with description "An optional INTEGER field"

• y — a STRUCT containing 2 columns:

  • a — an array of strings, with description "A repeated STRING field"
  • b — a boolean
  Note: When you examine the table schema in the BigQuery web UI, a STRUCT is displayed as a RECORD column, and an ARRAY is displayed as a REPEATED column. The STRUCT and ARRAY data types are used to create nested and repeated data in BigQuery. For more information, see Specifying nested and repeated fields.

The table option list specifies the:

• Table expiration time — January 1, 2020 at 00:00:00 UTC
• Partition expiration time — 1 day
• Description — a table that expires in 2020
• Label — org_unit = development

To create a new table using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.newtable
    (
      x INT64 OPTIONS(description="An optional INTEGER field"),
      y STRUCT<
        a ARRAY<STRING> OPTIONS(description="A repeated STRING field"),
        b BOOL
      >
    )
    PARTITION BY DATE(_PARTITIONTIME)
    OPTIONS(
      expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC",
      partition_expiration_days=1,
      description="a table that expires in 2020, with each partition living for 24 hours",
      labels=[("org_unit", "development")]
    )
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE mydataset.newtable
(
  x INT64 OPTIONS(description="An optional INTEGER field"),
  y STRUCT<
    a ARRAY<STRING> OPTIONS(description="A repeated STRING field"),
    b BOOL
  >
)
PARTITION BY DATE(_PARTITIONTIME)
OPTIONS(
  expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC",
  partition_expiration_days=1,
  description="a table that expires in 2020, with each partition living for 24 hours",
  labels=[("org_unit", "development")]
)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a new table from an existing table

The CREATE TABLE ... AS SELECT DDL statement creates a table from a query. If the table name exists in the dataset, the following error is returned:

Already Exists: [PROJECT]:[DATASET].[TABLE]

The following example creates a table named top_words in mydataset. If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.rainy_days`.

The table schema contains 2 columns:

• corpus — name of a Shakespeare corpus

• top_words — an ARRAY of STRUCTs containing 2 fields: word (a STRING) and word_count (an INT64 with the word count)

  Note: When you examine the table schema in the BigQuery web UI, a STRUCT is displayed as a RECORD column, and an ARRAY is displayed as a REPEATED column. The STRUCT and ARRAY data types are used to create nested and repeated data in BigQuery. For more information, see Specifying nested and repeated fields.

The table option list specifies the:

• Description — Top ten words per Shakespeare corpus

To create a new table using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.top_words
    OPTIONS(
      description="Top ten words per Shakespeare corpus"
    ) AS
    SELECT
      corpus,
      ARRAY_AGG(STRUCT(word, word_count) ORDER BY word_count DESC LIMIT 10) AS top_words
    FROM bigquery-public-data.samples.shakespeare
    GROUP BY corpus;

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
     CREATE TABLE mydataset.top_words
     OPTIONS(
       description="Top ten words per Shakespeare corpus"
     ) AS
     SELECT
       corpus,
       ARRAY_AGG(STRUCT(word, word_count)
                 ORDER BY word_count DESC LIMIT 10) AS top_words
     FROM `bigquery-public-data.samples.shakespeare`
     GROUP BY corpus;'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a table only if the table doesn't exist

The CREATE TABLE IF NOT EXISTS DDL statement creates a table with the specified options only if the table name does not exist in the dataset. If the table name exists in the dataset, no error is returned, and no action is taken.

The following example creates a table named newtable in mydataset only if no table named newtable exists in mydataset. If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.newtable`.

The table schema contains 2 columns:

• x — an integer

• y — a STRUCT containing a (an array of strings) and b (a boolean)

  Note: When you examine the table schema in the BigQuery web UI, a STRUCT is displayed as a RECORD, and an ARRAY is displayed as REPEATED. The STRUCT and ARRAY data types are used to create nested and repeated data in BigQuery. For more information, see Specifying nested and repeated fields.

The table option list specifies the:

• Expiration time — January 1, 2020 at 00:00:00 UTC
• Description — a table that expires in 2020
• Label — org_unit = development

To create a new table using DDL only if the table name doesn't exist in the dataset:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE IF NOT EXISTS mydataset.newtable (x INT64, y STRUCT<a ARRAY<STRING>, b BOOL>)
    OPTIONS(
      expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC",
      description="a table that expires in 2020",
      labels=[("org_unit", "development")]
    )
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE IF NOT EXISTS mydataset.newtable (x INT64, y STRUCT<a ARRAY<STRING>, b BOOL>)
 OPTIONS(
   expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC",
   description="a table that expires in 2020",
   labels=[("org_unit", "development")]
 )'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating or replacing a table

The CREATE OR REPLACE TABLE DDL statement creates a table with the specified options. If the table name exists in the dataset, the table is overwritten with an empty table.

The following example creates a table named newtable in mydataset, and if newtable exists in mydataset, it is overwritten. If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.newtable`.

The table schema contains 2 columns:

• x — an integer

• y — a STRUCT containing a (an array of strings) and b (a boolean)

  Note: When you examine the table schema in the BigQuery web UI, a STRUCT is displayed as a RECORD, and an ARRAY is displayed as REPEATED. The STRUCT and ARRAY data types are used to create nested and repeated data in BigQuery. For more information, see Specifying nested and repeated fields.

The table option list specifies the:

• Expiration time — January 1, 2020 at 00:00:00 UTC
• Description — a table that expires in 2020
• Label — org_unit = development

To create a new table using DDL and to overwrite a table with the same name:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE OR REPLACE TABLE mydataset.newtable (x INT64, y STRUCT<a ARRAY<STRING>, b BOOL>)
    OPTIONS(
      expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC",
      description="a table that expires in 2020",
      labels=[("org_unit", "development")]
    )
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE OR REPLACE TABLE mydataset.newtable (x INT64, y STRUCT<a ARRAY<STRING>, b BOOL>)
 OPTIONS(
   expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC",
   description="a table that expires in 2020",
   labels=[("org_unit", "development")]
 )'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a table with REQUIRED columns

The NOT NULL modifier in the column definition list of a CREATE TABLE statement specifies that a column or field is created in REQUIRED mode.

The following example creates a table named newtable in mydataset. If the table name exists in the dataset, the following error is returned:

Already Exists: [PROJECT]:[DATASET].[TABLE]

If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.newtable`.

The table schema contains 3 columns:

• x — a REQUIRED integer
• y — a REQUIRED STRUCT containing a (an array of strings), b (a REQUIRED boolean), and c (a NULLABLE float)

• z — a NULLABLE string

  Note: When you examine the table schema in the BigQuery web UI, a STRUCT is displayed as a RECORD, and an ARRAY is displayed as REPEATED. The STRUCT and ARRAY data types are used to create nested and repeated data in BigQuery. For more information, see Specifying nested and repeated fields.

To create a new table with REQUIRED columns using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE my_dataset.new_table (
      x INT64 NOT NULL,
      y STRUCT<
        a ARRAY<STRING>,
        b BOOL NOT NULL,
        c FLOAT64
      > NOT NULL,
      z STRING
    )
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
 CREATE TABLE my_dataset.new_table (
   x INT64 NOT NULL,
   y STRUCT<
     a ARRAY<STRING>,
     b BOOL NOT NULL,
     c FLOAT64
   > NOT NULL,
   z STRING
 )'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a partitioned table

The following example creates a partitioned table named newtable in mydataset using a DATE column. If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.newtable`.

The table schema contains 2 columns:

• transaction_id — an integer
• transaction_date — a date

The table option list specifies the:

• Partition expiration — three days
• Description — a table partitioned by transaction_date

To create a new table using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.newtable (transaction_id INT64, transaction_date DATE)
    PARTITION BY transaction_date
    OPTIONS(
      partition_expiration_days=3,
      description="a table partitioned by transaction_date"
    )
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE mydataset.newtable (transaction_id INT64, transaction_date DATE)
PARTITION BY transaction_date
OPTIONS(
  partition_expiration_days=3,
  description="a table partitioned by transaction_date"
)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a partitioned table from the result of a query

The following example creates a partitioned table named days_with_rain in mydataset using a DATE column. If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.newtable`.

The table schema contains 2 columns:

• date — the DATE of data collection
• station_name — the name of the weather station as a STRING
• prcp — the amount of precipitation in inches as a FLOAT64

The table option list specifies the:

• Partition expiration — one year
• Description — weather stations with precipitation, partitioned by day

To create a new table using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.days_with_rain
    PARTITION BY date
    OPTIONS (
      partition_expiration_days=365,
      description="weather stations with precipitation, partitioned by day"
    ) AS
    SELECT
      DATE(CAST(year AS INT64), CAST(mo AS INT64), CAST(da AS INT64)) AS date,
      (SELECT ANY_VALUE(name) FROM `bigquery-public-data.noaa_gsod.stations` AS stations
       WHERE stations.usaf = stn) AS station_name,  -- Stations may have multiple names
      prcp
    FROM `bigquery-public-data.noaa_gsod.gsod2017` AS weather
    WHERE prcp != 99.9  -- Filter unknown values
      AND prcp > 0      -- Filter stations/days with no precipitation
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE mydataset.days_with_rain
PARTITION BY date
OPTIONS (
  partition_expiration_days=365,
  description="weather stations with precipitation, partitioned by day"
) AS
SELECT
  DATE(CAST(year AS INT64), CAST(mo AS INT64), CAST(da AS INT64)) AS date,
  (SELECT ANY_VALUE(name) FROM \`bigquery-public-data.noaa_gsod.stations\` AS stations
   WHERE stations.usaf = stn) AS station_name,  -- Stations may have multiple names
  prcp
FROM \`bigquery-public-data.noaa_gsod.gsod2017\` AS weather
WHERE prcp != 99.9  -- Filter unknown values
  AND prcp > 0      -- Filter stations/days with no precipitation
'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a clustered table

Note: Support for table clustering is currently in beta.

Example 1

The following example creates a clustered table named myclusteredtable in mydataset. The table is a partitioned table, partitioned by a TIMESTAMP column and clustered by a STRING column named customer_id.

If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.myclusteredtable`.

The table schema contains 3 columns:

• timestamp — the time of data collection as a TIMESTAMP
• customer_id — the customer ID as a STRING
• transaction_amount — the transaction amount as NUMERIC

The table option list specifies the:

• Partition expiration — 3 days
• Description — "a table clustered by customer_id"

To create a clustered table using a DDL statement:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your CREATE TABLE DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.myclusteredtable
    (
      timestamp TIMESTAMP,
      customer_id STRING,
      transaction_amount NUMERIC
    )
    PARTITION BY DATE(timestamp)
    CLUSTER BY customer_id
    OPTIONS (
      partition_expiration_days=3,
      description="a table clustered by customer_id"
    )

4. Click Show Options.

5. (Optional) For Processing Location, click Unspecified and choose your data's location.

6. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE mydataset.myclusteredtable
(
  timestamp TIMESTAMP,
  customer_id STRING,
  transaction_amount NUMERIC
)
PARTITION BY DATE(timestamp)
CLUSTER BY customer_id
OPTIONS (
  partition_expiration_days=3,
  description="a table clustered by customer_id"
)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Example 2

The following example creates a clustered table named myclusteredtable in mydataset. The table is an ingestion-time partitioned table.

If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.myclusteredtable`.

The table schema contains 3 columns:

• timestamp — the time of data collection as a TIMESTAMP
• customer_id — the customer ID as a STRING
• transaction_amount — the transaction amount as NUMERIC

The table option list specifies the:

• Partition expiration — 3 days
• Description — "a table clustered by customer_id"

To create a clustered table using a DDL statement:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your CREATE TABLE DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.myclusteredtable
    (
      timestamp TIMESTAMP,
      customer_id STRING,
      transaction_amount NUMERIC
    )
    PARTITION BY DATE(_PARTITIONTIME)
    CLUSTER BY
      customer_id
    OPTIONS (
      partition_expiration_days=3,
      description="a table clustered by customer_id"
    )

4. Click Show Options.

5. (Optional) For Processing Location, click Unspecified and choose your data's location.

6. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE mydataset.myclusteredtable
(
  timestamp TIMESTAMP,
  customer_id STRING,
  transaction_amount NUMERIC
)
PARTITION BY DATE(_PARTITIONTIME)
CLUSTER BY
  customer_id
OPTIONS (
  partition_expiration_days=3,
  description="a table clustered by customer_id"
)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating a clustered table from the result of a query

The following example creates a clustered table named myclusteredtable in mydataset using the result of a query. The table is a partitioned table, partitioned by a TIMESTAMP column.

If you do not have a default project configured, prepend it to the dataset name in following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.myclusteredtable`.

The table schema contains 3 columns:

• timestamp — the time of data collection as a TIMESTAMP
• customer_id — the customer ID as a STRING
• transaction_amount — the transaction amount as NUMERIC

The table option list specifies the:

• Partition expiration — 3 days
• Description — "a table clustered by customer_id"

To create a clustered table using a DDL statement:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your CREATE TABLE DDL statement into the New Query text area.

    #standardSQL
    CREATE TABLE mydataset.myclusteredtable
    (
      timestamp TIMESTAMP,
      customer_id STRING,
      transaction_amount NUMERIC
    )
    PARTITION BY DATE(timestamp)
    CLUSTER BY
      customer_id
    OPTIONS (
      partition_expiration_days=3,
      description="a table clustered by customer_id"
    )
    AS SELECT * FROM mydataset.myothertable

4. Click Show Options.

5. (Optional) For Processing Location, click Unspecified and choose your data's location.

6. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE mydataset.myclusteredtable
  (
    timestamp TIMESTAMP,
    customer_id STRING,
    transaction_amount NUMERIC
  )
PARTITION BY DATE(timestamp)
CLUSTER BY
  customer_id
OPTIONS (
  partition_expiration_days=3,
  description="a table clustered by customer_id"
)
AS SELECT * FROM mydataset.myothertable'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

CREATE VIEW statement

To create a view in BigQuery, use the CREATE VIEW DDL statement.

Syntax

{CREATE VIEW | CREATE VIEW IF NOT EXISTS | CREATE OR REPLACE VIEW}
view_name
[OPTIONS(view_option_list)]
AS query_expression

Where:

{CREATE VIEW | CREATE VIEW IF NOT EXISTS | CREATE OR REPLACE VIEW} is one of the following statements:

• CREATE VIEW — creates a new view.
• CREATE VIEW IF NOT EXISTS — creates a new view only if the view does not currently exist in the specified dataset.
• CREATE OR REPLACE VIEW — creates a view and replaces an existing view with the same name in the specified dataset.

view_name is the name of the view you're creating. The view name must be unique per dataset. The view name can:

• Contain up to 1,024 characters
• Contain letters (upper or lower case), numbers, and underscores

view_option_list allows you to specify additional view creation options such as a label and an expiration time.

CREATE VIEW statements must comply with the following rules:

• Only one CREATE statement is allowed.

query_expression is the standard SQL query expression used to define the view.

view_option_list

The option list allows you to set view options such as a label and an expiration time. You can include multiple options using a comma-separated list.

Specify a view option list in the following format:

NAME=VALUE, ...

NAME and VALUE must be one of the following combinations:

NAME	VALUE	Details
expiration_timestamp	TIMESTAMP	Example: expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC" This property is equivalent to the expirationTime table resource property.
friendly_name	STRING	Example: friendly_name="my_view" This property is equivalent to the friendlyName table resource property.
description	STRING	Example: description="a view that expires in 2020" This property is equivalent to the description table resource property.
labels	ARRAY<STRUCT<STRING, STRING>>	Example: labels=[("org_unit", "development")] This property is equivalent to the labels table resource property.

VALUE is a constant expression containing only literals, query parameters, and scalar functions. If the constant expression evaluates to null, the corresponding option NAME is ignored.

The constant expression cannot contain:

• A reference to a table
• Subqueries or SQL statements such as SELECT, CREATE, and UPDATE
• User-defined functions, aggregate functions, or analytic functions
• The following scalar functions:
  • ARRAY_TO_STRING
  • REPLACE
  • REGEXP_REPLACE
  • RAND
  • FORMAT
  • LPAD
  • RPAD
  • REPEAT
  • SESSION_USER
  • GENERATE_ARRAY
  • GENERATE_DATE_ARRAY

Examples

Creating a new view

The CREATE VIEW DDL statement creates a view with the specified options. If the view name exists in the dataset, the following error is returned:

Already Exists: [PROJECT]:[DATASET].[VIEW]

The following example creates a view named newview in mydataset. When you use a DDL statement to create a view, you must specify the project, dataset, and view in the following format: `[PROJECT].[DATASET].[VIEW]` (including the backticks); for example, `myproject.mydataset.newview`.

The view is defined using the following standard SQL query:

SELECT column_1, column_2, column_3 FROM myproject.mydataset.mytable

The view option list specifies the:

• Expiration time — 48 hours from the time the view is created
• Friendly name — newview
• Description — a view that expires in 2 days
• Label — org_unit = development

To create a new view using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE VIEW `myproject.mydataset.newview`
    OPTIONS(
      expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
      friendly_name="newview",
      description="a view that expires in 2 days",
      labels=[("org_unit", "development")]
    )
    AS SELECT column_1, column_2, column_3 FROM myproject.mydataset.mytable
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE TABLE `myproject.mydataset.newview`
 OPTIONS(
   expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
   friendly_name="newview",
   description="a view that expires in 2 days",
   labels=[("org_unit", "development")]
 )
 AS SELECT column_1, column_2, column_3 FROM `myproject.mydataset.mytable`'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

JAVA

Call the BigQuery.create() method to start a query job. Call the Job.waitFor() method to wait for the DDL query to finish.

google-cloud-examples/src/test/java/com/google/cloud/examples/bigquery/snippets/ITCloudSnippets.java

View on GitHub Feedback

// import com.google.cloud.bigquery.*;
// String projectId = "my-project";
// String datasetId = "my_dataset";
// String tableId = "new_view";
// BigQuery bigquery = BigQueryOptions.getDefaultInstance().toBuilder()
//     .setProjectId(projectId)
//     .build().getService();

String sql =
    String.format(
        "CREATE VIEW `%s.%s.%s`\n"
            + "OPTIONS(\n"
            + "  expiration_timestamp=TIMESTAMP_ADD(\n"
            + "    CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),\n"
            + "  friendly_name=\"new_view\",\n"
            + "  description=\"a view that expires in 2 days\",\n"
            + "  labels=[(\"org_unit\", \"development\")]\n"
            + ")\n"
            + "AS SELECT name, state, year, number\n"
            + "  FROM `bigquery-public-data.usa_names.usa_1910_current`\n"
            + "  WHERE state LIKE 'W%%';\n",
        projectId, datasetId, tableId);

// Make an API request to run the query job.
Job job = bigquery.create(JobInfo.of(QueryJobConfiguration.newBuilder(sql).build()));

// Wait for the query to finish.
job = job.waitFor();

QueryJobConfiguration jobConfig = (QueryJobConfiguration) job.getConfiguration();
System.out.printf(
    "Created new view \"%s.%s.%s\".\n",
    jobConfig.getDestinationTable().getProject(),
    jobConfig.getDestinationTable().getDataset(),
    jobConfig.getDestinationTable().getTable());

PYTHON

Call the Client.query() method to start a query job. Call the QueryJob.result() method to wait for the DDL query to finish.

bigquery/docs/snippets.py

View on GitHub Feedback

# from google.cloud import bigquery
# project = 'my-project'
# dataset_id = 'my_dataset'
# table_id = 'new_view'
# client = bigquery.Client(project=project)

sql = """
CREATE VIEW `{}.{}.{}`
OPTIONS(
    expiration_timestamp=TIMESTAMP_ADD(
        CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
    friendly_name="new_view",
    description="a view that expires in 2 days",
    labels=[("org_unit", "development")]
)
AS SELECT name, state, year, number
    FROM `bigquery-public-data.usa_names.usa_1910_current`
    WHERE state LIKE 'W%'
""".format(project, dataset_id, table_id)

job = client.query(sql)  # API request.
job.result()  # Waits for the query to finish.

print('Created new view "{}.{}.{}".'.format(
    job.destination.project,
    job.destination.dataset_id,
    job.destination.table_id))

Creating a view only if the view doesn't exist

The CREATE VIEW IF NOT EXISTS DDL statement creates a view with the specified options only if the view name does not exist in the dataset. If the view name exists in the dataset, no error is returned, and no action is taken.

The following example creates a view named newview in mydataset only if no view named newview exists in mydataset. When you use a DDL statement to create a view, you must specify the project, dataset, and view in the following format: `[PROJECT].[DATASET].[VIEW]` (including the backticks); for example, `myproject.mydataset.newview`.

The view is defined using the following standard SQL query:

SELECT column_1, column_2, column_3 FROM myproject.mydataset.mytable

The view option list specifies the:

• Expiration time — 48 hours from the time the view is created
• Friendly name — newview
• Description — a view that expires in 2 days
• Label — org_unit = development

To create a new view using DDL only if the view name doesn't exist in the dataset:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE VIEW IF NOT EXISTS `myproject.mydataset.newview`
    OPTIONS(
      expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
      friendly_name="newview",
      description="a view that expires in 2 days",
      labels=[("org_unit", "development")]
    )
    AS SELECT column_1, column_2, column_3 FROM myproject.mydataset.mytable
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE VIEW IF NOT EXISTS `myproject.mydataset.newview`
 OPTIONS(
   expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
   friendly_name="newview",
   description="a view that expires in 2 days",
   labels=[("org_unit", "development")]
 )
 AS SELECT column_1, column_2, column_3 FROM `myproject.mydataset.mytable`'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Creating or replacing a view

The CREATE OR REPLACE VIEW DDL statement creates a view with the specified options. If the view name exists in the dataset, the view is overwritten using the specified query expression.

The following example creates a view named newview in mydataset, and if newview exists in mydataset, it is overwritten. When you use a DDL statement to create a view, you must specify the project, dataset, and view in the following format: `[PROJECT].[DATASET].[VIEW]` (including the backticks); for example, `myproject.mydataset.newview`.

The view is defined using the following standard SQL query:

    SELECT column_1, column_2, column_3 FROM `myproject.mydataset.mytable`

The view option list specifies the:

• Expiration time — 48 hours from the time the view is created
• Friendly name — newview
• Description — a view that expires in 2 days
• Label — org_unit = development

To create a new view using DDL and to overwrite a view with the same name:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    CREATE OR REPLACE VIEW `myproject.mydataset.newview`
    OPTIONS(
      expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
      friendly_name="newview",
      description="a view that expires in 2 days",
      labels=[("org_unit", "development")]
    )
    AS SELECT column_1, column_2, column_3 FROM myproject.mydataset.mytable
    

4. Click Run query. When the query completes, the table appears in the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
CREATE OR REPLACE VIEW `myproject.mydataset.newview`
 OPTIONS(
   expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),
   friendly_name="newview",
   description="a view that expires in 2 days",
   labels=[("org_unit", "development")]
 )
 AS SELECT column_1, column_2, column_3 FROM `myproject.mydataset.mytable`'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

ALTER TABLE SET OPTIONS statement

Beta

This is a beta release of BigQuery support for the ALTER TABLE SET OPTIONS statement. This feature might be changed in backward-incompatible ways and is not subject to any SLA or deprecation policy.

To set the options on a table in BigQuery, use the ALTER TABLE SET OPTIONS DDL statement.

Syntax

{ALTER TABLE | ALTER TABLE IF EXISTS}
table_name
SET OPTIONS(table_set_options_list)

Where:

{ALTER TABLE | ALTER TABLE IF EXISTS} is one of the following statements:

• ALTER TABLE — alters the options on an existing table.
• ALTER TABLE IF EXISTS — alters the options on a table only if it exists.

table_name is the name of the table you're altering.

table_set_options_list

The option list allows you to set table options such as a label and an expiration time. You can include multiple options using a comma-separated list.

Specify a table option list in the following format:

NAME=VALUE, ...

NAME and VALUE must be one of the following combinations:

NAME	VALUE	Details
expiration_timestamp	TIMESTAMP	Example: expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC" This property is equivalent to the expirationTime table resource property.
partition_expiration_days	FLOAT64	Example: partition_expiration_days=7 This property is equivalent to the timePartitioning.expirationMs table resource property but uses days instead of milliseconds. One day is equivalent to 86400000 milliseconds, or 24 hours. This property can only be set if the table is partitioned.
require_partition_filter	BOOL	Example: require_partition_filter=true This property is equivalent to the timePartitioning.requirePartitionFilter table resource property. This property can only be set if the table is partitioned.
kms_key_name	STRING	Example: kms_key_name="projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" This property is equivalent to the encryptionConfiguration.kmsKeyName table resource property. See more details about Protecting Data with Cloud KMS Keys.
friendly_name	STRING	Example: friendly_name="my_table" This property is equivalent to the friendlyName table resource property.
description	STRING	Example: description="a table that expires in 2020" This property is equivalent to the description table resource property.
labels	ARRAY<STRUCT<STRING, STRING>>	Example: labels=[("org_unit", "development")] This property is equivalent to the labels table resource property.

VALUE is a constant expression containing only literals, query parameters, and scalar functions. If the constant expression evaluates to null, the corresponding option NAME is ignored.

The constant expression cannot contain:

• A reference to a table
• Subqueries or SQL statements such as SELECT, CREATE, and UPDATE
• User-defined functions, aggregate functions, or analytic functions
• The following scalar functions:
  • ARRAY_TO_STRING
  • REPLACE
  • REGEXP_REPLACE
  • RAND
  • FORMAT
  • LPAD
  • RPAD
  • REPEAT
  • SESSION_USER
  • GENERATE_ARRAY
  • GENERATE_DATE_ARRAY

Setting the VALUE replaces the existing value of that option for the table, if there was one. Setting the VALUE to NULL clears the table's value for that option.

Examples

Setting the expiration timestamp and description on a table

The following example sets the expiration timestamp on a table to seven days from the execution time of the ALTER TABLE statement, and sets the description as well:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    ALTER TABLE mydataset.mytable
    SET OPTIONS (
      expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 7 DAY),
      description="Table that expires seven days from now"
    )
    

4. Click Run query. When the query completes, the property has been set on the table.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
ALTER TABLE mydataset.mytable
SET OPTIONS (
  expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 7 DAY),
  description="Table that expires seven days from now"
)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Setting the require partition filter attribute on a partitioned table

The following example sets the timePartitioning.requirePartitionFilter attribute on a partitioned table. When set to true, queries that reference this table must use a filter on the partitioning column, or else BigQuery will return an error. Setting this option to true can help prevent mistakes in querying more data than intended:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    ALTER TABLE mydataset.mypartitionedtable
    SET OPTIONS (require_partition_filter=true)
    

4. Click Run query. When the query completes, the property has been set on the table.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
ALTER TABLE mydataset.mypartitionedtable
SET OPTIONS (require_partition_filter=true)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Clearing the expiration timestamp on a table

The following example clears the expiration timestamp on a table so that it will not expire:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    ALTER TABLE mydataset.mytable
    SET OPTIONS (expiration_timestamp=NULL)
    

4. Click Run query. When the query completes, the table no longer has an expiration time.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
ALTER TABLE mydataset.mytable
SET OPTIONS (expiration_timestamp=NULL)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

ALTER VIEW SET OPTIONS statement

Beta

This is a beta release of BigQuery support for the ALTER VIEW SET OPTIONS statement. This feature might be changed in backward-incompatible ways and is not subject to any SLA or deprecation policy.

To set the options on a view in BigQuery, use the ALTER VIEW SET OPTIONS DDL statement.

Syntax

{ALTER VIEW | ALTER VIEW IF EXISTS}
view_name
SET OPTIONS(view_set_options_list)

Where:

{ALTER VIEW | ALTER VIEW IF EXISTS} is one of the following statements:

• ALTER VIEW — alters the options on an existing view.
• ALTER VIEW IF EXISTS — alters the options on a view only if it exists.

view_name is the name of the view you're altering.

view_set_options_list

The option list allows you to set view options such as a label and an expiration time. You can include multiple options using a comma-separated list.

Specify a view option list in the following format:

NAME=VALUE, ...

NAME and VALUE must be one of the following combinations:

NAME	VALUE	Details
expiration_timestamp	TIMESTAMP	Example: expiration_timestamp=TIMESTAMP "2020-01-01 00:00:00 UTC" This property is equivalent to the expirationTime table resource property.
friendly_name	STRING	Example: friendly_name="my_view" This property is equivalent to the friendlyName table resource property.
description	STRING	Example: description="a view that expires in 2020" This property is equivalent to the description table resource property.
labels	ARRAY<STRUCT<STRING, STRING>>	Example: labels=[("org_unit", "development")] This property is equivalent to the labels table resource property.

VALUE is a constant expression containing only literals, query parameters, and scalar functions. If the constant expression evaluates to null, the corresponding option NAME is ignored.

The constant expression cannot contain:

• A reference to a table
• Subqueries or SQL statements such as SELECT, CREATE, and UPDATE
• User-defined functions, aggregate functions, or analytic functions
• The following scalar functions:
  • ARRAY_TO_STRING
  • REPLACE
  • REGEXP_REPLACE
  • RAND
  • FORMAT
  • LPAD
  • RPAD
  • REPEAT
  • SESSION_USER
  • GENERATE_ARRAY
  • GENERATE_DATE_ARRAY

Setting the VALUE replaces the existing value of that option for the view, if there was one. Setting the VALUE to NULL clears the view's value for that option.

Examples

Setting the expiration timestamp and description on a view

The following example sets the expiration timestamp on a view to seven days from the execution time of the ALTER VIEW statement, and sets the description as well:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    ALTER VIEW mydataset.myview
    SET OPTIONS (
      expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 7 DAY),
      description="View that expires seven days from now"
    )
    

4. Click Run query. When the query completes, the property has been set on the view.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
ALTER VIEW mydataset.myview
SET OPTIONS (
  expiration_timestamp=TIMESTAMP_ADD(CURRENT_TIMESTAMP(), INTERVAL 7 DAY),
  description="View that expires seven days from now"
)'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

DROP TABLE statement

To delete a table in BigQuery, use the DROP TABLE DDL statement.

Syntax

{DROP TABLE | DROP TABLE IF EXISTS}
table_name

Where:

{DROP TABLE | DROP TABLE IF EXISTS} is one of the following statements:

• DROP TABLE — deletes a table in the specified dataset
• DROP TABLE IF EXISTS — deletes a table only if the table exists in the specified dataset

table_name is the name of the table you're deleting.

Examples

Deleting a table

The DROP TABLE DDL statement deletes a table in the specified dataset. If the table name does not exist in the dataset, the following error is returned:

Error: Not found: Table myproject:mydataset.mytable

If you are deleting a table in another project, you must specify the project, dataset, and table in the following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.mytable`.

To delete a table using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    DROP TABLE mydataset.mytable
    

4. Click Run query. When the query completes, the table is removed from the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
DROP TABLE mydataset.mytable'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Deleting a table only if the table exists

The DROP TABLE IF EXISTS DDL statement deletes a table in the specified dataset only if the table exists. If the table name does not exist in the dataset, no error is returned, and no action is taken.

If you are deleting a table in another project, you must specify the project, dataset, and table in the following format: `[PROJECT].[DATASET].[TABLE]` (including the backticks); for example, `myproject.mydataset.mytable`.

To delete a table using DDL only if the table exists:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    DROP TABLE IF EXISTS mydataset.mytable
    

4. Click Run query. When the query completes, the table is removed from the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
DROP TABLE IF EXISTS mydataset.mytable'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

DROP VIEW statement

To delete a view in BigQuery, use the DROP VIEW DDL statement.

Syntax

{DROP VIEW | DROP VIEW IF EXISTS}
view_name

Where:

{DROP VIEW | DROP VIEW IF EXISTS} is one of the following statements:

• DROP VIEW — deletes a view in the specified dataset
• DROP VIEW IF EXISTS — deletes a view only if the view exists in the specified dataset

view_name is the name of the view you're deleting.

Examples

Deleting a view

The DROP VIEW DDL statement deletes a view in the specified dataset. If the view name does not exist in the dataset, the following error is returned:

Error: Not found: Table myproject:mydataset.myview

If you are deleting a view in another project, you must specify the project, dataset, and view in the following format: `[PROJECT].[DATASET].[VIEW]` (including the backticks); for example, `myproject.mydataset.myview`.

To delete a view using DDL:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    DROP VIEW mydataset.myview
    

4. Click Run query. When the query completes, the view is removed from the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
DROP VIEW mydataset.myview'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Deleting a view only if the view exists

The DROP VIEW IF EXISTS DDL statement deletes a view in the specified dataset only if the view exists. If the view name does not exist in the dataset, no error is returned, and no action is taken.

If you are deleting a view in another project, you must specify the project, dataset, and view in the following format: `[PROJECT].[DATASET].[VIEW]` (including the backticks); for example, `myproject.mydataset.myview`.

To delete a view using DDL only if the view exists:

Web UI

1. Go to the BigQuery web UI.

   Go to the BigQuery web UI

2. Click Compose query.

3. Type your DDL statement into the New Query text area.

    #standardSQL
    DROP VIEW IF EXISTS mydataset.myview
    

4. Click Run query. When the query completes, the table is removed from the navigation pane.

Command-line

Enter the bq query command and supply the DDL statement as the query parameter.

bq query --use_legacy_sql=false '
DROP VIEW IF EXISTS mydataset.myview'

API

Call the jobs.query method and supply the DDL statement in the request body's query property.

DDL functionality extends the information returned by a Jobs resource. statistics.query.statementType includes the following additional values for DDL support:

• CREATE_TABLE
• CREATE_TABLE_AS_SELECT
• DROP_TABLE
• CREATE_VIEW
• DROP_VIEW

statistics.query has 2 additional fields:

• ddlOperationPerformed: The DDL operation performed, possibly dependent on the existence of the DDL target. Current values include:
  • CREATE: The query created the DDL target.
  • SKIP: No-op. Examples — CREATE TABLE IF NOT EXISTS was submitted, and the table exists. Or DROP TABLE IF EXISTS was submitted, and the table does not exist.
  • REPLACE: The query replaced the DDL target. Example — CREATE OR REPLACE TABLE was submitted, and the table already exists.
  • DROP: The query deleted the DDL target.
• ddlTargetTable: When you submit a CREATE TABLE/VIEW statement or a DROP TABLE/VIEW statement, the target table is returned as an object with 3 fields:
• "projectId": string
• "datasetId": string
• "tableId": string

Features under development

The following features are being developed but are not currently available in the beta release:

• Automatically updating the table list in the BigQuery web UI after using a DROP TABLE DDL statement