https://github.com/hex7c0/mongodb-backup

backup data for mongodb for Nodejs
https://github.com/hex7c0/mongodb-backup

backup mongodb nodejs

Last synced: 4 days ago
JSON representation

backup data for mongodb for Nodejs

• Host: GitHub
• URL: https://github.com/hex7c0/mongodb-backup
• Owner: hex7c0
• License: apache-2.0
• Created: 2014-12-05T14:51:43.000Z (about 10 years ago)
• Default Branch: 1.6
• Last Pushed: 2024-04-09T19:28:05.000Z (9 months ago)
• Last Synced: 2024-12-18T08:06:33.970Z (11 days ago)
• Topics: backup, mongodb, nodejs
• Language: JavaScript
• Homepage: https://github.com/hex7c0/mongodb-backup
• Size: 265 KB
• Stars: 134
• Watchers: 8
• Forks: 49
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [mongodb-backup](https://github.com/hex7c0/mongodb-backup)

[![NPM version](https://img.shields.io/npm/v/mongodb-backup.svg)](https://www.npmjs.com/package/mongodb-backup)

[![Linux Status](https://img.shields.io/travis/hex7c0/mongodb-backup.svg?label=linux)](https://travis-ci.org/hex7c0/mongodb-backup)

[![Windows Status](https://img.shields.io/appveyor/ci/hex7c0/mongodb-backup.svg?label=windows)](https://ci.appveyor.com/project/hex7c0/mongodb-backup)

[![Dependency Status](https://img.shields.io/david/hex7c0/mongodb-backup.svg)](https://david-dm.org/hex7c0/mongodb-backup)

[![Coveralls](https://img.shields.io/coveralls/hex7c0/mongodb-backup.svg)](https://coveralls.io/r/hex7c0/mongodb-backup)

Backup for mongodb

Look at [`mongodb-backup-cli`](https://github.com/hex7c0/mongodb-backup-cli) for command line usage, similar to [mongodump](http://docs.mongodb.org/manual/reference/program/mongodump/)

Look at [`mongodb-restore`](https://github.com/hex7c0/mongodb-restore) for restore data

## Installation

Install through NPM

```bash

npm install mongodb-backup

```

or

```bash

git clone git://github.com/hex7c0/mongodb-backup.git

```

[email protected] has been pulled out, so versions >= `1.3.0` and <= `1.4.1` are deprecated

## API

inside nodejs project

```js

var backup = require('mongodb-backup');

backup({

  uri: 'uri', // mongodb://:@.mongolab.com:/

  root: __dirname

});

```

### backup(options)

#### options

 - `uri` - **String** [URI](http://mongodb.github.io/node-mongodb-native/2.0/tutorials/urls/) for MongoDb connection *(default "required")*

 - `root`- **String** Path where save data *(default "required")*

 - `[parser]` - **String | Function** Data parser (bson, json) or custom *(default "bson")*

 - `[collections]` - **Array** Select which collections save *(default "disabled")*

 - `[callback]` - **Function** Callback when done *(default "disabled")*

 - `[stream]`- **Object** Send `.tar` file to Node stream *(default "disabled")*

 - `[tar]` - **String** Pack files into a .tar file *(default "disabled")*

 - `[query]` - **Object** Query that optionally limits the documents included *(default "{}")*

 - `[numCursors]` - **Number** Set number of cursor for [parallelCollectionScan](https://docs.mongodb.org/v3.0/reference/command/parallelCollectionScan) without query *(default "disabled")*

 - `[logger]` - **String** Path where save a .log file *(default "disabled")*

 - `[metadata]` - **Boolean** Save metadata of collections as Index, ecc *(default "false")*

 - `[options]` - **Object** MongoDb [options](http://mongodb.github.io/node-mongodb-native/2.0/tutorials/connecting/#toc_7) *(default)*

## Examples

Take a look at my [examples](https://github.com/hex7c0/mongodb-backup/tree/1.6/examples)

### [License Apache2](https://github.com/hex7c0/mongodb-backup/blob/1.6/LICENSE)