Registry / storage / mongodb-backup-streaming

mongodb-backup-streaming

JSON →
library1.6.12jsnpmunverified

A Node.js package for streaming MongoDB backups, forked from hex7c0/mongodb-backup with PR #22 merged. Version 1.6.12 is the latest stable; low maintenance cadence. Supports streaming backup to streams or files via a simple streaming API. Differentiated by its streaming approach vs. exec-based mongodump alternatives. Requires Node >=4.

storage
npm install mongodb-backup-streaming
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · MONGODB-BACKUP-STR
M
mongodb-backup-streaming
storagejavascriptv1.6.12
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
✓ import backup from 'mongodb-backup-streaming'
✗ const backup = require('mongodb-backup-streaming').default
ESM default import; use require('mongodb-backup-streaming') in CJS.
backup
✓ import { backup } from 'mongodb-backup-streaming'
✗ const { backup } = require('mongodb-backup-streaming')
Named export also available; avoid destructuring from CJS if using default.
MongoBackup
✓ import { MongoBackup } from 'mongodb-backup-streaming'
✗ const MongoBackup = require('mongodb-backup-streaming').MongoBackup
Class export available; CJS compatible but ESM preferred.

Streams a MongoDB collection backup to stdout, demonstrating streaming usage with event handlers.

import backup from 'mongodb-backup-streaming'; backup({ uri: process.env.MONGO_URI ?? 'mongodb://localhost:27017/test', collection: 'users', stream: process.stdout }) .on('data', chunk => console.log('got chunk length:', chunk.length)) .on('error', err => console.error(err)) .on('end', () => console.log('Backup complete'));
Debug
Known issues
gotchaThe package uses mongodb driver v2.x internally; newer driver versions may break compatibility.
fix
Pin mongodb driver version or use a different backup solution.
affects: >=1.0 <2.0
deprecatedThe callback style is deprecated; use promises or stream events.
fix
Use stream API (data, error, end events) or async/await with pipeline.
affects: >=1.0
gotchaRequires mongod/mongos to be running locally or via URI. Does not use mongodump binary.
fix
Ensure MongoDB server is accessible via the provided URI.
affects: >=1.0
breakingPR #22 changed the default stream output from a file to stdout. Existing code relying on file output may break.
fix
Specify a 'output' option or pipe to a file stream.
affects: >=1.0
Errors
Common errors & fixes
Cannot find module 'mongodb-backup-streaming'
Package not installed or typo in package name.
fix
Run 'npm install mongodb-backup-streaming'.
backup is not a function
Using default import incorrectly with CJS require.
fix
Use 'const backup = require('mongodb-backup-streaming');' (no .default) in CommonJS.
TypeError: backup(...).on is not a function
Not using the returned stream; backup returns a stream.
fix
Ensure you're calling backup() and chaining .on() on the returned stream.
Upgrade
Version history
1.6.12latest on npm
Audit
Dependencies
lodashrequiredUsed for internal utility functions
asyncrequiredUsed for async flow control
mongodbrequiredMongoDB driver for database connection
Agent activity
20 hits · last 30 days
node
20
Resources
githubhttps://github.com/spmiller/mongodb-backup ↗
packagemongodb-backup-streaming ↗
homepagehttps://github.com/spmiller/mongodb-backup ↗
mongodb-backup-streaming — npm install mongodb-backup-streaming · libregistry