trona
v1.0.0
Published
Write DB migrations with SQL and run them with a CLI
Downloads
8
Readme
trona
This library allows you to write migration scenarios using SQL and run them with a simple CLI.
- Simple: only plain SQL
- Lightweight: only 6.8 kB in node_modules
- Modern: ESM support out of the box
Usage example
foo@bar:~$ yarn trona
Running evolve script
--- 1.sql ---
CREATE TABLE Customers (
id INTEGER NOT NULL,
name VARCHAR(32) NOT NULL,
primary key (id)
);
Evolution is successful!
foo@bar:~$
Installation
First you need to install trona
via package manager:
yarn add trona
Configuration
Than you need to setup simple configuration file named .trona-config.js
and containing script that
exports async function runQuery
. The function should be rejected in case of failure of said query and in case of SELECT query successfully executed contains array of selected rows in form of an object {[field]: value}
.
PostgreSQL example
import PG from 'pg';
const client = new PG.Client({
// ...
});
await client.connect();
console.log(`Connected to database`);
export function runQuery(query) {
return client.query(query).then((result) => result.rows);
}
MySQL example
import mysql from 'mysql';
import { promisify } from 'util';
const connection = mysql.createConnection({
// ...
});
const connect = promisify(connection.connect).bind(connection);
const runQuery = promisify(connection.query).bind(connection);
await connect();
console.log(`Connected to database`);
export { runQuery };
Write evolutions
Create a folder evolutions
for your evolutions script and add your first evolution to it. Note the rules which you should follow writing said evolutions:
- Name file {evolution-number}.sql (e.g. 1.sql)
- Write up and fallback scripts in file and separate them via "#DOWN" comment as at the example below
Folder content example:
- evolutions
- 1.sql
- 2.sql
- 3.sql
...
Evolution contents example:
CREATE TABLE Customers (
id INTEGER NOT NULL,
name VARCHAR(32) NOT NULL,
primary key (id)
);
#DOWN
DROP TABLE Customers;
Run command
yarn trona
This command will create table with information about evolutions, if it isn't exist. After it execute all your evolutions.
Usage
After you managed to successfully setup trona
you can run yarn trona
command. This command will automatically detect any changed or new files in your evolutions folder, run respected fallback scripts if needed and than evolve your databae schema (e. g. if you have 1.sql, 2.sql, and 3.sql evolutions already in your database, you have changed 2.sql and added 4.sql it will run fallback for 3.sql and 2.sql and than run 2.sql, 3.sql, and 4.sql scripts)
Options
Interactivity
By default evolution script will ask for a confirmation to run a degrade script. You can disable this feature by -y
or --no-interactive
flag.
yarn trona -y