Cloud Firestore V1 Client - Class ConcurrencyMode (2.1.0-RC1)

Reference documentation and code samples for the Cloud Firestore V1 Client class ConcurrencyMode.

The type of concurrency control mode for transactions.

Protobuf type google.firestore.admin.v1.Database.ConcurrencyMode

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Database

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

CONCURRENCY_MODE_UNSPECIFIED

Value: 0

Not used.

Generated from protobuf enum CONCURRENCY_MODE_UNSPECIFIED = 0;

OPTIMISTIC

Value: 1

Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

This is the default setting for Cloud Firestore Enterprise Edition databases.

Generated from protobuf enum OPTIMISTIC = 1;

PESSIMISTIC

Value: 2

Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases.

This is the default setting for Cloud Firestore Standard Edition databases.

Generated from protobuf enum PESSIMISTIC = 2;

OPTIMISTIC_WITH_ENTITY_GROUPS

Value: 3

Use optimistic concurrency control with entity groups by default.

This mode is enabled for some databases that were automatically upgraded from Cloud Datastore to Cloud Firestore with Datastore Mode. It is not recommended for any new databases, and not supported for Firestore Native databases.

Generated from protobuf enum OPTIMISTIC_WITH_ENTITY_GROUPS = 3;