sql-apply
TypeScript icon, indicating that this package has built-in type declarations

2.1.6 • Public • Published

Node.js CI codecov

SQL Apply

This project aims at doing what the already existing flyway project is doing in the JVM world. It allows you to define one or multiple directories where you can create SQL files. Upon applying these files the library will check if the files have already been applied before (by looking into a migrations table in the DB). If they have not yet been applied they will be executed sequantially.

There are already other libraries available for Node that helps you with performing DB migrations, why create a new one? Because I want a library that exists that allows you to write the migration scripts in pure SQL (no need for every function / feature in SQL to get a corresponding translation written in JS). I also want the migrations to be executable from code. This way it's very low effort to making sure that all environments (local / staging / prod) are all being kept up to date.

Is this difficult? I don't know, perhaps it is. We'll find out. At least I'll start and see where I land. This is still a young project, so don't hesitate to report Issues if you find them or to come with suggestion on how this could be done better. As a first step it's expected to support postgres, in later stages there's no reason why functionality can't be extended to support other SQL databases.

Installation

This project is published at npmjs here. You can install it using npm i -S sql-apply.

Execution

This project can both be used from inside nodejs projects by saving it as a dependency and then running runMigrations (don't forget to await the result). It can also be used from the command line through npx sql-apply migrate -m <directory-with-migrations>. Of course additional parameters exist, just run npx sql-apply to see available options.

Limitations

This project currently uses IF NOT EXISTS syntax which means it's only compatible with Postgres 9.1 and upward.

Features

These features are not yet implemented, but the aim is to:

  • Allow project to bootstrap a migrations table on first run.
  • Allow one or multiple target folders to be used for migration scripts
  • Ensuring that scripts are applied in an ordered manner according to naming convention.
  • Migrations scripts will be written in SQL.

For full information please refer to the API Documentation.

Conventions

The project aims at staying true to the flyway project mentioned above. For this the name convention consists of:

  • Prefix: Defaults to V.
  • Version: Dots or underscores separated in as many parts as one likes.
  • Separator: Defaults to __ (two underscores) and separates the version from the description.
  • Description: A text with words separated by underscores or spaces.
  • Suffix: Defaults to .sql.

For example, the following are all valid migration scripts:

  • V1__some_description.sql
  • V15.003__some_other_script.sql

The library will enforce that versions are monotonically increasing starting at 1.

Requirements

  • Node 11 or higher
  • npm
  • Postgres

License

MIT

Package Sidebar

Install

npm i sql-apply

Weekly Downloads

23

Version

2.1.6

License

MIT

Unpacked Size

281 kB

Total Files

116

Last publish

Collaborators

  • ruffythepirate