Module transforms (2.9.0)

Version 2.9.0

• 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

Helpful constants to use for Google Cloud Firestore.

Classes

ArrayRemove

ArrayRemove(values)

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

Parameter

Name	Description
values	List Tuple values to remove.

ArrayUnion

ArrayUnion(values)

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

Parameter

Name	Description
values	List Tuple values to append.

Increment

Increment(value)

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

Parameter

Name	Description
value	int float value used to increment the field.

Maximum

Maximum(value)

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

Parameter

Name	Description
value	int float value used to bound the field.

Minimum

Minimum(value)

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

Parameter

Name	Description
value	int float value used to bound the field.

Sentinel

Sentinel(description)

Sentinel objects used to signal special handling.