✎ elasticsearch [Wiki ubuntu-fr]

Vous affichez une ancienne révision du document ! Si vous l'enregistrez, vous créerez une nouvelle version avec ce contenu.

----

====== ElasticSearch ======

**[[https://fr.wikipedia.org/wiki/Elasticsearch|ElasticSearch]] ** est une base de données documentaire libre se basant sur le serveur Apache [[https://fr.wikipedia.org/wiki/Lucene|Lucene]]. Les requêtes se font via le protocole [[https://fr.wikipedia.org/wiki/Hypertext_Transfer_Protocol|HTTP]] et l'interface [[https://fr.wikipedia.org/wiki/Representational_state_transfer|REST]]. Le requête PUT permet d'ajouter/modifier une entrée tandis que GET permet de la récupérer. L'échange de données se faisant via le format [[https://fr.wikipedia.org/wiki/JavaScript_Object_Notation|JSON]].

Ce tutoriel a pour but de montrer comment installer basiquement le service ElasticSearch et réaliser des requêtes simples. Les paramètres techniques détaillées et les concepts d'architecture ou de modèle documentaire ne seront pas abordés ici. Pour obtenir des informations plus poussées, veuillez vous référer aux liens en fin de pages ou chercher des sites plus spécialisés.

<note important>La version d'Ubuntu utilisée pour l'exemple est la 16.04. Peut-être faut-il adapter certaines commandes ou scripts pour d'autres versions.</note>
<note >Pour réaliser ce tutoriel, mieux veut connaitre les bases de :
  * L'installation de paquets : [[apt-get|apt-get]]
  * La modification de fichiers de paramètres : [[nano|nano]]
  * L'utilisation des services : [[creer_un_service_avec_systemd|Créer un nouveau service avec Systemd]] et [[script_sysv|Les scripts d'initialisation système V]]
  * Requetage HTTP : [[http://www.zem.fr/curl-15-commandes-pratiques-avec-curl/|Tuturiel FR]] ou  [[http://www.slashroot.in/curl-command-tutorial-linux-example-usage/|Tuturiel EN]]
</note>

=====Installation=====

[[:tutoriel:comment_installer_un_paquet|Installez le paquet]] **[[apt://elasticsearch|elasticsearch]]**.

====En mode console====

<code bash>sudo apt-get install elasticsearch</code>
Pour vérifier que le service est installé, rechercher le via :
<code bash>service --status-all</code>
Vous devriez voir une ligne **elasticsearch** :
<code bash> [ - ]  elasticsearch</code>

====Script de lancement====
<note warning>Sur la version 16.04 d'Ubuntu, le script de lancement par défaut est bogué. Il faut donc le corriger.

En effet, si vous saisissez cette commande :
<code bash>sudo service elasticsearch status</code>
Alors vous devriez voir un **active (exited)** qui indique la commande de lancement a été exécutée mais que l'on est pas sur du status du service : 
<code bash>● elasticsearch.service - LSB: Starts elasticsearch
   Loaded: loaded (/etc/init.d/elasticsearch; bad; vendor preset: enabled)
   Active: active (exited) since dim. 2016-09-18 12:57:38 CEST; 15s ago
     Docs: man:systemd-sysv-generator(8)

sept. 18 12:57:38 lubuntu-DEV systemd[1]: Starting LSB: Starts elasticsearch...
sept. 18 12:57:38 lubuntu-DEV systemd[1]: Started LSB: Starts elasticsearch</code></note>

Pour remédier à cela, il faut modifier le script "init.d" :
<code bash>sudo nano /etc/init.d/elasticsearch</code>

D'abord, trouver la ligne :
<code bash>test "$START_DAEMON" = true || exit 0</code>
et la commenter :
<code bash>#test "$START_DAEMON" = true || exit 0</code>

Puis rechercher cette ligne :
<code bash>start-stop-daemon --start -b --user "$ES_USER" -c "$ES_USER" --pidfile "$PID_FILE" --exec $DAEMON -- $DAEMON_OPTS</code>
et la modifier :
<code bash>start-stop-daemon --start -b --user "$ES_USER" --pidfile "$PID_FILE" --exec $DAEMON -- $DAEMON_OPTS</code>

<note help> A quoi servent réellement ces commandes ?

D'un côté la variable START_DAEMON n'est pas utilisée dans la suite du script. Donc pourquoi forcer l'arret du script si elle n'existe pas ?

Ensuite, le groupe défini par la variable ES_USER ne semble pas le droit de lancer le démon alors que l'utilisateur référencer par la m^me variable lui le peut. Bizarre.</note>

Maintenant le service doit pouvoir se lancer correctement.
Pour le vérifier, exécutez :
<code bash>sudo systemctl daemon-reload
sudo service elasticsearch restart
service elasticsearch status</code>
Ce qui doit donner un **active (running)** qui indique la commande de lancement a été exécutée et que l'on a eu un retour positif:
<code bash>● elasticsearch.service - LSB: Starts elasticsearch
   Loaded: loaded (/etc/init.d/elasticsearch; bad; vendor preset: enabled)
   Active: active (running) since dim. 2016-09-18 13:42:40 CEST; 18ms ago
     Docs: man:systemd-sysv-generator(8)
  Process: 7340 ExecStop=/etc/init.d/elasticsearch stop (code=exited, status=0/SUCCESS)
  Process: 7376 ExecStart=/etc/init.d/elasticsearch start (code=exited, status=0/SUCCESS)
   CGroup: /system.slice/elasticsearch.service
           ├─7151 /usr/lib/jvm/java-8-openjdk-i386/bin/java -Xms256m -Xmx1g -Djava.awt.headless=true -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseCMSInitiatingOccupa
           └─7417 start-stop-daemon --start -b --user elasticsearch --pidfile /var/run/elasticsearch.pid --exec /usr/share/elasticsearch/bin/elasticsearch -- -d -p /var/run/elasticsearch.pid -Des.default.con

sept. 18 13:42:40 lubuntu-DEV systemd[1]: Starting LSB: Starts elasticsearch...
sept. 18 13:42:40 lubuntu-DEV elasticsearch[7376]:  * Starting Elasticsearch Server
sept. 18 13:42:40 lubuntu-DEV elasticsearch[7376]:    ...done.
sept. 18 13:42:40 lubuntu-DEV systemd[1]: Started LSB: Starts elasticsearch.</code>

====Vérification====

Il est maintenant possible d'interroger le serveur via la requête HTTP GET :
<code bash>curl -X GET 'http://localhost:9200'</code>
Qui va renvoyer un JSON :
<code bash>{
  "status" : 200,
  "name" : "Stature",
  "cluster_name" : "elasticsearch",
  "version" : {
    "number" : "1.7.3",
    "build_hash" : "NA",
    "build_timestamp" : "NA",
    "build_snapshot" : false,
    "lucene_version" : "4.10.4"
  },
  "tagline" : "You Know, for Search"
}</code>
<note tip>Le port par défaut d'ElasticSearch est 9200</note>

=====Configuration=====

Il reste à créer la configuration minimale pour avoir un service opérationnel. Pour cela, ouvrir le fichier de configuration :
<code bash>sudo nano /etc/elasticsearch/elasticsearch.yml</code>

Dans la section **Cluster**, choisissez un nom pour le groupe. Par exemple :
<code bash>cluster.name: elasticsearch</code>

Dans la section **Node**, choisissez un nom pour le nœud. Par exemple :
<code bash>node.name: "development"</code>

Dans la section **Index**, paramétrez la répartition des données. Par exemple :
<code bash>index.number_of_shards: 1
index.number_of_replicas: 0</code>

Dans la section **Network And HTTP**, indiquez quelle plage du réseau est à écouter. Par exemple, pour tout écouter sans aucune restriction :
<code bash>network.host: 0.0.0.0</code>

Il ne reste plus qu'à relancer le service :
<code bash>sudo service elasticsearch restart</code>

=====Requêtage=====

====Opérations de base====

Dans un base de données, il existe 4 opérations de base. Elle sont synthétisées sous l'acronyme [[https://fr.wikipedia.org/wiki/CRUD|CRUD]] :
  - **C**reate : création d'une donnée
  - **D**elete : supression d'une donnée
  - **R**ead : lecture d'une donnée
  - **U**pdate : mise-à-jour d'une donnée

De même, le protocole [[https://fr.wikipedia.org/wiki/Hypertext_Transfer_Protocol#M.C3.A9thodes|HTTP]] possède, entre autres, 4 méthodes :
  - **G**ET : accession à une ressource
  - **P**OST : publication d'une nouvelle ressource
  - **P**UT : mise-à-jour d'une ressource existante (création si elle n'existe pas)
  - **D**ELETE : suppression d'une donnée

Dans le cadre d'ElasticSearch, on peut donc faire le rapprochement :
  - Create ↔ POST
  - Delete ↔ DELETE
  - Read ↔ GET
  - Update ↔ PUT

===Indexation===

<note tip>Elastic ne fait pas de différence fondamental entre "Create ↔ POST" et "Update ↔ PUT". Ces 2 opérations se confondent en une seule : l'indexation.</note>

Pour ajouter un enregistrement dans ElasticSearch, on peut prendre comme exemple un méthode PUT :
<code bash>curl -XPUT "http://localhost:9200/movies/movie/1" -d'
{
    "title": "The Godfather",
    "director": "Francis Ford Coppola",
    "year": 1972
}'</code>
Avec :
  * L'index ''movies'' : Espace ou notre enregistrement sera stocké dans lequel sera  (obligatoire)
  * Le type ''movie'' : Pour affiner l'index (obligatoire). On pourra par exemple ajouter des réalisateurs à notre base de films
  * L'identifiant (ID) ''1'' : une étiquette unique associée à l'enregistrement (optionnel)
  * Les données à stocker : au format JSON, entre les balises ''{}''
On aura alors une réponse, elle aussi au format JSON, du type :
<code bash>{"_index":"movies","_type":"movie","_id":"1","_version":1,"created":true}</code>
Avec :
  * Un rappel de l'index
  * Un rappel du type
  * Un rappel de l'ID (si vous en avez donné un, sinon généré aléatoirement)
  * Le numéro de version (toujours 1 pour une création)
  * Le type ''créé'' à VRAI (évident pour une création)

Avec la méthode POST, on peut faire l'opération similaire avec l'index 2 :
<code bash>curl -XPOST "http://localhost:9200/movies/movie/2" -d'
{
    "title": "Terminator",
    "director": "James Cameron",
    "year": 1984
}'</code>
Pour avoir en retour :
<code bash>{"_index":"movies","_type":"movie","_id":"2","_version":1,"created":true}</code>

On peut créer un enregistrement avec la méthode POST sans spécifier d'ID :
<code bash>curl -XPOST "http://localhost:9200/movies/movie" -d'
{
    "title": "Star Wars",
    "director": "George Lucas",
    "year": 1977
}'</code>
On reçoit donc un ID aléatoire (ici ''AVc-Cf49qZYpQV_XCKMq'') :
<code bash>{"_index":"movies","_type":"movie","_id":"AVc-Cf49qZYpQV_XCKMq","_version":1,"created":true}</code>

<note important>La méthode PUT doit **obligatoirement** avoir un ID. En effet, cette requête :
<code bash>curl -XPUT "http://localhost:9200/movies/movie/" -d'
{
    "title": "Alien",
    "director": " Ridley Scott",
    "year": 1979
}'</code>
Va donner une erreur :
<code bash>No handler found for uri [/movies/movie/] and method [PUT]</code></note>

Il est possible de mettre à jour un enregistrement existant. Il faut alors refaire le même type de requête que pour une création, mais en utilisant un ID existant.
Par exemple avec PUT, on peut ajouter les genres à un film :
<code bash>curl -XPUT "http://localhost:9200/movies/movie/1" -d'
{
    "title": "The Godfather",
    "director": "Francis Ford Coppola",
    "year": 1972,
    "genres": ["Crime", "Drama"]
}'</code>
On reçoit en réponse quelque chose de similaire à la création, mais :
  * Le numéro de version a été incrémenté d'un cran (donc passe à 2)
  * Le type ''créé'' à FAUX (l'enregistrement existé déjà)
<code bash>{"_index":"movies","_type":"movie","_id":"1","_version":2,"created":false}</code>

Et avec POST :
<code bash>curl -XPOST "http://localhost:9200/movies/movie/AVc-Cf49qZYpQV_XCKMq" -d'
{
    "title": "Star Wars",
    "director": "George Lucas",
    "year": 1977,
    "genres": ["Action", "Adventure", "Fantasy", "Sci-Fi"]
}'</code>
On reçoit en réponse qui suit le même principe :
<code bash>{"_index":"movies","_type":"movie","_id":"AVc-Cf49qZYpQV_XCKMq","_version":2,"created":false}</code>

===Lecture sur un index===

Maintenant que nous avons créé et modifié des enregistrements, il est facilement possible de les récupérer via la méthode GET en utilisant uniquement les IDs. Par exemple, pour récupérer notre premier film :
<code bash>curl -XGET "http://localhost:9200/movies/movie/1"</code>
On reçoit en réponse quelque chose de similaire à l'indexation, mais :
  * Le dernier numéro de version
  * Le type ''found'' à VRAI (l'enregistrement existe)
  * Les donnée sources indexées en JSON sont retournées telles qu'elles
<code bash>{"_index":"movies","_type":"movie","_id":"1","_version":2,"found":true,"_source":
{
    "title": "The Godfather",
    "director": "Francis Ford Coppola",
    "year": 1972,
    "genres": ["Crime", "Drama"]
}}</code>

Si l'on demande à récupérer un enregistrement inexistant :
<code bash>curl -XGET "http://localhost:9200/movies/movie/19"</code>
On reçoit en réponse quelque chose de similaire à l'indexation, mais :
  * Le type ''found'' à FAUX (l'enregistrement n'existe pas)
  * Aucune données source JSON n'est renvoyée
<code bash>{"_index":"movies","_type":"movie","_id":"19","found":false}</code>

===Supression===

Pour effacer un enregistrement, il suffit de connaitre son ID et d'utiliser la méthode DELETE. On a donc une commande assez proche de la lecture:
<code bash>curl -XDELETE "http://localhost:9200/movies/movie/2"</code>
On reçoit en réponse quelque chose de similaire à l'indexation, mais :
  * Le type ''found'' à VRAI (l'enregistrement existe)
<code bash>{"found":true,"_index":"movies","_type":"movie","_id":"2","_version":2}</code>

Du coup, si l'on refait une lecture de l'enregistrement :
<code bash>curl -XGET "http://localhost:9200/movies/movie/2"</code>
On remarque qu'il ne peut plus être trouvé :
<code bash>{"_index":"movies","_type":"movie","_id":"2","found":false}</code>

Donc, si on redemande à supprimer cette enregistrement une 2nd foix:
<code bash>curl -XDELETE "http://localhost:9200/movies/movie/2"</code>
On reçoit en réponse quelque chose de similaire à la 1ère suppression, mais :
  * Le type ''found'' à FAUX (l'enregistrement n'existe pas)
<code bash>{"found":false,"_index":"movies","_type":"movie","_id":"2","_version":3}</code>

<note tip>On remarque que pour chaque suppression, la version est incrémentée, même si l'enregistrement n'existe plus.</note>

====Recherches avancées====

Avant d'aller plus loin, il est nécessaire d'alimenter la base de données :
<code bash>curl -XPUT "http://localhost:9200/movies/movie/1" -d'
{
    "title": "The Godfather",
    "director": "Francis Ford Coppola",
    "year": 1972,
    "genres": ["Crime", "Drama"]
}'
curl -XPUT "http://localhost:9200/movies/movie/2" -d'
{
    "title": "Lawrence of Arabia",
    "director": "David Lean",
    "year": 1962,
    "genres": ["Adventure", "Biography", "Drama"]
}'
curl -XPUT "http://localhost:9200/movies/movie/3" -d'
{
    "title": "To Kill a Mockingbird",
    "director": "Robert Mulligan",
    "year": 1962,
    "genres": ["Crime", "Drama", "Mystery"]
}'
curl -XPUT "http://localhost:9200/movies/movie/4" -d'
{
    "title": "Apocalypse Now",
    "director": "Francis Ford Coppola",
    "year": 1979,
    "genres": ["Drama", "War"]
}'
curl -XPUT "http://localhost:9200/movies/movie/5" -d'
{
    "title": "Kill Bill: Vol. 1",
    "director": "Quentin Tarantino",
    "year": 2003,
    "genres": ["Action", "Crime", "Thriller"]
}'
curl -XPUT "http://localhost:9200/movies/movie/6" -d'
{
    "title": "The Assassination of Jesse James by the Coward Robert Ford",
    "director": "Andrew Dominik",
    "year": 2007,
    "genres": ["Biography", "Crime", "Drama"]
}'</code>
On peut vérifier que tout est bien intégré :
<code bash>{"_index":"movies","_type":"movie","_id":"1","_version":3,"created":false}
{"_index":"movies","_type":"movie","_id":"2","_version":1,"created":true}
{"_index":"movies","_type":"movie","_id":"3","_version":1,"created":true}
{"_index":"movies","_type":"movie","_id":"4","_version":1,"created":true}
{"_index":"movies","_type":"movie","_id":"5","_version":1,"created":true}
{"_index":"movies","_type":"movie","_id":"6","_version":1,"created":true}</code>

===Recherche globale===

Le mot clé **_search** se place à la fin d'un chemin pour rechercher tous les enregistrements au niveau du chemin.
Il est possible de rechercher respectivement dans tous :
  * Les indexes et types confondus : <code bash>curl -XGET "http://localhost:9200/_search"</code>
  * Les types d'un index précis : <code bash>curl -XGET "http://localhost:9200/movies/_search"</code>
  * Les ID liés à un coupleindexe/type précis : <code bash>curl -XGET "http://localhost:9200/movies/movie/_search"</code>
Comme nous n'avons qu'un seuls type et un seul index, le résultat sera sensiblement le même :
<code bash>{"took":43,"timed_out":false,"_shards":{"total":1,"successful":1,"failed":0},"hits":{"total":7,"max_score":1.0,"hits":[{"_index":"movies","_type":"movie","_id":"AVc-Cf49qZYpQV_XCKMq","_score":1.0,"_source":
{
    "title": "Star Wars",
    "director": "George Lucas",
    "year": 1977,
    "genres": ["Action", "Adventure", "Fantasy", "Sci-Fi"]
}},{"_index":"movies","_type":"movie","_id":"1","_score":1.0,"_source":
{
    "title": "The Godfather",
    "director": "Francis Ford Coppola",
    "year": 1972,
    "genres": ["Crime", "Drama"]
}},{"_index":"movies","_type":"movie","_id":"2","_score":1.0,"_source":
{
    "title": "Lawrence of Arabia",
    "director": "David Lean",
    "year": 1962,
    "genres": ["Adventure", "Biography", "Drama"]
}},{"_index":"movies","_type":"movie","_id":"3","_score":1.0,"_source":
{
    "title": "To Kill a Mockingbird",
    "director": "Robert Mulligan",
    "year": 1962,
    "genres": ["Crime", "Drama", "Mystery"]
}},{"_index":"movies","_type":"movie","_id":"4","_score":1.0,"_source":
{
    "title": "Apocalypse Now",
    "director": "Francis Ford Coppola",
    "year": 1979,
    "genres": ["Drama", "War"]
}},{"_index":"movies","_type":"movie","_id":"5","_score":1.0,"_source":
{
    "title": "Kill Bill: Vol. 1",
    "director": "Quentin Tarantino",
    "year": 2003,
    "genres": ["Action", "Crime", "Thriller"]
}},{"_index":"movies","_type":"movie","_id":"6","_score":1.0,"_source":
{
    "title": "The Assassination of Jesse James by the Coward Robert Ford",
    "director": "Andrew Dominik",
    "year": 2007,
    "genres": ["Biography", "Crime", "Drama"]
}}]}}</code>

===Recherche textuelle libre===

Il est possible d'adjoindre une requète au format JSON après le mot-clé _search pour affiner les résultats. Il faut placer dans la requète les mots clés :
  * ''query'' pour indiquer que l'on passe une requète
  * ''query_string'' pour indiquer que l'on recherche du texte
  * ''query : <MOTS CLES>'' pour indiquer que l'on recherche tout les textes contenant les mots clés
Par exemple, pour rechercher tous les films contenant le mot "kill", il faut faire :
<code bash>curl -XPOST "http://localhost:9200/_search" -d'
{
    "query": {
        "query_string": {
            "query": "kill"
        }
    }
}'</code>
Ce qui va donner :
<code bash>{"took":49,"timed_out":false,"_shards":{"total":1,"successful":1,"failed":0},"hits":{"total":2,"max_score":0.5772806,"hits":[{"_index":"movies","_type":"movie","_id":"3","_score":0.5772806,"_source":
{
    "title": "To Kill a Mockingbird",
    "director": "Robert Mulligan",
    "year": 1962,
    "genres": ["Crime", "Drama", "Mystery"]
}},{"_index":"movies","_type":"movie","_id":"5","_score":0.5772806,"_source":
{
    "title": "Kill Bill: Vol. 1",
    "director": "Quentin Tarantino",
    "year": 2003,
    "genres": ["Action", "Crime", "Thriller"]
}}]}}</code>
Le résultat peut-être décomposé en  parties :
  -

=====Voir aussi=====

====En français====

* **(fr)** [[https://fr.wikipedia.org/wiki/Elasticsearch]]
  * **(fr)** [[https://fr.wikipedia.org/wiki/Lucene]]
  * **(fr)** [[https://fr.wikipedia.org/wiki/Representational_state_transfer]]
  * **(fr)** [[https://fr.wikipedia.org/wiki/Hypertext_Transfer_Protocol]]
  * **(fr)** [[https://fr.wikipedia.org/wiki/JavaScript_Object_Notation]]

====En anglais=====

* **(en)** [[https://en.wikipedia.org/wiki/Elasticsearch]]
  * **(en)** [[https://www.elastic.co/]]
  * **(en)** [[https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-elasticsearch-on-ubuntu-16-04]]
  * **(en)** [[http://joelabrahamsson.com/elasticsearch-101/]]

Merci de recopier le code ci-contre pour prouver que vous êtes humain : Q I S C E Merci de laisser ce champ vide :

Résumé

Note : En modifiant cette page, vous acceptez que le contenu soit placé sous les termes de la licence suivante : CC Paternité-Partage des Conditions Initiales à l'Identique 3.0 Unported