Method: projects.databases.indexes.create

Crée l'index spécifié. L'état initial d'un index nouvellement créé est CREATING. Une fois l'google.longrunning.Operation renvoyée, l'état est READY. Si l'index existe déjà, l'appel renvoie l'état ALREADY_EXISTS.

Lors de la création, le processus peut entraîner une erreur, auquel cas l'index passe à l'état ERROR. Vous pouvez récupérer le processus en corrigeant les données à l'origine de l'erreur, en supprimant l'index avec delete, puis en le recréant avec create.

Impossible de créer des index ne comportant qu'un seul champ.

Requête HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Nom de la base de données à laquelle cet index s'appliquera. Par exemple : projects/{projectId}/databases/{databaseId}

Corps de la requête

Le corps de la requête contient une instance Index.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Operation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.