View Source GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index (google_api_firestore v0.26.0)
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Attributes
-
apiScope
(type:String.t
, default:nil
) - The API scope supported by this index. -
fields
(type:list(GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexField.t)
, default:nil
) - The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 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.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index{ apiScope: String.t() | nil, fields: [GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexField.t()] | nil, name: String.t() | nil, queryScope: String.t() | nil, state: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.