https://github.com/apostrophecms/mongodb-snapshot
Save and restore mongodb snapshots without mongodump and mongorestore
https://github.com/apostrophecms/mongodb-snapshot
Last synced: 4 months ago
JSON representation
Save and restore mongodb snapshots without mongodump and mongorestore
- Host: GitHub
- URL: https://github.com/apostrophecms/mongodb-snapshot
- Owner: apostrophecms
- License: mit
- Created: 2025-01-21T22:03:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-22T18:17:18.000Z (over 1 year ago)
- Last Synced: 2025-10-19T09:46:19.501Z (8 months ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @apostrophecms/mongodb-snapshot
A simple nodejs utility library to create and restore snapshots of mongodb databases without the need for `mongodump` and `mongorestore` to be installed. This reduces unnecessary dependencies on packages users may not be eager to install, especially developers relying solely on MongoDB Atlas for MongoDB hosting.
Because the format of mongodb archive files is a bit more complicated and apparently undocumented, and the BSON format has no readily available streaming support in JavaScript, this module **does not** read and write mongodump files. Instead it reads and writes a simple format based on EJSON (Extended JSON).
As a bonus, command line `mongodb-snapshot-write` and `mongodb-snapshot-read` utilities are provided. Of course these do not perform as quickly as `mongodump` and `mongorestore`.
## Installation
```bash
# If you want to use the utilities
npm install -g @apostrophecms/mongodb-snapshot
# If you want to use the library in your nodejs code
npm install @apostrophecms/mongodb-snapshot
```
## Command line usage
```bash
mongodb-snapshot-write --from=mongodb://localhost:27017/mydbname --to=myfile.snapshot
# add --erase ONLY if you want the previous contents removed first!
mongodb-snapshot-read --from=myfile.snapshot --to=mongodb://localhost:27017/mydbname --erase
```
### Including and excluding collections
With both commands, if you want to exclude certain certain collections, just add:
```
--exclude=name1,name2
```
### Filtering individual documents
With the `mongodb-snapshot-write` command **only**, you can specify a MongoDB query to
filter the documents for any collection. For example:
```bash
mongodb-snapshot-write --from=mongodb://localhost:27017/mydbname --to=myfile.snapshot --filter-COLLECTION-NAME-HERE='{"type":"interesting"}'
```
The query must be valid JSON. Watch out for shell escaping rules (note the single quotes in the example). Note that
MongoDB has a `$regex` operator which can be useful here.
You may specify filters for as many collections as you wish. Note that the parameter name begins with `--filter-` followed by the collection name.
## Node.js API usage
```javascript
// Note: ESM import syntax also works.
// writing
const { MongoClient } = require('mongodb');
const { write } = require('@apostrophecms/mongodb-snapshot');
async function saveASnapshot() {
const client = new MongoClient(yourMongodbUriGoesHere);
await client.connect();
const db = await client.db();
// Writes the contents of db to myfilename.snapshot, including indexes
// Two collections are excluded (optional third argument)
await write(db, 'myfilename.snapshot', {
// No password hashes please
exclude: [ 'aposUsersSafe' ],
filters: {
aposDocs: {
type: {
// No users please
$ne: '@apostrophecms/user'
}
}
}});
}
```
```javascript
const { MongoClient } = require('mongodb');
const { erase, read } = require('@apostrophecms/mongodb-snapshot');
async function saveASnapshot() {
const client = new MongoClient(yourMongodbUriGoesHere);
await client.connect();
const db = await client.db();
// If you want to replace the current contents and avoid unique key errors and/or duplicate
// documents, call erase first
await erase(db);
// Two collections are excluded (optional third argument)
await read(db, 'myfilename.snapshot', { exclude: [ 'coll3', 'coll4' ]});
}
```
## Limitations
Correctness comes before performance, for now. Sensible amounts of parallelism might help.
## Credits
This module was [originally created for use with ApostropheCMS](https://apostrophecms.com), an open-source Node.js CMS with robust support for in-context, on-page editing, multitenant, multisite projects and lots of other great features worth checking out.