EFFECTIVE_PROJECT_OPTIONS view

You can query the INFORMATION_SCHEMA.EFFECTIVE_PROJECT_OPTIONS view to retrieve real-time metadata about BigQuery effective project options. This view contains default settings at the organization or project levels.

Required permissions

To get effective project options metadata, you need the bigquery.config.get Identity and Access Management (IAM) permission.

The following predefined IAM role includes the permissions that you need in order to get effective project options metadata:

roles/bigquery.jobUser

For more information about granular BigQuery permissions, see roles and permissions.

Schema

When you query the INFORMATION_SCHEMA.EFFECTIVE_PROJECT_OPTIONS view, the query results contain one row for each configuration in a project.

The INFORMATION_SCHEMA.EFFECTIVE_PROJECT_OPTIONS view has the following schema:

Column name	Data type	Value
`OPTION_NAME`	`STRING`	Option ID for the specified configuration setting.
`OPTION_DESCRIPTION`	`STRING`	The option description.
`OPTION_TYPE`	`STRING`	The data type of the `OPTION_VALUE`.
`OPTION_SET_LEVEL`	`STRING`	The level in the hierarchy at which the setting is defined, with possible values of `DEFAULT`, `ORGANIZATION`, or `PROJECTS`.
`OPTION_SET_ON_ID`	`STRING`	Set value based on value of `OPTION_SET_LEVEL`: If `DEFAULT`, set to `null`. If `ORGANIZATION`, set to `""`. If `PROJECT`, set to `ID`.
`OPTION_VALUE`	`STRING`	The current value of the option.

Options table

`OPTION_NAME`	`OPTION_TYPE`	`OPTION_VALUE`
`default_time_zone`	`STRING`	The effective default time zone for this project.
`default_kms_key_name`	`STRING`	The effective default key name for this project.
`default_query_job_timeout_ms`	`INT64`	The effective default query timeout in milliseconds for this project.
`default_interactive_query_queue_timeout_ms`	`STRING`	The effective default timeout in milliseconds for queued interactive queries for this project.
`default_batch_query_queue_timeout_ms`	`STRING`	The effective default timeout in milliseconds for queued batch queries for this project.

Data retention

This view contains currently running sessions and the history of sessions completed in the past 180 days.

Scope and syntax

Queries against this view must have a region qualifier.

View name	Resource scope	Region scope
`region-REGION`.INFORMATION_SCHEMA.EFFECTIVE_PROJECT_OPTIONS	Configuration options within the specified project.	`REGION`

Replace the following:

REGION: any dataset region name. For example, region-us.

Examples

The following example retrieves the OPTION_NAME, OPTION_TYPE, OPTION_VALUE, OPTION_SET_LEVEL, and OPTION_SET_ON_ID columns from the INFORMATION_SCHEMA.EFFECTIVE_PROJECT_OPTIONS view.

SELECT
  option_name, option_type, option_value, option_set_level, option_set_on_id
FROM
  `region-REGION`.INFORMATION_SCHEMA.EFFECTIVE_PROJECT_OPTIONS;

The result is similar to the following:

  +--------------------------------------------+-------------+---------------------+------------------+--------------------+
  | option_name                                | option_type | option_value        | option_set_level | option_set_on_id   |
  +--------------------------------------------+-------------+---------------------+------------------+--------------------+
  | default_time_zone                          | STRING      | America/Los_Angeles | organizations    | my_organization_id |
  +--------------------------------------------+-------------+---------------------+------------------+--------------------+
  | default_kms_key_name                       | STRING      | test/testkey1       | projects         | my_project_id      |
  +--------------------------------------------+-------------+---------------------+------------------+--------------------+
  | default_query_job_timeout_ms               | INT64       | 18000000            | projects         | my_project_id      |
  +--------------------------------------------+-------------+---------------------+------------------+--------------------+
  | default_interactive_query_queue_timeout_ms | INT64       | 600000              | organization     | my_organization_id |
  +--------------------------------------------+-------------+---------------------+------------------+--------------------+
  | default_batch_query_queue_timeout_ms       | INT64       | 1200000             | projects         | my_project_id      |
  +--------------------------------------------+-------------+---------------------+------------------+--------------------+