Cloud Firestore V1 Client - Class QueryScope (1.46.0)

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

Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from field.

Protobuf type google.firestore.admin.v1.Index.QueryScope

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Index

Methods

static::name

Parameter
Name	Description
`value`	`mixed`

static::value

Parameter
Name	Description
`name`	`mixed`

Constants

QUERY_SCOPE_UNSPECIFIED

Value: 0

The query scope is unspecified. Not a valid option.

Generated from protobuf enum QUERY_SCOPE_UNSPECIFIED = 0;

COLLECTION

Value: 1

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection ID specified by the index.

Generated from protobuf enum COLLECTION = 1;

COLLECTION_GROUP

Value: 2

Indexes with a collection group query scope specified allow queries against all collections that has the collection ID specified by the index.

Generated from protobuf enum COLLECTION_GROUP = 2;

COLLECTION_RECURSIVE

Value: 3

Include all the collections's ancestor in the index. Only available for Datastore Mode databases.

Generated from protobuf enum COLLECTION_RECURSIVE = 3;