Spanner Studio でコンテキスト セットを管理する

コンテキスト エンジニアリング エージェントを使用すると、CLI からコンテキスト セットを自動的に作成してアップロードできます。このドキュメントでは、 Google Cloud コンソールでコンテキスト セット ファイルを管理するためのビジュアル インターフェースが必要な場合に、Spanner Studio でコンテキスト セットを作成、編集、削除する方法について説明します。Spanner Studio でコンテキスト セットを作成すると、Spanner Studio は選択したリージョンのプロジェクトの default コンテキスト セット グループに保存し、現在のデータベースにリンクします。コンテキスト セット名(および派生したコンテキスト セット ID)は、特定のリージョンのプロジェクトの default コンテキスト セット グループ内で、すべてのデータベースとインスタンスにわたって一意である必要があります。Spanner Studio で、派生 ID がすでに存在する名前のコンテキスト セットを作成すると、検証に失敗します。データベースの関連付けを維持しながらコンテンツを上書きするには、既存のコンテキスト セットを編集します。コンテキスト エンジニアリング エージェントまたは Dataplex API を使用して、既存のコンテキスト セット ID で直接アップロードすると、そのコンテンツと、指定されている場合はデータベースの関連付けが置き換えられます。

Spanner Studio の [コンテキスト セット] リストには、現在のデータベースにリンクされている、サポートされているすべてのリージョンの default コンテキスト セット グループ内のコンテキスト セットのみが表示されます。別のデータベース用に作成されたコンテキスト セット、または databases(またはカスタム コンテキスト セット グループ)でデータベース リソースをリンクせずに API を介して作成されたコンテキスト セットは、Spanner Studio のリストに表示されません。

コンテキスト セットの詳細については、コンテキスト セットの概要をご覧ください。

始める前に

コンテキスト セットを作成またはアップロードする前に、次の前提条件を満たす必要があります。

コンテキスト セットは、us-central1、us-east1、europe-west4、asia-southeast1 の各リージョンで作成できます。

必要なサービスを有効にする

プロジェクトで次のサービスを有効にします。

Spanner インスタンスを準備する

必要なロールと権限

  • IAM ユーザーまたはサービス アカウントをインスタンスに追加します。詳細については、IAM ロールを適用するをご覧ください。
  • プロジェクト レベルで IAM ユーザーに roles/spanner.databaseReader、roles/serviceusage.serviceUsageConsumer、roles/geminidataanalytics.queryDataUser のロールを付与します。詳細については、プロジェクトの IAM ポリシー バインディングを追加するをご覧ください。
  • コンテキスト セットを作成、アップロード、管理するには、プロジェクト レベルで IAM ユーザーに Dataplex Catalog 編集者(roles/dataplex.catalogEditor)または Dataplex Catalog 管理者(roles/dataplex.catalogAdmin)のロールを付与します。詳細については、コンテキスト セットの権限をご覧ください。
  • 必要なデータベースに対して、プロジェクト レベルで IAM ユーザーにロールと権限を付与します。

コンテキスト セットを作成する

コンテキスト セットを作成する手順は次のとおりです。

  1. Google Cloud コンソールで、[Spanner] ページに移動します。

    Spanner に移動

  2. リストからインスタンスを選択し、データベースを選択します。

  3. ナビゲーション メニューで [Spanner Studio] をクリックします。

  4. [エクスプローラ] ペインで、[コンテキスト セット] の横にある [アクションを表示] をクリックします。

  5. [コンテキスト セットを作成] をクリックします。

  6. [コンテキスト セット名] に、一意のコンテキスト セット名を入力します。Spanner Studio では、名前は 4 ~ 30 文字で、先頭に空白文字を使用することはできません。Studio は、名前を小文字に変換し、英数字以外の文字をハイフン(-)に置き換えることで、コンテキスト セット ID を導出します。導出されたコンテキスト セット ID は、選択したリージョンのプロジェクトの default コンテキスト セット グループ内で一意である必要があります。たとえば、コンテキスト セット名 querydata_e2e_test のコンテキスト セット ID は querydata-e2e-test です。コンテキスト エンジニアリング エージェントまたは Dataplex API を使用してコンテキスト セットを直接アップロードする場合、コンテキスト セット ID は大文字と小文字が区別され、スラッシュ(/)を含めることはできません。また、4 ~ 30 文字、英数字、ハイフン、アンダースコアに制限されません。

  7. 省略可。[コンテキスト セットの説明] に、コンテキスト セットの説明を追加します。

  8. 省略可。コンテキスト セット ファイルをアップロードするには、[コンテキスト セット ファイルのアップロード] セクションで [参照] をクリックし、コンテキスト セット ファイルを選択します。

  9. 省略可。コンテキスト セットのリージョンを選択するには、[詳細オプションを表示] をクリックし、[ロケーションを選択] でリージョンを選択します(作成ごとにデフォルトで us-east1 に設定されます)。us-east1 以外のリージョンを選択する場合は、コンテキスト セット名を入力する前にリージョンを選択します。これにより、Spanner Studio はそのリージョンで名前の一意性を検証します。

  10. [作成] をクリックします。

コンテキスト セットを構築する

Studio で空のコンテキスト セットを作成した場合や、既存のコンテキスト セットを更新する場合は、コンテキスト エンジニアリング エージェントを使用してコンテキスト セットを構築して最適化するの手順に沿って、コンテキスト セット ファイルを生成して最適化します。コンテキスト エンジニアリング エージェントは、CLI からコンテキスト セットを直接作成してアップロードできます。また、Studio でコンテキスト セットを編集して、コンテキスト セット ファイルを手動でアップロードすることもできます。

コンテキスト セットを編集する

コンテキスト セットを編集する手順は次のとおりです。

  1. Google Cloud コンソールで、[Spanner] ページに移動します。

    Spanner に移動

  2. リストからインスタンスを選択し、データベースを選択します。

  3. ナビゲーション メニューで [Spanner Studio] をクリックします。

  4. 編集するコンテキスト セットの横にある [アクションを表示] をクリックします。

  5. [コンテキスト セットを編集] をクリックします。

  6. 省略可。[コンテキスト セットの説明] を編集します。

  7. [コンテキスト セット ファイルのアップロード] セクションで [参照] をクリックし、コンテキスト セット ファイルを選択します。

  8. [保存] をクリックします。

コンテキスト セットを削除する

コンテキスト セットを削除する手順は次のとおりです。

  1. Google Cloud コンソールで、[Spanner] ページに移動します。

    Spanner に移動

  2. リストからインスタンスを選択し、データベースを選択します。

  3. ナビゲーション メニューで [Spanner Studio] をクリックします。

  4. 削除するコンテキスト セットの横にある [アクションを表示] をクリックします。

  5. [コンテキスト セットを削除] をクリックします。

  6. [コンテキスト セットを削除しますか?] 確認ダイアログで、コンテキスト セットの ID を入力します。

  7. [確認] をクリックして、コンテキスト セットを削除します。

次のステップ