Cloud Firestore Admin V1 API - Module Google::Cloud::Firestore::Admin::V1::Index::Density (v1.7.0)

Version latest

• 1.7.0 (latest)
• 1.6.0
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.1
• 0.18.0
• 0.17.1
• 0.16.0
• 0.15.0
• 0.14.3
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

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

The density configuration for the index.

Constants

DENSITY_UNSPECIFIED

value: 0
Unspecified. It will use database default setting. This value is input only.

SPARSE_ALL

value: 1
In order for an index entry to be added, the document must contain all fields specified in the index.

This is the only allowed value for indexes having ApiScope ANY_API and DATASTORE_MODE_API.

SPARSE_ANY

value: 2
In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.

DENSE

value: 3
An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.