MongoDB Adapter

MongoDB Adapter gives your site its own MongoDB database. It is set up for you by the Domma CMS Manager that runs your site. There is nothing to configure on the site itself.

What it does

• Gives the site a dedicated MongoDB database, separate from every other site.
• Gives the site its own database login, which can only reach that one database. The master database password never sits on your site.
• Lets the site store data in MongoDB instead of in files on the server.

Once the database is in place, these become available:

• Collections: a Storage tab in the collection editor, where you can move a collection from file storage to MongoDB.
• Actions: Actions keep their settings in MongoDB, so they need it.
• Plugins that use MongoDB. For example, Surveys stores its data in MongoDB when it can, and Email Pro needs it for search, threads, rules, scheduled sends, snooze and vacation replies. Data Transfer can move collections between file and MongoDB storage.

Without a MongoDB database, all of these fall back to file storage or are unavailable, and the rest of the site works as normal.

Getting started

MongoDB Adapter is managed-only: it is only offered for sites run by a Domma CMS Manager. On any other site it has nothing to do.

1. Ask whoever runs your Domma CMS Manager to grant MongoDB Adapter to your site.
2. The Manager creates the database and its login, installs the plugin and restarts your site.
3. Open Collections, edit a collection and check that the Storage tab is there.

That is all. There is no screen for this plugin in your admin.

Screens

None. The plugin has no admin screen, sidebar entry, settings or shortcodes. You see its effect in the places listed under What it does.

Moving a collection to MongoDB

1. Open the collection in Collections and go to the Storage tab.
2. Set Adapter to MongoDB and choose the Connection.
3. Click Save. You are asked whether to move the existing entries across. Moving copies each entry to the new store.

Export the entries first if they matter.

Settings

None on the site. The plugin's mongoUri setting belongs to the Manager, not to your site. Leave it empty.

Permissions and roles

MongoDB Adapter adds no permission and no roles. Its guide is shown to people who can manage plugins.

Who can use the features it enables is decided by those features: for example, the Collections and Actions permissions in System > Roles.

Tips

• The connection details are read when the site starts. After the Manager changes them, the site needs a restart. The Manager restarts it for you when it grants the plugin.
• The connection belongs to the running site process. Domma CMS runs each site as one process, so each site has one connection to its database.
• If the database cannot be reached, the site still starts and collections set to MongoDB fall back to file storage until it is back. Tell whoever runs your Manager.

Limitations

• Available only on sites run from a Domma CMS Manager.
• If the plugin is taken away from your site, the site's connection details and database login are removed. The database itself is kept, not deleted.
• Without the connection, a collection set to MongoDB falls back to file storage, so entries held in MongoDB stop showing. Move collections back to file storage on the Storage tab before the plugin is removed.
• There is no screen on the site to see or change the database connection.