IndexQueryScope

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 same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.

Entries

Link copied to clipboard

The query scope is unspecified. Not a valid option.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun toJava(): IndexQueryScope
Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.

Properties

Link copied to clipboard
val javaValue: IndexQueryScope
Link copied to clipboard
Link copied to clipboard