Skip to content

Latest commit

 

History

History
121 lines (87 loc) · 4.3 KB

README.adoc

File metadata and controls

121 lines (87 loc) · 4.3 KB
Raw

Spring Data for Meilisearch

Maven Central Maintainability Rating Coverage License

The Spring Data Meilisearch project provides integration with the Meilisearch search engine.

Features

  • Spring Configuration support using Java based @Configuration classes or an XML namespace for the Meilisearch client.

  • Implementation of CRUD methods for Meilisearch Documents.

Getting Started

Here is a quick teaser of an application using Spring Data Repositories in Java:

public interface MovieRepository extends CrudRepository<Movie, Integer> { }

@Service
public class MyService {

    @Autowired private MovieRepository repository;

    public void doWork(Movie movie) {
        repository.save(movie);
    }
}

@Configuration
@EnableMeilisearchRepositories
public class Config extends MeilisearchConfiguration {

    @Override
    public ClientConfiguration clientConfiguration() {
        return ClientConfiguration.builder()
                .connectedToLocalhost()
                .withApiKey("masterKey")
                .build();
    }
}

Maven configuration

Add the Maven dependency:

<dependency>
  <groupId>io.vanslog</groupId>
  <artifactId>spring-data-meilisearch</artifactId>
  <version>${version}</version>
</dependency>

If you’d rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.

<dependency>
    <groupId>io.vanslog</groupId>
    <artifactId>spring-data-meilisearch</artifactId>
    <version>${version}-SNAPSHOT</version>
</dependency>

<repository>
    <id>sonatype-snapshots</id>
    <name>Sonatype Snapshot Repository</name>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
</repository>

Guide

Reporting Issues

Spring Data uses GitHub as issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:

  • Before you log a bug, please search the issue tracker to see if someone has already reported the problem.

  • If the issue doesn’t already exist, create a new issue.

  • Please provide as much information as possible with the issue report, we like to know the version of Spring Data Meilisearch that you are using and JVM version.

  • If you need to paste code, or include a stack trace format it as code using triple backtick.

  • If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.

Building from Source

Spring Data can be easily built with the maven wrapper. You also need JDK 17 or above.

 $ ./mvnw clean install

If you want to build with the regular mvn command, you will need Maven v3.5.0 or above.

Also see CONTRIBUTING.adoc if you wish to submit pull requests.

Building reference documentation

Building the documentation builds also the project without running tests.

 $ ./mvnw clean install -Pdistribute

The generated documentation is available from target/site/reference/html/index.html.

License

Spring Data Meilisearch is Open Source software released under the Apache 2.0 license.