{"_id":"@airvert.com/mysqldump","_rev":"5-ad7ddf66e3acc71db9eab6502b228b89","name":"@airvert.com/mysqldump","dist-tags":{"latest":"2.2.3"},"versions":{"2.2.1":{"name":"@airvert.com/mysqldump","version":"2.2.1","description":"Create a DUMP from MySQL","main":"dist/cjs.js","module":"dist/es.js","publishConfig":{"access":"public"},"typings":"dist/mysqldump.d.ts","scripts":{"pretest":"ts-node -P ./tsconfig.json --files ./test/scripts/initDb.ts","pretest-prod":"ts-node -P ./tsconfig.json --files ./test/scripts/initDb.ts","setup-travis":"node ./test/setupTravis.js","test":"jest --ci --config=./jest.json","test-prod":"JEST_USE_NPM_BUILD=true jest --ci --config=./test/jest-prod-config.js","view-coverage":"open ./coverage/index.html","build":"rollup -c && dts-bundle-generator -o dist/mysqldump.d.ts build-decl/main.d.ts --umd-module-name=mysqldump && rimraf build-decl","clean":"rimraf dist && rimraf build-decl","lint":"eslint src --ext \".ts\"","start":"ts-node -P ./tsconfig.json --files ./test/scripts/launch.ts","ci":"yarn lint --quiet && yarn build"},"repository":{"type":"git","url":"git+https://github.com/airvert/mysqldump.git"},"keywords":["backup","mysql","mysql-dump","dump","restore","database","backup","database"],"author":{"name":"Brad Zacher"},"license":"MIT","bugs":{"url":"https://github.com/airvert/mysqldump/issues"},"homepage":"https://github.com/airvert/mysqldump","dependencies":{"@types/node":"^10.5.2","deepmerge":"^2.1.1","mysql2":"^1.5.3","sql-formatter":"^2.3.1","sqlstring":"^2.3.1"},"devDependencies":{"@types/deepmerge":"^2.1.0","@types/extend":"^3.0.0","@types/invariant":"^2.2.29","@types/jest":"^23.3.0","@types/mysql":"^2.15.5","@types/sqlstring":"^2.2.0","@types/tmp":"^0.0.33","babel":"^6.23.0","babel-plugin-transform-object-rest-spread":"^6.26.0","copyfiles":"^2.0.0","dts-bundle-generator":"^1.6.0","eslint":"^5.1.0","eslint-config-assignar-node":"^1.2.1","eslint-import-resolver-node":"^0.3.2","eslint-import-resolver-typescript":"^1.0.2","jest":"^23.4.1","rimraf":"^2.6.2","rollup":"^0.52.1","rollup-plugin-commonjs":"^8.2.6","rollup-plugin-typescript2":"^0.9.0","tmp":"^0.0.33","ts-jest":"^22.4.6","ts-node":"^7.0.0","typescript":"2.9.2"},"gitHead":"805f8adb5c218b96d21cdfff5a73ebd62a28f5f8","_id":"@airvert.com/mysqldump@2.2.1","_npmVersion":"6.4.1","_nodeVersion":"10.15.0","_npmUser":{"name":"thuanpq","email":"thuanpq.io@gmail.com"},"dist":{"integrity":"sha512-vlz1J71wGZ2+0qOWQR1mL64RX1416MtchELCk2bOnRSrpqNbescDYzPnNgcyt9wwxM5pvK9WwU7R7VJHSdASHQ==","shasum":"cc679e3f12b33c6775acd1c4380b61217fa1bd96","tarball":"https://registry.npmjs.org/@airvert.com/mysqldump/-/mysqldump-2.2.1.tgz","fileCount":4,"unpackedSize":19333,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcLWlJCRA9TVsSAnZWagAA7ZwQAIM6LsbVDuQOzP2vJVdX\nAXyR2uFUgcFIxp1FvBS8XoWec3LKoF59wgBCnxizt2uydqLKut4hVgklT8Bg\nfbIwl1il2UwinuY9u6+YmC6VSnieqJEqfVrWv/3rzOhWlt7VizdA253ElyHc\nBpQ8MIUso10/8g0fSjjRtdWtOnhIU/jLi4snaABDd8vzpqnRkQ9Ci0i22Nzl\nDfxxTJVxmRZKmE7qmVhD+08+YUd4xU9hFV2qs1MnX0LJ8m9GjIri6tHa/PVJ\nZkBJHs7qe4pKCnm1N2hVUw4QKuttGVPPFLc01Tf3IT7rva3fcK4Lb0PGECKf\npK+oQ7kWVuLcR/18oD2QcE0cFR9Xj6SRXEd/+n/B540vL445gfW2jb7M6oiv\niNugr+2b+SWVPqQtBxYmE/IJCCbLS8SlJhyni76Z466Y2BmNNt+HojEYM1PP\nvkRS0T0ZV62BjGq3cszbwVKToiq9TXp2xZq+HvkvFI6IhbO9zn+vz3LUtrOR\nF95gIdZ3fd2U5ywMbL3++Yoesg/OiBE9oownfjvISUmjs2T+1gNkE6S7WlPv\nK58T/mqyJLfyJ6VflIZKqeMdI1fMfAgYjtBaOQNcqcNMR26kGNKQ0y6peM1c\n1VYpz42cko4SXdU9oUi4NIn1CQi+YLbWpOfU7yVc1RdekApkl+SpXvnncA1H\nePuv\r\n=ow3v\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCAJlq87SXI69yipog1wUaV3coIReGbQDSiE8boQFh7RQIgO/entcgjIEl5rxn4rNPPmRS+e72Gw3Riqh/16EhCN4E="}]},"maintainers":[{"name":"thuanpq","email":"thuanpq.io@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mysqldump_2.2.1_1546479944573_0.478167349592467"},"_hasShrinkwrap":false},"2.2.2":{"name":"@airvert.com/mysqldump","version":"2.2.2","description":"Create a DUMP from MySQL","main":"dist/cjs.js","module":"dist/es.js","publishConfig":{"access":"public"},"typings":"dist/mysqldump.d.ts","scripts":{"pretest":"ts-node -P ./tsconfig.json --files ./test/scripts/initDb.ts","pretest-prod":"ts-node -P ./tsconfig.json --files ./test/scripts/initDb.ts","setup-travis":"node ./test/setupTravis.js","test":"jest --ci --config=./jest.json","test-prod":"JEST_USE_NPM_BUILD=true jest --ci --config=./test/jest-prod-config.js","view-coverage":"open ./coverage/index.html","build":"rollup -c && dts-bundle-generator -o dist/mysqldump.d.ts build-decl/main.d.ts --umd-module-name=mysqldump && rimraf build-decl","clean":"rimraf dist && rimraf build-decl","lint":"eslint src --ext \".ts\"","start":"ts-node -P ./tsconfig.json --files ./test/scripts/launch.ts","ci":"yarn lint --quiet && yarn build"},"repository":{"type":"git","url":"git+https://github.com/airvert/mysqldump.git"},"keywords":["backup","mysql","mysql-dump","dump","restore","database","backup","database"],"author":{"name":"Brad Zacher"},"license":"MIT","bugs":{"url":"https://github.com/airvert/mysqldump/issues"},"homepage":"https://github.com/airvert/mysqldump","dependencies":{"@types/node":"^10.5.2","deepmerge":"^2.1.1","mysql2":"^1.5.3","sql-formatter":"^2.3.1","sqlstring":"^2.3.1"},"devDependencies":{"@types/deepmerge":"^2.1.0","@types/extend":"^3.0.0","@types/invariant":"^2.2.29","@types/jest":"^23.3.0","@types/mysql":"^2.15.5","@types/sqlstring":"^2.2.0","@types/tmp":"^0.0.33","babel":"^6.23.0","babel-plugin-transform-object-rest-spread":"^6.26.0","copyfiles":"^2.0.0","dts-bundle-generator":"^1.6.0","eslint":"^5.1.0","eslint-config-assignar-node":"^1.2.1","eslint-import-resolver-node":"^0.3.2","eslint-import-resolver-typescript":"^1.0.2","jest":"^23.4.1","rimraf":"^2.6.2","rollup":"^0.52.1","rollup-plugin-commonjs":"^8.2.6","rollup-plugin-typescript2":"^0.9.0","tmp":"^0.0.33","ts-jest":"^22.4.6","ts-node":"^7.0.0","typescript":"2.9.2"},"gitHead":"805f8adb5c218b96d21cdfff5a73ebd62a28f5f8","_id":"@airvert.com/mysqldump@2.2.2","_npmVersion":"6.4.1","_nodeVersion":"10.15.0","_npmUser":{"name":"thuanpq","email":"thuanpq.io@gmail.com"},"dist":{"integrity":"sha512-8WhfKiRwCNOVIg9CYppHZWCjH2CPPGiP2tmPWq7wezQ87VFz6jTwoazN/VaxjQVbNaDX88QoJBio3J3YmPUZvw==","shasum":"f9adbd08a74a37df69af4003a9b39075d59ab33b","tarball":"https://registry.npmjs.org/@airvert.com/mysqldump/-/mysqldump-2.2.2.tgz","fileCount":6,"unpackedSize":85800,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcLW2ICRA9TVsSAnZWagAAaewP/AxDYC4POB29FKFNnQuU\ni2vAiMdKDSVgSUQyQRrLhIdXtvcjI9mt1BDuQp+wdsz3l5f/avo3maW8OzG5\n9qaC/2VWmMrEJDqVqYnYqOTn9jkBFhOuL9/JgSZRosUghMPJ539m21lsV7Kc\nhwGJnVawajw1F06+Y8zcV3Dk6nL3ZrKv8Mk4BH4EkW5cI6mkgZlZgpq+xDzb\nkXQUZ6QXYRhhC58fT6JsCqgKk7Aeo1UKcvRKoMAWqeFnY7OQF+BqR9amt3P/\nJW4SF7jPCHw3Fi5tiTDBAliIwzu7XaXwWKakHuFxZzCJKRHutx2qF0m7UEeE\nBT6jdO7nzs7XvwpOmA3otqS6CCgHuguJv6R5LBqvV5LMh8k7b4Dyo1OqU9+/\nIThuGPUKRkU1u9ZWprq4IR9zNnyusINKyi44K0wZlTuO2IwHWFo+vi+Q0Mqa\np0cE/I6a/80/NdRzUJH//ECA9vYxRe9Gkodbf4GdYs6y0QylSqqHTiQBzFfO\nmB9XvnwSrNDdFZfMF84Rdn3JjroFJZWkJb5MqcM379uYrnWKvJxcek75/yb8\nzM31aoPcuR+cNppcSA6Ks3Nyzs3hB/QNzguyUvPblEJj7ch7ZtnyR0a02P4X\ntHXgI2ziiwComZ/HiGN2Z26C2XDeFztHXolWlzkXkxf+kfI+T2VUOoy7FHgz\nv6z8\r\n=YU1p\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEcRede4/sMGT5T0BPwJsqeDRODMEMNlch6gxNAtYTz/AiEA9nukP5CBp85lPQIFhjB24exT5Ljlq8ID8HTTeRfxpPg="}]},"maintainers":[{"name":"thuanpq","email":"thuanpq.io@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mysqldump_2.2.2_1546481032088_0.2657810450203719"},"_hasShrinkwrap":false},"2.2.3":{"name":"@airvert.com/mysqldump","version":"2.2.3","description":"Create a DUMP from MySQL","main":"dist/cjs.js","module":"dist/es.js","publishConfig":{"access":"public"},"typings":"dist/mysqldump.d.ts","scripts":{"pretest":"ts-node -P ./tsconfig.json --files ./test/scripts/initDb.ts","pretest-prod":"ts-node -P ./tsconfig.json --files ./test/scripts/initDb.ts","setup-travis":"node ./test/setupTravis.js","test":"jest --ci --config=./jest.json","test-prod":"JEST_USE_NPM_BUILD=true jest --ci --config=./test/jest-prod-config.js","view-coverage":"open ./coverage/index.html","build":"rollup -c && dts-bundle-generator -o dist/mysqldump.d.ts build-decl/main.d.ts --umd-module-name=mysqldump && rimraf build-decl","clean":"rimraf dist && rimraf build-decl","lint":"eslint src --ext \".ts\"","start":"ts-node -P ./tsconfig.json --files ./test/scripts/launch.ts","ci":"yarn lint --quiet && yarn build"},"repository":{"type":"git","url":"git+https://bitbucket.org/airvert_team/mysqldump.git"},"keywords":["backup","mysql","mysql-dump","dump","restore","database","backup","database"],"author":{"name":"Brad Zacher"},"license":"MIT","homepage":"https://bitbucket.org/airvert_team/mysqldump.git","dependencies":{"@types/node":"^10.5.2","deepmerge":"^2.1.1","mysql2":"^1.5.3","sql-formatter":"^2.3.1","sqlstring":"^2.3.1"},"devDependencies":{"@types/deepmerge":"^2.1.0","@types/extend":"^3.0.0","@types/invariant":"^2.2.29","@types/jest":"^23.3.0","@types/mysql":"^2.15.5","@types/sqlstring":"^2.2.0","@types/tmp":"^0.0.33","babel":"^6.23.0","babel-plugin-transform-object-rest-spread":"^6.26.0","copyfiles":"^2.0.0","dts-bundle-generator":"^1.6.0","eslint":"^5.1.0","eslint-config-assignar-node":"^1.2.1","eslint-import-resolver-node":"^0.3.2","eslint-import-resolver-typescript":"^1.0.2","jest":"^23.4.1","rimraf":"^2.6.2","rollup":"^0.52.1","rollup-plugin-commonjs":"^8.2.6","rollup-plugin-typescript2":"^0.9.0","tmp":"^0.0.33","ts-jest":"^22.4.6","ts-node":"^7.0.0","typescript":"2.9.2"},"gitHead":"a6eaae849330eef036e9d4ff728556ec854fb7b6","_id":"@airvert.com/mysqldump@2.2.3","_npmVersion":"6.4.1","_nodeVersion":"10.15.0","_npmUser":{"name":"thuanpq","email":"thuanpq.io@gmail.com"},"dist":{"integrity":"sha512-to1LzswQz1HUCUHHAM5DRU405r6Les1eG9K7UOSYNjY9jr+36XziF1+96aVh0oBNjEVg3rpPDiBGHsooGZQzeQ==","shasum":"974d663cf06c6225d718846c7ad0ef4beeb37ed2","tarball":"https://registry.npmjs.org/@airvert.com/mysqldump/-/mysqldump-2.2.3.tgz","fileCount":6,"unpackedSize":85746,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcLXNzCRA9TVsSAnZWagAAToMP/R5Zht3nM6L5qwJUGjs6\nagvI3Gi72xT6pFbLG3d7lG9jGcrDnI06OfoUx2royijrSg3Wu2vFvcNmZk5k\n3HjBBTROv284LjIY9s+h1rT8ixg+m/Qg08dUIzZBSAsMQA29Q4hh5wXoGBry\npdWhwLjO0To6hjaiQHbYK7Jwwp4TTytg/E1R21aYew4dBiciZsxaSEQEl9qr\n3vAjadhfYGFBqI0P4Kw9lixO7mtx55+gw2qkrVmaEflcS94/l+BfhDg3GL96\naCjOW5dpOsCk6ehdEEqWBxXTOzfx9gYA5YuNnBOV9hXj0nOmk/sXsUim3nE3\noX/HLyvyyPlncJqDNN7sG1es7I8ZdAsOMQ9qG+vKLrrCCV0c/lm1/KmosJxV\n7JKk/TizqspvXUFjjpqXOzoOuSQRnUhuNSTuRuihUhwOK1MTAjyJFXv7TsX+\ne9e+mLa7uY8+OV2TQtgDhz/HuJkWakDKwrJM9wqXTrLZkA/cWpzH7R7Owvv/\nQEvph5aFPrk7U/wCkGu0LSXMPLw/uDLQKLJN9mbQ9MYQ4kPjc/3u1NAi654w\nDB/ENwMFZRangaM0Vgj2UbJ+KbjyMWxib0KUjgPb2wdWu/Z2U86BEurKQOde\nw2tui+F2H4JmtzWB2/JNIUfiQWqzgb4Re8W6HdCBvIzAqlWdoPhl0C2ofFSx\njX8S\r\n=awTI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGKOGb9E9F+i7ljSY55FG6RLerP5ZLFtDgdPFOIVa6MGAiBa4dcKxcbozIJ9+S41WJIT3pi4+NR5y1dUBXGTR5KCZA=="}]},"maintainers":[{"name":"thuanpq","email":"thuanpq.io@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mysqldump_2.2.3_1546482546996_0.13224945996427429"},"_hasShrinkwrap":false,"deprecated":"This package is not being used or supported"}},"time":{"created":"2019-01-03T01:45:44.399Z","2.2.1":"2019-01-03T01:45:44.732Z","modified":"2022-04-04T12:23:41.965Z","2.2.2":"2019-01-03T02:03:52.217Z","2.2.3":"2019-01-03T02:29:07.081Z"},"maintainers":[{"name":"thuanpq","email":"thuanpq.io@gmail.com"}],"description":"Create a DUMP from MySQL","homepage":"https://bitbucket.org/airvert_team/mysqldump.git","keywords":["backup","mysql","mysql-dump","dump","restore","database","backup","database"],"repository":{"type":"git","url":"git+https://bitbucket.org/airvert_team/mysqldump.git"},"author":{"name":"Brad Zacher"},"license":"MIT","readme":"# Mysql Dump\n\n[![npm version](https://badge.fury.io/js/mysqldump.svg)](https://npmjs.com/package/mysqldump) [![Build Status](https://travis-ci.org/bradzacher/mysqldump.svg)](https://travis-ci.org/bradzacher/mysqldump)\n\nCreate a backup of a MySQL database.\n\n## Installation\n\n```\nyarn add mysqldump\n// or\nnpm install mysqldump\n```\n\n## Usage\n```typescript\nimport mysqldump from 'mysqldump'\n// or const mysqldump = require('mysqldump')\n\n// dump the result straight to a file\nmysqldump({\n    connection: {\n        host: 'localhost',\n        user: 'root',\n        password: '123456',\n        database: 'my_database',\n    },\n    dumpToFile: './dump.sql',\n})\n\n// return the dump from the function and not to a file\nconst result = await mysqldump({\n    connection: {\n        host: 'localhost',\n        user: 'root',\n        password: '123456',\n        database: 'my_database',\n    },\n})\n```\n\n\n## Options\nAll the below options are documented in the [typescript declaration file](./dist/mysqldump.d.ts):\n```TS\nexport interface ConnectionOptions {\n\t/**\n\t * The database host to connect to.\n\t * Defaults to 'localhost'.\n\t */\n\thost?: string;\n\t/**\n\t * The port on the host to connect to.\n\t * Defaults to 3306.\n\t */\n\tport?: number;\n\t/**\n\t * The database to dump.\n\t */\n\tdatabase: string;\n\t/**\n\t * The DB username to use to connect.\n\t */\n\tuser: string;\n\t/**\n\t * The password to use to connect.\n\t */\n\tpassword: string;\n\t/**\n\t * The charset to use for the connection.\n\t * Defaults to 'UTF8_GENERAL_CI'.\n\t */\n\tcharset?: string;\n}\nexport interface SchemaDumpOptions {\n\t/**\n\t * True to include autoincrement values in schema, false otherwise.\n\t * Defaults to true.\n\t */\n\tautoIncrement?: boolean;\n\t/**\n\t * True to include engine values in schema, false otherwise.\n\t * Defaults to true.\n\t */\n\tengine?: boolean;\n\t/**\n\t * True to run a sql formatter over the output, false otherwise.\n\t * Defaults to true.\n\t */\n\tformat?: boolean;\n\t/**\n\t * Options for table dumps\n\t */\n\ttable?: {\n\t\t/**\n\t\t * Guard create table calls with an \"IF NOT EXIST\"\n\t\t * Defaults to true.\n\t\t */\n\t\tifNotExist?: boolean;\n\t\t/**\n\t\t * Drop tables before creation (overrides `ifNotExist`).\n\t\t * Defaults to false.\n\t\t */\n\t\tdropIfExist?: boolean;\n\t\t/**\n\t\t * Include the `DEFAULT CHARSET = x` at the end of the table definition\n\t\t * Set to true to include the value form the DB.\n\t\t * Set to false to exclude it altogether.\n\t\t * Set to a string to explicitly set the charset.\n\t\t * Defaults to true.\n\t\t */\n\t\tcharset?: boolean | string;\n\t};\n\tview?: {\n\t\t/**\n\t\t * Uses `CREATE OR REPLACE` to define views.\n\t\t * Defaults to true.\n\t\t */\n\t\tcreateOrReplace?: boolean;\n\t\t/**\n\t\t * Include the `DEFINER = {\\`user\\`@\\`host\\` | CURRENT_USER}` in the view definition or not\n\t\t * Defaults to false.\n\t\t */\n\t\tdefiner?: boolean;\n\t\t/**\n\t\t * Include the `ALGORITHM = {UNDEFINED | MERGE | TEMPTABLE}` in the view definition or not\n\t\t * Defaults to false.\n\t\t */\n\t\talgorithm?: boolean;\n\t\t/**\n\t\t * Incldue the `SQL SECURITY {DEFINER | INVOKER}` in the view definition or not\n\t\t * Defaults to false.\n\t\t */\n\t\tsqlSecurity?: boolean;\n\t};\n}\nexport interface TriggerDumpOptions {\n\t/**\n\t * The temporary delimiter to use between statements.\n\t * Set to false to not use delmiters\n\t * Defaults to ';;'.\n\t */\n\tdelimiter?: string | false;\n\t/**\n\t * Drop triggers before creation.\n\t * Defaults to false.\n\t */\n\tdropIfExist?: boolean;\n\t/**\n\t * Include the `DEFINER = {\\`user\\`@\\`host\\` | CURRENT_USER}` in the view definition or not\n\t * Defaults to false.\n\t */\n\tdefiner?: boolean;\n}\nexport interface DataDumpOptions {\n\t/**\n\t * True to run a sql formatter over the output, false otherwise.\n\t * Defaults to true.\n\t */\n\tformat?: boolean;\n\t/**\n\t * Dump data from views.\n\t * Defaults to false.\n\t */\n\tincludeViewData?: boolean;\n\t/**\n\t * Maximum number of rows to include in each multi-line insert statement\n\t * Defaults to 1 (i.e. new statement per row).\n\t */\n\tmaxRowsPerInsertStatement?: number;\n\t/**\n\t * True to return the data in a function, false to not.\n\t * This is useful in databases with a lot of data.\n\t *\n\t * We stream data from the DB to reduce the memory footprint.\n\t * However note that if you want the result returned from the function,\n\t * this will result in a larger memory footprint as the string has to be stored in memory.\n\t *\n\t * Defaults to false if dumpToFile is truthy, or true if not dumpToFile is falsey.\n\t */\n\treturnFromFunction?: boolean;\n\t/**\n\t * A map of tables to additional where strings to add.\n\t * Use this to limit the number of data that is dumped.\n\t * Defaults to no limits\n\t */\n\twhere?: {\n\t\t[k: string]: string;\n\t};\n}\nexport interface DumpOptions {\n\t/**\n\t * The list of tables that you want to dump.\n\t * Defaults to all tables (signalled by passing an empty array).\n\t */\n\ttables?: string[];\n\t/**\n\t * True to use the `tables` options as a blacklist, false to use it as a whitelist.\n\t * Defaults to false.\n\t */\n\texcludeTables?: boolean;\n\t/**\n\t * Explicitly set to false to not include the schema in the dump.\n\t * Defaults to including the schema.\n\t */\n\tschema?: false | SchemaDumpOptions;\n\t/**\n\t * Explicitly set to false to not include data in the dump.\n\t * Defaults to including the data.\n\t */\n\tdata?: false | DataDumpOptions;\n\t/**\n\t * Explicitly set to false to not include triggers in the dump.\n\t * Defaults to including the triggers.\n\t */\n\ttrigger?: false | TriggerDumpOptions;\n}\nexport interface Options {\n\t/**\n\t * Database connection options\n\t */\n\tconnection: ConnectionOptions;\n\t/**\n\t * Dump configuration options\n\t */\n\tdump?: DumpOptions;\n\t/**\n\t * Set to a path to dump to a file.\n\t * Exclude to just return the string.\n\t */\n\tdumpToFile?: string;\n}\nexport interface ColumnList {\n\t/**\n\t * Key is the name of the column\n\t */\n\t[k: string]: {\n\t\t/**\n\t\t * The type of the column as reported by the underlying DB.\n\t\t */\n\t\ttype: string;\n\t\t/**\n\t\t * True if the column is nullable, false otherwise.\n\t\t */\n\t\tnullable: boolean;\n\t};\n}\nexport interface Table {\n\t/**\n\t * The name of the table.\n\t */\n\tname: string;\n\t/**\n\t * The raw SQL schema dump for the table.\n\t * Null if configured to not dump.\n\t */\n\tschema: string | null;\n\t/**\n\t * The raw SQL data dump for the table.\n\t * Null if configured to not dump.\n\t */\n\tdata: string | null;\n\t/**\n\t * The list of column definitions for the table.\n\t */\n\tcolumns: ColumnList;\n\t/**\n\t * An ordered list of columns (for consistently outputing as per the DB definition)\n\t */\n\tcolumnsOrdered: string[];\n\t/**\n\t * True if the table is actually a view, false otherwise.\n\t */\n\tisView: boolean;\n\t/**\n\t * A list of triggers attached to the table\n\t */\n\ttriggers: string[];\n}\nexport interface DumpReturn {\n\t/**\n\t * The result of the dump\n\t */\n\tdump: {\n\t\t/**\n\t\t * The concatenated SQL schema dump for the entire database.\n\t\t * Null if configured not to dump.\n\t\t */\n\t\tschema: string | null;\n\t\t/**\n\t\t * The concatenated SQL data dump for the entire database.\n\t\t * Null if configured not to dump.\n\t\t */\n\t\tdata: string | null;\n\t\t/**\n\t\t * The concatenated SQL trigger dump for the entire database.\n\t\t * Null if configured not to dump.\n\t\t */\n\t\ttrigger: string | null;\n\t};\n\ttables: Table[];\n}\nexport default function main(inputOptions: Options): Promise<DumpReturn>;\n\nexport as namespace mysqldump;\n```\n\n---------------------------------\n\nThe MIT [License](./LICENSE.md)\n\n## Contributing\n\n### Installation\n\nMake sure to first install all the required development dependencies:\n```\nyarn\n// or\nnpm install .\n```\n\n### Linting\n\nWe use [eslint](https://www.npmjs.com/package/eslint) in conjunction with [typescript-eslint-parser](https://www.npmjs.com/package/typescript-eslint-parser) for code linting.\n\nPRs are required to pass the linting with no errors and preferrably no warnings.\n\n### Testing\n\nTests can be run via the `test` script - `yarn test` / `npm test`.\n\nAdditionally it's required that you do a build and run your test against the public package to ensure the build doesn't cause regressions - `yarn run test-prod` / `npm run test-prod`.\n\nPRs are required to maintain the 100% test coverage, and all tests must pass successfully.\n","readmeFilename":"README.md"}