Cloud Firestore Client - Class DocumentReference (1.53.1)

Reference documentation and code samples for the Cloud Firestore Client class DocumentReference.

Represents a reference to a Firestore document.

Example:

 use Google\Cloud\Firestore\FirestoreClient;

$firestore = new FirestoreClient();
$document = $firestore->document('users/john'); 

Returns the parent collection.

Example:

 $parent = $document->parent(); 

Get the document name.

Names are absolute. The result of this call would be of the form projects/<project-id>/databases/<database-id>/documents/<relative-path> .

Other methods are available to retrieve different parts of a collection name:

• DocumentReference::id() Returns the last element.
• DocumentReference::path() Returns the path, relative to the database.

Example:

 $name = $document->name(); 

Get the document path.

Paths identify the location of a document, relative to the database name.

To retrieve the document ID (the last element of the path), use DocumentReference::id() .

Example:

 $path = $document->path(); 

Get the document identifier (i.e. the last path element).

IDs are the path element which identifies a resource. To retrieve the path of a resource, relative to the database name, use DocumentReference::path() .

Example:

 $id = $document->id(); 

See also:

• Commit

See also:

• Commit

See also:

• Commit

See also:

• Commit

See also:

• BatchGetDocuments

Get a reference to a collection which is a child of the current document.

Example:

 $child = $document->collection('wallet'); 

List all collections which are children of the current document.

Example:

 $collections = $document->collections();