REST Resource: projects.databases.indexes

Ressource: Index

Définition d'un index.

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

string

Nom de ressource de l'index. Uniquement en sortie.
collectionId

string

ID de collection auquel cet index s'applique. Obligatoire.
fields[]

object (IndexField)

Champs à indexer.
state

enum (State)

État de l'index. Uniquement en sortie.

IndexField

Champ d'un index.

Représentation JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Champs
fieldPath

string

Chemin d'accès du champ. Doit correspondre à la spécification du chemin d'accès du champ décrite par [google.firestore.v1beta1.Document.fields][fields]. Le chemin d'accès de champ spécial __name__ peut être utilisé seul ou à la fin d'un chemin. __type__ ne peut être utilisé qu'à la fin du chemin.
mode

enum (Mode)

Mode du champ.

Mode

Le mode détermine la manière dont un champ est indexé.

Enums
MODE_UNSPECIFIED Le mode n'est pas spécifié.
ASCENDING Les valeurs du champ sont indexées de manière à permettre le séquençage dans l'ordre croissant et à être interrogées avec les caractères <, >, <=, >= et =.
DESCENDING Les valeurs du champ sont indexées de manière à permettre le séquençage par ordre décroissant et également à interroger les données en fonction des caractères <, >, <=, >= et =.
ARRAY_CONTAINS Les valeurs de tableau du champ sont indexées de manière à permettre l'appartenance à l'aide de requêtes ARRAY_CONTAINS.

État

État d'un index. Lors de la création d'un index, son état est CREATING. Si l'index a bien été créé, il passe à l'état READY. Si l'index ne peut pas être créé, il passe à l'état ERROR.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié.
CREATING L'index est en cours de création. Une opération de longue durée est active pour l'index. L'index est mis à jour lors de l'écriture d'un document. Certaines données d'index peuvent exister.
READY L'index est prêt à être utilisé. L'index est mis à jour lors de l'écriture d'un document. L'index est entièrement renseigné à partir de tous les documents stockés auxquels il s'applique.
ERROR L'index était en cours de création, mais un problème est survenu. Il n'existe pas d'opération de longue durée active pour l'index, et la dernière opération de longue durée terminée a échoué. L'index n'est pas mis à jour lors de la rédaction d'un document. Certaines données d'index peuvent exister.

Méthodes

create

 Crée l'index spécifié.

delete

 Supprime un index.

get

 Récupère un indice.

list

 Répertorie les index correspondant aux filtres spécifiés.