https://github.com/antares-sql/antares-mysql-dumper

Dumps MySQL database into file. You could use both node-mysql clients, mysql and mysql2.
https://github.com/antares-sql/antares-mysql-dumper

javascipt mysql mysql-dump nodejs

Last synced: 11 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/antares-sql/antares-mysql-dumper
• Owner: antares-sql
• License: mit
• Created: 2022-03-31T16:42:42.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-28T09:30:36.000Z (over 2 years ago)
• Last Synced: 2024-10-31T09:27:11.624Z (20 days ago)
• Topics: javascipt, mysql, mysql-dump, nodejs
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/antares-mysql-dumper
• Size: 379 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![NPM version](https://img.shields.io/npm/v/antares-mysql-dumper.svg)](https://www.npmjs.com/package/antares-mysql-dumper)

# antares-mysql-dumper

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

## Usage

```js

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:

```ts

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:

```sh

yarn dc:up

```

Run all tests:

```sh

yarn test

```

Stop local MySQL server

```sh

yarn dc:down

```