feat: Add bloom filter related proto fields (only in the preview API surface)

Google APIs · copybara-github · commit e2b7cb94f3e7 · 2023-04-25T15:22:22.000-07:00
PiperOrigin-RevId: 527090049
diff --git a/google/firestore/v1/aggregation_result.proto b/google/firestore/v1/aggregation_result.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/firestore/v1/common.proto b/google/firestore/v1/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/firestore/v1/document.proto b/google/firestore/v1/document.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/firestore/v1/firestore.proto b/google/firestore/v1/firestore.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -178,16 +178,16 @@ service Firestore {
   }
 
   // Streams batches of document updates and deletes, in order. This method is
-  // only available via the gRPC API (not REST).
+  // only available via gRPC or WebChannel (not REST).
   rpc Write(stream WriteRequest) returns (stream WriteResponse) {
     option (google.api.http) = {
       post: "/v1/{database=projects/*/databases/*}/documents:write"
       body: "*"
     };
   }
 
-  // Listens to changes. This method is only available via the gRPC API (not
-  // REST).
+  // Listens to changes. This method is only available via gRPC or WebChannel
+  // (not REST).
   rpc Listen(stream ListenRequest) returns (stream ListenResponse) {
     option (google.api.http) = {
       post: "/v1/{database=projects/*/databases/*}/documents:listen"
@@ -655,7 +655,14 @@ message RunAggregationQueryResponse {
   // a new transaction.
   bytes transaction = 2;
 
-  // The time at which the aggregate value is valid for.
+  // The time at which the aggregate result was computed. This is always
+  // monotonically increasing; in this case, the previous AggregationResult in
+  // the result stream are guaranteed not to have changed between their
+  // `read_time` and this one.
+  //
+  // If the query returns no results, a response with `read_time` and no
+  // `result` will be sent, and this represents the time at which the query
+  // was run.
   google.protobuf.Timestamp read_time = 3;
 }
 
diff --git a/google/firestore/v1/query.proto b/google/firestore/v1/query.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -136,25 +136,28 @@ message StructuredQuery {
       //
       // Requires:
       //
-      // * That `value` is a non-empty `ArrayValue` with at most 10 values.
-      // * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
+      // * That `value` is a non-empty `ArrayValue`, subject to disjunction
+      //   limits.
+      // * No `NOT_IN` filters in the same query.
       IN = 8;
 
       // The given `field` is an array that contains any of the values in the
       // given array.
       //
       // Requires:
       //
-      // * That `value` is a non-empty `ArrayValue` with at most 10 values.
-      // * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
+      // * That `value` is a non-empty `ArrayValue`, subject to disjunction
+      //   limits.
+      // * No other `ARRAY_CONTAINS_ANY` filters within the same disjunction.
+      // * No `NOT_IN` filters in the same query.
       ARRAY_CONTAINS_ANY = 9;
 
       // The value of the `field` is not in the given array.
       //
       // Requires:
       //
       // * That `value` is a non-empty `ArrayValue` with at most 10 values.
-      // * No other `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`,
+      // * No other `OR`, `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`,
       //   `IS_NOT_NULL`, or `IS_NOT_NAN`.
       // * That `field` comes first in the `order_by`.
       NOT_IN = 10;
@@ -251,7 +254,11 @@ message StructuredQuery {
     repeated FieldReference fields = 2;
   }
 
-  // The projection to return.
+  // Optional sub-set of the fields to return.
+  //
+  // This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the
+  // documents returned from a query. When not set, assumes that the caller
+  // wants all fields returned.
   Projection select = 1;
 
   // The collections to query.
@@ -349,7 +356,7 @@ message StructuredQuery {
 // Firestore query for running an aggregation over a
 // [StructuredQuery][google.firestore.v1.StructuredQuery].
 message StructuredAggregationQuery {
-  // Defines a aggregation that produces a single result.
+  // Defines an aggregation that produces a single result.
   message Aggregation {
     // Count of documents that match the query.
     //
@@ -360,7 +367,7 @@ message StructuredAggregationQuery {
       // count.
       //
       // This provides a way to set an upper bound on the number of documents
-      // to scan, limiting latency and cost.
+      // to scan, limiting latency, and cost.
       //
       // Unspecified is interpreted as no bound.
       //
@@ -394,7 +401,7 @@ message StructuredAggregationQuery {
     //   COUNT_UP_TO(1) AS count_up_to_1,
     //   COUNT_UP_TO(2),
     //   COUNT_UP_TO(3) AS count_up_to_3,
-    //   COUNT_UP_TO(4)
+    //   COUNT(*)
     // OVER (
     //   ...
     // );
@@ -407,7 +414,7 @@ message StructuredAggregationQuery {
     //   COUNT_UP_TO(1) AS count_up_to_1,
     //   COUNT_UP_TO(2) AS field_1,
     //   COUNT_UP_TO(3) AS count_up_to_3,
-    //   COUNT_UP_TO(4) AS field_2
+    //   COUNT(*) AS field_2
     // OVER (
     //   ...
     // );
diff --git a/google/firestore/v1/write.proto b/google/firestore/v1/write.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2022 Google LLC`
	`1`	`+// Copyright 2023 Google LLC`
`2`	`2`	`//`
`3`	`3`	`// Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`// you may not use this file except in compliance with the License.`