https://github.com/neo9/n9-mongodb-migration

Project to run migration script on MongoDB
https://github.com/neo9/n9-mongodb-migration

Last synced: 1 day ago
JSON representation

Project to run migration script on MongoDB

• Host: GitHub
• URL: https://github.com/neo9/n9-mongodb-migration
• Owner: neo9
• Created: 2020-06-22T12:23:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-16T19:05:05.000Z (10 months ago)
• Last Synced: 2024-12-01T07:30:43.990Z (26 days ago)
• Language: TypeScript
• Size: 1.02 MB
• Stars: 1
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# n9-mongodb-migration

Project to run migration script on mongodb.

[![npm version](https://img.shields.io/npm/v/@neo9/n9-mongodb-migration.svg)](https://www.npmjs.com/package/@neo9/n9-mongodb-migration)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fneo9%2Fn9-mongodb-migration%2Fbadge&style=flat)](https://actions-badge.atrox.dev/neo9/n9-mongodb-migration/goto)

[![Coverage](https://img.shields.io/codecov/c/github/neo9/n9-mongodb-migration/master.svg)](https://codecov.io/gh/neo9/n9-mongodb-migration)

## simple usage :

```typescript

import { N9MongodbMigration } from '@neo9/n9-mongodb-migration';

const mongodbPatchApplier = new N9MongodbMigration({

	migrationScriptsFolderPath: './scripts',

	mongodbURI: process.env.MONGODB_URI,

});

await mongodbPatchApplier.apply();

```

## Scripts names :

`x.y.z_dscription-of-the-upgrade.js`

## Script example :

```js

async function up(db, log) {

	await db.collection('test').insertOne({

		test: true,

	});

}

async function down(db, log) {

	await db.collection('test').deleteOne({

		test: true,

	});

}

module.exports = { up, down };

```

More examples can be found in the [tests folder](https://github.com/neo9/n9-mongodb-migration/tree/master/test/fixtures).