Skip to content
Provide support to increase developer productivity in Java when using MongoDB. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java Kotlin
Branch: master
Clone or download
mp911de DATAMONGO-2341 - Polishing.
Inline MongoPersistentEntity.idPropertyIsShardKey() into UpdateContext. Move mapped shard key cache to QueryOperations level. Simplify conditionals. Tweak documentation.

Original pull request: #833.
Latest commit 22ca597 Feb 17, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github DATAMONGO-1589 - Update project documentation with the CLA tool integ… Jan 13, 2017
.mvn/wrapper DATAMONGO-2280 - Set user.name and user.home for CI jobs. Jun 25, 2019
ci DATAMONGO-2427 - Simplify docker setup. Jan 27, 2020
spring-data-mongodb-benchmarks DATAMONGO-2456 - Prepare next development iteration. Feb 12, 2020
spring-data-mongodb-distribution DATAMONGO-2456 - Prepare next development iteration. Feb 12, 2020
spring-data-mongodb DATAMONGO-2341 - Polishing. Feb 17, 2020
src/main DATAMONGO-2341 - Polishing. Feb 17, 2020
.gitignore DATAMONGO-1721 - Fixed package dependencies. Jul 13, 2017
.travis.yml DATAMONGO-2461 - Polishing. Feb 5, 2020
CI.adoc DATAMONGO-2318 - Revise readme for a consistent structure. Jul 9, 2019
CODE_OF_CONDUCT.adoc DATAMONGO-2231 - URL Cleanup. Mar 21, 2019
CONTRIBUTING.adoc DATAMONGO-1371 - Added code of conduct. Feb 2, 2016
Jenkinsfile DATAMONGO-2461 - Efficient resource usage and ci related improvments. Feb 5, 2020
README.adoc DATAMONGO-2427 - Update GridFS API to use MongoDB native ByteBuffer P… Jan 27, 2020
SECURITY.adoc DATAMONGO-2292 - Create security policy readme. May 31, 2019
lombok.config DATAMONGO-1678 - Polishing. Jun 26, 2017
mvnw DATAMONGO-2231 - URL Cleanup. Mar 19, 2019
mvnw.cmd DATAMONGO-2231 - URL Cleanup. Mar 19, 2019
pom.xml DATAMONGO-2474 - Upgrade to MongoDB driver 4.0.0-rc0. Feb 14, 2020

README.adoc

Spring Data MongoDB Spring Data MongoDB

Spring Data MongoDB icon?job=spring data mongodb%2Fmaster&subject=Build Gitter

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 MongoDB project aims to provide a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities. The Spring Data MongoDB project provides integration with the MongoDB document database. Key functional areas of Spring Data MongoDB are a POJO centric model for interacting with a MongoDB Document and easily writing a repository style data access layer.

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("Oliver");
    person.setLastname("Gierke");
    repository.save(person);

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

@Configuration
@EnableMongoRepositories
class ApplicationConfig extends AbstractMongoClientConfiguration {

  @Override
  public MongoClient mongoClient() {
    return MongoClients.create();
  }

  @Override
  protected String getDatabaseName() {
    return "springdata";
  }
}

Maven configuration

Add the Maven dependency:

<dependency>
  <groupId>org.springframework.data</groupId>
  <artifactId>spring-data-mongodb</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-mongodb</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>

Upgrading from 2.x

The 4.0 MongoDB Java Driver does no longer support certain features that have already been deprecated in one of the last minor versions. Some of the changes affect the initial setup configuration as well as compile/runtime features. We summarized the most typical changes one might encounter.

XML Namespace

Table 1. Changed XML Namespace Elements and Attributes:
Element / Attribute 2.x 3.x

<mongo:mongo-client />

Used to create a com.mongodb.MongoClient

Now exposes a com.mongodb.client.MongoClient

<mongo:mongo-client replica-set="…​" />

Was a comma delimited list of replica set members (host/port)

Now defines the replica set name.
Use <mongo:client-settings cluster-hosts="…​" /> instead

<mongo:db-factory writeConcern="…​" />

NONE, NORMAL, SAFE, FSYNC_SAFE, REPLICAS_SAFE, MAJORITY

W1, W2, W3, UNAKNOWLEDGED, AKNOWLEDGED, JOURNALED, MAJORITY

Table 2. Removed XML Namespace Elements and Attributes:
Element / Attribute Replacement in 3.x Comment

<mongo:db-factory mongo-ref="…​" />

<mongo:db-factory mongo-client-ref="…​" />

Referencing a com.mongodb.client.MongoClient.

<mongo:mongo-client credentials="…​" />

<mongo:mongo-client credential="…​" />

Single authentication data instead of list.

<mongo:client-options />

<mongo:client-settings />

See com.mongodb.MongoClientSettings for details.

Table 3. New XML Namespace Elements and Attributes:
Element Comment

<mongo:db-factory mongo-client-ref="…​" />

Replacement for <mongo:db-factory mongo-ref="…​" />

<mongo:db-factory connection-string="…​" />

Replacement for uri and client-uri.

<mongo:mongo-client connection-string="…​" />

Replacement for uri and client-uri.

<mongo:client-settings />

Namespace element for com.mongodb.MongoClientSettings.

Java Configuration

Table 4. Java API changes
Type Comment

MongoClientFactoryBean

Creates com.mongodb.client.MongoClient instead of com.mongodb.MongoClient
Uses MongoClientSettings instead of MongoClientOptions.

MongoDataIntegrityViolationException

Uses WriteConcernResult instead of WriteResult.

BulkOperationException

Uses MongoBulkWriteException and com.mongodb.bulk.BulkWriteError instead of BulkWriteException and com.mongodb.BulkWriteError

ReactiveMongoClientFactoryBean

Uses com.mongodb.MongoClientSettings instead of com.mongodb.async.client.MongoClientSettings

ReactiveMongoClientSettingsFactoryBean

Now produces com.mongodb.MongoClientSettings instead of com.mongodb.async.client.MongoClientSettings

Table 5. Removed Java API:
2.x Replacement in 3.x Comment

MongoClientOptionsFactoryBean

MongoClientSettingsFactoryBean

Creating a com.mongodb.MongoClientSettings.

AbstractMongoConfiguration

AbstractMongoClientConfiguration
(Available since 2.1)

Using com.mongodb.client.MongoClient.

MongoDbFactory#getLegacyDb()

-

-

SimpleMongoDbFactory

SimpleMongoClientDbFactory
(Available since 2.1)

MapReduceOptions#getOutputType()

MapReduceOptions#getMapReduceAction()

Returns MapReduceAction instead of MapReduceCommand.OutputType.

Meta|Query maxScan & snapshot

Other Changes

UUID Types

The MongoDB UUID representation can now be configured with different formats. This has to be done via MongoClientSettings as shown in the snippet below.

Example 1. UUID Codec Configuration
static class Config extends AbstractMongoClientConfiguration {

    @Override
    public void configureClientSettings(MongoClientSettings.Builder builder) {
        builder.uuidRepresentation(UuidRepresentation.STANDARD);
    }

    // ...
}

Getting Help

Having trouble with Spring Data? We’d love to help!

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.

Guides

The spring.io site contains several guides that show how to use Spring Data step-by-step:

Examples

License

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

You can’t perform that action at this time.