Cloud Firestore V1 Client - Class Density (2.1.0-RC1)

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

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

Generated from protobuf enum DENSITY_UNSPECIFIED = 0;

An index entry will only exist if ALL fields are present in the document.

This is both the default and only allowed value for Standard Edition databases (for both Cloud Firestore ANY_API and Cloud Datastore DATASTORE_MODE_API). Take for example the following document:

{
  "__name__": "...",
  "a": 1,
  "b": 2,
  "c": 3
}

an index on (a ASC, b ASC, c ASC, __name__ ASC) will generate an index entry for this document since a, 'b', c, and __name__ are all present but an index of (a ASC, d ASC, __name__ ASC) will not generate an index entry for this document since d is missing. This means that such indexes can only be used to serve a query when the query has either implicit or explicit requirements that all fields from the index are present.

Generated from protobuf enum SPARSE_ALL = 1;

An index entry will exist if ANY field are present in the document.

This is used as the definition of a sparse index for Enterprise Edition databases. Take for example the following document:

{
  "__name__": "...",
  "a": 1,
  "b": 2,
  "c": 3
}

an index on (a ASC, d ASC) will generate an index entry for this document since a is present, and will fill in an unset value for d. An index on (d ASC, e ASC) will not generate any index entry as neither d nor e are present. An index that contains __name__ will generate an index entry for all documents since Firestore guarantees that all documents have a __name__ field.

Generated from protobuf enum SPARSE_ANY = 2;

An index entry will exist regardless of if the fields are present or not.

This is the default density for an Enterprise Edition database. The index will store unset values for fields that are not present in the document.

Generated from protobuf enum DENSE = 3;