User Documentation

How to Deploy Spring on with MongoDB

Sign up for Upsun

Get your free trial by clicking the link below.

Get your Upsun free trial

To activate MongoDB and then have it accessed by the Spring application already in, it is necessary to modify two files.

1. Add the MongoDB service Anchor to this heading

In your service configuration, include MongoDB with a valid supported version:

    type: mongodb:3.6
    disk: 512

2. Grant access to MongoDb through a relationship Anchor to this heading

In your app configuration, use the service name dbmongo to grant the application access to MongoDB via a relationship:
    mongodb: "mongodb:mongodb"

3. Export connection credentials to the environment Anchor to this heading

Connection credentials for services are exposed to the application container through the PLATFORM_RELATIONSHIPS environment variable from the deploy hook onward. Since this variable is a base64 encoded JSON object of all of your project’s services, you’ll likely want a clean way to extract the information specific to the database into it’s own environment variables that can be used by Spring. On, custom environment variables can be defined programmatically in a .environment file using jq to do just that:

export SPRING_DATA_MONGODB_USERNAME=`echo $PLATFORM_RELATIONSHIPS|base64 -d|jq -r ".dbmongo[0].username"`
export SPRING_DATA_MONGODB_PASSWORD=`echo $PLATFORM_RELATIONSHIPS|base64 -d|jq -r ".dbmongo[0].password"`
export SPRING_DATA_MONGODB_HOST=`echo $PLATFORM_RELATIONSHIPS|base64 -d|jq -r ".dbmongo[0].host"`
export SPRING_DATA_MONGODB_DATABASE=`echo $PLATFORM_RELATIONSHIPS|base64 -d|jq -r ".dbmongo[0].path"`
export JAVA_OPTS="-Xmx$(jq .info.limits.memory /run/config.json)m -XX:+ExitOnOutOfMemoryError"

4. Connect to the service Anchor to this heading

Commit that code and push. The application is ready and connected to a MongoDB instance.

Use Spring Data for MongoDB Anchor to this heading

You can use Spring Data MongoDB to use MongoDB with your app. First, determine the MongoDB client using the Java configuration reader library.

import com.mongodb.MongoClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import sh.platform.config.Config;
import sh.platform.config.MongoDB;

public class MongoConfig extends AbstractMongoConfiguration {

    private Config config = new Config();

    public MongoClient mongoClient() {
        MongoDB mongoDB = config.getCredential("database", MongoDB::new);
        return mongoDB.get();

    protected String getDatabaseName() {
        return config.getCredential("database", MongoDB::new).getDatabase();

Is this page helpful?