README.adoc

Spring Data for Apache Solr

Warning

Spring Data for Apache Solr had been discontinued in early 2020 and exceeded its support timeline in February 2023. The team has laid out the reasons to discontinue the project here. The repository is in read-only mode having issues, comments and pull requests disabled. For current users of Spring Data Solr, we recommend to look into alternative search-engine-related modules like Spring Data Elasticsearch.

The primary goal of the 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 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 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:

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("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:

<dependency>
  <groupId>org.springframework.data</groupId>
  <artifactId>spring-data-solr</artifactId>
  <version>${version}.RELEASE</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>org.springframework.data</groupId>
  <artifactId>spring-data-solr</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 reference documentation, and Javadocs.

• Learn the Spring basics – Spring Data builds on Spring Framework, check the spring.io web-site for a wealth of reference documentation. If you are just starting out with Spring, try one of the guides.

• If you are upgrading, check out the changelog for “new and noteworthy” features.

• Ask a question - we monitor stackoverflow.com for questions tagged with spring-data-solr. You can also chat with the community on Gitter.

• Report bugs with Spring Data for Apache Solr at 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 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 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 repo.spring.io), but if you want to try out the latest and greatest, Spring Data can be easily built with the maven wrapper. You also need JDK 1.8.

 $ ./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, and in particular please sign the Contributor’s Agreement before your first non-trivial change.

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.

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 Apache 2.0 license.