AI_INDEX_COLUMNS view
The INFORMATION_SCHEMA.AI_INDEX_COLUMNS view contains one row for each
AI-indexed column on each table in a dataset.
Required permissions
To view AI index metadata, you need the bigquery.tables.get or
bigquery.tables.list Identity and Access Management (IAM) permission on the table
with the index. Each of the following predefined
IAM roles includes at least one of these permissions:
roles/bigquery.adminroles/bigquery.dataEditorroles/bigquery.dataOwnerroles/bigquery.dataViewerroles/bigquery.metadataViewerroles/bigquery.user
For more information about BigQuery permissions, see Access control with IAM.
Schema
When you query the INFORMATION_SCHEMA.AI_INDEX_COLUMNS view, the query
results contain one row for each indexed column on each table in a dataset.
The INFORMATION_SCHEMA.AI_INDEX_COLUMNS view has the following schema:
| Column name | Data type | Value |
|---|---|---|
index_catalog |
STRING |
The name of the project that contains the dataset. |
index_schema |
STRING |
The name of the dataset that contains the AI index. |
table_name |
STRING |
The name of the table that the AI index is created on. |
index_name |
STRING |
The name of the AI index. |
index_column_name |
STRING |
The name of an AI-indexed column. For AI indexes created with
AUTO COLUMNS, this view lists every column that was
selected. |
Scope and syntax
Queries against this view must have a dataset qualifier. The following table explains the region scope for this view:
| View Name | Resource scope | Region scope |
|---|---|---|
[PROJECT_ID.]DATASET_ID.INFORMATION_SCHEMA.AI_INDEX_COLUMNS |
Dataset level | Dataset location |
Replace the following:
PROJECT_ID: the ID of your Google Cloud project.DATASET_ID: the ID of your dataset.
Example
The following query lists the indexed columns for AI indexes in
my_project.my_dataset:
SELECT table_name, index_name, index_column_name FROM my_project.my_dataset.INFORMATION_SCHEMA.AI_INDEX_COLUMNS;
The result is similar to the following:
+------------+-------------------+-------------------+
| table_name | index_name | index_column_name |
+------------+-------------------+-------------------+
| products | products_ai_index | name |
| products | products_ai_index | description |
| products | products_ai_index | category |
| products | products_ai_index | review |
+------------+-------------------+-------------------+