google_api_firestore v0.13.0 GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index View Source

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Attributes

fields (type: list(GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexField.t), default: nil) - The fields supported by this index.

For composite indexes, this is always 2 or more fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified).

For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
name (type: String.t, default: nil) - Output only. A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
queryScope (type: String.t, default: nil) - 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.
state (type: String.t, default: nil) - Output only. The serving state of the index.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index{
  fields: [GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexField.t()],
  name: String.t(),
  queryScope: String.t(),
  state: String.t()
}

Link to this section Functions

decode(value, options)

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.