Version 2.13.1

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

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.