Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/midgarjs/migrate
https://github.com/midgarjs/migrate
midgar migration nodejs plugin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/midgarjs/migrate
- Owner: midgarjs
- License: mit
- Created: 2019-12-30T23:12:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:23:26.000Z (almost 2 years ago)
- Last Synced: 2023-09-30T03:33:34.725Z (over 1 year ago)
- Topics: midgar, migration, nodejs, plugin
- Language: JavaScript
- Size: 1.28 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://drone.midgar.io/Midgar/migrate)
[](https://sonar.midgar.io/dashboard?id=midgar-migrate)
## @midgar/migrate
Système de migration pour [Midgar](https://github.com/midgarjs/midgar)
## Installation
```sh
$ npm i @midgar/migrate
```
Si tout s'est bien passé, un message de confirmation s'affiche:
```sh
#midgar-cli
@midgar/migrate added to plugins.json !
```
## Fonctionnement
Ajoute les types de modules **midgar-migrate-schema** dans le dossier ./migrations/schemas et **midgar-migrate-data**,./migrations/data.
Les migration **data** sont exéctuté apres les **schema**.
Ce plugin à besoin d'un storage pour fonctionner. Le storage sert a sauvegarder de facon permanante l'état des migrations.
## module migration
Exemple de module de migration:
```js
export default {
up: async (mid, ...storageArgs) => {
// Up script
},
down: async (mid, ...storageArgs) => {
// Down script
}
}
```
## Commandes cli
### Up
Exéctute up sur toutes les migrations en attente:
```sh
$ midgar migrate:up
```
Exéctute up sur les 3 premières migrations en attente:
```sh
$ midgar migrate:up 3
```
### Down
Exéctute down sur toutes les migrations en executé:
```sh
$ midgar migrate:down
```
Exéctute down sur les 3 denière migrations en executé:
```sh
$ midgar migrate:down 3
```
### Status
Affiche le nombre et la liste de migration en attente d'exécutions:
```sh
$ midgar migrate:down
```
### Paramètre optionnels
--config chemin vers le dossier de configuration du projet:
```sh
$ midgar migrate:up --config ~/mon-project/src/config
```
--storage clef du storage:
```sh
$ midgar migrate:up --storage mongo
```
## Storages
Exemple de storage:
```js
/**
* @typedef {Object} Migration
* @property {string} plugin Plugin name
* @property {string} name Migration file name
* @property {string} type Migration type (schema|data)
*/
class Storage {
constructor (mid) {
this.mid = mid
}
/**
* @return {>}
*/
async isInstalled () {
return true
}
/**
* @return {>>}
*/
async getMigrations () {
return []
}
/**
* Save executed migration
*
* @param {string} plugin Plugin name
* @param {string} name Migration file name
* @param {string} type Migration type (schema|data)
*
* @return {Promise}
*/
async saveMigration (plugin, name, type) {}
/**
* Delete executed migration
*
* @param {string} plugin Plugin name
* @param {string} name Migration file name
* @param {string} type Migration type (schema|data)
*
* @return {Promise}
*/
async deleteMigration (plugin, name, type) {}
/**
* Retrun migation function args after midgar instance
*
* @return {Array}
*/
getCallArgs () {
return []
}
}
export default Storage
```
## Ajouter le storate
Depuis la méthode init du plugin:
```js
import Storage from './libs/migrate-storage.js'
...
this.mid.on('@midgar/migrate:init', (migrateService) => {
migrateService.addStorage('monstorage', Storage)
})
```
[documentation Api](https://midgarjs.github.io/migrate/).