README.md

antares-mysql-dumper

Dumps MySQL database into file. You could use both node-mysql clients, mysql and mysql2.

Usage

import MySqlDumper from "antares-mysql-dumper";
import mysql2 from "mysql2";

const connection = mysql2.createConnection({
  host: "localhost",
  port: 3306,
  user: "root",
  password: "test",
  database: "myDatabase",
});

const dumper = new MySqlDumper({
  connection,
  schema: "myDatabase",
  outputFile: "test.sql",
});

await dumper.run();

MySqlDumper constructor takes one parameter, options, with following type:

export interface MySqlDumperOptions_Table {
  table: string;
  includeStructure?: boolean;
  includeContent?: boolean;
  includeDropStatement?: boolean;
}

export interface MySqlDumperOptions_Includes {
  views?: boolean;
  triggers?: boolean;
  routines?: boolean;
  functions?: boolean;
  schedulers?: boolean;
}

export interface MySqlDumperOptions {
  /** mysql client */
  connection: any;
  /** database/schema name */
  schema: string;
  outputFile: string;
  tables?: MySqlDumperOptions_Table[];

  includes?: MySqlDumperOptions_Includes;

  compress?: boolean;
  sqlInsertAfter?: number;
  sqlInsertDivider?: "rows" | "bytes";

  getHeader?: ({ serverVersion, schema }) => string;
  getFooter?: () => string;
}

Testing package locally

MySql Dumper is partially covered by integration tests. It is good idea to run these tests before pushing to GIT. Test requires MySQL server running at local machine, there is docker-compose file defining this. Every test run creates its own clean database, tests don't enfluence each other.

Use following commands for integration testing:

Start local MySQL server:

yarn dc:up

Run all tests:

yarn test

Stop local MySQL server

yarn dc:down