Cloud Firestore Admin V1 API - Module Google::Cloud::Firestore::Admin::V1::Index::QueryScope (v1.0.1)

Reference documentation and code samples for the Cloud Firestore Admin V1 API module Google::Cloud::Firestore::Admin::V1::Index::QueryScope.

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

Constants

QUERY_SCOPE_UNSPECIFIED

value: 0
The query scope is unspecified. Not a valid option.

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.

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.

COLLECTION_RECURSIVE

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