VECTOR_INDEX_COLUMNS view

TheINFORMATION_SCHEMA.VECTOR_INDEX_COLUMNS view contains one row for eachvector-indexed column on each table in a dataset.

Required permissions

To seevector index metadata, you need thebigquery.tables.get orbigquery.tables.list Identity and Access Management (IAM)permission on the table with the index. Each of the following predefinedIAM roles includes at least one of these permissions:

• roles/bigquery.admin
• roles/bigquery.dataEditor
• roles/bigquery.dataOwner
• roles/bigquery.dataViewer
• roles/bigquery.metadataViewer
• roles/bigquery.user

For more information about BigQuery permissions, seeAccess control with IAM.

Schema

TheINFORMATION_SCHEMA.VECTOR_INDEX_COLUMNS view has the following schema:

For stability, we recommend that you explicitly list columns in your information schema queries instead ofusing a wildcard (SELECT *). Explicitly listing columns prevents queries frombreaking if the underlying schema changes.

Scope and syntax

Queries against this view must have adataset qualifier. Thefollowing table explains the region scope for this view:

• Optional:PROJECT_ID: the ID of your Google Cloud project. If not specified, the default project is used.
• DATASET_ID: the ID of your dataset. For more information, seeDataset qualifier.

  Note: You must usea region qualifier to queryINFORMATION_SCHEMA views. The location of the query execution must match the region of theINFORMATION_SCHEMA view.

Example

-- Returns metadata for vector indexes in a single dataset.SELECT*FROMmyDataset.INFORMATION_SCHEMA.VECTOR_INDEX_COLUMNS;

Examples

The following query extracts information on columns that have vector indexes:

SELECTtable_name,index_name,index_column_name,index_field_pathFROMmy_project.dataset.INFORMATION_SCHEMA.VECTOR_INDEX_COLUMNS;

The result is similar to the following:

+------------+------------+-------------------+------------------+| table_name | index_name | index_column_name | index_field_path |+------------+------------+-------------------+------------------+| table1     | indexa     | embeddings        | embeddings       || table2     | indexb     | vectors           | vectors          || table3     | indexc     | vectors           | vectors          |+------------+------------+-------------------+------------------+