Module base_collection (2.16.1)

Classes for representing collections for the Google Cloud Firestore API.

Classes

BaseCollectionReference(*path, **kwargs)

A reference to a collection in a Firestore database.

The collection may already exist or this class can facilitate creation of documents within the collection.

Parameters
Name	Description
`path`	`Tuple[str, ...]` The components in the collection 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.
`kwargs`	`dict` The keyword arguments for the constructor. The only supported keyword is `client` and it must be a Client if provided. It represents the client that created this collection 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.