Cloud Firestore V1 Client - Class QueryMode (1.52.0)

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

The mode in which the query request must be processed.

Protobuf type google.firestore.v1.QueryMode

Namespace

Google \ Cloud \ Firestore \ V1

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

NORMAL

Value: 0

The default mode. Only the query results are returned.

Generated from protobuf enum NORMAL = 0;

PLAN

Value: 1

This mode returns only the query plan, without any results or execution statistics information.

Generated from protobuf enum PLAN = 1;

PROFILE

Value: 2

This mode returns both the query plan and the execution statistics along with the results.

Generated from protobuf enum PROFILE = 2;