索引
Firestore
(インターフェース)-
AggregationResult
(メッセージ) -
ArrayValue
(メッセージ) -
BatchGetDocumentsRequest
(メッセージ) -
BatchGetDocumentsResponse
(メッセージ) -
BatchWriteRequest
(メッセージ) -
BatchWriteResponse
(メッセージ) -
BeginTransactionRequest
(メッセージ) -
BeginTransactionResponse
(メッセージ) -
BitSequence
(メッセージ) -
BloomFilter
(メッセージ) -
CommitRequest
(メッセージ) -
CommitResponse
(メッセージ) -
CreateDocumentRequest
(メッセージ) -
Cursor
(メッセージ) -
DeleteDocumentRequest
(メッセージ) -
Document
(メッセージ) -
DocumentChange
(メッセージ) -
DocumentDelete
(メッセージ) -
DocumentMask
(メッセージ) -
DocumentRemove
(メッセージ) -
DocumentTransform
(メッセージ) -
DocumentTransform.FieldTransform
(メッセージ) -
DocumentTransform.FieldTransform.ServerValue
(列挙型) -
ExistenceFilter
(メッセージ) -
GetDocumentRequest
(メッセージ) -
ListCollectionIdsRequest
(メッセージ) -
ListCollectionIdsResponse
(メッセージ) -
ListDocumentsRequest
(メッセージ) -
ListDocumentsResponse
(メッセージ) -
ListenRequest
(メッセージ) -
ListenResponse
(メッセージ) -
MapValue
(メッセージ) -
PartitionQueryRequest
(メッセージ) -
PartitionQueryResponse
(メッセージ) -
Precondition
(メッセージ) -
RollbackRequest
(メッセージ) -
RunAggregationQueryRequest
(メッセージ) -
RunAggregationQueryResponse
(メッセージ) -
RunQueryRequest
(メッセージ) -
RunQueryResponse
(メッセージ) -
StructuredAggregationQuery
(メッセージ) -
StructuredAggregationQuery.Aggregation
(メッセージ) -
StructuredAggregationQuery.Aggregation.Avg
(メッセージ) -
StructuredAggregationQuery.Aggregation.Count
(メッセージ) -
StructuredAggregationQuery.Aggregation.Sum
(メッセージ) -
StructuredQuery
(メッセージ) -
StructuredQuery.CollectionSelector
(メッセージ) -
StructuredQuery.CompositeFilter
(メッセージ) -
StructuredQuery.CompositeFilter.Operator
(列挙型) -
StructuredQuery.Direction
(列挙型) -
StructuredQuery.FieldFilter
(メッセージ) -
StructuredQuery.FieldFilter.Operator
(列挙型) -
StructuredQuery.FieldReference
(メッセージ) -
StructuredQuery.Filter
(メッセージ) -
StructuredQuery.Order
(メッセージ) -
StructuredQuery.Projection
(メッセージ) -
StructuredQuery.UnaryFilter
(メッセージ) -
StructuredQuery.UnaryFilter.Operator
(列挙型) -
Target
(メッセージ) -
Target.DocumentsTarget
(メッセージ) -
Target.QueryTarget
(メッセージ) -
TargetChange
(メッセージ) -
TargetChange.TargetChangeType
(列挙型) -
TransactionOptions
(メッセージ) -
TransactionOptions.ReadOnly
(メッセージ) -
TransactionOptions.ReadWrite
(メッセージ) -
UpdateDocumentRequest
(メッセージ) -
Value
(メッセージ) -
Write
(メッセージ) -
WriteRequest
(メッセージ) -
WriteResponse
(メッセージ) -
WriteResult
(メッセージ)
ファイヤーストア
クラウド Firestore サービス。
Cloud Firestore は、高速でフルマネージドのサーバーレスのクラウドネイティブ NoSQL ドキュメント データベースで、モバイル、Web、IoT アプリのデータの保存、同期、クエリを世界規模で簡素化します。クライアント ライブラリはライブ同期とオフライン サポートを提供し、セキュリティ機能と Firebase および Google Cloud Platform との統合により、真のサーバーレス アプリの構築が加速されます。
バッチ取得ドキュメント |
---|
複数のドキュメントを取得します。 このメソッドによって返されるドキュメントは、要求された順序と同じ順序で返されることは保証されません。
|
バッチ書き込み |
---|
書き込み操作のバッチを適用します。 BatchWrite メソッドは書き込み操作をアトミックに適用せず、順不同で適用する可能性があります。このメソッドでは、ドキュメントごとに複数の書き込みは許可されません。各書き込みは独立して成功または失敗します。各書き込みの成功ステータスについては、 アトミックに適用される一連の書き込みが必要な場合は、代わりに
|
トランザクションの開始 |
---|
新しいトランザクションを開始します。
|
専念 |
---|
トランザクションをコミットし、必要に応じてドキュメントを更新します。
|
ドキュメントの作成 |
---|
新しいドキュメントを作成します。
|
ドキュメントの削除 |
---|
文書を削除します。
|
GetDocument |
---|
単一のドキュメントを取得します。
|
コレクション ID のリスト |
---|
ドキュメントの下にあるすべてのコレクション ID をリストします。
|
リストドキュメント |
---|
ドキュメントをリストします。
|
聞く |
---|
変化を聞きます。このメソッドは、gRPC または WebChannel (REST ではない) 経由でのみ使用できます。
|
パーティションクエリ |
---|
クエリを並列実行するために使用できるパーティション カーソルを返すことによって、クエリをパーティション化します。返されたパーティション カーソルは、RunQuery でクエリ結果の開始点/終了点として使用できる分割ポイントです。
|
ロールバック |
---|
トランザクションをロールバックします。
|
RunAggregationQuery |
---|
集計クエリを実行します。 この API を使用すると、 高レベルの例:
|
RunQuery |
---|
クエリを実行します。
|
ドキュメントの更新 |
---|
ドキュメントを更新または挿入します。
|
書く |
---|
ドキュメントの更新と削除のバッチを順番にストリーミングします。このメソッドは、gRPC または WebChannel (REST ではない) 経由でのみ使用できます。
|
集計結果
Firestore 集計クエリからの単一バケットの結果。
結果ごとに異なるフィールドが存在する可能性があるドキュメント クエリとは異なり、 aggregate_fields
のキーは集計クエリのすべての結果で同じです。
田畑 | |
---|---|
aggregate_fields | 集計関数の結果 (例: キーは入力時に集計関数に割り当てられた |
配列値
配列値。
田畑 | |
---|---|
values[] | 配列内の値。 |
BatchGetDocumentsRequest
Firestore.BatchGetDocuments
のリクエスト。
田畑 | |
---|---|
database | 必須。データベース名。形式は、 |
documents[] | 取得するドキュメントの名前。形式は、 |
mask | 返されるフィールド。設定されていない場合は、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドは応答で返されません。 |
ユニオンフィールドのconsistency_selector 。このトランザクションの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector 次のいずれか 1 つだけです。 | |
transaction | トランザクションでドキュメントを読み取ります。 |
new_transaction | 新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトでは読み取り専用トランザクションになります。新しいトランザクション ID は、ストリームの最初の応答として返されます。 |
read_time | 指定された時点でのドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
バッチGetDocumentsResponse
Firestore.BatchGetDocuments
のストリーミングされた応答。
田畑 | |
---|---|
transaction | このリクエストの一部として開始されたトランザクション。最初の応答でのみ設定され、 |
read_time | 文書が読まれた時刻。これは単調に増加する可能性があり、この場合、結果ストリーム内の以前のドキュメントは、read_time と今回のドキュメントの間で変更されていないことが保証されます。 |
共用体フィールドresult 。たった一つの結果。サーバーがトランザクションを返すだけの場合、これは空にすることができます。 result 次のいずれか 1 つだけになります。 | |
found | 要求された書類。 |
missing | 要求されたが存在しないドキュメント名。形式は、 |
バッチ書き込みリクエスト
Firestore.BatchWrite
のリクエスト。
田畑 | |
---|---|
database | 必須。データベース名。形式は、 |
writes[] | 適用する書き込み。 このメソッドは書き込みをアトミックに適用せず、順序を保証しません。各書き込みは独立して成功または失敗します。リクエストごとに同じドキュメントに複数回書き込むことはできません。 |
labels | このバッチ書き込みに関連付けられたラベル。 |
バッチ書き込み応答
Firestore.BatchWrite
からの応答。
田畑 | |
---|---|
write_results[] | 書き込みを適用した結果。 この i 番目の書き込み結果は、リクエスト内の i 番目の書き込みに対応します。 |
status[] | 書き込みの適用ステータス。 この i 番目の書き込みステータスは、リクエスト内の i 番目の書き込みに対応します。 |
BeginTransactionRequest
Firestore.BeginTransaction
のリクエスト。
田畑 | |
---|---|
database | 必須。データベース名。形式は、 |
options | トランザクションのオプション。デフォルトは読み取り/書き込みトランザクションです。 |
BeginTransactionResponse
田畑 | |
---|---|
transaction | 開始されたトランザクション。 |
ビットシーケンス
バイト配列にエンコードされたビットのシーケンス。
bitmap
バイト配列の各バイトには、シーケンスの 8 ビットが格納されます。唯一の例外は最後のバイトで、8 ビット以下を格納できます。 padding
「パディング」として無視される最後のバイトのビット数を定義します。これらの「パディング」ビットの値は指定されていないため、無視する必要があります。
最初のビットであるビット 0 を取得するには、 (bitmap[0] & 0x01) != 0
計算します。 2 番目のビットであるビット 1 を取得するには、 (bitmap[0] & 0x02) != 0
計算します。 3 番目のビットであるビット 2 を取得するには、 (bitmap[0] & 0x04) != 0
計算します。 4 番目のビットであるビット 3 を取得するには、 (bitmap[0] & 0x08) != 0
計算します。ビット n を取得するには、 (bitmap[n / 8] & (0x01 << (n % 8))) != 0
計算します。
BitSequence
の「サイズ」 (それに含まれるビット数) は、次の式で計算されます: (bitmap.length * 8) - padding
。
田畑 | |
---|---|
bitmap | ビット シーケンスをエンコードするバイト。長さがゼロの場合もあります。 |
padding | 「パディング」として無視する |
ブルームフィルター
ブルームフィルター ( https://en.wikipedia.org/wiki/Bloom_filter) 。
ブルーム フィルターはエントリを MD5 でハッシュし、結果の 128 ビット ハッシュを 2 つの異なる 64 ビット ハッシュ値として扱い、2 の補数エンコーディングを使用して符号なし整数として解釈します。
h1
およびh2
という名前のこれら 2 つのハッシュ値は、 i=0
から始まる次の式を使用してhash_count
ハッシュ値を計算するために使用されます。
h(i) = h1 + (i * h2)
これらの結果の値は、ブルーム フィルターのビット数を法として取得され、指定されたエントリをテストするためのブルーム フィルターのビットが取得されます。
田畑 | |
---|---|
bits | ブルームフィルターデータ。 |
hash_count | アルゴリズムによって使用されるハッシュの数。 |
コミットリクエスト
Firestore.Commit
のリクエスト。
田畑 | |
---|---|
database | 必須。データベース名。形式は、 |
writes[] | 適用する書き込み。 常にアトミックかつ順番に実行されます。 |
transaction | 設定すると、このトランザクション内のすべての書き込みが適用され、コミットされます。 |
コミット応答
Firestore.Commit
の応答。
田畑 | |
---|---|
write_results[] | 書き込みを適用した結果。 この i 番目の書き込み結果は、リクエスト内の i 番目の書き込みに対応します。 |
commit_time | コミットが発生した時刻。 |
CreateDocumentRequest
Firestore.CreateDocument
のリクエスト。
田畑 | |
---|---|
parent | 必須。親リソース。例: |
collection_id | 必須。リストへの、 |
document_id | このドキュメントに使用するクライアント割り当てのドキュメント ID。 オプション。指定しない場合、サービスによって ID が割り当てられます。 |
document | 必須。作成するドキュメント。 |
mask | 返されるフィールド。設定されていない場合は、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドは応答で返されません。 |
カーソル
クエリ結果セット内の位置。
田畑 | |
---|---|
values[] | クエリの order by 句に表示される順序で位置を表す値。 order by 句で指定した値よりも少ない値を含めることができます。 |
before | 位置が、クエリで定義された並べ替え順序を基準にして、指定された値の直前または直後である場合。 |
ドキュメントの削除リクエスト
Firestore.DeleteDocument
のリクエスト。
田畑 | |
---|---|
name | 必須。削除するドキュメントのリソース名。形式は、 |
current_document | ドキュメントのオプションの前提条件。これが設定されていてもターゲット ドキュメントが満たさない場合、リクエストは失敗します。 |
書類
Firestore ドキュメント。
1 MiB - 4 バイトを超えてはなりません。
田畑 | |
---|---|
name | ドキュメントのリソース名 (例 |
fields | |
create_time | 出力のみ。ドキュメントが作成された時刻。 この値は、ドキュメントが削除されてから再作成されると単調に増加します。また、他のドキュメントの値やクエリの |
update_time | 出力のみ。ドキュメントが最後に変更された時刻。 この値は、最初は |
文書変更
Document
変更されました。
削除を含む複数回のwrites
の結果、最終的にDocument
に新しい値が生成された可能性があります。
複数のターゲットが影響を受ける場合、同じ論理変更に対して複数のDocumentChange
メッセージが返されることがあります。
田畑 | |
---|---|
document | |
target_ids[] | このドキュメントに一致するターゲットのターゲット ID のセット。 |
removed_target_ids[] | このドキュメントと一致しなくなったターゲットのターゲット ID のセット。 |
文書削除
Document
削除されました。
更新を含む複数のwrites
の結果である可能性があり、最後にDocument
削除されました。
複数のターゲットが影響を受ける場合、同じ論理削除に対して複数のDocumentDelete
メッセージが返されることがあります。
田畑 | |
---|---|
document | 削除された |
removed_target_ids[] | 以前にこのエンティティと一致したターゲットのターゲット ID のセット。 |
read_time | 削除が観察された読み取りタイムスタンプ。 削除の |
ドキュメントマスク
ドキュメント上の一連のフィールド パス。ドキュメントの取得または更新操作をそのフィールドのサブセットに制限するために使用されます。これは、常にDocument
にスコープされ、 Value
の動的な性質が考慮されるため、標準のフィールド マスクとは異なります。
田畑 | |
---|---|
field_paths[] | マスク内のフィールド パスのリスト。フィールド パス構文のリファレンスについては、 |
文書の削除
Document
ターゲットのビューから削除されました。
ドキュメントがターゲットに関連しなくなり、表示されなくなった場合に送信されます。サーバーがドキュメントの新しい値を送信できない場合は、DocumentDelete または DocumentChange の代わりに送信できます。
複数のターゲットが影響を受ける場合、同じ論理書き込みまたは削除に対して複数のDocumentRemove
メッセージが返されることがあります。
田畑 | |
---|---|
document | 表示されなくなった |
removed_target_ids[] | 以前にこのドキュメントと一致したターゲットのターゲット ID のセット。 |
read_time | 削除が観察された読み取りタイムスタンプ。 変更/削除/削除の |
ドキュメント変換
文書の変換。
田畑 | |
---|---|
document | 変換するドキュメントの名前。 |
field_transforms[] | ドキュメントのフィールドに順番に適用する変換のリスト。これは空であってはなりません。 |
フィールド変換
ドキュメントのフィールドの変換。
田畑 | |
---|---|
field_path | 畑の道。フィールド パス構文のリファレンスについては、 |
ユニオンフィールドのtransform_type 。フィールドに適用する変換。 transform_type 次のいずれか 1 つだけです。 | |
set_to_server_value | フィールドを指定されたサーバー値に設定します。 |
increment | 指定された値をフィールドの現在の値に追加します。 これは整数または double 値である必要があります。フィールドが整数または倍精度でない場合、またはフィールドがまだ存在しない場合、変換によってフィールドは指定された値に設定されます。指定された値または現在のフィールド値のいずれかが double の場合、両方の値が double として解釈されます。 double の算術演算と double 値の表現は、IEEE 754 のセマンティクスに従います。正/負の整数のオーバーフローがある場合、フィールドは最大の大きさの正/負の整数に解決されます。 |
maximum | フィールドを現在の値と指定された値の最大値に設定します。 これは整数または double 値である必要があります。フィールドが整数または倍精度でない場合、またはフィールドがまだ存在しない場合、変換によってフィールドは指定された値に設定されます。フィールドと入力値の型が混在している (つまり、1 つは整数、もう 1 つは double) 場合に最大演算が適用される場合、フィールドは大きい方のオペランドの型を受け取ります。オペランドが等しい場合 (例: 3 と 3.0)、フィールドは変更されません。 0、0.0、および -0.0 はすべてゼロです。ゼロの保存値とゼロの入力値の最大値は、常に保存された値になります。数値 x と NaN の最大値は NaN です。 |
minimum | フィールドを現在の値と指定された値の最小値に設定します。 これは整数または double 値である必要があります。フィールドが整数または倍精度でない場合、またはフィールドがまだ存在しない場合、変換によりフィールドが入力値に設定されます。フィールドと入力値の型が混在している (つまり、1 つは整数、もう 1 つは double) 場合に最小演算が適用される場合、フィールドは小さい方のオペランドの型を受け取ります。オペランドが等しい場合 (例: 3 と 3.0)、フィールドは変更されません。 0、0.0、および -0.0 はすべてゼロです。ゼロの保存値とゼロの入力値の最小値が常に保存値になります。数値 x と NaN の最小値は NaN です。 |
append_missing_elements | 現在のフィールド値に指定された要素がまだ存在しない場合は、指定された要素を順番に追加します。フィールドが配列でない場合、またはフィールドがまだ存在しない場合は、まず空の配列に設定されます。 値が欠落しているかどうかをチェックするとき、異なるタイプの同等の数 (例: 3L と 3.0) は等しいとみなされます。 NaN は NaN と等しく、Null は Null と等しくなります。入力に複数の同等の値が含まれている場合は、最初の値のみが考慮されます。 対応するtransform_resultはnull値になります。 |
remove_all_from_array | フィールド内の配列から指定された要素をすべて削除します。フィールドが配列でない場合、またはフィールドがまだ存在しない場合は、空の配列に設定されます。 要素を削除するかどうかを決定する際、異なるタイプ (3L と 3.0 など) の同等の数は等しいとみなされます。 NaN は NaN と等しく、Null は Null と等しくなります。これにより、重複がある場合は同等の値がすべて削除されます。 対応するtransform_resultはnull値になります。 |
サーバー値
サーバーによって計算される値。
列挙型 | |
---|---|
SERVER_VALUE_UNSPECIFIED | 不特定。この値は使用してはなりません。 |
REQUEST_TIME | サーバーがリクエストを処理した時刻 (ミリ秒精度)。トランザクション内の複数のフィールド (同じまたは異なるドキュメント) で使用される場合、すべてのフィールドが同じサーバー タイムスタンプを取得します。 |
存在フィルター
指定されたターゲットに一致するすべてのドキュメントのダイジェスト。
田畑 | |
---|---|
target_id | このフィルターが適用されるターゲット ID。 |
count | 一致するクライアント内のドキュメントの数と異なる場合、クライアントはどのドキュメントがターゲットと一致しなくなったかを手動で判断する必要があります。 クライアントは、 |
unchanged_names | ブルーム フィルターには、その名前に反して、 このブルーム フィルターは、クライアントが使用しないとみなされる場合、または計算または送信するには計算コストが高すぎる場合など、サーバーの裁量で省略される場合があります。クライアントは、このフィールドが存在する前に使用されていたロジックにフォールバックすることで、このフィールドが存在しないことを適切に処理する必要があります。つまり、クライアントのキャッシュ内のどのドキュメントが同期していないのかを特定するために、再開トークンを使用せずにターゲットを再追加します。 |
GetDocumentRequest
Firestore.GetDocument
のリクエスト。
田畑 | |
---|---|
name | 必須。取得するドキュメントのリソース名。形式は、 |
mask | 返されるフィールド。設定されていない場合は、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドは応答で返されません。 |
ユニオンフィールドのconsistency_selector 。このトランザクションの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector 次のいずれか 1 つだけです。 | |
transaction | トランザクションでドキュメントを読み取ります。 |
read_time | 指定された時点でのドキュメントのバージョンを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
ListCollectionIdsRequest
Firestore.ListCollectionIds
のリクエスト。
田畑 | |
---|---|
parent | 必須。親ドキュメント。形式は、 |
page_size | 返される結果の最大数。 |
page_token | ページトークン。 |
ユニオンフィールドのconsistency_selector 。このリクエストの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector 次のいずれか 1 つだけです。 | |
read_time | 指定された時点でのドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
ListCollectionIdsResponse
田畑 | |
---|---|
collection_ids[] | コレクションID。 |
next_page_token | リストを継続するために使用できるページ トークン。 |
リストドキュメントリクエスト
Firestore.ListDocuments
のリクエスト。
田畑 | |
---|---|
parent | 必須。親リソースの名前。形式は、 例: |
collection_id | オプション。リストへの、 例: これはオプションであり、指定しない場合、Firestore は指定された |
page_size | オプション。 1 回の応答で返されるドキュメントの最大数。 Firestore が返す値はこの値よりも少ない場合があります。 |
page_token | オプション。以前の これを指定して後続のページを取得します。ページ分割する場合、他のすべてのパラメーター ( |
order_by | オプション。返却するドキュメントのオプションの順序。 例: これは、Firestore クエリで使用される |
mask | オプション。返されるフィールド。設定されていない場合は、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドは応答で返されません。 |
show_missing | リストに不足しているドキュメントが表示されるかどうか。 ドキュメントが存在しない場合、ドキュメントは欠落していますが、その下にサブドキュメントがネストされています。 true の場合、そのような欠落しているドキュメントはキーとともに返されますが、フィールド、 |
ユニオンフィールドのconsistency_selector 。このトランザクションの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector 次のいずれか 1 つだけです。 | |
transaction | すでにアクティブなトランザクションの一部として読み取りを実行します。 |
read_time | 指定された時間に読み取りを実行します。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
リストドキュメント応答
田畑 | |
---|---|
documents[] | 書類が見つかりました。 |
next_page_token | ドキュメントの次のページを取得するためのトークン。 このフィールドを省略した場合、後続のページはありません。 |
リッスンリクエスト
Firestore.Listen
のリクエスト
田畑 | |
---|---|
database | 必須。データベース名。形式は、 |
labels | このターゲットに関連付けられたラベルが変更されます。 |
ユニオンフィールドtarget_change 。サポート対象が変わります。 target_change 次のいずれか 1 つだけです。 | |
add_target | このストリームに追加するターゲット。 |
remove_target | このストリームから削除するターゲットの ID。 |
リッスンレスポンス
Firestore.Listen
の応答。
田畑 | |
---|---|
共用体フィールドresponse_type 。サポートされている応答。 response_type 次のいずれか 1 つだけです。 | |
target_change | ターゲットが変わりました。 |
document_change | |
document_delete | |
document_remove | |
filter | 指定されたターゲットに対して以前に返されたドキュメントのセットに適用するフィルター。 ドキュメントが指定されたターゲットから削除された可能性があるが、正確なドキュメントが不明な場合に返されます。 |
マップ値
マップ値。
田畑 | |
---|---|
fields | マップのフィールド。 マップ キーはフィールド名を表します。正規表現 |
PartitionQueryRequest
Firestore.PartitionQuery
のリクエスト。
田畑 | |
---|---|
parent | 必須。親リソースの名前。形式は、 |
partition_count | 必要なパーティション ポイントの最大数。パーティションは、結果の複数ページにわたって返される場合があります。数値は正の値でなければなりません。実際に返されるパーティションの数はこれよりも少ない場合があります。 たとえば、これを、実行する並列クエリの数より 1 つ少なく設定したり、データ パイプライン ジョブの実行時に使用可能なワーカーまたはコンピューティング インスタンスの数より 1 つ少なく設定したりできます。 |
page_token | PartitionQuery への以前の呼び出しから返された たとえば、page_token を使用した後続の 2 つの呼び出しでは、次が返される場合があります。
PartitionQuery に指定されたクエリの結果に関して順序付けされた完全な結果セットを取得するには、結果セットをマージする必要があります: カーソル A、カーソル B、カーソル M、カーソル Q、カーソル U、カーソル W |
page_size | この呼び出しで返されるパーティションの最大数 ( たとえば、 |
ユニオンフィールドquery_type 。パーティション化するクエリ。 query_type 次のいずれか 1 つだけです。 | |
structured_query | 構造化されたクエリ。クエリでは、すべての子孫を含むコレクションを指定し、名前の昇順で並べる必要があります。他のフィルター、オーダーバイ、制限、オフセット、および開始/終了カーソルはサポートされていません。 |
ユニオンフィールドのconsistency_selector 。このリクエストの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector 次のいずれか 1 つだけです。 | |
read_time | 指定された時点でのドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
PartitionQueryResponse
田畑 | |
---|---|
partitions[] | パーティションの結果。各パーティションは、RunQuery がクエリ結果の開始点または終了点として使用できる分割ポイントです。 RunQuery リクエストは、この PartitionQuery リクエストに指定されたものと同じクエリを使用して作成する必要があります。パーティション カーソルは、PartitionQuery に指定されたクエリの結果と同じ順序に従って順序付けされます。 たとえば、PartitionQuery リクエストがパーティション カーソル A と B を返した場合、次の 3 つのクエリを実行すると、元のクエリの結果セット全体が返されます。
空の結果は、クエリの結果が少なすぎるためパーティション化できないか、クエリがまだパーティション化をサポートしていないことを示している可能性があります。 |
next_page_token | PartitionQuery リクエストの |
前提条件
ドキュメントの前提条件。条件付き操作に使用されます。
田畑 | |
---|---|
ユニオンフィールドのcondition_type 。前提条件のタイプ。 condition_type 次のいずれか 1 つだけです。 | |
exists | |
update_time | 設定する場合、ターゲット ドキュメントが存在し、その時点で最後に更新されている必要があります。タイムスタンプはマイクロ秒に揃える必要があります。 |
ロールバックリクエスト
Firestore.Rollback
のリクエスト。
田畑 | |
---|---|
database | 必須。データベース名。形式は、 |
transaction | 必須。ロールバックするトランザクション。 |
RunAggregationQueryRequest
田畑 | |
---|---|
parent | 必須。親リソースの名前。形式は、 |
ユニオンフィールドquery_type 。実行するクエリ。 query_type 次のいずれか 1 つだけです。 | |
structured_aggregation_query | 集計クエリ。 |
ユニオンフィールドのconsistency_selector 。クエリの整合性モードは、デフォルトで強い整合性になります。 consistency_selector 次のいずれか 1 つだけです。 | |
transaction | すでにアクティブなトランザクション内で集計を実行します。 ここでの値は、クエリを実行する不透明なトランザクション ID です。 |
new_transaction | クエリの一部として新しいトランザクションを開始します。デフォルトは読み取り専用です。 新しいトランザクション ID は、ストリームの最初の応答として返されます。 |
read_time | 指定されたタイムスタンプでクエリを実行します。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
RunAggregationQueryResponse
田畑 | |
---|---|
result | 単一の集計結果。 部分的な進捗状況を報告する場合には存在しません。 |
transaction | このリクエストの一部として開始されたトランザクション。 リクエストが新しいトランザクションの開始を要求したときの最初のレスポンスでのみ存在します。 |
read_time | 集計結果が計算された時刻。これは常に単調増加です。この場合、結果ストリーム内の以前の AggregationResult は、 クエリが結果を返さない場合、 |
RunQueryRequest
Firestore.RunQuery
のリクエスト。
田畑 | |
---|---|
parent | 必須。親リソースの名前。形式は、 |
ユニオンフィールドquery_type 。実行するクエリ。 query_type 次のいずれか 1 つだけです。 | |
structured_query | 構造化されたクエリ。 |
ユニオンフィールドのconsistency_selector 。このトランザクションの整合性モード。設定されていない場合は、デフォルトで強い整合性が設定されます。 consistency_selector 次のいずれか 1 つだけです。 | |
transaction | すでにアクティブなトランザクション内でクエリを実行します。 ここでの値は、クエリを実行する不透明なトランザクション ID です。 |
new_transaction | 新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトでは読み取り専用トランザクションになります。新しいトランザクション ID は、ストリームの最初の応答として返されます。 |
read_time | 指定された時点でのドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。また、ポイントインタイム リカバリが有効な場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
RunQueryResponse
田畑 | |
---|---|
transaction | このリクエストの一部として開始されたトランザクション。最初の応答でのみ設定でき、リクエストで |
document | クエリ結果。部分的な進行状況を報告する場合は設定されません。 |
read_time | 文書が読まれた時刻。これは単調増加する可能性があります。この場合、結果ストリーム内の以前のドキュメントは、 クエリに結果が返されない場合、 |
skipped_results | 最後の応答と現在の応答の間のオフセットのためにスキップされた結果の数。 |
ユニオンフィールドcontinuation_selector 。クエリの継続モード。存在する場合、現在のクエリ応答ストリームが終了したことを示します。これは、 document の有無にかかわらず設定できますが、設定すると、結果は返されません。 continuation_selector 次のいずれかになります。 | |
done | 存在する場合、Firestoreはリクエストを完全に完了し、これ以上のドキュメントは返されません。 |
構造編集クエリ
StructuredQuery
介して集約を実行するためのFirestoreクエリ。
田畑 | |
---|---|
aggregations[] | オプション。 必要:
|
ユニオンフィールドquery_type 。集約するためのベースクエリ。 query_type 次のいずれかになります。 | |
structured_query | ネストされた構造化クエリ。 |
集計
単一の結果を生成する集計を定義します。
田畑 | |
---|---|
alias | オプション。集約の結果を格納するためのフィールドのオプション名。 提供されていない場合、FirestoreはFormat
は次のようになります:
必要:
|
ユニオンフィールドoperator 。実行するための集約のタイプ、必須。 operator 次のいずれかになることができます。 | |
count | カウントアグリゲーター。 |
sum | 合計アグリゲーター。 |
avg | 平均的なアグリゲーター。 |
平均
要求されたフィールドの値の平均。
数値のみが集約されます。
NULL
を含むすべての非数値値がスキップされます。集約値に
NaN
が含まれている場合、NaN
を返します。 Infinity MathはIEEE-754基準に従います。集約値セットが空の場合、
NULL
を返します。常に結果をダブルとして返します。
田畑 | |
---|---|
field | 集約するフィールド。 |
カウント
クエリに一致するドキュメントのカウント。
COUNT(*)
集約関数はドキュメント全体で動作するため、フィールド参照は必要ありません。
田畑 | |
---|---|
up_to | オプション。カウントするドキュメントの最大数に対するオプションの制約。 これにより、スキャンし、レイテンシとコストを制限するためのドキュメントの数に上限を設定する方法が提供されます。 不特定は、拘束されていないと解釈されます。 高レベルの例:
必要:
|
和
要求されたフィールドの値の合計。
数値のみが集約されます。
NULL
を含むすべての非数値値がスキップされます。集約値に
NaN
が含まれている場合、NaN
を返します。 Infinity MathはIEEE-754基準に従います。集計値セットが空の場合、0を返します。
すべての集約された数値が整数であり、合計結果がオーバーフローしない場合、64ビット整数を返します。それ以外の場合、結果はダブルとして返されます。すべての集約値が整数であっても、64ビットの署名整数内に収まらない場合、結果はダブルとして返されることに注意してください。これが発生すると、返された値は精度を失います。
アンダーフローが発生すると、浮動小数点凝集は非決定的です。これは、同じクエリを繰り返し実行することなく、基礎となる値を変更せずに実行すると、毎回わずかに異なる結果が生じる可能性があることを意味します。そのような場合、値は浮動小数点数に整数として保存する必要があります。
田畑 | |
---|---|
field | 集約するフィールド。 |
StructuredQuery
ファイヤーストアクエリ。
田畑 | |
---|---|
select | 返品するフィールドのオプションのサブセット。 これは、クエリから返されたドキュメント上の |
from[] | クエリするコレクション。 |
where | 適用するフィルター。 |
order_by[] | クエリ結果に適用する順序。 Firestoreを使用すると、発信者は完全な注文、部分的な注文、またはまったく注文しないことを可能にします。すべての場合において、Firestoreは次のルールを通じて安定した注文を保証します。
フィールドには、指定された最後の順序と同じ並べ替え方向、または命令が指定されていない場合は「昇順」で追加されます。例えば:
|
start_at | 結果を設定した位置の潜在的なプレフィックス。クエリを開始します。 結果セットの順序付けは、元のクエリの句ごと
このクエリの結果は カーソルは、提供された 上記の例を続けて、次のスタートカーソルを添付すると、さまざまな影響があります。
スキップするために最初のn結果をスキャンする必要がある 必要:
|
end_at | 結果の位置の潜在的な接頭辞は、でクエリを終了するように設定されています。 これは 必要:
|
offset | 最初の結果を返す前にスキップするドキュメントの数。 これは、 必要:
|
limit | 返される結果の最大数。 他のすべての制約の後に適用されます。 必要:
|
CollectionSelector
messages as m1
などのコレクションの選択。
田畑 | |
---|---|
collection_id | コレクションID。設定すると、このIDでコレクションのみを選択します。 |
all_descendants | FALSEの場合、contering |
compositefilter
指定された演算子を使用して複数の他のフィルターをマージするフィルター。
田畑 | |
---|---|
op | 複数のフィルターを結合するための演算子。 |
filters[] | 結合するフィルターのリスト。 必要:
|
オペレーター
複合フィルター演算子。
列挙型 | |
---|---|
OPERATOR_UNSPECIFIED | 不特定。この値を使用してはなりません。 |
AND | すべての結合されたフィルターを満たすには、ドキュメントが必要です。 |
OR | 組み合わせたフィルターの少なくとも1つを満たすには、ドキュメントが必要です。 |
方向
ソート方向。
列挙型 | |
---|---|
DIRECTION_UNSPECIFIED | 不特定。 |
ASCENDING | 上昇。 |
DESCENDING | 下降。 |
FieldFilter
特定のフィールド上のフィルター。
田畑 | |
---|---|
field | フィルターするフィールド。 |
op | フィルタリングする演算子。 |
value | 比較する値。 |
オペレーター
フィールドフィルター演算子。
列挙型 | |
---|---|
OPERATOR_UNSPECIFIED | 不特定。この値を使用してはなりません。 |
LESS_THAN | 指定された 必要:
|
LESS_THAN_OR_EQUAL | 指定された 必要:
|
GREATER_THAN | 指定された 必要:
|
GREATER_THAN_OR_EQUAL | 指定された 必要:
|
EQUAL | 指定されたfield 指定されたvalue に等しくなります。 |
NOT_EQUAL | 指定された 必要:
|
ARRAY_CONTAINS | 指定されたfield 指定されたvalue を含む配列です。 |
IN | 指定された 必要:
|
ARRAY_CONTAINS_ANY | 指定された 必要:
|
NOT_IN | 必要:
|
fieldreference
ドキュメント内のフィールドへの参照、例: stats.operations
。
田畑 | |
---|---|
field_path | ドキュメント内のフィールドへの参照。 必要:
|
フィルター
フィルター。
田畑 | |
---|---|
ユニオンフィールドfilter_type 。フィルターのタイプ。 filter_type 次のいずれかの1つにすぎません。 | |
composite_filter | 複合フィルター。 |
field_filter | ドキュメントフィールドのフィルター。 |
unary_filter | ちょうど1つの引数を取るフィルター。 |
注文
フィールドでの注文。
田畑 | |
---|---|
field | 注文するフィールド。 |
direction | 注文する方向。デフォルトは |
投影
ドキュメントのフィールドが返される予測。
田畑 | |
---|---|
fields[] | 返すフィールド。 空の場合、すべてのフィールドが返されます。ドキュメントの名前のみを返すには、 |
UniaryFilter
単一のオペランドを備えたフィルター。
田畑 | |
---|---|
op | 応募するための単位オペレーター。 |
ユニオンフィールドoperand_type 。フィルターへの引数。 operand_type 次のいずれかのいずれかになります。 | |
field | オペレーターを適用するフィールド。 |
オペレーター
単一のオペレーター。
列挙型 | |
---|---|
OPERATOR_UNSPECIFIED | 不特定。この値を使用してはなりません。 |
IS_NAN | 指定されたfield はNaN に等しくなります。 |
IS_NULL | 指定されたfield はNULL に等しくなります。 |
IS_NOT_NAN | 指定された 必要:
|
IS_NOT_NULL | 指定された 必要:
|
目標
聴くためのドキュメントのセットの仕様。
田畑 | |
---|---|
target_id | ストリーム上のターゲットを識別するターゲットID。正の数と非ゼロでなければなりません。 クライアントがIDなしで複数の |
once | ターゲットを削除する必要がある場合は、最新かつ一貫しています。 |
expected_count | 履歴書トークンまたは読み取り時間で最後にクエリに一致したドキュメントの数。 この値は、 |
ユニオンフィールドtarget_type 。聞くためのターゲットのタイプ。 target_type 次のいずれかになります。 | |
query | クエリで指定されたターゲット。 |
documents | ドキュメント名のセットで指定されたターゲット。 |
ユニオンフィールド 指定されている場合、 | |
resume_token | 同一の 異なるターゲットで履歴書トークンを使用することはサポートされておらず、失敗する可能性があります。 |
read_time | 特定の クライアントは、現時点でドキュメントを一致させる状態を知っている必要があります。 |
documentStarget
ドキュメント名のセットによって指定されたターゲット。
田畑 | |
---|---|
documents[] | 取得するドキュメントの名前。形式: |
QueryTarget
クエリで指定されたターゲット。
田畑 | |
---|---|
parent | 親リソース名。形式: |
ユニオンフィールドquery_type 。実行するクエリ。 query_type 次のいずれかになります。 | |
structured_query | 構造化されたクエリ。 |
TargetChange
監視されているターゲットが変更されました。
田畑 | |
---|---|
target_change_type | 発生した変化の種類。 |
target_ids[] | 変更されたターゲットのターゲットID。 空の場合、変更はすべてのターゲットに適用されます。 ターゲットIDの順序は定義されていません。 |
cause | 該当する場合、この変更をもたらしたエラー。 |
resume_token | 指定された すべてのターゲットの変更に設定されていません。 |
read_time | 指定された ストリームは、ストリーム全体が新しい一貫したスナップショットに到達するたびに、 特定のストリームの場合、 |
TargetChangeType
変化の種類。
列挙型 | |
---|---|
NO_CHANGE | 変更は発生していません。更新されたresume_token を送信するためにのみ使用されます。 |
ADD | ターゲットが追加されました。 |
REMOVE | ターゲットが削除されました。 |
CURRENT | ターゲットは、ターゲットがストリームに追加される前にコミットされたすべての変更を反映しています。 これは、ターゲットが追加された時間以上の リスナーは、読み取り後のセマンティクスが望まれる場合、この変更を待つことができます。 |
RESET | ターゲットはリセットされており、その後の変更でターゲットの新しい初期状態が返されます。 初期状態が完了すると、 |
TransactionOptions
新しいトランザクションを作成するためのオプション。
田畑 | |
---|---|
ユニオンフィールドmode 。トランザクションのモード。 mode 次のいずれかのいずれかになります。 | |
read_only | トランザクションは、読み取り操作にのみ使用できます。 |
read_write | トランザクションは、読み取り操作と書き込み操作の両方に使用できます。 |
読み取り専用
ドキュメントの読み取りにのみ使用できるトランザクションのオプション。
田畑 | |
---|---|
ユニオンフィールドのconsistency_selector 。このトランザクションの一貫性モード。設定されていない場合、デフォルトは強力な一貫性になります。 consistency_selector 次のいずれかになります。 | |
read_time | 指定された時間にドキュメントを読み取ります。 これは、過去1時間以内にマイクロ秒の精度タイムスタンプである必要があります。または、ポイントインタイムの回復が有効になっている場合は、過去7日以内に1分間のタイムスタンプになる可能性があります。 |
読み書き
ドキュメントの読み書きに使用できるトランザクションのオプション。
Firestoreでは、サードパーティの認証要求が読み取りワイトを作成することを許可していません。取引。
田畑 | |
---|---|
retry_transaction | 再試行するためのオプションのトランザクション。 |
updatedocumentRequest
Firestore.UpdateDocument
のリクエスト。
田畑 | |
---|---|
document | 必須。更新されたドキュメント。ドキュメントがまだ存在しない場合は、ドキュメントを作成します。 |
update_mask | 更新するフィールド。マスク内のフィールドパスには、予約済みの名前が含まれている場合はありません。 ドキュメントがサーバーに存在し、マスクで参照されていないフィールドがある場合、それらは変更されていません。マスクで参照されているフィールドは、入力ドキュメントに存在しないが、サーバー上のドキュメントから削除されます。 |
mask | 返すフィールド。設定されていない場合は、すべてのフィールドを返します。 ドキュメントにこのマスクに存在しないフィールドがある場合、そのフィールドは応答で返されません。 |
current_document | ドキュメントのオプションの前提条件。これが設定され、ターゲットドキュメントで満たされない場合、リクエストは失敗します。 |
価値
サポートされている値タイプのいずれかを保持できるメッセージ。
田畑 | |
---|---|
ユニオンフィールドvalue_type 。値セットが必要です。 value_type 次のいずれかのいずれかになります。 | |
null_value | ヌル値。 |
boolean_value | ブール値。 |
integer_value | 整数値。 |
double_value | 二重値。 |
timestamp_value | タイムスタンプ値。 マイクロ秒のみに正確に。保存すると、追加の精度が丸くなります。 |
string_value | 文字列値。 UTF -8として表される文字列は、1 MIB -89バイトを超えてはなりません。 UTF-8表現の最初の1,500バイトのみがクエリによって考慮されます。 |
bytes_value | バイト値。 1 mib -89バイトを超えてはなりません。最初の1,500バイトのみがクエリで考慮されます。 |
reference_value | ドキュメントへの参照。例: |
geo_point_value | 地球の表面のポイントを表すジオポイント値。 |
array_value | 配列値。 別の配列値を直接含めることはできませんが、別の配列を含むマップを含めることができます。 |
map_value | マップ値。 |
書く
ドキュメントに書く。
田畑 | |
---|---|
update_mask | この書き込みで更新するフィールド。 このフィールドは、操作が |
update_transforms[] | 更新後に実行する変換。 このフィールドは、操作が |
current_document | ドキュメントのオプションの前提条件。 これが設定され、ターゲットドキュメントで満たされない場合、書き込みは失敗します。 |
ユニオンフィールドoperation 。実行する操作。 operation 次のいずれかになります。 | |
update | 書くドキュメント。 |
delete | 削除するドキュメント名。形式: |
transform | ドキュメントに変換を適用します。 |
Writerequest
Firestore.Write
のリクエスト。
最初の要求は、ストリームを作成するか、トークンから既存の要求を再開します。
新しいストリームを作成するとき、サーバーは次のリクエストで使用するために、IDとトークンのみを含む応答で返信します。
ストリームを再開するとき、サーバーは最初に指定されたトークンよりも遅く応答をストリーミングし、次に最新のトークンのみを含む応答を次のリクエストで使用します。
田畑 | |
---|---|
database | 必須。データベース名。形式: |
stream_id | 再開する書き込みストリームのID。これは、最初のメッセージでのみ設定できます。空のままになると、新しい書き込みストリームが作成されます。 |
writes[] | 適用するための書き込み。 常に原子的かつ順番に実行されます。これは、最初のリクエストで空にする必要があります。これは、最後のリクエストで空になる場合があります。これは、他のすべてのリクエストで空にしてはなりません。 |
stream_token | 以前にサーバーによって送信されたストリームトークン。 クライアントは、受信した最新の 未把握されていない応答が多すぎる場合、サーバーはストリームを閉じることができます。 新しいストリームを作成するときに、このフィールドが解き放たれます。特定のポイントでストリームを再開するには、このフィールドと 新しいストリームを作成するときに、このフィールドが解き放たれます。 |
labels | この書き込み要求に関連付けられたラベル。 |
writereponse
Firestore.Write
の応答。
田畑 | |
---|---|
stream_id | ストリームのID。新しいストリームが作成されたときの最初のメッセージにのみ設定されます。 |
stream_token | ストリーム内のこの応答の位置を表すトークン。これは、クライアントがこの時点でストリームを再開するために使用できます。 このフィールドは常に設定されています。 |
write_results[] | 書き込みを適用した結果。 このIth Writeの結果は、リクエストのi番目の書き込みに対応しています。 |
commit_time | コミットが発生した時間。等しいまたはそれ以上の |
writeresult
書き込みを適用した結果。
田畑 | |
---|---|
update_time | 書き込みを適用した後のドキュメントの最後の更新時間。 書き込みが実際にドキュメントを変更しなかった場合、これは以前のupdate_timeになります。 |
transform_results[] | 各 |