Comment utiliser API en vrac Elasticsearch
Ce court article illustrera l'utilisation de l'API en vrac pour effectuer plusieurs opérations CRUD dans une seule demande d'API.
Elasticsearch Bulk API Basics
Nous pouvons utiliser l'API en vrac en envoyant une demande HTTP Post au point de terminaison de l'API _bulk. La demande doit contenir l'opération effectuée dans l'appel de l'API, comme la création ou la suppression d'un index.
Considérez la demande suivante.
Obtenir / test-index
Post _bulk
"index": "_index": "test-index-1", "_id": 1
"field1": "value1"
"Update": "_id": 1, "_index": "test-index-1"
"doc": "field2": "value2"
"Delete": "_index": "test-index-1", "_id": 1
L'exemple de demande ci-dessus effectue trois actions consécutives à la fois. Il crée un index et ajoute un document.
Ensuite, nous mettons à jour l'enregistrement et le supprimons.
Vous devriez voir la sortie similaire à celle ci-dessous:
Explication
Comme mentionné, l'API en vrac vous permet d'exécuter plusieurs actions telles que Index, Create, Update et Supprimer dans une seule requête.
Chaque action est spécifiée dans le corps de la demande en utilisant le format JSON délimité à Newline.
Les opérations d'index et de création vous obligent à spécifier la source. L'action d'index ajoute ou effectue un remplacement de l'index comme spécifié. Il est bon de noter que l'opération d'index échouera si un document avec un index similaire existe déjà.
Une opération de mise à jour, en revanche, nécessite un doc partiel spécifié.
Comprendre le corps de la demande
L'API en vrac accepte les opérations à exécuter dans le corps. Les entrées dans le corps sont sous la forme d'un format déliré JSON.
Chaque entrée d'une nouvelle ligne comprend l'action et les données connexes pour l'opération cible.
Laissez-nous décomposer les opérations que vous pouvez spécifier dans le corps de la demande et les paramètres acceptés:
Créer
L'opération de création indexera un document spécifié si le document n'existe pas. Les paramètres essentiels de l'opération de création incluent:
_indice - Définit le nom de l'index ou de l'index Alias sur lequel exécuter l'opération d'index. Ce paramètre n'est pas facultatif si vous n'avez pas le paramètre cible défini dans le chemin de demande.
_identifiant - L'ID du document à indexer. Si vous n'avez aucune valeur spécifiée, Elasticsearch générera automatiquement l'ID de document.
Mise à jour
L'opération de mise à jour effectuera une mise à jour partielle du document. Les paramètres incontournables de l'opération de mise à jour incluent:
_indice - Spécifie le nom des zones d'index ou d'index pour effectuer l'opération de mise à jour.
_identifiant - ID de document, généré automatiquement s'il n'est pas spécifié.
Doc - Définit le nom du document partiel à indexer.
Indice
L'opération d'index index un document spécifié. Si le document spécifié existe, l'opération d'index remplacera le document et incrément sa version. Les paramètres essentiels de cette opération comprennent:
_indice - Définit le nom de l'index ou de l'index à l'alias pour indexer sur.
_identifiant - ID du document.
Supprimer
L'opération de suppression supprime un document de l'index. Doit connaître les paramètres de cette opération incluent:
_indice - Définit le nom ou l'alias de l'index.
_identifiant - L'ID du document à supprimer de l'index.
NOTE: Il est bon de prêter attention à la réponse de l'API en vrac pour déterminer les informations telles que les opérations échouées et réussies.
Conclusion
L'API en vrac dans Elasticsearch peut être un économe à la fois dans le nombre de demandes à faire et les performances d'indexation. Ce guide fournit les bases de la façon de travailler avec l'API pour effectuer plusieurs opérations.
Pour en savoir plus sur l'API en vrac, consultez la documentation.