Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

data-elevator-mysql

marcojonker67MIT5.0.1

Flexible utility for managing migrations of mysql data sources

migrate, migration, migrations, migrate data, data migrate, migrate database, database migrate, database migration, database migrations, data migration, data migrations, migrate mysql, mysql migration, mysql migrate, donwgrade, upgrade, mysql, data-elevator, data-elevator-mysql, elevate data, datasource, database

readme

DATA ELEVATOR MYSQL

The data elevator mysql is an easy to use and very flexible utility for migrating data sources based on the NPM module data elevator. The only difference is that data elevator mysql stores its current migration level in a mysql database.

Storing the current migration level in a database brings advantages when a project shares its data source with multiple running instances of a project. For example when multiple developers working with one database or the project runs on multiple servers.

QUICKSTART

STEP 1: Install

npm install data-elevator-mysql

STEP 2: Construct a new data elevator for the project.

node ./node-modules/data-elevator-mysql construct

STEP 3: Add a new migration.

node ./data-elevator/elevator add "add phone number to users"

STEP 4: Enter you migration code in the generated floor file.

see: ./data-elevator/floors/

STEP 5: Move the elevator to migrate data.

node ./data-elevator/elevator move top
node ./data-elevator/elevator move ground
node ./data-elevator/elevator move 2

STEP 6: Use help command to get information about additional commands

node ./data-elevator/elevator help

CONFIGURATION

  • levelControllerConfig.tableName: Name of the table to store the migration level in
  • levelControllerConfig.connectionOptions: Options used to connect to mysql see npm mysql for more information
    var config = {
      levelControllerConfig: {
         tableName: "_data_elevator",
         connectionOptions: {}
      }
    }

FURTHER DOCUMENTATION

For further documenation about commands or customizations see data elevator documentation.

RELATED MODULES

  • data-elevator (npm, github) - store elevator migration levels in a plain file
  • data-elevator-elasticsearch (npm, github) - store elevator migration levels in elasticsearch
  • data-elevator-mongodb (npm, github) - store elevator migration levels in mongodb
  • data-elevator-mysql (npm, github) - store elevator migration levels in mysql
  • data-elevator-postgres (npm, github) - store elevator migration levels in postgres
  • data-elevator-sqlite3 (npm, github) - store elevator migration levels in sqlite3

changelog

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

[Unreleased]

[5.0.1] - 2024-07-03

Updated

  • Bump versions
  • Migrate to mysql2 client library

[4.0.0] - 2021-09-27

Updated

  • Async library version
  • Mysql library version
  • Data elevator version
  • Update unittests with mocha
  • Refactor code to es6
  • Eslint

[2.1.0] - 2016-11-04

Updated

  • Tested with NodeJs 7
  • Depencency for async

[2.0.0] - 2016-06-14

Added

  • move command
  • marker for current floor in list command

Removed

  • up commnad
  • down command

Changed

  • add command 'elevator add -n="test migration"' => 'elevator add "test migration"'
  • documentation
  • testing code
  • direction property removed from level class

Fixes

  • callback issue in printing

[1.1.0] - 2016-06-08

Added

  • Global execute for global installation
  • List command
  • CHANGELOG

Changed

  • Documentation
  • Log message