Module documents

Firestore Document Access

Interact with Firestore documents. Please check the root page of this documentation for examples.

Structs

Query

This type is returned as a result by query. Use it as an iterator. The query API returns a list of document references, not the documents itself.

WriteOptions

Write options. The default will overwrite a target document and not merge fields.

WriteResult

This is returned by the write() method in a successful case.

Traits

JoinableIterator

An Iterator implementation that provides a join method

Functions

abs_to_rel

Converts an absolute path like “projects/{PROJECT_ID}/databases/(default)/documents/my_collection/document_id” into a relative document path like “my_collection/document_id”

contents

Return the raw unparsed content of the Firestore document. Methods like read() will deserialize the JSON-encoded response into a known type T

delete

Deletes the document at the given path.

list

List all documents of a given collection.

query

Queries the database for specific documents, for example all documents in a collection of ‘type’ == “car”.

read

Read a document of a specific type from a collection

read_by_name

Read a document of a specific type from a collection by its Firestore document name

write

Write a document to a given collection.