package google.firestore.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Firestore
firestore.proto:56The Cloud Firestore service. This service exposes several types of comparable timestamps: * `create_time` - The time at which a document was created. Changes only when a document is deleted, then re-created. Increases in a strict monotonic fashion. * `update_time` - The time at which a document was last updated. Changes every time a document is modified. Does not change when a write results in no modifications. Increases in a strict monotonic fashion. * `read_time` - The time at which a particular state was observed. Used to denote a consistent snapshot of the database or the time at which a Document was observed to not exist. * `commit_time` - The time at which the writes in a transaction were committed. Any read with an equal or greater `read_time` is guaranteed to see the effects of the transaction.
rpc GetDocument (, )
firestore.proto:63Gets a single document.
message
firestore.proto:176The request for [Firestore.GetDocument][google.firestore.v1beta1.Firestore.GetDocument].
string name = 1
The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
optional mask = 2
The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.
oneof consistency_selector
The consistency mode for this transaction. If not set, defaults to strong consistency.
bytes transaction = 3
Reads the document in a transaction.
read_time = 5
Reads the version of the document at the given time. This may not be older than 60 seconds.
rpc ListDocuments (, )
firestore.proto:70Lists documents.
message
firestore.proto:200The request for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].
string parent = 1
The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
string collection_id = 2
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
int32 page_size = 3
The maximum number of documents to return.
string page_token = 4
The `next_page_token` value returned from a previous List request, if any.
string order_by = 6
The order to sort results by. For example: `priority desc, name`.
optional mask = 7
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
oneof consistency_selector
The consistency mode for this transaction. If not set, defaults to strong consistency.
bytes transaction = 8
Reads documents in a transaction.
read_time = 10
Reads documents as they were at the given time. This may not be older than 60 seconds.
bool show_missing = 12
If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1beta1.Document.create_time], or [Document.update_time][google.firestore.v1beta1.Document.update_time] set. Requests with `show_missing` may not specify `where` or `order_by`.
message
firestore.proto:250The response for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].
repeated documents = 1
The Documents found.
string next_page_token = 2
The next page token.
rpc CreateDocument (, )
firestore.proto:77Creates a new document.
message
firestore.proto:259The request for [Firestore.CreateDocument][google.firestore.v1beta1.Firestore.CreateDocument].
string parent = 1
The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
string collection_id = 2
The collection ID, relative to `parent`, to list. For example: `chatrooms`.
string document_id = 3
The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
optional document = 4
The document to create. `name` must not be set.
optional mask = 5
The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.
rpc UpdateDocument (, )
firestore.proto:85Updates or inserts a document.
message
firestore.proto:284The request for [Firestore.UpdateDocument][google.firestore.v1beta1.Firestore.UpdateDocument].
optional document = 1
The updated document. Creates the document if it does not already exist.
optional update_mask = 2
The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.
optional mask = 3
The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.
optional current_document = 4
An optional precondition on the document. The request will fail if this is set and not met by the target document.
rpc DeleteDocument (, )
firestore.proto:93Deletes a document.
message
firestore.proto:310The request for [Firestore.DeleteDocument][google.firestore.v1beta1.Firestore.DeleteDocument].
string name = 1
The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
optional current_document = 2
An optional precondition on the document. The request will fail if this is set and not met by the target document.
rpc BatchGetDocuments (, stream )
firestore.proto:103Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
message
firestore.proto:321The request for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].
string database = 1
The database name. In the format: `projects/{project_id}/databases/{database_id}`.
repeated string documents = 2
The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
optional mask = 3
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
oneof consistency_selector
The consistency mode for this transaction. If not set, defaults to strong consistency.
bytes transaction = 4
Reads documents in a transaction.
new_transaction = 5
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
read_time = 7
Reads documents as they were at the given time. This may not be older than 60 seconds.
message
firestore.proto:357The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].
oneof result
A single result. This can be empty if the server is just returning a transaction.
found = 1
A document that was requested.
string missing = 2
A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
bytes transaction = 3
The transaction that was started as part of this request. Will only be set in the first response, and only if [BatchGetDocumentsRequest.new_transaction][google.firestore.v1beta1.BatchGetDocumentsRequest.new_transaction] was set in the request.
optional read_time = 4
The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.
rpc BeginTransaction (, )
firestore.proto:111Starts a new transaction.
message
firestore.proto:382The request for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction].
string database = 1
The database name. In the format: `projects/{project_id}/databases/{database_id}`.
optional options = 2
The options for the transaction. Defaults to a read-write transaction.
message
firestore.proto:393The response for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction].
bytes transaction = 1
The transaction that was started.
rpc Commit (, )
firestore.proto:119Commits a transaction, while optionally updating documents.
message
firestore.proto:399The request for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit].
string database = 1
The database name. In the format: `projects/{project_id}/databases/{database_id}`.
repeated writes = 2
The writes to apply. Always executed atomically and in order.
bytes transaction = 3
If set, applies all writes in this transaction, and commits it.
message
firestore.proto:414The response for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit].
repeated write_results = 1
The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
optional commit_time = 2
The time at which the commit occurred.
rpc Rollback (, )
firestore.proto:127Rolls back a transaction.
message
firestore.proto:426The request for [Firestore.Rollback][google.firestore.v1beta1.Firestore.Rollback].
string database = 1
The database name. In the format: `projects/{project_id}/databases/{database_id}`.
bytes transaction = 2
The transaction to roll back.
rpc RunQuery (, stream )
firestore.proto:135Runs a query.
message
firestore.proto:436The request for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
string parent = 1
The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
oneof query_type
The query to run.
structured_query = 2
A structured query.
oneof consistency_selector
The consistency mode for this transaction. If not set, defaults to strong consistency.
bytes transaction = 5
Reads documents in a transaction.
new_transaction = 6
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
read_time = 7
Reads documents as they were at the given time. This may not be older than 60 seconds.
message
firestore.proto:470The response for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
bytes transaction = 2
The transaction that was started as part of this request. Can only be set in the first response, and only if [RunQueryRequest.new_transaction][google.firestore.v1beta1.RunQueryRequest.new_transaction] was set in the request. If set, no other fields will be set in this response.
optional document = 1
A query result. Not set when reporting partial progress.
optional read_time = 3
The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.
int32 skipped_results = 4
The number of results that have been skipped due to an offset between the last response and the current response.
rpc Write (stream , stream )
firestore.proto:147Streams batches of document updates and deletes, in order.
message
firestore.proto:505The request for [Firestore.Write][google.firestore.v1beta1.Firestore.Write]. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.
string database = 1
The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message.
string stream_id = 2
The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.
repeated writes = 3
The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
bytes stream_token = 4
A stream token that was previously sent by the server. The client should set this field to the token from the most recent [WriteResponse][google.firestore.v1beta1.WriteResponse] it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream.
map<string, string> labels = 5
Labels associated with this write request.
message
firestore.proto:545The response for [Firestore.Write][google.firestore.v1beta1.Firestore.Write].
string stream_id = 1
The ID of the stream. Only set on the first message, when a new stream was created.
bytes stream_token = 2
A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.
repeated write_results = 3
The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
optional commit_time = 4
The time at which the commit occurred.
rpc Listen (stream , stream )
firestore.proto:155Listens to changes.
message
firestore.proto:567A request for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen]
string database = 1
The database name. In the format: `projects/{project_id}/databases/{database_id}`.
oneof target_change
The supported target changes.
add_target = 2
A target to add to this stream.
int32 remove_target = 3
The ID of a target to remove from this stream.
map<string, string> labels = 4
Labels associated with this target change.
message
firestore.proto:586The response for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen].
oneof response_type
The supported responses.
target_change = 2
Targets have changed.
document_change = 3
A [Document][google.firestore.v1beta1.Document] has changed.
document_delete = 4
A [Document][google.firestore.v1beta1.Document] has been deleted.
document_remove = 6
A [Document][google.firestore.v1beta1.Document] has been removed from a target (because it is no longer relevant to that target).
filter = 5
A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.
rpc ListCollectionIds (, )
firestore.proto:163Lists all the collection IDs underneath a document.
message
firestore.proto:736The request for [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds].
string parent = 1
The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
int32 page_size = 2
The maximum number of results to return.
string page_token = 3
A page token. Must be a value from [ListCollectionIdsResponse][google.firestore.v1beta1.ListCollectionIdsResponse].
message
firestore.proto:752The response from [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds].
repeated string collection_ids = 1
The collection ids.
string next_page_token = 2
A page token that may be used to continue the list.
message
document.proto:136An array value.
Used in: ,
repeated values = 1
Values in the array.
message
query.proto:233A position in a query result set.
Used in:
repeated values = 1
The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
bool before = 2
If the position is just before or just after the given values, relative to the sort order defined by the query.
message
document.proto:36A Firestore document. Must not exceed 1 MiB - 4 bytes.
Used as response type in: Firestore.CreateDocument, Firestore.GetDocument, Firestore.UpdateDocument
Used as field type in: , , , , , ,
string name = 1
The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
map<string, > fields = 2
The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
optional create_time = 3
Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
optional update_time = 4
Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.
message
write.proto:190A [Document][google.firestore.v1beta1.Document] has changed. May be the result of multiple [writes][google.firestore.v1beta1.Write], including deletes, that ultimately resulted in a new value for the [Document][google.firestore.v1beta1.Document]. Multiple [DocumentChange][google.firestore.v1beta1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.
Used in:
optional document = 1
The new state of the [Document][google.firestore.v1beta1.Document]. If `mask` is set, contains only fields that were updated or added.
repeated int32 target_ids = 5
A set of target IDs of targets that match this document.
repeated int32 removed_target_ids = 6
A set of target IDs for targets that no longer match this document.
message
write.proto:210A [Document][google.firestore.v1beta1.Document] has been deleted. May be the result of multiple [writes][google.firestore.v1beta1.Write], including updates, the last of which deleted the [Document][google.firestore.v1beta1.Document]. Multiple [DocumentDelete][google.firestore.v1beta1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.
Used in:
string document = 1
The resource name of the [Document][google.firestore.v1beta1.Document] that was deleted.
repeated int32 removed_target_ids = 6
A set of target IDs for targets that previously matched this entity.
optional read_time = 4
The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete.
message
common.proto:36A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a [Document][google.firestore.v1beta1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1beta1.Value].
Used in: , , , , ,
repeated string field_paths = 1
The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field path syntax reference.
message
write.proto:231A [Document][google.firestore.v1beta1.Document] has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple [DocumentRemove][google.firestore.v1beta1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.
Used in:
string document = 1
The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
repeated int32 removed_target_ids = 2
A set of target IDs for targets that previously matched this document.
optional read_time = 4
The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove.
message
write.proto:70A transformation of a document.
Used in:
string document = 1
The name of the document to transform.
repeated field_transforms = 2
The list of transformations to apply to the fields of the document, in order. This must not be empty.
message
write.proto:72A transformation of a field of the document.
Used in:
string field_path = 1
The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax reference.
oneof transform_type
The transformation to apply on the field.
FieldTransform.ServerValue set_to_server_value = 2
Sets the field to the given server value.
increment = 3
Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
maximum = 4
Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
minimum = 5
Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
append_missing_elements = 6
Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
remove_all_from_array = 7
Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
A value that is calculated by the server.
Used in:
SERVER_VALUE_UNSPECIFIED = 0
Unspecified. This value must not be used.
REQUEST_TIME = 1
The time at which the server processed the request, with millisecond precision.
message
write.proto:245A digest of all the documents that match a given target.
Used in:
int32 target_id = 1
The target ID to which this filter applies.
int32 count = 2
The total count of documents that match [target_id][google.firestore.v1beta1.ExistenceFilter.target_id]. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.
message
document.proto:142A map value.
Used in:
map<string, > fields = 1
The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
message
common.proto:43A precondition on a document, used for conditional operations.
Used in: , ,
oneof condition_type
The type of precondition.
bool exists = 1
When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
update_time = 2
When set, the target document must exist and have been last updated at that time.
message
query.proto:33A Firestore query.
Used in: ,
optional select = 1
The projection to return.
repeated from = 2
The collections to query.
optional where = 3
The filter to apply.
repeated order_by = 4
The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
optional start_at = 7
A starting point for the query results.
optional end_at = 8
A end point for the query results.
int32 offset = 6
The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
optional limit = 5
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
message
query.proto:35A selection of a collection, such as `messages as m1`.
Used in:
string collection_id = 2
The collection ID. When set, selects only collections with this ID.
bool all_descendants = 3
When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
message
query.proto:62A filter that merges multiple other filters using the given operator.
Used in:
CompositeFilter.Operator op = 1
The operator for combining multiple filters.
repeated filters = 2
The list of filters to combine. Must contain at least one filter.
A composite filter operator.
Used in:
OPERATOR_UNSPECIFIED = 0
Unspecified. This value must not be used.
AND = 1
The results are required to satisfy each of the combined filters.
A sort direction.
Used in:
DIRECTION_UNSPECIFIED = 0
Unspecified.
ASCENDING = 1
Ascending.
DESCENDING = 2
Descending.
message
query.proto:81A filter on a specific field.
Used in:
optional field = 1
The field to filter by.
FieldFilter.Operator op = 2
The operator to filter by.
optional value = 3
The value to compare to.
A field filter operator.
Used in:
OPERATOR_UNSPECIFIED = 0
Unspecified. This value must not be used.
LESS_THAN = 1
Less than. Requires that the field come first in `order_by`.
LESS_THAN_OR_EQUAL = 2
Less than or equal. Requires that the field come first in `order_by`.
GREATER_THAN = 3
Greater than. Requires that the field come first in `order_by`.
GREATER_THAN_OR_EQUAL = 4
Greater than or equal. Requires that the field come first in `order_by`.
EQUAL = 5
Equal.
ARRAY_CONTAINS = 7
Contains. Requires that the field is an array.
IN = 8
In. Requires that `value` is a non-empty ArrayValue with at most 10 values.
ARRAY_CONTAINS_ANY = 9
Contains any. Requires that the field is an array and `value` is a non-empty ArrayValue with at most 10 values.
message
query.proto:168A reference to a field, such as `max(messages.time) as max_time`.
Used in: , , ,
string field_path = 2
message
query.proto:47A filter.
Used in: ,
oneof filter_type
The type of filter.
composite_filter = 1
A composite filter.
field_filter = 2
A filter on a document field.
unary_filter = 3
A filter that takes exactly one argument.
message
query.proto:150An order on a field.
Used in:
optional field = 1
The field to order by.
Direction direction = 2
The direction to order by. Defaults to `ASCENDING`.
message
query.proto:159The projection of document's fields to return.
Used in:
repeated fields = 2
The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`.
message
query.proto:126A filter with a single operand.
Used in:
UnaryFilter.Operator op = 1
The unary operator to apply.
oneof operand_type
The argument to the filter.
field = 2
The field to which to apply the operator.
A unary operator.
Used in:
OPERATOR_UNSPECIFIED = 0
Unspecified. This value must not be used.
IS_NAN = 2
Test if a field is equal to NaN.
IS_NULL = 3
Test if an expression evaluates to Null.
message
firestore.proto:612A specification of a set of documents to listen to.
Used in:
oneof target_type
The type of target to listen to.
query = 2
A target specified by a query.
documents = 3
A target specified by a set of document names.
oneof resume_type
When to start listening. If not specified, all matching Documents are returned before any subsequent changes.
bytes resume_token = 4
A resume token from a prior [TargetChange][google.firestore.v1beta1.TargetChange] for an identical target. Using a resume token with a different target is unsupported and may fail.
read_time = 11
Start listening after a specific `read_time`. The client must know the state of matching documents at this time.
int32 target_id = 5
The target ID that identifies the target on the stream. Must be a positive number and non-zero.
bool once = 6
If the target should be removed once it is current and consistent.
message
firestore.proto:614A target specified by a set of documents names.
Used in:
repeated string documents = 2
The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
message
firestore.proto:623A target specified by a query.
Used in:
string parent = 1
The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
oneof query_type
The query to run.
structured_query = 2
A structured query.
message
firestore.proto:673Targets being watched have changed.
Used in:
TargetChange.TargetChangeType target_change_type = 1
The type of change that occurred.
repeated int32 target_ids = 2
The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined.
optional cause = 3
The error that resulted in this change, if applicable.
bytes resume_token = 4
A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change.
optional read_time = 6
The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing.
The type of change.
Used in:
NO_CHANGE = 0
No change has occurred. Used only to send an updated `resume_token`.
ADD = 1
The targets have been added.
REMOVE = 2
The targets have been removed.
CURRENT = 3
The targets reflect all changes committed before the targets were added to the stream. This will be sent after or with a `read_time` that is greater than or equal to the time at which the targets were added. Listeners can wait for this change if read-after-write semantics are desired.
RESET = 4
The targets have been reset, and a new initial state for the targets will be returned in subsequent changes. After the initial state is complete, `CURRENT` will be returned even if the target was previously indicated to be `CURRENT`.
message
common.proto:57Options for creating a new transaction.
Used in: , ,
oneof mode
The mode of the transaction.
read_only = 2
The transaction can only be used for read operations.
read_write = 3
The transaction can be used for both read and write operations.
message
common.proto:65Options for a transaction that can only be used to read documents.
Used in:
oneof consistency_selector
The consistency mode for this transaction. If not set, defaults to strong consistency.
read_time = 2
Reads documents at the given time. This may not be older than 60 seconds.
message
common.proto:59Options for a transaction that can be used to read and write documents.
Used in:
bytes retry_transaction = 1
An optional transaction to retry.
message
document.proto:83A message that can hold any of the supported value types.
Used in: , , , , , ,
oneof value_type
Must have a value set.
protobuf.NullValue null_value = 11
A null value.
bool boolean_value = 1
A boolean value.
int64 integer_value = 2
An integer value.
double double_value = 3
A double value.
timestamp_value = 10
A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
string string_value = 17
A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
bytes bytes_value = 18
A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
string reference_value = 5
A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
geo_point_value = 8
A geo point value representing a point on the surface of Earth.
array_value = 9
An array value. Cannot directly contain another array value, though can contain an map which contains another array.
map_value = 6
A map value.
message
write.proto:34A write on a document.
Used in: ,
oneof operation
The operation to execute.
update = 1
A document to write.
string delete = 2
A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
transform = 6
Applies a transformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request.
optional update_mask = 3
The fields to update in this write. This field can be set only when the operation is `update`. If the mask is not set for an `update` and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.
optional current_document = 4
An optional precondition on the document. The write will fail if this is set and not met by the target document.
message
write.proto:170The result of applying a write.
Used in: ,
optional update_time = 1
The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time.
repeated transform_results = 2
The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], in the same order.