@charan379/mongodb-backup v1.0.2

mongodb-backup

This Node.js package allows you to backup a MongoDB database to a zip file.

Usage

Method 1: Importing the Package

Installation

First you need to install this package via npm:

npm install @charan379/mongodb-backup

You can use this package by importing the backupDatabaseToZip function into your Node.js application, like below

const { backupDatabaseToZip } = require("mongodb-backup");

const connectionString = 'mongodb://localhost:27017/your_database'; // Replace with your MongoDB connection string
const outputZipPath = 'backup.zip'; // The path where the zip file will be saved

backupDatabaseToZip(connectionString, outputZipPath)
  .then(() => {
    console.log('Backup completed successfully.');
  })
  .catch((err) => {
    console.error('Error while performing the backup:', err);
  });

In this method, you can use the backupDatabaseToZip function with the desired MongoDB connection string and output zip path directly within your application.

Method 2: Command Line Usage

Installation

First you need to clone this repository from github:

git clone https://github.com/charan379/mongodb-backup.git

To backup your MongoDB database from the command line, navigate to project folder where exportDB.js exists :

cd mongodb-backup

You can use the provided script exportDB.js directly with the node command by passing the MongoDB connection string and output zip file path as runtime arguments.

Example command:

node exportDB.js <MONGODB_CONNECTION_STRING> <OUTPUT_ZIP_PATH>

Replace <MONGODB_CONNECTION_STRING> with your actual MongoDB connection string, and <OUTPUT_ZIP_PATH> with the desired path to save the backup zip file.

For example:

node exportDB.js mongodb://localhost:27017/my_database my_backup.zip

The script will connect to the specified MongoDB database, export each collection to a JSON file, zip the files into my_backup.zip, and save it in the current directory.

Dependencies

This package depends on the following modules:

archiver (^5.3.1)
mongodb (^5.7.0)
shelljs (^0.8.5)

Authors

• @charan379

License