Cloud Firestore V1 Client - Class Density (1.50.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Density.

The density configuration for the index.

Protobuf type google.firestore.admin.v1.Index.Density

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Index

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

DENSITY_UNSPECIFIED

Value: 0

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

Generated from protobuf enum DENSITY_UNSPECIFIED = 0;

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.

Generated from protobuf enum SPARSE_ALL = 1;

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.

Generated from protobuf enum SPARSE_ANY = 2;

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.

Generated from protobuf enum DENSE = 3;