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 |
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. |