Skip to content

Commit

Permalink
Firestore: Small Count API documentation improvements (#12254)
Browse files Browse the repository at this point in the history
  • Loading branch information
dconeybe authored Jan 10, 2024
1 parent 7db032c commit 4ae0c5d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ typedef NS_ENUM(NSUInteger, FIRAggregateSource) {
* The result received from the server is presented, unaltered, without considering any local
* state. That is, documents in the local cache are not taken into consideration, neither are
* local modifications not yet synchronized with the server. Previously-downloaded results, if
* any, are not used: every request using this source necessarily involves a round trip to the
* any, are not used. Every request using this source necessarily involves a round trip to the
* server.
*
* The `AggregateQuery` will fail if the server cannot be reached, such as if the client is
Expand Down
15 changes: 8 additions & 7 deletions Firestore/Source/Public/FirebaseFirestore/FIRQuery.h
Original file line number Diff line number Diff line change
Expand Up @@ -556,22 +556,23 @@ NS_SWIFT_NAME(Query)
#pragma mark - Aggregation

/**
* A query that counts the documents in the result set of this query, without actually downloading
* A query that counts the documents in the result set of this query without actually downloading
* the documents.
*
* Using this `AggregateQuery` to count the documents is efficient because only the final count,
* not the documents' data, is downloaded. This allows for counting document collections that would
* otherwise be too large to download (e.g. containing thousands of documents).
* Using this `AggregateQuery` to count the documents is efficient because only the final count, not
* the documents' data, is downloaded. The `AggregateQuery` can count the documents in cases where
* the result set is prohibitively large to download entirely (thousands of documents).
*/
@property(nonatomic, readonly) FIRAggregateQuery *count;

/**
* Creates and returns a new `AggregateQuery` that aggregates the documents in the result set
* of this query, without actually downloading the documents.
* of this query without actually downloading the documents.
*
* Using an `AggregateQuery` to perform aggregations is efficient because only the final aggregation
* values, not the documents' data, is downloaded. This allows for aggregating document collections
* that would otherwise be too large to download (e.g. containing thousands of documents).
* values, not the documents' data, is downloaded. The returned `AggregateQuery` can perform
* aggregations of the documents in cases where the result set is prohibitively large to download
* entirely (thousands of documents).
*
* @param aggregateFields Specifies the aggregate operations to perform on the result set of this
* query.
Expand Down

0 comments on commit 4ae0c5d

Please sign in to comment.