Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.29 KB

README.md

File metadata and controls

48 lines (36 loc) · 2.29 KB
Raw

Lambda RDS MySQL Migration utility

This project is a fully functional 'prototype' which you an use to fix your RDS (specifically MySQL) SQL migrations in your Lambda environment. It is designed in the spirit of Flyway (a popular Java sql migration tool) but it's still in infancy.

Workings

On initial load the existence of a schema version table is assessed. When none is found a new table (db_version) is created and migrations will afterwards be kicked off.

Each database version is represented by a semantic version like 1.0.0.sql. These versions are listed and executed sequentially. When the current schema is already migrated (lets say halfway a list of migrations) the remainder of the sequence is executed.

Tool usage

The primary goal for the Github repo is to clone it and adjust to your needs. You will probably want to change it. It might be nice to create an NPM package at some point. Feel free to reach out on Twitter or some other medium it you want to collaborate.

Feature support

  • Incremental migrations based on .sql files in the migrations folder, with file named based on semver.
  • Creates an initial version meta table (called db_version)
  • Executes migrations in sequence
  • Is version aware (through db_version) and only executes subsequent updates
  • Is able to execute a single file again by providing a single version string.
  • It pushes migrations with multiple queries separated with a semicolon (;) separation in one query execution.
  • Has support for database connection parameters

Extendability to other RDS databases

Other db's are easily supported. Just import the proper driver in the npm dependencies and modify the mysql.ts with your new database queries and update the triggers/migrate.ts with new connection params.

Installing and using

Copy sources and modify environment variables and migration scripts for your own needs. Open parameter store (in ec2 in console) and add parameters for RDS access:

  • QS_RDS_USERNAME
  • QS_RDS_ENDPOINT
  • QS_RDS_DATABASE
  • QS_RDS_PASSWORD (as secure param)
  • QS_RDS_PORT

Then in console (of cli) invoke the Lambda and installation of the db_version is kicked off.

Alternatively you can provide a version argument like this:

{
    version: '1.0.0'
}

This is executed as a single SQL migration without making a checkpoint.