Class BaseDocumentReference (2.5.0)

BaseDocumentReference(*path, **kwargs)

A reference to a document in a Firestore database.

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

Parameters

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

Inheritance

builtins.object > BaseDocumentReference

Properties

id

The document identifier (within its collection).

Returns
TypeDescription
strThe last component of the path.

parent

Collection that owns the current document.

Returns
TypeDescription
CollectionReferenceThe parent collection.

path

Database-relative for this document.

Returns
TypeDescription
strThe document's relative path.

Methods

__copy__

__copy__()

Shallow copy the instance.

We leave the client "as-is" but tuple-unpack the path.

Returns
TypeDescription
.DocumentReferenceA copy of the current document.

__deepcopy__

__deepcopy__(unused_memo)

Deep copy the instance.

This isn't a true deep copy, wee leave the client "as-is" but tuple-unpack the path.

Returns
TypeDescription
.DocumentReferenceA copy of the current document.

__eq__

__eq__(other)

Equality check against another instance.

Parameter
NameDescription
other Any

A value to compare against.

Returns
TypeDescription
Union[bool, NotImplementedType]Indicating if the values are equal.

__ne__

__ne__(other)

Inequality check against another instance.

Parameter
NameDescription
other Any

A value to compare against.

Returns
TypeDescription
Union[bool, NotImplementedType]Indicating if the values are not equal.

collection

collection(collection_id: str)

Create a sub-collection underneath the current document.

Parameter
NameDescription
collection_id str

The sub-collection identifier (sometimes referred to as the "kind").

Returns
TypeDescription
CollectionReferenceThe child collection.