Transforms

Helpful constants to use for Google Cloud Firestore.

class google.cloud.firestore_v1.transforms.ArrayRemove(values)

Bases: google.cloud.firestore_v1.transforms._ValueList

Field transform: remove values from an array field.

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.remove_all_from_array

• Parameters

  values (List* | *Tuple) – values to remove.

class google.cloud.firestore_v1.transforms.ArrayUnion(values)

Bases: google.cloud.firestore_v1.transforms._ValueList

Field transform: appends missing values to an array field.

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.append_missing_elements

• Parameters

  values (List* | *Tuple) – values to append.

class google.cloud.firestore_v1.transforms.Increment(value)

Bases: google.cloud.firestore_v1.transforms._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

• Parameters

  value (int* | [float*](https://python.readthedocs.io/en/latest/library/functions.html#float)) – value used to increment the field.

class google.cloud.firestore_v1.transforms.Maximum(value)

Bases: google.cloud.firestore_v1.transforms._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

• Parameters

  value (int* | [float*](https://python.readthedocs.io/en/latest/library/functions.html#float)) – value used to bound the field.

class google.cloud.firestore_v1.transforms.Minimum(value)

Bases: google.cloud.firestore_v1.transforms._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

• Parameters

  value (int* | [float*](https://python.readthedocs.io/en/latest/library/functions.html#float)) – value used to bound the field.

class google.cloud.firestore_v1.transforms.Sentinel(description)

Bases: object

Sentinel objects used to signal special handling.