https://github.com/lucasferreira/db-migr

Javascript db migrations utility for SQLite, MySQL or other SQL Ansi databases
https://github.com/lucasferreira/db-migr

javascript migrations sqlite3 tool upgrade utility

Last synced: 27 days ago
JSON representation

Javascript db migrations utility for SQLite, MySQL or other SQL Ansi databases

• Host: GitHub
• URL: https://github.com/lucasferreira/db-migr
• Owner: lucasferreira
• License: mit
• Created: 2018-09-29T23:14:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-03T14:12:59.000Z (about 6 years ago)
• Last Synced: 2024-09-27T18:40:53.932Z (about 1 month ago)
• Topics: javascript, migrations, sqlite3, tool, upgrade, utility
• Language: JavaScript
• Homepage:
• Size: 25.4 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# db-migr

## Installation

Since the library is a JS-based solution, to install the latest version of `db-migr` you only need to run:

```bash

$ npm install --save db-migr

```

or

```bash

$ yarn add db-migr

```

## How it works

This tool implements a lightweight migrations API that works with a array of migrations as the follow example:

```javascript

const migrations = [

  {

    name: "001-create-table",

    migration: `

-- Up

CREATE TABLE IF NOT EXISTS "people" (

  id   INTEGER PRIMARY KEY,

  name TEXT    NOT NULL

);

-- Down

DROP TABLE people;`,

  },

  {

    name: "002-create-index-name",

    migrationUp: `CREATE INDEX people_name ON people (name)`,

    migrationDown: `DROP INDEX people_name`,

  },

  {

    name: "003-create-field",

    migration: [

      "ALTER TABLE people ADD address VARCHAR(255)",

      "ALTER TABLE people ADD email VARCHAR(60)"

    ],

  },

  {

    name: "004-create-index-email",

    migration: `CREATE INDEX people_email ON people ('email')`,

  },

];

```

The `name` attribute it's required in each `migration`, so you can use this attribute as execution order and history. Every `name` needs to follow this format `{n}-{description}`. Migrations with names that didn't start with number will be ignored.

Each `migration` in your array could be based in a complex string, or using two attributes `migrationUp` and `migrationDown`. You could use in up operations some array of queries also.

It's very important to keep a history of migrations in your migrations array, if you remove some migration entry in futures updates/releases if you implements some `migrationDown` query this tool will automatically reverts your `migrationUp`.

### Implement your query runner

To make this tool more versatile *we didn't implement* a default _query runner_ method, so you can use this tool with your favorite database adapter just implementing some promisable/async _query_ function.

#### Simple generic example:

```javascript

import migr from "db-migr";

const myMigrations = [

  // a incremental list of migrations for your db...

];

const dbConn = ...implements your database connection

// run your migrations when you are sure that your db connection are already opened

migr({

  // implemention your query runner [required]

  // this method needs to return some promisable function

  query: async (query, params = []) => {

    return await dbConn.executeSql(query, params);

  },

  // pass your migrations

  migrations: myMigrations

}).then(() => {

  // if you got here, everything ran ok

}).catch(err => {

  // if you got here, something wrong happened

  // and you could look to `err` object

});

```

## License

[MIT](./LICENSE)