The Search add-on enables full-text search capabilities in your application. It allows you to set up indexing of entities and uploaded files and provides API and UI controls for searching through the indexed data. Search results are filtered according to the data access permissions of the current user.
The add-on uses Elasticsearch as its search engine. More information about search internals and indexing can be found in Elasticsearch documentation.
For automatic installation through Jmix Marketplace, follow instructions in the Add-ons section.
For manual installation, add the following dependencies to your
implementation "io.jmix.search:jmix-search-starter" implementation "io.jmix.search:jmix-search-ui-starter"
Connecting to Elasticsearch Service
To connect to the Elasticsearch service, specify the following properties in the
jmix.search.elasticsearch.url- a full URL of the Elasticsearch cluster.
jmix.search.elasticsearch.login- a user login to connect to the Elasticsearch cluster.
jmix.search.elasticsearch.password- a user password to connect to the Elasticsearch cluster.
By default, the Search add-on is is configured for Elasticsearch version 7.11 and above. If you need to use a version below 7.11, set the jmix.search.rest-high-level-client-api-compatibility-mode-enabled application property to
|Note that the Search add-on is currently incompatible with Elasticsearch service provided by AWS.|