保存したクエリの作成と管理

このページでは、保存済みクエリを作成して管理する方法について説明します。Firestore Studio でクエリを記述すると、それらのクエリを保存して管理できます。詳細については、保存済みクエリの概要をご覧ください。

保存済みクエリ機能は、 Google Cloud コンソールでのみ使用できます。

必要なロール

保存済みクエリの使用に必要な権限を取得するには、プロジェクトに対する次の Identity and Access Management（IAM）ロールを付与するよう管理者に依頼してください。

  • 保存済みクエリを表示する: Cloud Datastore 閲覧者（roles/datastore.viewer）
  • 保存済みクエリを表示、作成、変更、削除するには: Cloud Datastore ユーザー（roles/datastore.user）
  • 保存済みクエリの管理、表示、作成、変更、削除を行うには: Cloud Datastore オーナー（roles/datastore.owner）。このロールには広範な権限があり、MongoDB 互換の Firestore へのフルアクセスを提供します。管理者が使用する場合にのみ使用できます。

ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

これらの事前定義ロールには、保存済みクエリの使用に必要な権限が含まれています。必要な権限の詳細については、必要な権限をご覧ください。

必要な権限

保存済みクエリを作成、表示、変更、削除するには、プロジェクト レベルで次の IAM 権限が必要です。

操作 必要な IAM 権限
保存したクエリを作成する
  • databasesconsole.studioQueries.create
保存したクエリを表示する
  • databasesconsole.studioQueries.search
  • databasesconsole.locations.get
  • databasesconsole.locations.list
保存済みクエリを変更する
  • databasesconsole.studioQueries.update
保存したクエリを削除
  • databasesconsole.studioQueries.delete
保存済みクエリを管理する
（管理者のみが使用）
  • databasesConsole.studioQueries.list
  • databasesconsole.locations.list

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

Studio クエリユーザー（roles/databasesconsole.studioQueryUser）ロールには、保存済みクエリの作成、表示、書き込みのアクセス権が含まれます。このロールは、ほとんどのユーザーのニーズを満たします。

Studio クエリ管理者（roles/databasesconsole.studioQueryAdmin）ロールは、管理者にのみ付与します。MongoDB 互換の Firestore の IAM の詳細については、Identity and Access Management をご覧ください。

保存済みクエリを作成する

保存済みクエリを作成する手順は次のとおりです。

  1. Google Cloud コンソールの [すべてのデータベース] ページに移動します。
    すべてのデータベース
  2. 保存済みクエリを作成する MongoDB 互換の Firestore データベースを選択します。
  3. ナビゲーション メニューで [Firestore Studio] をクリックします。
  4. Firestore Studio ページの [エクスプローラ] ペインで、[コレクション] セクションに移動します。
  5. コレクションをクリックして、新しいエディタタブを開きます。必要に応じて、コレクションの横にある [ アクションを表示] をクリックします。次に、[クエリ コレクション] をクリックして、新しいエディタタブを開きます。
  6. クエリエディタでクエリを入力します。
  7. [保存] をクリックします。
  8. [クエリを保存] ダイアログで、保存済みクエリの名前を入力します。
  9. [保存] をクリックします。

保存済みクエリを開いて実行する

保存済みクエリを新しいクエリとして開く手順は次のとおりです。

  1. [Firestore Studio] ページの [エクスプローラ] ペインで、[クエリ] セクションに移動します。
  2. 保存済みクエリをクリックして、新しいエディタタブで開きます。必要に応じて、保存済みクエリの横にある [ アクションを表示] をクリックします。[クエリを開く] をクリックして、新しいエディタタブでクエリを開きます。
  3. [実行] をクリックします。

保存済みクエリを更新する

既存の保存済みクエリを更新する手順は次のとおりです。

  1. [Firestore Studio] ページの [エクスプローラ] ペインで、[クエリ] セクションに移動します。
  2. 保存済みクエリをクリックして、新しいエディタタブで開きます。必要に応じて、保存済みクエリの横にある [ アクションを表示] をクリックします。[クエリを開く] をクリックして、新しいエディタタブでクエリを開きます。
  3. クエリを変更します。
  4. 変更済みクエリを保存するには、[保存] をクリックします。

すべての保存済みクエリのリストを表示、管理する

プロジェクトに保存されているすべてのクエリのリストを表示するには、次の操作を行います。

  1. Google Cloud コンソールの [すべてのデータベース] ページに移動します。
    すべてのデータベース
  2. 任意のデータベースを選択します。保存済みクエリはプロジェクトの子であるため、必要なロールが付与されていれば、任意のデータベースからプロジェクト内のすべての保存済みクエリを表示できます。
  1. 任意のデータベースを選択します。
  2. [Firestore Studio] ページの [エクスプローラ] ペインで、[クエリ] セクションに移動します。
  3. 保存済みクエリの横にある [ アクションを表示] をクリックします。[クエリを管理する] をクリックします。

    [保存済みクエリ] ページが開きます。このページには、このプロジェクト内のすべての保存済みクエリ（他の Google Cloud プロダクトの保存済みクエリを含む）が一覧表示されます。

クエリの検索、フィルタ、表示、削除は、[保存済みクエリ] ページで行えます。[保存済みクエリ] ページで既存のクエリを編集することはできません。

保存済みクエリを削除する

保存済みクエリは、Firestore Studio ページまたは Google Cloud コンソールの [保存済みクエリ] ページで削除できます。

  1. [Firestore Studio] ページの [エクスプローラ] ペインで、[クエリ] セクションに移動します。
  2. 削除する保存済みクエリの横にある [ アクションを表示] をクリックします。[クエリを削除] をクリックして、保存済みクエリを削除します。
  3. [クエリを削除] ダイアログで、[削除] をクリックします。

[保存したクエリ] ページで保存済みクエリを削除することもできます。[保存したクエリ] ページで保存済みクエリを削除する手順は次のとおりです。

  1. [保存したクエリ] ページに移動します。
  2. 削除する保存済みクエリの横にある [ アクションを表示] をクリックします。
  3. [クエリを削除] をクリックして、保存済みクエリを削除します。
  4. [クエリを削除] ダイアログで、[削除] をクリックします。

次のステップ