image:https://spring.io/badges/spring-data-solr/ga.svg[Spring Data for Apache Solr,link=https://projects.spring.io/spring-data-solr/#quick-start]
image:https://spring.io/badges/spring-data-solr/snapshot.svg[Spring Data for Apache Solr,link=https://projects.spring.io/spring-data-solr/#quick-start]
= Spring Data for Apache Solr image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-solr%2Fmaster&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-solr/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]]
![https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]]](https://gitter.im/spring-projects/spring-data%5Bimage:https://badges.gitter.im/spring-projects/spring-data.svg%5BGitter%5D%5D){kind=link}
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 for Apache Solr project provides integration with the https://lucene.apache.org/solr/[Apache Solr] search engine
Providing its own extensible MappingSolrConverter as alternative to DocumentObjectBinder Spring Data for Apache Solr handles inheritance as well as usage of custom Types such as Point or DateTime
== Features
- High level repository abstractions with multicore support
- Annotations for Boost-, Facet- and Highlighting
- Customizable type mappings and type conversions
- Solr template supporting fluent query api
- Exception translation to Spring’s portable Data Access exception hierarchy
== 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 findByLastname(String lastname);
List 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("Christoph");
person.setLastname("Strobl");
repository.save(person);
List<Person> lastNameResults = repository.findByLastname("Strobl");
List<Person> firstNameResults = repository.findByFirstnameLike("C*");
}
}
@Configuration
@EnableSolrRepositories(schemaCreationSupport = true)
class Config {
@Bean
public SolrClient solrClient() {
return new HttpSolrClient("http://localhost:8983/solr");
}
}
=== Maven configuration
Add the Maven dependency:
[source,xml]
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]
== Getting Help
Having trouble with Spring Data? We’d love to help!
- Check the
https://docs.spring.io/spring-data/solr/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/solr/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/solr/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-solr`].
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter]. - Report bugs with Spring Data for Apache Solr at https://jira.spring.io/browse/DATASOLR[jira.spring.io/browse/DATASOLR].
== 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/DATASOLR[issue tracker] to see if someone has already reported the problem. - If the issue doesn’t already exist, https://jira.spring.io/browse/DATASOLR[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
- https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.
== License
Spring Data for Apache Solr is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].