Module async_document (2.18.0)

Version 2.18.0

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

Classes for representing documents for the Google Cloud Firestore API.

Classes

AsyncDocumentReference

AsyncDocumentReference(*path, **kwargs)

A reference to a document in a Firestore database.

The document may already exist or can be created by this class.

Parameters
Name	Description
path	Tuple[str, ...] The components in the document path. This is a series of strings representing each collection and sub-collection ID, as well as the document IDs for any documents that contain a sub-collection (as well as the base document).
kwargs	dict The keyword arguments for the constructor. The only supported keyword is client and it must be a Client. It represents the client that created this document reference.

Exceptions
Type	Description
ValueError	if * the path is empty * there are an even number of elements * a collection ID in path is not a string * a document ID in path is not a string
TypeError	If a keyword other than client is used.