Class AsyncCollectionReference (2.13.1) 

AsyncCollectionReference(*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

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

Methods

add

add(
    document_data: dict,
    document_id: typing.Optional[str] = None,
    retry: google.api_core.retry.Retry = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.Tuple[typing.Any, typing.Any]

Create a document in the Firestore database with the provided data.

Parameters
NameDescription
document_data dict

Property names and values to use for creating the document.

document_id Optional[str]

The document identifier within the current collection. If not provided, an ID will be automatically assigned by the server (the assigned ID will be a random 20 character string composed of digits, uppercase and lowercase letters).

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried. Defaults to a system-specified policy.

timeout float

The timeout for this request. Defaults to a system-specified value.

Exceptions
TypeDescription
google.cloud.exceptions.ConflictIf document_id is provided and the document already exists.
Returns
TypeDescription
Tuple[google.protobuf.timestamp_pb2.Timestamp, AsyncDocumentReference]Pair of * The update_time when the document was created/overwritten. * A document reference for the created document.

document

document(
    document_id: typing.Optional[str] = None,
) -> google.cloud.firestore_v1.async_document.AsyncDocumentReference

Create a sub-document underneath the current collection.

Parameter
NameDescription
document_id Optional[str]

The document identifier within the current collection. If not provided, will default to a random 20 character string composed of digits, uppercase and lowercase and letters.

Returns
TypeDescription
AsyncDocumentReferenceThe child document.

get

get(
    transaction: typing.Optional[
        google.cloud.firestore_v1.transaction.Transaction
    ] = None,
    retry: google.api_core.retry.Retry = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> list

Read the documents in this collection.

This sends a RunQuery RPC and returns a list of documents returned in the stream of RunQueryResponse messages.

Parameters
NameDescription
transaction Transaction

(Optional[Transaction]): An existing transaction that this query will run in.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried. Defaults to a system-specified policy.

timeout float If a transaction is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed).

The timeout for this request. Defaults to a system-specified value.

Returns
TypeDescription
listThe documents in this collection that match the query.

list_documents

list_documents(
    page_size: typing.Optional[int] = None,
    retry: google.api_core.retry.Retry = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.AsyncGenerator[google.cloud.firestore_v1.document.DocumentReference, None]

List all subdocuments of the current collection.

Parameters
NameDescription
page_size Optional[int]]

The maximum number of documents in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried. Defaults to a system-specified policy.

timeout float

The timeout for this request. Defaults to a system-specified value.

Returns
TypeDescription
Sequence[DocumentReference]iterator of subdocuments of the current collection. If the collection does not exist at the time of snapshot, the iterator will be empty

stream

stream(
    transaction: typing.Optional[
        google.cloud.firestore_v1.transaction.Transaction
    ] = None,
    retry: google.api_core.retry.Retry = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Optional[float] = None,
) -> typing.AsyncIterator[google.cloud.firestore_v1.base_document.DocumentSnapshot]

Read the documents in this collection.

This sends a RunQuery RPC and then returns an iterator which consumes each document returned in the stream of RunQueryResponse messages.

Parameters
NameDescription
transaction Optional[ Transaction]

An existing transaction that the query will run in.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried. Defaults to a system-specified policy.

timeout float :Yields: DocumentSnapshot -- The next document that fulfills the query.

The timeout for this request. Defaults to a system-specified value.