Firestore API - Class CollectionReference (3.5.1)

public sealed class CollectionReference : Query, IEquatable<Query>, IEquatable<CollectionReference>, IComparable<CollectionReference>

Reference documentation and code samples for the Firestore API class CollectionReference.

A reference to a collection in a Firestore database. The existence of this object does not imply that the collection currently exists in storage.

Inheritance

object > Query > CollectionReference

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Properties

Id

public string Id { get; }

The final part of the complete collection path; this is the identity of the collection relative to its parent document.

Property Value
TypeDescription
string

Parent

public DocumentReference Parent { get; }

The parent document, or null if this is a root collection.

Property Value
TypeDescription
DocumentReference

Path

public string Path { get; }

The complete collection path, including project and database ID.

Property Value
TypeDescription
string

Methods

AddAsync(object, CancellationToken)

public Task<DocumentReference> AddAsync(object documentData, CancellationToken cancellationToken = default)

Asynchronously creates a document with the given data in this collection. The document has a randomly generated ID.

Parameters
NameDescription
documentDataobject

The data for the document. Must not be null.

cancellationTokenCancellationToken

A cancellation token to monitor for the asynchronous operation.

Returns
TypeDescription
TaskDocumentReference

The reference for the newly-created document.

Remarks

If the WriteResult for the operation is required, use CreateAsync(object, CancellationToken) instead of this method.

CompareTo(CollectionReference)

public int CompareTo(CollectionReference other)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameter
NameDescription
otherCollectionReference

An object to compare with this instance.

Returns
TypeDescription
int

A value that indicates the relative order of the objects being compared. The return value has these meanings:
Value

Meaning

Less than zero

This instance precedes other in the sort order.

Zero

This instance occurs in the same position in the sort order as other.

Greater than zero

This instance follows other in the sort order.

Document()

public DocumentReference Document()

Creates a DocumentReference for a direct child document of this collection with a random ID. This performs no server-side operations; it only generates the appropriate DocumentReference.

Returns
TypeDescription
DocumentReference

A DocumentReference to a child document of this collection with a random ID.

Document(string)

public DocumentReference Document(string path)

Creates a DocumentReference for a child document of this reference.

Parameter
NameDescription
pathstring

The path to the document, relative to this collection. Must not be null, and must contain an odd number of slash-separated path elements.

Returns
TypeDescription
DocumentReference

A DocumentReference for the specified document.

GetHashCode()

public override int GetHashCode()

Serves as the default hash function.

Returns
TypeDescription
int

A hash code for the current object.

Overrides

ListDocumentsAsync()

public IAsyncEnumerable<DocumentReference> ListDocumentsAsync()

Lists the documents in this collection. The results include documents which don't exist in their own right, but which have nested documents which do exist.

Returns
TypeDescription
IAsyncEnumerableDocumentReference

A lazily-iterated sequence of document references within this collection.

ToString()

public override string ToString()

Returns a string that represents the current object.

Returns
TypeDescription
string

A string that represents the current object.

Overrides