Firestore: Small Count API documentation improvements#5634
Merged
Conversation
Contributor
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateSource.html 2024-01-10 18:07:39.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateSource.html 2024-01-10 18:05:55.000000000 +0000
@@ -88,7 +88,7 @@
<h3 class="api-name" id="SERVER">SERVER</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateSource.html">AggregateSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateSource.html#SERVER">AggregateSource.SERVER</a></pre>
<p>Perform the aggregation on the server and download the result. </p>
- <p>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 server. </p>
+ <p>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 server. </p>
<p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code> will fail if the server cannot be reached, such as if the client is offline.</p>
</div>
</div>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/CollectionReference.html 2024-01-10 18:07:39.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/CollectionReference.html 2024-01-10 18:05:55.000000000 +0000
@@ -182,7 +182,7 @@
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> AggregateField[] aggregateFields<br>)</code></div>
- <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</p>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.</p>
</td>
</tr>
<tr>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/Query.html 2024-01-10 18:07:39.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/Query.html 2024-01-10 18:05:55.000000000 +0000
@@ -136,7 +136,7 @@
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> AggregateField[] aggregateFields<br>)</code></div>
- <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</p>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.</p>
</td>
</tr>
<tr>
@@ -811,8 +811,8 @@
<div class="api-item"><a name="aggregate(com.google.firebase.firestore.AggregateField, com.google.firebase.firestore.AggregateField...)"></a><a name="aggregate-com.google.firebase.firestore.AggregateField-com.google.firebase.firestore.AggregateField...-"></a><a name="aggregate"></a>
<h3 class="api-name" id="aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</h3>
<pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> AggregateField[] aggregateFields<br>)</pre>
- <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents. </p>
- <p>Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. This function can even perform aggregations of the documents if the result set would be prohibitively large to download entirely (like thousands of documents).</p>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents. </p>
+ <p>Using the returned query to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. The returned query can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -840,7 +840,7 @@
<pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html#count()">count</a>()</pre>
<p>Returns a query that counts the documents in the result set of this query. </p>
<p>The returned query, when executed, counts the documents in the result set of this query <em>without actually downloading the documents</em>. </p>
- <p>Using the returned query to count the documents is efficient because only the final count, not the documents' data, is downloaded. The returned query can even count the documents if the result set would be prohibitively large to download entirely (like thousands of documents).</p>
+ <p>Using the returned query to count the documents is efficient because only the final count, not the documents' data, is downloaded. The returned query can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateSource.html 2024-01-10 18:07:39.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateSource.html 2024-01-10 18:05:55.000000000 +0000
@@ -88,7 +88,7 @@
<h3 class="api-name" id="SERVER">SERVER</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateSource.html#SERVER">AggregateSource.SERVER</a>: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateSource.html">AggregateSource</a></pre>
<p>Perform the aggregation on the server and download the result. </p>
- <p>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 server. </p>
+ <p>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 server. </p>
<p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code> will fail if the server cannot be reached, such as if the client is offline.</p>
</div>
</div>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/CollectionReference.html 2024-01-10 18:07:39.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/CollectionReference.html 2024-01-10 18:05:55.000000000 +0000
@@ -151,7 +151,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>,<br> aggregateFields: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!><br>)</code></div>
- <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</p>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.</p>
</td>
</tr>
<tr>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/Query.html 2024-01-10 18:07:39.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/Query.html 2024-01-10 18:05:55.000000000 +0000
@@ -115,7 +115,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>,<br> aggregateFields: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!><br>)</code></div>
- <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</p>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.</p>
</td>
</tr>
<tr>
@@ -797,8 +797,8 @@
<div class="api-item"><a name="aggregate(com.google.firebase.firestore.AggregateField, com.google.firebase.firestore.AggregateField...)"></a><a name="aggregate-com.google.firebase.firestore.AggregateField-com.google.firebase.firestore.AggregateField...-"></a><a name="aggregate"></a>
<h3 class="api-name" id="aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>,<br> aggregateFields: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></pre>
- <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents. </p>
- <p>Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. This function can even perform aggregations of the documents if the result set would be prohibitively large to download entirely (like thousands of documents).</p>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents. </p>
+ <p>Using the returned query to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. The returned query can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -826,7 +826,7 @@
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#count()">count</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></pre>
<p>Returns a query that counts the documents in the result set of this query. </p>
<p>The returned query, when executed, counts the documents in the result set of this query <em>without actually downloading the documents</em>. </p>
- <p>Using the returned query to count the documents is efficient because only the final count, not the documents' data, is downloaded. The returned query can even count the documents if the result set would be prohibitively large to download entirely (like thousands of documents).</p>
+ <p>Using the returned query to count the documents is efficient because only the final count, not the documents' data, is downloaded. The returned query can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup> |
Contributor
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. |
1 similar comment
Contributor
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. |
Collaborator
Coverage Report 1Affected Products
Test Logs
|
Contributor
Collaborator
Size Report 1Affected ProductsNo changes between base commit (ba067b5) and merge commit (44f5521).Test Logs
|
Collaborator
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
tom-andersen
approved these changes
Jan 10, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Apply the feedback to the count and aggregation API documentation as suggested in firebase/firebase-js-sdk#6608. This is a port of firebase/firebase-js-sdk#7933.