File tree Expand file tree Collapse file tree 1 file changed +14
-4
lines changed
firebase-firestore/src/main/java/com/google/firebase/firestore Expand file tree Collapse file tree 1 file changed +14
-4
lines changed Original file line number Diff line number Diff line change 14
14
15
15
package com .google .firebase .firestore ;
16
16
17
- /** Configures the behavior of {@link AggregateQuery#get}. */
17
+ /**
18
+ * The sources from which an {@link AggregateQuery} can retrieve its results.
19
+ *
20
+ * @see AggregateQuery#get
21
+ */
18
22
public enum AggregateSource {
19
23
/**
20
- * Reach to the Firestore backend and surface the result verbatim, that is no local documents or
21
- * mutations in the SDK cache will be included in the surfaced result.
24
+ * Perform the aggregation on the server and download the result.
22
25
*
23
- * <p>Requires client to be online.
26
+ * <p>The result received from the server is presented, unaltered, without considering any local
27
+ * state. That is, any documents in the local cache are ignored and any documents that have been
28
+ * locally modified but not yet synchronized with the server are not taken into account. The
29
+ * result received from the server is not cached for later use: every request using this source
30
+ * necessarily involves a round trip to the server and back.
31
+ *
32
+ * <p>The {@link AggregateQuery} will fail if the server cannot be reached, such as if the client
33
+ * is offline.
24
34
*/
25
35
SERVER ,
26
36
}
You can’t perform that action at this time.
0 commit comments