{"id":19308905,"url":"https://github.com/antares-sql/antares-mysql-dumper","last_synced_at":"2026-03-16T21:34:07.819Z","repository":{"id":57684890,"uuid":"476394023","full_name":"antares-sql/antares-mysql-dumper","owner":"antares-sql","description":"Dumps MySQL database into file. You could use both node-mysql clients, mysql and mysql2.","archived":false,"fork":false,"pushed_at":"2022-04-28T09:30:36.000Z","size":388,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-14T01:17:35.861Z","etag":null,"topics":["javascipt","mysql","mysql-dump","nodejs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/antares-mysql-dumper","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/antares-sql.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-31T16:42:42.000Z","updated_at":"2024-10-23T12:08:46.000Z","dependencies_parsed_at":"2022-09-17T05:41:28.916Z","dependency_job_id":null,"html_url":"https://github.com/antares-sql/antares-mysql-dumper","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antares-sql%2Fantares-mysql-dumper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antares-sql%2Fantares-mysql-dumper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antares-sql%2Fantares-mysql-dumper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antares-sql%2Fantares-mysql-dumper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antares-sql","download_url":"https://codeload.github.com/antares-sql/antares-mysql-dumper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250248842,"owners_count":21399346,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascipt","mysql","mysql-dump","nodejs"],"created_at":"2024-11-10T00:16:54.127Z","updated_at":"2026-03-16T21:34:07.792Z","avatar_url":"https://github.com/antares-sql.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version](https://img.shields.io/npm/v/antares-mysql-dumper.svg)](https://www.npmjs.com/package/antares-mysql-dumper)\n\n# antares-mysql-dumper\n\nDumps MySQL database into file. You could use both node-mysql clients, mysql and mysql2.\n\n## Usage\n\n```js\nimport MySqlDumper from \"antares-mysql-dumper\";\nimport mysql2 from \"mysql2\";\n\nconst connection = mysql2.createConnection({\n  host: \"localhost\",\n  port: 3306,\n  user: \"root\",\n  password: \"test\",\n  database: \"myDatabase\",\n});\n\nconst dumper = new MySqlDumper({\n  connection,\n  schema: \"myDatabase\",\n  outputFile: \"test.sql\",\n});\n\nawait dumper.run();\n```\n\nMySqlDumper constructor takes one parameter, options, with following type:\n\n```ts\nexport interface MySqlDumperOptions_Table {\n  table: string;\n  includeStructure?: boolean;\n  includeContent?: boolean;\n  includeDropStatement?: boolean;\n}\n\nexport interface MySqlDumperOptions_Includes {\n  views?: boolean;\n  triggers?: boolean;\n  routines?: boolean;\n  functions?: boolean;\n  schedulers?: boolean;\n}\n\nexport interface MySqlDumperOptions {\n  /** mysql client */\n  connection: any;\n  /** database/schema name */\n  schema: string;\n  outputFile: string;\n  tables?: MySqlDumperOptions_Table[];\n\n  includes?: MySqlDumperOptions_Includes;\n\n  compress?: boolean;\n  sqlInsertAfter?: number;\n  sqlInsertDivider?: \"rows\" | \"bytes\";\n\n  getHeader?: ({ serverVersion, schema }) =\u003e string;\n  getFooter?: () =\u003e string;\n}\n```\n\n## Testing package locally\nMySql Dumper is partially covered by integration tests. It is good idea to run these tests before pushing to GIT.\nTest requires MySQL server running at local machine, there is docker-compose file defining this.\nEvery test run creates its own clean database, tests don't enfluence each other.\n\nUse following commands for integration testing:\n\nStart local MySQL server:\n```sh\nyarn dc:up\n```\n\nRun all tests:\n```sh\nyarn test\n```\n\nStop local MySQL server\n```sh\nyarn dc:down\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantares-sql%2Fantares-mysql-dumper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantares-sql%2Fantares-mysql-dumper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantares-sql%2Fantares-mysql-dumper/lists"}