REST Resource: projects.databases.collectionGroups.indexes

Ressource: Index

Les index Cloud Firestore permettent d'exécuter des requêtes simples et complexes sur les documents d'une base de données.

Représentation JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Champs
name

string

Uniquement en sortie. Nom défini par le serveur pour cet index. Ce nom pour les index composites prendra la forme suivante: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Pour les index à champ unique, ce champ sera vide.
queryScope

enum (QueryScope)

Les index dont le champ d'application de requête de collection est spécifié autorisent les requêtes sur une collection enfant d'un document spécifique, spécifié au moment de la requête, et possédant le même ID de collection.

Les index dont le champ d'application de requête de groupe de collections est spécifié autorisent les requêtes sur toutes les collections descendant d'un document spécifique, spécifié au moment de la requête et ayant le même ID de collection que cet index.
fields[]

object (IndexField)

Champs acceptés par cet index.

Pour les index composites, il s'agit toujours d'au moins deux champs. La dernière entrée de champ correspond toujours au chemin d'accès du champ __name__. Si, lors de la création, __name__ n'a pas été spécifié comme dernier champ, il sera ajouté automatiquement dans la même direction que celle du dernier champ défini. Si le dernier champ d'un index composite n'est pas directionnel, __name__ sera classé par ordre croissant dans l'ordre décroissant (sauf indication contraire explicite).

Pour les index à champ unique, il s'agira toujours d'une seule entrée dont le chemin d'accès de champ correspond à celui du champ associé.
state

enum (State)

Uniquement en sortie. État de diffusion de l'index.

Méthodes

create

 Crée un index composite.

delete

 Supprime un index composite.

get

 Récupère un index composite.

list

 Répertorie les index composites.