# loopback-component-auto-migrate

> migrate the database and import datas automatcally for the loopback application.

Latest version **0.4.0** (published 2018-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install loopback-component-auto-migrate
pnpm add loopback-component-auto-migrate
yarn add loopback-component-auto-migrate
bun add loopback-component-auto-migrate
```

Provides the command `slc-migrate`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2018-07-25 |
| First published | 2016-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 56.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Riceball LEE |
| Maintainers | riceball |
| Keywords | loopback, strongloop, migrate, database, import |

## Links

- npm: https://www.npmjs.com/package/loopback-component-auto-migrate
- Repository: https://github.com/snowyu/loopback-component-auto-migrate.js
- Issues: https://github.com/snowyu/loopback-component-auto-migrate.js/issues
- npm.io page: https://npm.io/package/loopback-component-auto-migrate

## Dependencies (7)

- [cson](https://npm.io/package/cson.md) ^5.1.0
- [debug](https://npm.io/package/debug.md) ^3.1.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.11.0
- [util-ex](https://npm.io/package/util-ex.md) ^0.3.15
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.0
- [app-root-path](https://npm.io/package/app-root-path.md) ^2.0.1
- [load-config-file](https://npm.io/package/load-config-file.md) ^0.3.6

## Recent versions

- 0.4.0 (latest) — 2018-07-25
- 0.3.1 — 2018-04-10
- 0.3.0 — 2017-08-14
- 0.2.7 — 2017-04-26
- 0.2.6 — 2017-04-18
- 0.2.5 — 2017-04-18
- 0.2.4 — 2017-03-18
- 0.2.3 — 2017-03-18
- 0.2.2 — 2016-11-15
- 0.2.1 — 2016-11-10
- 0.2.0 — 2016-08-01
- 0.1.4 — 2016-07-14
- 0.1.3 — 2016-07-12
- 0.1.2 — 2016-07-12
- 0.1.1 — 2016-06-02
- … 2 more at https://npm.io/package/loopback-component-auto-migrate/versions

## README

# Loopback Component auto migrate database and load data

This loopback component enables you to migrate the database and import datas automatcally for the loopback application.


### Installation

1. Install in you loopback project:

  `npm install --save loopback-component-auto-migrate`

2. Create a component-config.json file in your server folder (if you don't already have one)

3. Configure options inside `component-config.json`:

  ```json
  {
    "loopback-component-auto-migrate": {
      "enabled": true,
      "raiseError": false,
      "migration": "auto-migrate-data",
      "models": ["Role"],
      "fixtures": "./test/fixtures/"
    }
  }
  ```
  - `enabled` *[Boolean]*: whether enable this component. *defaults: true*
  - `raiseError` *[Boolean]*: whether raise error. *defaults: false*
    * it wont stop to import data if not raise error.
  - `migration` *[String]* : the migration ways:
    * "auto-migrate": drop and recreate the tables of the database.
    * "auto-migrate-data": drop and recreate the tables, load datas from `fixtures` folder.
    * "auto-update" *defaults*: update the tables of the databse.
    * "auto-update-data": update the tables, load datas from `fixtures` folder.
    * "auto-load-data": load datas from `fixtures` folder.
  - `models` *[array of String]|[String]*: the models to process. *defaults to the all models in the model-config.json*
    * *[String]*: a config file location can be used instead of passing all list inside *component-config.json*. eg `"./test/models/model-list"` (you can use yaml, json or cson format by its extension name)
  - `fixtures` *[String]*: the datas folder to import.
    * the file base name is the lowercase model name with dash seperated if any.
    * the file extension name is the data file format, the following format is supported:
      * cson
      * yaml
      * json


### Usage

#### Automatically use it:

Just enable it on `component-config.json`.

or run `node_modules/.bin/slc-migrate` directly.

set `DEBUG=loopback:component:autoMigrate:*` env variable to show debug info.

When it runs through `component-config.json`, it is attaching the `autoMigrate` promise at `app.get('loopback-component-auto-migrate-done')` that you can use to know when all migrations, data importing etc have finished.

Also the `loopback-component-auto-migrate-status` will be set for convenience:

  * 'loaded': autoMigrate loaded.
  * 'failed': autoMigrate failed.
  * 'done': autoMigrate successful.

#### Manually use it:

```js

autoMigrate = require('loopback-component-auto-migrate/lib/auto-migrate');
autoMigrate(app, {models:['Role'], fixtures: 'yourDataFolder'}).then()

```

#### Options:
Migration can be disabled for the model if you specify `skipMigration` option in the `./server/model-config.json` file:
```
{
  ...
  "customModel": {
      "dataSource": "datasource",
      "public": true,
      "options": {
        "skipMigration": true
      }
  }
  ...
}
```
## History

### v0.2.3

+ attaching done Promise at the app.

### v0.2.0

+ hasMany relation data supports.

---
_Source: https://npm.io/package/loopback-component-auto-migrate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._