索引
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
(列挙型)ExecutionStats
(メッセージ)ExistenceFilter
(メッセージ)ExplainMetrics
(メッセージ)ExplainOptions
(メッセージ)GetDocumentRequest
(メッセージ)ListCollectionIdsRequest
(メッセージ)ListCollectionIdsResponse
(メッセージ)ListDocumentsRequest
(メッセージ)ListDocumentsResponse
(メッセージ)ListenRequest
(メッセージ)ListenResponse
(メッセージ)MapValue
(メッセージ)PartitionQueryRequest
(メッセージ)PartitionQueryResponse
(メッセージ)PlanSummary
(メッセージ)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.FindNearest
(メッセージ)StructuredQuery.FindNearest.DistanceMeasure
(列挙型)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 サービス。
Cloud Firestore は、高速でサーバーレスなフルマネージドのクラウド ネイティブ NoSQL ドキュメント データベースです。グローバル規模で展開されるこのサービスを利用することにより、モバイルアプリやウェブアプリ、IoT アプリのデータの保存、同期、照会を簡単に行えるようになります。クライアント ライブラリによってライブ同期とオフライン サポートが提供され、セキュリティ機能、Firebase および Google Cloud Platform との統合により、真にサーバーレスなアプリの構築が促進されます。
BatchGetDocuments |
---|
複数のドキュメントを取得します。 このメソッドで返されるドキュメントは、リクエストされた順序で返されるとは限りません。
|
BatchWrite |
---|
書き込みオペレーションのバッチを適用します。 BatchWrite メソッドは、書き込みオペレーションをアトミックに適用せず、順不同で適用できます。このメソッドはドキュメントごとに複数回の書き込みに対応していません。各書き込みは個別に成功または失敗します。各書き込みの成功ステータスについては、 アトミックに適用される一連の書き込みが必要な場合は、代わりに
|
BeginTransaction |
---|
新しいトランザクションを開始します。
|
Commit |
---|
必要に応じてドキュメントを更新します。トランザクションを commit します。
|
CreateDocument |
---|
新しいドキュメントを作成します。
|
DeleteDocument |
---|
ドキュメントを削除します。
|
GetDocument |
---|
単一のドキュメントを取得します。
|
ListCollectionIds |
---|
ドキュメント内のすべてのコレクション ID を一覧表示します。
|
ListDocuments |
---|
ドキュメントを一覧表示します。
|
聴く |
---|
変更をリッスンする。このメソッドは、gRPC または WebChannel でのみ使用できます(REST では使用できません)。
|
PartitionQuery |
---|
クエリの並列実行に使用できるパーティション カーソルを返してクエリを分割します。返されるパーティション カーソルは、クエリ結果の開始点または終了点として RunQuery で使用できる分割ポイントです。
|
ロールバック |
---|
トランザクションをロールバックします。
|
RunAggregationQuery |
---|
集計クエリを実行します。 この API では、 大まかな例:
|
RunQuery |
---|
クエリを実行します。
|
UpdateDocument |
---|
ドキュメントを更新または挿入します。
|
書き込み |
---|
ドキュメントの更新と削除のバッチを順番にストリーミングします。このメソッドは、gRPC または WebChannel でのみ使用できます(REST では使用できません)。
|
AggregationResult
Firestore 集約クエリからの単一バケットの結果。
aggregate_fields
のキーは、結果ごとに異なるフィールドが存在する可能性があるドキュメント クエリとは異なり、集計クエリのすべての結果で同じです。
フィールド | |
---|---|
aggregate_fields |
集計関数の結果(例: キーは、入力時に集計関数に割り当てられた |
ArrayValue
配列値。
フィールド | |
---|---|
values[] |
配列内の値。 |
BatchGetDocumentsRequest
Firestore.BatchGetDocuments
のリクエスト。
フィールド | |
---|---|
database |
必須。データベース名。形式は |
documents[] |
取得するドキュメントの名前。形式は |
mask |
返されるフィールド。設定されていない場合は、すべてのフィールドが返されます。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドはレスポンスで返されません。 |
共用体フィールド consistency_selector 。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
transaction |
トランザクション内のドキュメントを読み取ります。 |
new_transaction |
新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトは読み取り専用トランザクションです。新しいトランザクション ID は、ストリーム内の最初のレスポンスとして返されます。 |
read_time |
指定された時点のドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
BatchGetDocumentsResponse
Firestore.BatchGetDocuments
のストリーミングされたレスポンス。
フィールド | |
---|---|
transaction |
このリクエストの一部として開始されたトランザクション。リクエストで |
read_time |
ドキュメントが読み取られた時刻。これは単数に増加する可能性があります。この場合は、結果ストリームの以前のドキュメントが read_time とこのドキュメントの間で変更されていないことが保証されます。 |
共用体フィールド result 。単一の結果。サーバーがトランザクションを返すだけの場合は空にできます。result は次のいずれかになります。 |
|
found |
リクエストされたドキュメント。 |
missing |
リクエストされたドキュメント名が存在しない。形式は |
BatchWriteRequest
Firestore.BatchWrite
のリクエスト。
フィールド | |
---|---|
database |
必須。データベース名。形式は |
writes[] |
適用する書き込み。 メソッドは書き込みをアトミックに適用せず、順序を保証するものではありません。各書き込みは個別に成功または失敗します。1 回のリクエストで、同じドキュメントに複数回書き込むことはできません。 |
labels |
このバッチ書き込みに関連付けられているラベル。 |
BatchWriteResponse
Firestore.BatchWrite
からのレスポンス。
フィールド | |
---|---|
write_results[] |
書き込みを適用した結果。 この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。 |
status[] |
書き込みの適用のステータス。 この i 番目の書き込みステータスは、リクエストの i 番目の書き込みに対応します。 |
BeginTransactionRequest
Firestore.BeginTransaction
のリクエスト。
フィールド | |
---|---|
database |
必須。データベース名。形式は |
options |
トランザクションのオプション。デフォルトは読み取り / 書き込みトランザクションです。 |
BeginTransactionResponse
Firestore.BeginTransaction
に対するレスポンス。
フィールド | |
---|---|
transaction |
開始されたトランザクション。 |
BitSequence
バイト配列にエンコードされたビット列。
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 |
ビット シーケンスをエンコードするバイト。長さが 0 になることもあります。 |
padding |
「パディング」として無視する |
BloomFilter
ブルーム フィルタ(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 |
アルゴリズムで使用されるハッシュの数。 |
CommitRequest
Firestore.Commit
のリクエスト。
フィールド | |
---|---|
database |
必須。データベース名。形式は |
writes[] |
適用する書き込み。 常にアトミックに順番に実行されます。 |
transaction |
設定されている場合、このトランザクションのすべての書き込みを適用し、commit します。 |
CommitResponse
Firestore.Commit
に対するレスポンス。
フィールド | |
---|---|
write_results[] |
書き込みを適用した結果。 この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。 |
commit_time |
commit が発生した時刻。 |
CreateDocumentRequest
Firestore.CreateDocument
のリクエスト。
フィールド | |
---|---|
parent |
必須。親リソース。例: |
collection_id |
必須。 |
document_id |
このドキュメントで使用するためにクライアントによって割り当てられたドキュメント ID。 省略可。指定しない場合、サービスによって ID が割り当てられます。 |
document |
必須。作成するドキュメント。 |
mask |
返されるフィールド。設定されていない場合は、すべてのフィールドが返されます。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドはレスポンスで返されません。 |
Cursor
クエリ結果セット内の位置。
フィールド | |
---|---|
values[] |
クエリの order by 句に表示される順序で位置を表す値。 order by 句で指定されている値よりも少ない値を含めることができます。 |
before |
位置が指定された値の直前または直後である場合、クエリで定義された並べ替え順に対する相対的な位置です。 |
DeleteDocumentRequest
Firestore.DeleteDocument
のリクエスト。
フィールド | |
---|---|
name |
必須。削除するドキュメントのリソース名。形式は |
current_document |
ドキュメントの前提条件(省略可)。これが設定されていて、ターゲット ドキュメントでこれが満たされていない場合、リクエストは失敗します。 |
ドキュメント
Firestore ドキュメント。
1 MiB ~ 4 バイト以下にする必要があります。
フィールド | |
---|---|
name |
ドキュメントのリソース名(例: |
fields |
|
create_time |
出力のみ。ドキュメントが作成された時刻。 この値は、ドキュメントを削除してから再作成すると単調に増加します。また、他のドキュメントの値やクエリの |
update_time |
出力のみ。ドキュメントが最後に変更された時刻。 この値は最初に |
DocumentChange
Document
が変更されました。
削除を含む複数の writes
の結果、最終的に Document
に新しい値が生成された可能性があります。
複数のターゲットが影響を受ける場合、同じ論理変更に対して複数の DocumentChange
メッセージが返されることがあります。
フィールド | |
---|---|
document |
|
target_ids[] |
このドキュメントに一致するターゲットのターゲット ID のセット。 |
removed_target_ids[] |
このドキュメントに一致しなくなったターゲットのターゲット ID のセット。 |
DocumentDelete
Document
を削除しました。
更新を含む複数の writes
の結果であり、最後に Document
が削除された可能性があります。
複数のターゲットが影響を受ける場合、同じ論理削除に対して複数の DocumentDelete
メッセージが返されることがあります。
フィールド | |
---|---|
document |
削除された |
removed_target_ids[] |
以前にこのエンティティと一致していたターゲットのターゲット ID のセット。 |
read_time |
削除が確認された時点の読み取りタイムスタンプ。 削除の |
DocumentMask
ドキュメント上の一連のフィールドパス。ドキュメントに対する取得または更新のオペレーションを、そのフィールドのサブセットに制限するために使用します。標準のフィールド マスクとは異なり、常にスコープが Document
に設定され、Value
の動的な性質が考慮されます。
フィールド | |
---|---|
field_paths[] |
マスク内のフィールドパスのリスト。フィールドパスの構文リファレンスについては、 |
DocumentRemove
Document
がターゲットのビューから削除されました。
ドキュメントがターゲットと無関係で、画角に収まっていない場合に送信されます。サーバーがドキュメントの新しい値を送信できない場合は、DocumentDelete や DocumentChange の代わりに送信できます。
複数のターゲットが影響を受ける場合、同じ論理書き込みまたは削除に対して複数の DocumentRemove
メッセージが返されることがあります。
フィールド | |
---|---|
document |
表示されなくなった |
removed_target_ids[] |
以前にこのドキュメントと一致していたターゲットのターゲット ID のセット。 |
read_time |
削除が確認された時点の読み取りタイムスタンプ。 変更/削除/削除の |
DocumentTransform
ドキュメントの変換。
フィールド | |
---|---|
document |
変換するドキュメントの名前。 |
field_transforms[] |
ドキュメントのフィールドに適用する変換のリスト(順番)。空にすることはできません。 |
FieldTransform
ドキュメントのフィールドの変換。
フィールド | |
---|---|
field_path |
フィールドのパス。フィールドパスの構文リファレンスについては、 |
共用体フィールド transform_type 。フィールドに適用する変換。transform_type は次のいずれかになります。 |
|
set_to_server_value |
フィールドを指定されたサーバー値に設定します。 |
increment |
指定された値をフィールドの現在の値に追加します。 整数値または倍精度値を指定してください。フィールドが整数または倍精度浮動小数点でない場合、またはフィールドがまだ存在しない場合、変換によってそのフィールドは指定された値に設定されます。指定された値または現在のフィールド値のいずれかが double 型である場合、両方の値が double 型として解釈されます。double 算術と double 値の表現は IEEE 754 セマンティクスに従います。正または負の整数オーバーフローがある場合、フィールドは大きさが最大の正または負の整数に解決されます。 |
maximum |
フィールドの現在の値と指定された値の最大値に設定します。 整数値または倍精度値を指定してください。フィールドが整数または倍精度浮動小数点でない場合、またはフィールドがまだ存在しない場合、変換によってそのフィールドは指定された値に設定されます。フィールドと入力値の型が混在している(つまり、1 つは整数で、もう 1 つは倍精度)場合に最大演算が適用される場合、フィールドは大きい方のオペランドの型を使用します。オペランドが等しい場合(たとえば、3 と 3.0)、フィールドは変更されません。0、0.0、-0.0 はすべてゼロです。ゼロの保存値とゼロ入力値の最大値は常に、保存された値になります。数値 x と NaN の最大値は NaN です。 |
minimum |
現在の値と指定された値の最小値をフィールドに設定します。 整数値または倍精度値を指定してください。フィールドが整数または倍精度浮動小数点でない場合、またはフィールドがまだ存在しない場合は、変換によってそのフィールドは入力値に設定されます。フィールドと入力値の型が混在する最小演算が適用される場合(つまり、1 つは整数で、もう 1 つは倍精度)、フィールドは小さい方のオペランドの型を使用します。オペランドが等しい場合(たとえば、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 値になります。 |
ServerValue
サーバーによって計算される値。
列挙型 | |
---|---|
SERVER_VALUE_UNSPECIFIED |
指定なし。この値は使用しないでください。 |
REQUEST_TIME |
サーバーがリクエストを処理した時刻(ミリ秒単位)。トランザクションで複数のフィールド(同一または異なるドキュメント)で使用する場合は、すべてのフィールドに同じサーバー タイムスタンプが適用されます。 |
ExecutionStats
クエリの実行の統計情報。
フィールド | |
---|---|
results_returned |
ドキュメント、射影、集計結果、キーなど、返された結果の合計数。 |
execution_duration |
バックエンドでクエリを実行するための合計時間。 |
read_operations |
課金対象の読み取りオペレーションの合計数。 |
debug_stats |
クエリの実行に関する統計情報のデバッグ。デバッグ統計情報は、Firestore の進化に伴って変更される場合があります。It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } } |
ExistenceFilter
指定されたターゲットに一致するすべてのドキュメントのダイジェスト。
フィールド | |
---|---|
target_id |
このフィルタが適用されるターゲット ID。 |
count |
クライアント内の一致するドキュメントの数と異なる場合、クライアントはターゲットに一致しなくなったドキュメントを手動で決定する必要があります。 クライアントは |
unchanged_names |
名前にもかかわらず、 このブルーム フィルタは、クライアントがそれを使用しないと判断した場合や、計算や送信に費用がかかりすぎる場合など、サーバーの裁量で省略できます。クライアントは、このフィールドが存在しない場合に使用されていたロジックにフォールバックすることで、このフィールドが存在しない場合を適切に処理する必要があります。つまり、再開トークンなしでターゲットを再度追加して、クライアントのキャッシュ内のどのドキュメントが同期されていないのかを把握する必要があります。 |
ExplainMetrics
クエリの指標について説明します。
フィールド | |
---|---|
plan_summary |
クエリのプランニング フェーズの情報。 |
execution_stats |
クエリの実行から集計された統計情報。 |
ExplainOptions
クエリのオプションについて説明します。
フィールド | |
---|---|
analyze |
省略可。このクエリを実行するかどうか。 false(デフォルト)の場合、クエリが計画され、計画段階からの指標のみが返されます。 true の場合、クエリが計画されて実行され、計画段階と実行段階の両方の指標とともに、完全なクエリ結果が返されます。 |
GetDocumentRequest
Firestore.GetDocument
のリクエスト。
フィールド | |
---|---|
name |
必須。取得するドキュメントのリソース名。形式は |
mask |
返されるフィールド。設定されていない場合は、すべてのフィールドが返されます。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドはレスポンスで返されません。 |
共用体フィールド consistency_selector 。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
transaction |
トランザクションでドキュメントを読み取ります。 |
read_time |
指定された時点のドキュメントのバージョンを読み取ります。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
ListCollectionIdsRequest
Firestore.ListCollectionIds
のリクエスト。
フィールド | |
---|---|
parent |
必須。親ドキュメント。形式は |
page_size |
返される結果の最大件数です。 |
page_token |
ページトークン。 |
共用体フィールド consistency_selector 。このリクエストの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
read_time |
指定された時点のドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
ListCollectionIdsResponse
Firestore.ListCollectionIds
からのレスポンス。
フィールド | |
---|---|
collection_ids[] |
コレクション ID。 |
next_page_token |
リストの続行に使用できるページトークン。 |
ListDocumentsRequest
Firestore.ListDocuments
のリクエスト。
フィールド | |
---|---|
parent |
必須。親リソース名。形式は 例: |
collection_id |
省略可。 たとえば、 これは省略可能です。指定しない場合、Firestore は指定された |
page_size |
省略可。1 回のレスポンスで返すドキュメントの最大数。 Firestore はこの値より少ない数を返すことがあります。 |
page_token |
省略可。前の これを指定して、後続のページを取得します。ページ分けを行う際、他のすべてのパラメータ( |
order_by |
省略可。返されるドキュメントの順序(省略可)。 例: これは、Firestore クエリで使用される |
mask |
省略可。返されるフィールド。設定されていない場合は、すべてのフィールドが返されます。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドはレスポンスで返されません。 |
show_missing |
リストに不足している書類が表示されているかどうか。 ドキュメントが存在しないが、その下にサブドキュメントがネストされている場合、そのドキュメントは存在しない。true の場合、このような欠落したドキュメントはキーとともに返されますが、フィールド、
|
共用体フィールド consistency_selector 。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
transaction |
すでにアクティブなトランザクションの一部として読み取りを実行します。 |
read_time |
指定された時刻に読み取りを実行します。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
ListDocumentsResponse
Firestore.ListDocuments
に対するレスポンス。
フィールド | |
---|---|
documents[] |
見つかったドキュメント。 |
next_page_token |
ドキュメントの次のページを取得するためのトークン。 このフィールドを省略すると、後続のページはなくなります。 |
ListenRequest
Firestore.Listen
のリクエスト
フィールド | |
---|---|
database |
必須。データベース名。形式は |
labels |
このターゲットの変更に関連付けられているラベル。 |
共用体フィールド target_change 。サポートされているターゲットの変更。target_change は次のいずれかになります。 |
|
add_target |
このストリームに追加するターゲット。 |
remove_target |
このストリームから削除するターゲットの ID。 |
ListenResponse
Firestore.Listen
に対するレスポンス。
フィールド | |
---|---|
共用体フィールド response_type 。サポートされているレスポンス。response_type は次のいずれかになります。 |
|
target_change |
目標が変更されました。 |
document_change |
|
document_delete |
|
document_remove |
|
filter |
指定されたターゲットに対して以前に返された一連のドキュメントに適用するフィルタ。 指定されたターゲットからドキュメントが削除された可能性があるものの、正確なドキュメントが不明な場合に返されます。 |
MapValue
マップ値。
フィールド | |
---|---|
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 は次のいずれかになります。 |
|
structured_query |
構造化クエリ。クエリは、すべての子孫を含むコレクションを指定し、名前の昇順で並べる必要があります。その他のフィルタ、並べ替え、制限、オフセット、開始/終了カーソルはサポートされていません。 |
共用体フィールド consistency_selector 。このリクエストの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
read_time |
指定された時点のドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
PartitionQueryResponse
Firestore.PartitionQuery
に対するレスポンス。
フィールド | |
---|---|
partitions[] |
結果を分割します。各パーティションは、クエリ結果の開始点または終了点として RunQuery で使用できる分割ポイントです。RunQuery リクエストは、この PartitionQuery リクエストで指定したものと同じクエリを使用して実行する必要があります。パーティション カーソルは、PartitionQuery に渡されたクエリの結果と同じ順序に従って並べ替えられます。 たとえば、PartitionQuery 要求がパーティション カーソル A と B を返す場合、次の 3 つのクエリを実行すると、元のクエリの結果セット全体が返されます。
空の結果は、クエリに含まれる結果が少なすぎてパーティショニングできないか、クエリがパーティショニングでまだサポートされていないことを示している可能性があります。 |
next_page_token |
PartitionQuery リクエストで |
PlanSummary
クエリのプランニング フェーズの情報。
フィールド | |
---|---|
indexes_used[] |
クエリに対して選択されたインデックス。For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] |
Precondition
ドキュメントの前提条件。条件付きオペレーションに使用します。
フィールド | |
---|---|
共用体フィールド condition_type 。前提条件のタイプ。condition_type は次のいずれかになります。 |
|
exists |
|
update_time |
設定する場合、ターゲット ドキュメントが存在し、かつその時点で最終更新日になっている必要があります。タイムスタンプはマイクロ秒に揃える必要があります。 |
RollbackRequest
Firestore.Rollback
のリクエスト。
フィールド | |
---|---|
database |
必須。データベース名。形式は |
transaction |
必須。ロールバックするトランザクション。 |
RunAggregationQueryRequest
Firestore.RunAggregationQuery
のリクエスト。
フィールド | |
---|---|
parent |
必須。親リソース名。形式は |
explain_options |
省略可。クエリのオプションについて説明します。設定すると、追加のクエリ統計情報が返されます。そうでない場合は、クエリ結果のみが返されます。 |
共用体フィールド query_type 。実行するクエリ。query_type は次のいずれかになります。 |
|
structured_aggregation_query |
集計クエリ。 |
共用体フィールド consistency_selector 。クエリの整合性モード。デフォルトは強整合性です。consistency_selector は次のいずれかになります。 |
|
transaction |
すでにアクティブなトランザクション内で集計を実行します。 この値は、クエリを実行する不透明トランザクション ID です。 |
new_transaction |
クエリの一部として新しいトランザクションを開始します。デフォルトは読み取り専用です。 新しいトランザクション ID は、ストリーム内の最初のレスポンスとして返されます。 |
read_time |
指定されたタイムスタンプでクエリを実行します。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
RunAggregationQueryResponse
Firestore.RunAggregationQuery
に対するレスポンス。
フィールド | |
---|---|
result |
単一の集計結果。 部分的な進捗状況を報告する場合は表示されません。 |
transaction |
このリクエストの一部として開始されたトランザクション。 リクエストが新しいトランザクションの開始をリクエストしたときの最初のレスポンスにのみ存在します。 |
read_time |
集計結果が計算された時刻。これは常に単調に増加します。この場合、結果ストリームの以前の AggregationResult は、 クエリが結果を返さない場合、 |
explain_metrics |
クエリ説明の指標。これは、 |
RunQueryRequest
Firestore.RunQuery
のリクエスト。
フィールド | |
---|---|
parent |
必須。親リソース名。形式は |
explain_options |
省略可。クエリのオプションについて説明します。設定すると、追加のクエリ統計情報が返されます。そうでない場合は、クエリ結果のみが返されます。 |
共用体フィールド query_type 。実行するクエリ。query_type は次のいずれかになります。 |
|
structured_query |
構造化クエリ。 |
共用体フィールド consistency_selector 。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
transaction |
すでにアクティブなトランザクション内でクエリを実行します。 この値は、クエリを実行する不透明トランザクション ID です。 |
new_transaction |
新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトは読み取り専用トランザクションです。新しいトランザクション ID は、ストリーム内の最初のレスポンスとして返されます。 |
read_time |
指定された時点のドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
RunQueryResponse
Firestore.RunQuery
に対するレスポンス。
フィールド | |
---|---|
transaction |
このリクエストの一部として開始されたトランザクション。リクエストで |
document |
クエリ結果。部分的な進行状況を報告する場合は設定されません。 |
read_time |
ドキュメントが読み取られた時刻。これは単調に増加する可能性があります。この場合、結果ストリーム内の以前のドキュメントは、 クエリが結果を返さない場合、 |
skipped_results |
最後のレスポンスと現在のレスポンスとの間のオフセットが原因でスキップされた結果の数。 |
explain_metrics |
クエリ説明の指標。これは、 |
共用体フィールド continuation_selector 。クエリの継続モード。存在する場合は、現在のクエリ レスポンス ストリームが終了したことを示します。これは、document の有無にかかわらず設定できますが、設定するとそれ以上結果は返されません。continuation_selector は次のいずれかになります。 |
|
done |
存在する場合、Firestore はリクエストを完全に終了し、ドキュメントは返されません。 |
StructuredAggregationQuery
StructuredQuery
に対して集計を実行するための Firestore クエリ。
フィールド | |
---|---|
aggregations[] |
省略可。 必須の要素
|
共用体フィールド query_type 。集計する基本クエリ。query_type は次のいずれかになります。 |
|
structured_query |
ネストされた構造化クエリ。 |
集計
単一の結果を生成する集計を定義します。
フィールド | |
---|---|
alias |
省略可。集計の結果を格納するフィールドの名前(省略可)。 指定しない場合、Firestore は
は、次のようになります:
必須の要素
|
共用体フィールド operator 。実行する集計のタイプ(必須)。operator は次のいずれかになります。 |
|
count |
カウント アグリゲータ。 |
sum |
合計値。 |
avg |
平均的なアグリゲータ。 |
Avg
リクエストされたフィールドの値の平均。
数値のみが集計されます。
NULL
を含む、数値以外の値はすべてスキップされます。集計値に
NaN
が含まれている場合は、NaN
を返します。無限大の計算は IEEE-754 標準に準拠しています。集計値セットが空の場合は、
NULL
を返します。結果は常に double として返されます。
フィールド | |
---|---|
field |
集計対象のフィールド。 |
数
クエリに一致するドキュメントの数。
COUNT(*)
集計関数はドキュメント全体に対して動作するため、フィールド参照は必要ありません。
フィールド | |
---|---|
up_to |
省略可。カウントするドキュメントの最大数に関するオプションの制約。 これにより、スキャンするドキュメントの数に上限を設定し、レイテンシとコストを抑えることができます。 [指定なし] は、範囲なしと解釈されます。 大まかな例:
必須の要素
|
合計
リクエストされたフィールドの値の合計。
数値のみが集計されます。
NULL
を含む、数値以外の値はすべてスキップされます。集計値に
NaN
が含まれている場合は、NaN
を返します。無限大の計算は IEEE-754 標準に準拠しています。集計値セットが空の場合は 0 を返します。
集計された数値がすべて整数で、合計結果がオーバーフローしない場合、64 ビットの整数を返します。それ以外の場合、結果は double として返されます。なお、すべての集計値が整数であっても、64 ビット符号付き整数に収まらない場合は、結果が double として返されます。この場合、返される値の精度は低下します。
アンダーフローが発生した場合、浮動小数点集計は非決定的です。つまり、基になる値を変更せずに同じクエリを繰り返し実行すると、毎回わずかに異なる結果が生じる可能性があります。そのような場合、値は浮動小数点数ではなく整数として格納する必要があります。
フィールド | |
---|---|
field |
集計対象のフィールド。 |
StructuredQuery
Firestore クエリ。
クエリステージは、次の順序で実行されます。1. から 2. ここで、3. select 4. order_by + start_at + end_at 5. offset 6. limit
フィールド | |
---|---|
select |
省略可能で、返されるフィールドのサブセットです。 これは、クエリから返されるドキュメントに対する |
from[] |
クエリ対象のコレクション。 |
where |
適用するフィルタ。 |
order_by[] |
クエリ結果に適用する順序。 Firestore では、呼び出し元は、完全な順序付け、部分的な順序付け、または順序付けのまったく提供なしにできます。いずれの場合も、Firestore では次のルールを通じて安定した順序が保証されます。
フィールドには、最後に指定された順序と同じ並べ替え方向で追加されます。順序が指定されていない場合は「ASCENDING」になります。次に例を示します。
|
start_at |
結果セット内でクエリを開始する位置の接頭辞。 結果セットの順序は、元のクエリの
このクエリの結果は カーソルは、位置の完全な順序または接頭辞を参照できますが、指定された 上記の例に続き、次の開始カーソルをアタッチした場合の影響は異なります。
スキップするために最初の N 件の結果をスキャンする 必須の要素
|
end_at |
結果セット内でクエリを終了する位置の接頭辞。
必須の要素
|
offset |
最初の結果を返すまでにスキップするドキュメントの数。 これは、 必須の要素
|
limit |
返される結果の最大件数です。 他のすべての制約の後に適用されます。 必須の要素
|
find_nearest |
省略可。潜在的な最近傍探索。 他のすべてのフィルタと順序の後に適用されます。 指定されたクエリベクトルに最も近いベクトル エンベディングを見つけます。 |
CollectionSelector
コレクションの選択(messages as m1
など)。
フィールド | |
---|---|
collection_id |
コレクション ID。設定すると、この ID のコレクションのみが選択されます。 |
all_descendants |
false の場合、含まれる |
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 は次のいずれかになります。 |
|
composite_filter |
複合フィルタ。 |
field_filter |
ドキュメント フィールドのフィルタ。 |
unary_filter |
1 つの引数のみを取るフィルタ。 |
FindNearest
最近傍検索の設定。
フィールド | |
---|---|
vector_field |
必須。検索対象のインデックス付きベクトル フィールド。次元数が query_vector と一致するベクトルを含むドキュメントのみが返されます。 |
query_vector |
必須。検索対象のクエリベクトル。2,048 次元以下のベクトルにする必要があります。 |
distance_measure |
必須。使用する距離の測定値(必須)。 |
limit |
必須。返される最近傍の数。1,000 以下の正の整数を指定する必要があります。 |
DistanceMeasure
ベクトルを比較するときに使用する距離の測定値。
列挙型 | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
設定しないでください。 |
EUCLIDEAN |
ベクトル間の EUCLIDEAN 距離を測定します。詳しくはユークリッドをご覧ください。 |
COSINE |
ベクトル間の角度に基づいてベクトルを比較します。これにより、ベクトルの大きさに基づかない類似性を測定できます。COSINE 距離ではなく単位正規化ベクトルで DOT_PRODUCT を使用することをおすすめします。COSINE 距離は数学的に同等でパフォーマンスが向上します。詳しくは、コサイン類似度をご覧ください。 |
DOT_PRODUCT |
コサインに似ていますが、ベクトルの大きさの影響を受けます。詳しくは、ドットプロダクトをご覧ください。 |
注文
フィールド上の注文。
フィールド | |
---|---|
field |
並べ替えるフィールド。 |
direction |
並べ替える方向。デフォルトは |
投影
返されるドキュメントのフィールドの射影。
フィールド | |
---|---|
fields[] |
返されるフィールド。 空の場合、すべてのフィールドが返されます。ドキュメントの名前のみを返すには、 |
UnaryFilter
単一のオペランドを持つフィルタ。
フィールド | |
---|---|
op |
適用する単項演算子。 |
共用体フィールド operand_type 。フィルタの引数。operand_type は次のいずれかになります。 |
|
field |
演算子を適用するフィールド。 |
演算子
単項演算子。
列挙型 | |
---|---|
OPERATOR_UNSPECIFIED |
指定なし。この値は使用しないでください。 |
IS_NAN |
指定された field は NaN と等しくなります。 |
IS_NULL |
指定された field は NULL と等しくなります。 |
IS_NOT_NAN |
指定された 必須の要素
|
IS_NOT_NULL |
指定された 必須の要素
|
Target
リッスンするドキュメントのセットの仕様。
フィールド | |
---|---|
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 |
ターゲットには、ターゲットがストリームに追加される前に commit されたすべての変更が反映されます。 これは、ターゲットが追加された時間以降の read-after-write セマンティクスが必要な場合は、リスナーでこの変更を待機できます。 |
RESET |
ターゲットはリセットされました。以降の変更ではターゲットの新しい初期状態が返されます。 初期状態が完了すると、以前にターゲットが |
TransactionOptions
新しいトランザクションを作成するためのオプション。
フィールド | |
---|---|
共用体フィールド mode 。トランザクションのモード。mode は次のいずれかになります。 |
|
read_only |
このトランザクションは読み取りオペレーションにのみ使用できます。 |
read_write |
このトランザクションは読み取りオペレーションと書き込みオペレーションの両方に使用できます。 |
ReadOnly
ドキュメントの読み取りにのみ使用できるトランザクションのオプション。
フィールド | |
---|---|
共用体フィールド consistency_selector 。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。 |
|
read_time |
指定された時刻にドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒の精度のタイムスタンプにする必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間以内の 1 分単位のタイムスタンプにすることもできます。 |
ReadWrite
ドキュメントの読み取りと書き込みに使用できるトランザクションのオプション。
Firestore では、サードパーティの認証リクエストによる読み取り / 書き込みトランザクションの作成は許可されていません。
フィールド | |
---|---|
retry_transaction |
再試行するオプションのトランザクション。 |
UpdateDocumentRequest
Firestore.UpdateDocument
のリクエスト。
フィールド | |
---|---|
document |
必須。更新されたドキュメント。ドキュメントを作成します(まだ存在しない場合)。 |
update_mask |
更新するフィールド。マスク内のフィールドパスに予約済みの名前を含めることはできません。 ドキュメントがサーバー上に存在し、マスクで参照されていないフィールドがある場合、それらは変更されません。マスクで参照されているが入力ドキュメントに存在しないフィールドは、サーバー上のドキュメントから削除されます。 |
mask |
返されるフィールド。設定されていない場合は、すべてのフィールドが返されます。 このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドはレスポンスで返されません。 |
current_document |
ドキュメントの前提条件(省略可)。これが設定されていて、ターゲット ドキュメントでこれが満たされていない場合、リクエストは失敗します。 |
値
サポートされている値の型をすべて保持できるメッセージ。
フィールド | |
---|---|
共用体フィールド value_type 。値を設定する必要があります。value_type は次のいずれかになります。 |
|
null_value |
null 値。 |
boolean_value |
ブール値。 |
integer_value |
整数値。 |
double_value |
double 値。 |
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 |
地表面上の 1 点を表す地理的位置の値。 |
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 |
この書き込みリクエストに関連付けられているラベル。 |
WriteResponse
Firestore.Write
に対するレスポンス。
フィールド | |
---|---|
stream_id |
ストリームの ID。新しいストリームが作成されたときの最初のメッセージでのみ設定されます。 |
stream_token |
ストリーム内でのこのレスポンスの位置を表すトークン。クライアントはこれを使用して、この時点でストリームを再開できます。 このフィールドは常に設定されます。 |
write_results[] |
書き込みを適用した結果。 この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。 |
commit_time |
commit が発生した時刻。 |
WriteResult
書き込みを適用した結果。
フィールド | |
---|---|
update_time |
書き込みを適用した後のドキュメントの最終更新時間。 書き込みによって実際にドキュメントが変更されていない場合は、前の update_time になります。 |
transform_results[] |
各 |