Firestore API - Class CollectionReference (3.3.0)

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

Implements

IEquatable Query, IEquatable CollectionReference, IComparable CollectionReference

Inherited Members

Query.Database

Query.Select(params string[])

Query.Select(params FieldPath[])

Query.WhereEqualTo(string, object)

Query.WhereEqualTo(FieldPath, object)

Query.WhereNotEqualTo(string, object)

Query.WhereNotEqualTo(FieldPath, object)

Query.WhereLessThan(string, object)

Query.WhereLessThan(FieldPath, object)

Query.WhereLessThanOrEqualTo(string, object)

Query.WhereLessThanOrEqualTo(FieldPath, object)

Query.WhereGreaterThan(string, object)

Query.WhereGreaterThan(FieldPath, object)

Query.WhereGreaterThanOrEqualTo(string, object)

Query.WhereGreaterThanOrEqualTo(FieldPath, object)

Query.WhereArrayContains(string, object)

Query.WhereArrayContains(FieldPath, object)

Query.WhereArrayContainsAny(string, IEnumerable)

Query.WhereArrayContainsAny(FieldPath, IEnumerable)

Query.WhereIn(string, IEnumerable)

Query.WhereIn(FieldPath, IEnumerable)

Query.WhereNotIn(string, IEnumerable)

Query.WhereNotIn(FieldPath, IEnumerable)

Query.Count()

Query.Where(Filter)

Query.OrderBy(string)

Query.OrderByDescending(string)

Query.OrderBy(FieldPath)

Query.OrderByDescending(FieldPath)

Query.Limit(int)

Query.LimitToLast(int)

Query.Offset(int)

Query.StartAt(params object[])

Query.StartAfter(params object[])

Query.EndBefore(params object[])

Query.EndAt(params object[])

Query.StartAt(DocumentSnapshot)

Query.StartAfter(DocumentSnapshot)

Query.EndBefore(DocumentSnapshot)

Query.EndAt(DocumentSnapshot)

Query.GetSnapshotAsync(CancellationToken)

Query.StreamAsync(CancellationToken)

Query.Listen(Func<QuerySnapshot, CancellationToken, Task>, CancellationToken)

Query.Listen(Action<QuerySnapshot>, CancellationToken)

object.GetType()

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
Type	Description
`string`

Parent

public DocumentReference Parent { get; }

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

Property Value
Type	Description
`DocumentReference`

Path

public string Path { get; }

The complete collection path, including project and database ID.

Property Value
Type	Description
`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
Name	Description
`documentData`	`object` The data for the document. Must not be null.
`cancellationToken`	`CancellationToken` A cancellation token to monitor for the asynchronous operation.

Returns
Type	Description
`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)

Parameter
Name	Description
`other`	`CollectionReference`

Returns
Type	Description
`int`

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
Type	Description
`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
Name	Description
`path`	`string` 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
Type	Description
`DocumentReference`	A DocumentReference for the specified document.

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

Query.GetHashCode()

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
Type	Description
`IAsyncEnumerableDocumentReference`	A lazily-iterated sequence of document references within this collection.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()