Method: projects.databases.documents.runQuery

クエリを実行します。

HTTPリクエスト

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

必須。親リソースの名前。形式は、 projects/{projectId}/databases/{databaseId}/documentsまたはprojects/{projectId}/databases/{databaseId}/documents/{document_path} 。例: projects/my-project/databases/my-database/documentsまたはprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom

リクエストボディ

リクエスト本文には、次の構造のデータが含まれます。

JSON表現
{

  // Union field query_type can be only one of the following:
  "structuredQuery": {
    object (StructuredQuery)
  }
  // End of list of possible types for union field query_type.

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
田畑
ユニオンフィールドquery_type 。実行するクエリ。 query_type次のいずれか 1 つだけです。
structuredQuery

object ( StructuredQuery )

構造化されたクエリ。

ユニオンフィールドのconsistency_selector 。このトランザクションの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector次のいずれか 1 つだけです。
transaction

string ( bytes format)

すでにアクティブなトランザクション内でクエリを実行します。

ここでの値は、クエリを実行する不透明なトランザクション ID です。

Base64 でエンコードされた文字列。

newTransaction

object ( TransactionOptions )

新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトでは読み取り専用トランザクションになります。新しいトランザクション ID は、ストリームの最初の応答として返されます。

readTime

string ( Timestamp format)

指定された時点でのドキュメントを読み取ります。

これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

レスポンスボディ

Firestore.RunQueryの応答。

成功した場合、応答本文には次の構造のデータが含まれます。

JSON表現
{
  "transaction": string,
  "document": {
    object (Document)
  },
  "readTime": string,
  "skippedResults": integer,

  // Union field continuation_selector can be only one of the following:
  "done": boolean
  // End of list of possible types for union field continuation_selector.
}
田畑
transaction

string ( bytes format)

このリクエストの一部として開始されたトランザクション。最初の応答でのみ設定でき、リクエストでRunQueryRequest.new_transaction設定されている場合にのみ設定できます。設定した場合、この応答には他のフィールドは設定されません。

Base64 でエンコードされた文字列。

document

object ( Document )

クエリ結果。部分的な進行状況を報告する場合は設定されません。

readTime

string ( Timestamp format)

文書が読まれた時刻。これは単調増加する可能性があります。この場合、結果ストリーム内の以前のドキュメントは、 readTimeと今回のドキュメントの間で変更されていないことが保証されます。

クエリが結果を返さない場合、 readTimeを含む応答が送信されますが、 document送信されません。これはクエリが実行された時刻を表します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

skippedResults

integer

最後の応答と現在の応答の間のオフセットによりスキップされた結果の数。

ユニオンフィールドcontinuation_selector 。クエリの継続モード。存在する場合、現在のクエリ応答ストリームが終了したことを示します。これは、 documentが存在するかどうかに関係なく設定できますが、設定すると、それ以上の結果は返されません。 continuation_selector次のいずれか 1 つだけです。
done

boolean

存在する場合、Firestore はリクエストを完全に終了しており、それ以上のドキュメントは返されません。

認可範囲

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

詳細については、 「認証の概要」を参照してください。