Using Elasticsearch

Elasticsearch is an option that adds search capabilities on top of your database.

This option has some limitations:

  • It only works with SQL databases. MongoDB, Cassandra and Couchbase support will be added in the future (help is welcome!).
  • There is no consistency between your database and Elasticsearch, so you might have out-of-sync data. This is normal, as Elasticsearch is not a real database. As a result, you will probably need to write some specific code to synchronize your data, for example using the Spring @Scheduled annotation, to run every evening.
    • This also means if your database is changed outside of your application, your search indexes will be out-of-sync. The Elasticsearch Reindexer JHipster module can help in these situations.

When the Elasticsearch option is selected:

  • Spring Data Elasticsearch is being used, and is automatically configured by Spring Boot (here is the documentation).
  • The “repository” package has new subpackage, called “search”, that holds all ElastiSearch repositories.
  • The “User” entity gets indexed in Elasticsearch, and you can query is using the /api/_search/users/:query REST endpoint.
  • When the entity sub-generator is used, the generated entity gets automatically indexed by Elasticsearch, and is used in the REST endpoint. Search capabilities are also added to the AngularJS user interface, so you can search your entity in the main CRUD screen.

Using in Development

In development, JHipster uses an embedded Elasticsearch cluster. The embedded instance is configured to store data files under the target folder, a simple ./mvn clean will destroy the persisted indices. You will need to re-index your data if this happens.

You can enable HTTP access by adding this configuration in application-dev.yml :

          enabled: true

Using in Production

In production, JHipster expects an external Elasticsearch instance. By default, the application looks for an Elasticsearch instance running on localhost. This can be configured by using the standard Spring Boot properties, in the application-prod.yml file.