VECTOR_INDEX_OPTIONS 视图

对于数据集中每个表的每个矢量索引列,INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS 视图都会包含一个与之相对应的行。

所需权限

如需查看矢量索引元数据,您需要对具有相应索引的表拥有 bigquery.tables.getbigquery.tables.list Identity and Access Management (IAM) 权限。以下每个预定义的 IAM 角色都至少包含以下权限之一:

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

如需详细了解 BigQuery 权限,请参阅使用 IAM 进行访问权限控制

架构

当您查询 INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS 视图时,数据集中的每个表上每个索引都会有一行对应的查询结果。

INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS 视图具有如下架构:

列名 数据类型
index_catalog STRING 包含数据集的项目的名称。
index_schema STRING 包含矢量索引的数据集的名称。
table_name STRING 在其中创建矢量索引的表的名称。
index_name STRING 矢量索引的名称。
option_name STRING 数据定义语言语句 (DDL) 中用于创建矢量索引的选项的名称。
option_type STRING 选项数据类型。
option_value STRING 选项值。

范围和语法

针对此视图的查询必须具有数据集限定符。下表说明了此视图的区域范围:

视图名称 资源范围 区域范围
[PROJECT_ID.]DATASET_ID.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS 数据集级 数据集位置

请替换以下内容:

  • 可选:PROJECT_ID:您的 Google Cloud 项目的 ID。如果未指定,则使用默认项目。

    • DATASET_ID:您的数据集的 ID。如需了解详情,请参阅数据集限定符

    示例

    -- Returns metadata for vector indexes in a single dataset.
    SELECT * FROM myDataset.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS;
    

    示例

    以下查询会提取矢量索引选项的相关信息:

    SELECT table_name, index_name, option_name, option_type, option_value
    FROM my_project.dataset.INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS;

    结果类似于以下内容:

    +------------+------------+------------------+------------------+-------------------------------------------------------------------+
    | 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"} |
    +------------+------------+------------------+------------------+-------------------------------------------------------------------+