Firestore: add support for numeric transforms: 'increment' / 'maximum' / 'minimum'.

firestore/google/cloud/firestore_v1/__init__.py

@@ -30,6 +30,9 @@
 from google.cloud.firestore_v1.transforms import ArrayRemove
 from google.cloud.firestore_v1.transforms import ArrayUnion
 from google.cloud.firestore_v1.transforms import DELETE_FIELD
+from google.cloud.firestore_v1.transforms import Increment
+from google.cloud.firestore_v1.transforms import Maximum
+from google.cloud.firestore_v1.transforms import Minimum
 from google.cloud.firestore_v1.transforms import SERVER_TIMESTAMP
 from google.cloud.firestore_v1.document import DocumentReference
 from google.cloud.firestore_v1.document import DocumentSnapshot
@@ -52,7 +55,10 @@
     "enums",
     "ExistsOption",
     "GeoPoint",
+    "Increment",
     "LastUpdateOption",
+    "Maximum",
+    "Minimum",
     "Query",
     "ReadAfterWriteError",
     "SERVER_TIMESTAMP",

firestore/google/cloud/firestore_v1/_helpers.py

@@ -404,6 +404,9 @@ def __init__(self, document_data):
         self.server_timestamps = []
         self.array_removes = {}
         self.array_unions = {}
+        self.increments = {}
+        self.minimums = {}
+        self.maximums = {}
         self.set_fields = {}
         self.empty_document = False
 
@@ -427,6 +430,15 @@ def __init__(self, document_data):
             elif isinstance(value, transforms.ArrayUnion):
                 self.array_unions[field_path] = value.values
 
+            elif isinstance(value, transforms.Increment):
+                self.increments[field_path] = value.value
+
+            elif isinstance(value, transforms.Maximum):
+                self.maximums[field_path] = value.value
+
+            elif isinstance(value, transforms.Minimum):
+                self.minimums[field_path] = value.value
+
             else:
                 self.field_paths.append(field_path)
                 set_field_value(self.set_fields, field_path, value)
@@ -436,12 +448,24 @@ def _get_document_iterator(self, prefix_path):
 
     @property
     def has_transforms(self):
-        return bool(self.server_timestamps or self.array_removes or self.array_unions)
+        return bool(
+            self.server_timestamps
+            or self.array_removes
+            or self.array_unions
+            or self.increments
+            or self.maximums
+            or self.minimums
+        )
 
     @property
     def transform_paths(self):
         return sorted(
-            self.server_timestamps + list(self.array_removes) + list(self.array_unions)
+            self.server_timestamps
+            + list(self.array_removes)
+            + list(self.array_unions)
+            + list(self.increments)
+            + list(self.maximums)
+            + list(self.minimums)
         )
 
     def _get_update_mask(self, allow_empty_mask=False):
@@ -500,6 +524,33 @@ def make_array_value(values):
                 )
                 for path, values in self.array_unions.items()
             ]
+            + [
+                (
+                    path,
+                    write_pb2.DocumentTransform.FieldTransform(
+                        field_path=path.to_api_repr(), increment=encode_value(value)
+                    ),
+                )
+                for path, value in self.increments.items()
+            ]
+            + [
+                (
+                    path,
+                    write_pb2.DocumentTransform.FieldTransform(
+                        field_path=path.to_api_repr(), maximum=encode_value(value)
+                    ),
+                )
+                for path, value in self.maximums.items()
+            ]
+            + [
+                (
+                    path,
+                    write_pb2.DocumentTransform.FieldTransform(
+                        field_path=path.to_api_repr(), minimum=encode_value(value)
+                    ),
+                )
+                for path, value in self.minimums.items()
+            ]
         )
         field_transforms = [
             transform for path, transform in sorted(path_field_transforms)

firestore/google/cloud/firestore_v1/transforms.py

@@ -88,3 +88,64 @@ class ArrayRemove(_ValueList):
     Args:
         values (List | Tuple): values to remove.
     """
+
+
+class _NumericValue(object):
+    """Hold a single integer / float value.
+
+    Args:
+        value (int | float): value held in the helper.
+    """
+
+    def __init__(self, value):
+        if not isinstance(value, (int, float)):
+            raise ValueError("Pass an integer / float value.")
+
+        self._value = value
+
+    @property
+    def value(self):
+        """Value used by the transform.
+
+        Returns:
+            (Integer | Float) value passed in the constructor.
+        """
+        return self._value
+
+    def __eq__(self, other):
+        if not isinstance(other, self.__class__):
+            return NotImplemented
+        return self._value == other._value
+
+
+class Increment(_NumericValue):
+    """Field transform: increment a numeric field with specified value.
+
+    See:
+    https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.increment
+
+    Args:
+        value (int | float): value used to increment the field.
+    """
+
+
+class Maximum(_NumericValue):
+    """Field transform: bound numeric field with specified value.
+
+    See:
+    https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.maximum
+
+    Args:
+        value (int | float): value used to bound the field.
+    """
+
+
+class Minimum(_NumericValue):
+    """Field transform: bound numeric field with specified value.
+
+    See:
+    https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.minimum
+
+    Args:
+        value (int | float): value used to bound the field.
+    """