8000 GitHub - spring-projects/spring-data-mongodb: Provides 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.
[go: up one dir, main page]
Skip to content
/ spring-data-mongodb Public

Provides 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.

spring.io/projects/spring-data-mongodb/

License

Apache-2.0 license
1.6k stars 1.1k forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

spring-projects/spring-data-mongodb

BranchesTags

Repository files navigation

Spring Data MongoDB Spring Data MongoDB

Spring Data MongoDB icon?job=spring data mongodb%2Fmain&subject=Build Revved up by Develocity

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
  protected String getDatabaseName() {
    return "springdata";
  }
}

Maven configuration

Add the Maven dependency:

<dependency>
  <groupId>org.springframework.data</groupId>
  <artifactId>spring-data-mongodb</artifactId>
  <version>${version}</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}-SNAPSHOT</version>
</dependency>

<repository>
  <id>spring-snapshot</id>
  <name>Spring Snapshot Repository</name>
  <url>https://repo.spring.io/snapshot</url>
</repository>

Upgrading

Instructions for how to upgrade from earlier versions of Spring Data are provided on the project wiki. Follow the links in the release notes section to find the version that you want to upgrade to.

Getting Help

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

Reporting Issues

Spring Data uses Github 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 does not 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, the JVM version, Stacktrace, etc.

  • If you need to paste code, or include a stack trace use Markdown code fences ```.

Guides

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

Examples

Building from Source

You do not need to build from source to use Spring Data. Binaries are available in repo.spring.io and accessible from Maven using the Maven configuration noted above.

Note
 Configuration for Gradle is similar to Maven.

The best way to get started is by creating a Spring Boot project using MongoDB on start.spring.io. Follow this link to build an imperative application and this link to build a reactive one.

However, if you want to try out the latest and greatest, Spring Data MongoDB can be easily built with the Maven wrapper and minimally, JDK 17 (JDK downloads).

In order to build Spring Data MongoDB, you will need to download and install a MongoDB distribution.

Once you have installed MongoDB, you need to start a MongoDB server. It is convenient to set an environment variable to your MongoDB installation directory (e.g. MONGODB_HOME).

To run the full test suite, a MongoDB Replica Set is required.

To run the MongoDB server enter the following command from a command-line:

$ $MONGODB_HOME/bin/mongod --dbpath $MONGODB_HOME/runtime/data --ipv6 --port 27017 --replSet rs0
...
"msg":"Successfully connected to host"

Once the MongoDB server starts up, you should see the message (msg), "Successfully connected to host".

Notice the --dbpath option to the mongod command. You can set this to anything you like, but in this case, we set the absolute path to a sub-directory (runtime/data/) under the MongoDB installation directory (in $MONGODB_HOME).

You need to initialize the MongoDB replica set only once on the first time the MongoDB server is started. To initialize the replica set, start a mongo client:

$ $MONGODB_HOME/bin/mongo
MongoDB server version: 6.0.0
...

Then enter the following command:

mongo> rs.initiate({ _id: 'rs0', members: [ { _id: 0, host: '127.0.0.1:27017' } ] })

Finally, on UNIX-based system (for example, Linux or Mac OS X) you may need to adjust the ulimit. In case you need to, you can adjust the ulimit with the following command (32768 is just a recommendation):

$ ulimit -n 32768

You can use ulimit -a again to verify the ulimit for "open files" was set appropriately.

Now you are ready to build Spring Data MongoDB. Simply enter the following mvnw (Maven Wrapper) command:

 $ ./mvnw clean install

If you want to build with the regular mvn command, you will need Maven v3.8.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 -Pantora

The generated documentation is available from target/antora/site/index.html.

License

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

About

Provides 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.

spring.io/projects/spring-data-mongodb/

Topics

java framework spring mongodb spring-data ddd

Resources

Readme

License

Apache-2.0 license

Code of conduct

Code of conduct

Security policy

Security policy
Activity
Custom properties

Stars

1.6k stars

Watchers

168 watching

Forks

1.1k forks
Report repository

Releases 163

4.5.1 Latest
Jun 13, 2025
+ 162 releases

Contributors 172
+ 158 contributors

Languages

0