package firestore

Get desktop application:
View/edit binary Protocol Buffers messages

A Firestore bundle is a length-prefixed stream of JSON representations of `BundleElement`. Only one `BundleMetadata` is expected, and it should be the first element. The named queries follow after `metadata`. If a document exists when the bundle is built, `document_metadata` is immediately followed by the `document`, otherwise `document_metadata` will present by itself.

• oneof element_type

  • BundleMetadata metadata = 1

  • NamedQuery named_query = 2

  • BundledDocumentMetadata document_metadata = 3

  • google.firestore.v1.Document document = 4

Metadata describing the bundle file/stream.

Used in: BundleElement

• string id = 1

  The ID of the bundle.

• optional google.protobuf.Timestamp create_time = 2

  Time at which the documents snapshot is taken for this bundle.

• uint32 version = 3

  The schema version of the bundle.

• uint32 total_documents = 4

  The number of documents in the bundle.

• uint64 total_bytes = 5

  The size of the bundle in bytes, excluding this `BundleMetadata`.

Metadata describing a Firestore document saved in the bundle.

Used in: BundleElement

• string name = 1

  The document key of a bundled document.

• optional google.protobuf.Timestamp read_time = 2

  The snapshot version of the document data bundled.

• bool exists = 3

  Whether the document exists.

• repeated string queries = 4

  The names of the queries in this bundle that this document matches to.

Describes a query saved in the bundle.

Used in: NamedQuery

• string parent = 1

  The parent resource name.

• oneof query_type

  The query to run.

  • google.firestore.v1.StructuredQuery structured_query = 2

    A structured query.

• BundledQuery.LimitType limit_type = 3

If the query is a limit query, should the limit be applied to the beginning or the end of results.

Used in: BundledQuery

• FIRST = 0

• LAST = 1

A Query associated with a name, created as part of the bundle file, and can be read by client SDKs once the bundle containing them is loaded.

Used in: BundleElement

• string name = 1

  Name of the query, such that client can use the name to load this query from bundle, and resume from when the query results are materialized into this bundle.

• optional BundledQuery bundled_query = 2

  The query saved in the bundle.

• optional google.protobuf.Timestamp read_time = 3

  The read time of the query, when it is used to build the bundle. This is useful to resume the query from the bundle, once it is loaded by client SDKs.