MongoDB (Database service)

MongoDB is a cross-platform, document-oriented database.

For more information on using MongoDB, see MongoDB's own documentation.

Supported versions

  • 3.0
  • 3.2
  • 3.4
  • 3.6


Downgrades of MongoDB are not supported. MongoDB will update its own datafiles to a new version automatically but cannot downgrade them. If you want to experiment with a later version without committing to it use a non-master environment.


The format exposed in the $PLATFORM_RELATIONSHIPS environment variable:

   "database" : [
         "scheme" : "mongodb",
         "path" : "main",
         "port" : 27017,
         "query" : {
            "is_master" : true
         "rel" : "mongodb",
         "password" : "main",
         "username" : "main",
         "ip" : "",
         "host" : "database.internal"

Usage example

In your .platform/services.yaml:

    type: mongodb:3.6
    disk: 1024

In your

    database: "mydatabase:mongodb"

For PHP, in your add:

        - mongodb

(Before PHP 7, use mongo instead.)

You can then use the service in a configuration file of your application with something like:

// First run `composer require mongodb/mongodb` to get the userspace
// library, and autoload it.  Then:

if ($relationships = getenv('PLATFORM_RELATIONSHIPS')) {
    $relationships = json_decode(base64_decode($relationships), TRUE);

    // For a relationship named 'database' referring to one endpoint.
    if (!empty($relationships['database'])) {
        foreach ($relationships['database'] as $endpoint) {
            $settings = $endpoint;

$server = sprintf('%s://%s:%s@%s:%d/%s',

$client = new MongoDB\Client($server);
$collection = $client->main->starwars;

$result = $collection->insertOne( [ 'name' => 'Rey', 'occupation' => 'Jedi' ] );

echo "Inserted with Object ID '{$result->getInsertedId()}'";
var config= require("platformsh").config();
var db = config.relationships.database[0];
var url = db["scheme"] + '://' + db["username"] + ':' + db['password']+ "@" + db['ip']+ ":" + db['port']+ '/' + db['path'];

var MongoClient = require('mongodb').MongoClient
  , assert = require('assert');

// Use connect method to connect to the server
MongoClient.connect(url, function(err, db) {
  assert.equal(null, err);
  console.log("Connected successfully to server");


Exporting data

The most straightforward way to export data from a MongoDB database is to open an SSH tunnel to it and simply export the data directly using MongoDB's tools.

First, open an SSH tunnel with the CLI:

platform tunnel:open

That will open an SSH tunnel to all services on your current environment, and produce output something like the following:

SSH tunnel opened on port 30000 to relationship: mongodb
SSH tunnel opened on port 30001 to relationship: redis

The port may vary in your case. You will also need to obtain the user, password, and database name from the relationships array, as above.

Then, simply connect to that port locally using mongodump (or your favorite MongoDB tools) to export all data in that server:

mongodump --port 30000 -u main -p main --authenticationDatabase main --db main

(If necessary, vary the -u, -p, --authenticationDatabase and --db flags.)

As with any other shell command it can be piped to another command to compress the output or redirect it to a specific file.

For further references please see the official mongodump documentation.


To upgrade to 3.6 from a version earlier than 3.4, you must successively upgrade major releases until you have upgraded to 3.4. For example, if you are running a 3.0 image, you must upgrade first to 3.2 and then upgrade to 3.4 before you can upgrade to 3.6.

For more details on upgrading and how to handle potential application backward compatibility issues, please see Release Notes for MongoDB.