VECTOR_INDEX_OPTIONS ビュー
この機能に関するフィードバックやサポートのリクエストを行う場合は、bq-vector-search@google.com 宛てにメールを送信してください。
INFORMATION_SCHEMA.VECTOR_INDEX_OPTIONS
ビューには、データセット内の各テーブルのベクトル インデックス列ごとに 1 行が表示されます。
必要な権限
ベクトル インデックスのメタデータを表示するには、インデックスを含むテーブルに対する bigquery.tables.get
または bigquery.tables.list
の Identity and Access Management(IAM)権限が必要です。次に示す事前定義された各 IAM ロールには、これらのうち少なくとも 1 つの権限が含まれています。
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
ビューにクエリを実行すると、クエリ結果として、データセット内の各テーブルのインデックスごとに 1 行が表示されます。
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 | distance_type | STRING | EUCLIDEAN | | table1 | indexa | index_type | STRING | IVF | | table2 | indexb | ivf_options | STRING | {"num_lists": 100} | | table2 | indexb | index_type | STRING | IVF | +------------+------------+------------------+------------------+--------------------+