This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Data Meilisearch 0.10.0!

Client Configuration

Spring Data Meilisearch operates on top of the Meilisearch Java client and exposes a Spring-friendly configuration model for creating and wiring the client.

In most applications, the entry point is a Java configuration class that extends MeilisearchConfiguration. XML namespace support is available for applications that still use XML-based container configuration.

JavaConfig

Extend MeilisearchConfiguration to provide the ClientConfiguration bean. The base class also registers the default GsonJsonHandler, MeilisearchClient, mapping context, converter, and meilisearchTemplate bean.

import io.vanslog.spring.data.meilisearch.client.ClientConfiguration;
import io.vanslog.spring.data.meilisearch.config.MeilisearchConfiguration;

import org.springframework.context.annotation.Configuration;

@Configuration
class MyClientConfig extends MeilisearchConfiguration {

    @Override
    public ClientConfiguration clientConfiguration() {
        return ClientConfiguration.builder()
                .connectedTo("http://localhost:7700")
                .withApiKey(System.getenv("MEILISEARCH_API_KEY"))
                .withRequestTimeout(2_000)
                .withRequestInterval(20)
                .build();
    }
}

ClientConfiguration Builder

ClientConfiguration exposes the following core options through its builder:

connectedTo(…) or connectedToLocalhost() to choose the server endpoint.
withApiKey(…) to provide the Meilisearch API key.
withClientAgents(…) to append client agent values.
withRequestTimeout(…) to configure how long task-based operations wait for completion.
withRequestInterval(…) to configure the polling interval used while waiting for task completion.

These timeout and interval settings affect operations that submit asynchronous Meilisearch tasks, such as writes, index lifecycle changes, and runtime settings updates.

JSON Handler

MeilisearchConfiguration registers GsonJsonHandler by default. The JsonHandler configures the underlying Meilisearch Java SDK transport. Entity document mapping and document JSON payloads are handled by Spring Data Meilisearch through MeilisearchConverter and the meilisearchObjectMapper bean. Override jsonHandler() when you need a different implementation.

import com.meilisearch.sdk.json.JacksonJsonHandler;
import com.meilisearch.sdk.json.JsonHandler;

import org.springframework.context.annotation.Configuration;

@Configuration
class JsonHandlerConfig extends MeilisearchConfiguration {

    @Override
    public JsonHandler jsonHandler() {
        return new JacksonJsonHandler();
    }
}

The supported integration styles are:

com.meilisearch.sdk.json.GsonJsonHandler
com.meilisearch.sdk.json.JacksonJsonHandler
Any custom implementation of com.meilisearch.sdk.json.JsonHandler

XML Namespace

Spring Data Meilisearch also provides an XML namespace. Register a JSON handler bean and reference it from <meilisearch:meilisearch-client> when you do not want to use the default bean name. For production deployments, prefer a scoped API key rather than the Meilisearch master key.

<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:meilisearch="http://www.vanslog.io/spring/data/meilisearch"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.vanslog.io/spring/data/meilisearch
       http://www.vanslog.io/spring/data/meilisearch/spring-meilisearch-1.0.xsd">

    <bean id="jsonHandler" class="com.meilisearch.sdk.json.GsonJsonHandler"/>

    <meilisearch:meilisearch-client
            id="meilisearchClient"
            host-url="http://localhost:7700"
            api-key="${MEILISEARCH_API_KEY}"
            request-timeout="2000"
            request-interval="20"
            json-handler-ref="jsonHandler"/>
</beans>

The XML namespace attributes are documented in XML namespace reference.