Class BaseDocumentReference (2.17.0)

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

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

Properties

id

The document identifier (within its collection).

Returns
Type	Description
str	The last component of the path.

parent

Collection that owns the current document.

Returns
Type	Description
CollectionReference	The parent collection.

path

Database-relative for this document.

Returns
Type	Description
str	The document's relative path.

Methods

__copy__

__copy__()

Shallow copy the instance.

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

Returns
Type	Description
.DocumentReference	A 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
Type	Description
.DocumentReference	A copy of the current document.

__eq__

__eq__(other)

Equality check against another instance.

Parameter
Name	Description
other	Any A value to compare against.

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

__ne__

__ne__(other)

Inequality check against another instance.

Parameter
Name	Description
other	Any A value to compare against.

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

collection

collection(collection_id: str) -> typing.Any

Create a sub-collection underneath the current document.

Parameter
Name	Description
collection_id	str The sub-collection identifier (sometimes referred to as the "kind").

Returns
Type	Description
CollectionReference	The child collection.