Comment créer des indices Elasticsearch

Dans ce rapide didacticiel, nous examinerons Elasticsearch, en particulier comment créer des index dans le moteur Elasticsearch. Bien que vous n'ayez pas besoin de connaissances approfondies sur la pile ELK pour suivre ce didacticiel, il peut être avantageux d'avoir une compréhension de base des sujets suivants :

• En utilisant le terminal, en particulier, cURL
• Connaissance de base des API et JSON
• Faire une requête HTTP

REMARQUE: Ce didacticiel suppose également qu'Elasticsearch est installé et exécuté sur votre système.

Que sont les indices Elasticsearch ?

Sans trop simplifier ni trop compliquer les choses, un index Elasticsearch est une collection de documents JSON associés.

Comme mentionné dans un article précédent, les index Elasticsearch sont des objets JSON, considérés comme l'unité de base de stockage dans Elasticsearch. Ces documents JSON associés sont stockés dans une seule unité qui constitue un index. Considérez les documents Elasticsearch comme des tables dans une base de données relationnelle.

Associons un index Elasticsearch à une base de données dans le monde SQL.

• MySQL => Bases de données => Tables => Colonnes/Lignes
• Elasticsearch => Indices => Types => Documents JSON avec propriétés

Comment créer un index Elasticsearch

Elasticsearch utilise une API REST puissante et intuitive pour exposer ses services. Cette fonctionnalité vous permet d'utiliser des requêtes HTTP pour effectuer des opérations sur le cluster Elasticsearch. Par conséquent, nous utiliserons l'API de création d'index pour créer un nouvel index.

Pour ce guide, nous utiliserons cURL pour envoyer les demandes et préserver l'intégrité et la convivialité pour tous les utilisateurs. Cependant, si vous rencontrez des erreurs avec cURL, envisagez d'utiliser la console Kibana.

La syntaxe pour créer un nouvel index dans le cluster Elasticsearch est :

Pour créer un index, il suffit de passer le nom de l'index sans autres paramètres, ce qui crée un index en utilisant les paramètres par défaut.

Vous pouvez également spécifier diverses fonctionnalités de l'index, comme dans le corps de l'index :

• Les paramètres de l'index
• Indexer les alias
• Mappages pour les champs d'index

Le nom de l'index est un paramètre obligatoire ; sinon, vous obtiendrez une erreur pour l'URIL (/)

Pour créer un nouvel index avec le nom single_index, on passe la requête :

Pour cURL, utilisez la commande :

Cette commande doit entraîner l'état HTTP 200 OK et un message avec accusé de réception : vrai en tant que :

La requête ci-dessus crée un index single_index avec les paramètres par défaut car nous n'avons spécifié aucune configuration.

Règles de nommage d'index

Lors de la création de noms pour les index Elasticsearch, vous devez respecter les normes de nommage suivantes :

1. Le nom de l'index doit être en minuscules uniquement.
2. Les noms d'index ne peuvent pas commencer par un tiret (-), un trait de soulignement (_) ou un signe d'addition (+)
3. Les noms ne peuvent pas être . ou ..
4. Les noms d'index ne peuvent pas inclure de caractères spéciaux tels que : , /, *, ?, , , |, ` ` (caractère espace), ,, #
5. La longueur des noms d'index doit être inférieure à 255 octets. Les caractères multi-octets compteront dans la longueur totale du nom d'index. Par exemple, si un seul caractère a une longueur de 8 octets, la longueur totale restante du nom est de 255 à 8
6. Dans la dernière version d'Elasticsearch, les noms commençant par un . sont réservés aux index cachés et aux index internes utilisés par les plugins Elasticsearch.

Comment créer un corps d'index

Lorsque vous utilisez la requête PUT pour créer un index, vous pouvez transmettre divers arguments qui définissent les paramètres de l'index que vous souhaitez créer. Les valeurs que vous pouvez spécifier dans le corps incluent :

• Alias : Spécifie les noms d'alias pour l'index que vous souhaitez créer ; ce paramètre est facultatif.
• Paramètres: Cela définit les options de configuration de l'index que vous souhaitez créer. Si vous ne spécifiez aucun paramètre, l'index est créé à l'aide des configurations par défaut.
• Cartographies : Cela définit le mappage des champs dans l'index. Les spécifications que vous pouvez inclure dans les mappages incluent :
  • Le nom du champ
  • Le type de données
  • Le paramètre de mappage

Pour un exemple de création d'un index avec des configurations de corps, considérez la demande ci-dessous :

Pour une requête équivalente à cURL :

La requête ci-dessus crée un nouvel index avec le nom single_index_with_body avec 2 nombres de fragments et 2 répliques. Il crée également un mappage avec un champ de nom field1 et tapez en tant qu'objet JSON.

Une fois la demande envoyée, vous recevrez une réponse avec le statut de la demande comme suit :

Acknowledged indique si l'index a été créé avec succès dans le cluster, tandis que shards_acknowledged indique si le nombre requis de copies de partition a été démarré pour chaque partition de l'index spécifié avant l'expiration du délai.

Comment afficher l'index Elasticsearch

Pour afficher les informations sur l'index que vous avez créé, utilisez une requête similaire à celle de création d'un index, mais utilisez la méthode HTTP au lieu de PUT comme :

Pour cURL,

Cette commande vous donnera des informations détaillées sur l'index demandé comme :

Conclusion

Ce guide a expliqué comment travailler avec Elasticsearch pour créer une API d'index pour créer de nouveaux index. Nous avons également expliqué comment créer des noms appropriés pour les index et les paramètres de configuration.

En utilisant ce guide, vous pouvez désormais créer et afficher des index à l'aide de l'API Elasticsearch.