mirror of
https://github.com/spring-projects/spring-data-elasticsearch.git
synced 2025-05-31 09:12:11 +00:00
202 lines
8.6 KiB
Plaintext
202 lines
8.6 KiB
Plaintext
image:https://spring.io/badges/spring-data-elasticsearch/ga.svg[Spring Data Elasticsearch,link=https://projects.spring.io/spring-data-elasticsearch#quick-start] image:https://spring.io/badges/spring-data-elasticsearch/snapshot.svg[Spring Data Elasticsearch,link=https://projects.spring.io/spring-data-elasticsearch#quick-start]
|
||
|
||
= Spring Data for Elasticsearch image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-elasticsearch%2Fmaster&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-elasticsearch/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]]
|
||
|
||
The primary goal of the https://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
|
||
|
||
The Spring Data Elasticsearch project provides integration with the https://www.elastic.co/[Elasticsearch] search engine. Key functional areas of Spring Data Elasticsearch are a POJO centric model for interacting with a Elasticsearch Documents and easily writing a Repository style data access layer.
|
||
|
||
This project is lead and maintained by the community.
|
||
|
||
== Features
|
||
|
||
* Spring configuration support using Java based `@Configuration` classes or an XML namespace for a ES clients instances.
|
||
* `ElasticsearchTemplate` helper class that increases productivity performing common ES operations. Includes integrated object mapping between documents and POJOs.
|
||
* Feature Rich Object Mapping integrated with Spring’s Conversion Service
|
||
* Annotation based mapping metadata but extensible to support other metadata formats
|
||
* Automatic implementation of `Repository` interfaces including support for custom finder methods.
|
||
* CDI support for repositories
|
||
|
||
== Code of Conduct
|
||
|
||
This project is governed by the link:CODE_OF_CONDUCT.adoc[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
||
|
||
== Getting Started
|
||
|
||
Here is a quick teaser of an application using Spring Data Repositories in Java:
|
||
|
||
[source,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 Node Client
|
||
|
||
[source,xml]
|
||
----
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
<beans xmlns="http://www.springframework.org/schema/beans"
|
||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
|
||
xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
|
||
http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
|
||
|
||
<elasticsearch:node-client id="client" local="true"/>
|
||
|
||
<bean name="elasticsearchTemplate" class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
|
||
<constructor-arg name="client" ref="client"/>
|
||
</bean>
|
||
|
||
</beans>
|
||
----
|
||
|
||
Using Transport Client
|
||
|
||
[source,xml]
|
||
----
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
<beans xmlns="http://www.springframework.org/schema/beans"
|
||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
xmlns:elasticsearch="http://www.springframework.org/schema/data/elasticsearch"
|
||
xsi:schemaLocation="http://www.springframework.org/schema/data/elasticsearch https://www.springframework.org/schema/data/elasticsearch/spring-elasticsearch.xsd
|
||
http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
|
||
|
||
<elasticsearch:repositories base-package="com.xyz.acme"/>
|
||
|
||
<elasticsearch:transport-client id="client" cluster-nodes="ip:9300,ip:9300" cluster-name="elasticsearch" />
|
||
|
||
<bean name="elasticsearchTemplate" class="org.springframework.data.elasticsearch.core.ElasticsearchTemplate">
|
||
<constructor-arg name="client" ref="client"/>
|
||
</bean>
|
||
|
||
</beans>
|
||
----
|
||
|
||
=== Maven configuration
|
||
|
||
Add the Maven dependency:
|
||
|
||
[source,xml]
|
||
----
|
||
<dependency>
|
||
<groupId>org.springframework.data</groupId>
|
||
<artifactId>spring-data-elasticsearch</artifactId>
|
||
<version>${version}.RELEASE</version>
|
||
</dependency>
|
||
----
|
||
|
||
**Compatibility Matrix**
|
||
|
||
[cols="^,^"]
|
||
|===
|
||
|Spring Data Elasticsearch | Elasticsearch
|
||
|3.2.x |6.7.2
|
||
|3.1.x |6.2.2
|
||
|3.0.x |5.5.0
|
||
|2.1.x |2.4.0
|
||
|2.0.x |2.2.0
|
||
|1.3.x |1.5.2
|
||
|===
|
||
|
||
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
|
||
|
||
[source,xml]
|
||
----
|
||
<dependency>
|
||
<groupId>org.springframework.data</groupId>
|
||
<artifactId>spring-data-elasticsearch</artifactId>
|
||
<version>${version}.BUILD-SNAPSHOT</version>
|
||
</dependency>
|
||
|
||
<repository>
|
||
<id>spring-libs-snapshot</id>
|
||
<name>Spring Snapshot Repository</name>
|
||
<url>https://repo.spring.io/libs-snapshot</url>
|
||
</repository>
|
||
----
|
||
|
||
== Getting Help
|
||
|
||
Having trouble with Spring Data? We’d love to help!
|
||
|
||
* Check the
|
||
https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/elasticsearch/docs/current/api/[Javadocs].
|
||
* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
|
||
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
|
||
* If you are upgrading, check out the https://docs.spring.io/spring-data/elasticsearch/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
|
||
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-elasticsearch`].
|
||
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].
|
||
* Report bugs with Spring Data for Elasticsearch at https://jira.spring.io/browse/DATAES[jira.spring.io/browse/DATAES].
|
||
|
||
== Reporting Issues
|
||
|
||
Spring Data uses JIRA 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
|
||
https://jira.spring.io/browse/DATAES[issue tracker] to see if someone has already reported the problem.
|
||
* If the issue doesn’t already exist, https://jira.spring.io/browse/DATAES[create a new issue].
|
||
* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version.
|
||
* If you need to paste code, or include a stack trace use JIRA `{code}…{code}` escapes before and after your text.
|
||
* 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
|
||
|
||
You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
|
||
You also need JDK 1.8.
|
||
|
||
[source,bash]
|
||
----
|
||
$ ./mvnw clean install
|
||
----
|
||
|
||
If you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.5.0 or above].
|
||
|
||
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first non-trivial change._
|
||
|
||
=== Building reference documentation
|
||
|
||
Building the documentation builds also the project without running tests.
|
||
|
||
[source,bash]
|
||
----
|
||
$ ./mvnw clean install -Pdistribute
|
||
----
|
||
|
||
The generated documentation is available from `target/site/reference/html/index.html`.
|
||
|
||
== Examples
|
||
|
||
For examples on using the _Spring Data for Elasticsearch, see the https://github.com/SpringSource/spring-elasticsearch-examples[spring-elasticsearch-examples] project.
|
||
|
||
== License
|
||
|
||
Spring Data for Elasticsearch Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
|