🛢️ dbdump-gen

A lightweight, TypeScript-powered utility to generate MySQL database dumps as SQL files with clean INSERT statements. Ideal for backups, migrations, and data snapshots in Node.js projects.

✨ Features

• ✅ Dump full MySQL tables with data as .sql files
• 🔒 Handles escaping and nulls safely
• 🔧 Fully typed with TypeScript
• 📦 Easily used as an npm package in Node.js apps
• 🚀 Fast and minimal dependencies

📦 Installation

npm install dbdump-gen

🚀 Usage

1. Import & Use in Node.js App

import { MySQLDumper } from 'dbdump-gen';

const dumper = new MySQLDumper({
  host: 'localhost',
  user: 'root',
  password: 'your-password',
  database: 'your-database',
  outputFile: './dump.sql'
});

await dumper.dump();

📂 Output Example (dump.sql)

-- Dump of database mydb

INSERT INTO `users` (`id`, `name`, `email`) VALUES (1, 'Alice', '[email protected]');
INSERT INTO `users` (`id`, `name`, `email`) VALUES (2, 'Bob', '[email protected]');

⚙️ Configuration Options

| Option | Type | Description | |--------------|----------|------------------------------------| | host | string | MySQL host (default: localhost) | | port | number | MySQL port (default: 3306) | | user | string | MySQL username | | password | string | MySQL password | | database | string | Database name to dump | | outputFile | string | Path to output .sql file |

🔧 Future Plans

• [ ] CLI tool support (npx dbdump ...)
• [ ] Table filtering (includeTables, excludeTables)
• [ ] Option to dump CREATE TABLE statements
• [ ] Add support for PostgreSQL, MongoDB, and more

🧑‍💻 Author

Made with 💻 and ☕ by iPuppyYT

GitHub • npm

📝 License

MIT © iPuppyYT