VECTOR_INDEX_OPTIONS view

TheINFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS view contains one row for each vector index option 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

When you query theINFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS view, the query results contain one row for each vector index option in a dataset

TheINFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS view has the following schema:

Column nameData typeValue
index_catalogSTRINGThe name of the project that contains the dataset.
index_schemaSTRINGThe name of the dataset that contains the vector index.
table_nameSTRINGThe name of the table that the vector index is created on.
index_nameSTRINGThe name of the vector index.
option_nameSTRINGThe name of the option used in the data definition language statement (DDL) to create the vector index.
option_typeSTRINGThe option data type.
option_valueSTRINGThe option value.

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:

View NameResource scopeRegion scope
[PROJECT_ID.]DATASET_ID.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONSDataset levelDataset location

Replace the following:
  • 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_OPTIONS;

Examples

The following query extracts information on vector index options:

SELECTtable_name,index_name,option_name,option_type,option_valueFROMmy_project.dataset.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS;

The result is similar to the following:

+------------+------------+------------------+------------------+-------------------------------------------------------------------+| table_name | index_name | option_name      | option_type      | option_value                                                      |+------------+------------+------------------+------------------+-------------------------------------------------------------------+| table1     | indexa     | index_type       | STRING           | IVF                                                               || table1     | indexa     | distance_type    | STRING           | EUCLIDEAN                                                         || table1     | indexa     | ivf_options      | STRING           | {"num_lists": 100}                                                || table2     | indexb     | index_type       | STRING           | IVF                                                               || table2     | indexb     | distance_type    | STRING           | COSINE                                                            || table2     | indexb     | ivf_options      | STRING           | {"num_lists": 500}                                                || table3     | indexc     | index_type       | STRING           | TREE_AH                                                           || table3     | indexc     | distance_type    | STRING           | DOT_PRODUCT                                                       || table3     | indexc     | tree_ah_options  | STRING           | {"leaf_node_embedding_count": 1000, "normalization_type": "NONE"} |+------------+------------+------------------+------------------+-------------------------------------------------------------------+

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.