Cloud Firestore V1 Client - Class QueryScope (1.30.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

Methods

name

Parameter
NameDescription
value mixed

value

Parameter
NameDescription
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;