spring-data-elasticsearch

Introduction to Spring Data Elasticsearch

Spring Data Elasticsearch is a key project within the Spring ecosystem, designed to simplify data operations using the powerful Elasticsearch search engine. The primary aim of Spring Data is to assist developers in building Spring-powered applications that easily adopt new data access technologies such as non-relational databases, map-reduce frameworks, and cloud-based services.

Spring Data Elasticsearch provides a seamless integration with Elasticsearch, a robust distributed search and analytics engine. This project is maintained and guided by the Spring community, enhancing its functionality through community-driven efforts.

Key Features

Spring Data Elasticsearch is rich with features that simplify and automate interactions with Elasticsearch:

• Spring Configuration Support: Developers can configure Elasticsearch client instances using Java-based @Configuration classes or XML namespaces.

• Enhanced ElasticsearchOperations Class: This class and its implementations assist in performing common Elasticsearch operations effectively. It features an integrated object-mapping layer transforming documents into Plain Old Java Objects (POJOs) and vice versa.

• Feature-rich Object Mapping: The project includes in-depth object mapping integrated with Spring's Conversion Service, coupled with annotation-based mapping metadata.

• Repository Interfaces: Automatically implements repository interfaces with support for custom search methods. This allows developers to focus on defining their domain model and repository interfaces.

• CDI Support For Repositories: Provides support for Contexts and Dependency Injection (CDI), offering more control over dependency management within repositories.

Code of Conduct

The project adheres to the Spring Code of Conduct, which emphasizes respectful and inclusive interaction. Participants are encouraged to report any inappropriate behavior as outlined in the conduct documentation.

Getting Started

Here's a brief example showcasing a simple application using Spring Data Repositories in Java:

public interface PersonRepository extends CrudRepository<Person, Long> {

    List<Person> findByLastname(String lastname);

    List<Person> findByFirstnameLike(String firstname);
}

@Service
public class MyService {

    private final PersonRepository repository;

    public MyService(PersonRepository repository) {
        this.repository = repository;
    }

    public void doWork() {

        repository.deleteAll();

        Person person = new Person();
        person.setFirstname("Oliver");
        person.setLastname("Gierke");
        repository.save(person);

        List<Person> lastNameResults = repository.findByLastname("Gierke");
        List<Person> firstNameResults = repository.findByFirstnameLike("Oli");
    }
}

Using the RestClient

Users should refer to the official documentation for detailed instructions on configuring Elasticsearch RestClient.

Maven Configuration

To integrate Spring Data Elasticsearch into a project, add the following Maven dependency:

<dependency>
  <groupId>org.springframework.data</groupId>
  <artifactId>spring-data-elasticsearch</artifactId>
  <version>${version}</version>
</dependency>

For compatibility and version information, consult the reference documentation.

Getting Help

If developers encounter issues, they have several resources available:

• Review the reference documentation, and Javadocs.
• Engage with the community on Gitter.
• Track or report issues via GitHub.

Reporting Issues

To report bugs or feature requests, follow these steps:

• Search existing GitHub issues to avoid duplicates.
• If the issue is not found, create a new issue providing detailed information such as the version of Spring Data Elasticsearch and the JVM being used.

Building From Source

While using pre-built binaries from repo.spring.io is sufficient for most users, developers interested in the latest features can build the project from source. Building requires JDK 17 or above for the main branch. For prior releases up to 4.4, JDK 8 is needed.

Use the following command to build:

./mvnw clean install

Example Usage

Examples showcasing Spring Data Elasticsearch can be found in the spring-data-examples project on GitHub.

License

Spring Data for Elasticsearch is open-source software released under the Apache 2.0 license.