Cloud Firestore V1 Client - Class QueryScope (1.32.0)

Version 1.32.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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
Name	Description
value	mixed

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;