{
    "content": [
        {
            "type": "text",
            "text": "# mysqlpump (man)\n\n## NAME\n\nmysqlpump - a database backup program\n\n## SYNOPSIS\n\nmysqlpump [options] [dbname [tblname ...]]\n\n## DESCRIPTION\n\n•   mysqlpump Invocation Syntax\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **COPYRIGHT**\n- **NOTES**\n- **SEE ALSO**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "mysqlpump",
        "section": "",
        "mode": "man",
        "summary": "mysqlpump - a database backup program",
        "synopsis": "mysqlpump [options] [dbname [tblname ...]]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 1390,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 15,
                "subsections": []
            },
            {
                "name": "NOTES",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "mysqlpump - a database backup program\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "mysqlpump [options] [dbname [tblname ...]]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "•   mysqlpump Invocation Syntax\n\n•   mysqlpump Option Summary\n\n•   mysqlpump Option Descriptions\n\n•   mysqlpump Object Selection\n\n•   mysqlpump Parallel Processing\n\n•   mysqlpump Restrictions\n\nThe mysqlpump client utility performs logical backups, producing a set of SQL statements that\ncan be executed to reproduce the original database object definitions and table data. It\ndumps one or more MySQL databases for backup or transfer to another SQL server.\n\nNote\n\nmysqlpump is deprecated as of MySQL 8.0.34; expect it to be removed in a future version\nof MySQL. You can use such MySQL programs as mysqldump and MySQL Shell to perform logical\nbackups, dump databases, and similar tasks instead.\n\nTip\n\nConsider using the \u001b[34mMySQL Shell dump utilities[1], which provide parallel dumping with\nmultiple threads, file compression, and progress information display, as well as cloud\nfeatures such as Oracle Cloud Infrastructure Object Storage streaming, and MySQL HeatWave\ncompatibility checks and modifications. Dumps can be easily imported into a MySQL Server\ninstance or a MySQL HeatWave DB System using the \u001b[34mMySQL Shell load dump utilities[2].\nInstallation instructions for MySQL Shell can be found \u001b[34mhere[3].\n\nmysqlpump features include:\n\n•   Parallel processing of databases, and of objects within databases, to speed up the dump\nprocess\n\n•   Better control over which databases and database objects (tables, stored programs, user\naccounts) to dump\n\n•   Dumping of user accounts as account-management statements (CREATE USER, GRANT) rather\nthan as inserts into the mysql system database\n\n•   Capability of creating compressed output\n\n•   Progress indicator (the values are estimates)\n\n•   For dump file reloading, faster secondary index creation for InnoDB tables by adding\nindexes after rows are inserted\n\nNote\n\nmysqlpump uses MySQL features introduced in MySQL 5.7, and thus assumes use with MySQL\n5.7 or higher.\n\nmysqlpump requires at least the SELECT privilege for dumped tables, SHOW VIEW for dumped\nviews, TRIGGER for dumped triggers, and LOCK TABLES if the --single-transaction option is not\nused. The SELECT privilege on the mysql system database is required to dump user definitions.\nCertain options might require other privileges as noted in the option descriptions.\n\nTo reload a dump file, you must have the privileges required to execute the statements that\nit contains, such as the appropriate CREATE privileges for objects created by those\nstatements.\n\nNote\n\nA dump made using PowerShell on Windows with output redirection creates a file that has\nUTF-16 encoding:\n\nmysqlpump [options] > dump.sql\n\nHowever, UTF-16 is not permitted as a connection character set (see Section 12.4,\n“Connection Character Sets and Collations”), so the dump file cannot be loaded correctly.\nTo work around this issue, use the --result-file option, which creates the output in\nASCII format:\n\nmysqlpump [options] --result-file=dump.sql\nmysqlpump Invocation Syntax\n\nBy default, mysqlpump dumps all databases (with certain exceptions noted in mysqlpump\nRestrictions). To specify this behavior explicitly, use the --all-databases option:\n\nmysqlpump --all-databases\n\nTo dump a single database, or certain tables within that database, name the database on the\ncommand line, optionally followed by table names:\n\nmysqlpump dbname\nmysqlpump dbname tblname1 tblname2 ...\n\nTo treat all name arguments as database names, use the --databases option:\n\nmysqlpump --databases dbname1 dbname2 ...\n\nBy default, mysqlpump does not dump user account definitions, even if you dump the mysql\nsystem database that contains the grant tables. To dump grant table contents as logical\ndefinitions in the form of CREATE USER and GRANT statements, use the --users option and\nsuppress all database dumping:\n\nmysqlpump --exclude-databases=% --users\n\nIn the preceding command, % is a wildcard that matches all database names for the\n--exclude-databases option.\n\nmysqlpump supports several options for including or excluding databases, tables, stored\nprograms, and user definitions. See mysqlpump Object Selection.\n\nTo reload a dump file, execute the statements that it contains. For example, use the mysql\nclient:\n\nmysqlpump [options] > dump.sql\nmysql < dump.sql\n\nThe following discussion provides additional mysqlpump usage examples.\n\nTo see a list of the options mysqlpump supports, issue the command mysqlpump --help.\nmysqlpump Option Summary\n\nmysqlpump supports the following options, which can be specified on the command line or in\nthe [mysqlpump] and [client] groups of an option file. (Prior to MySQL 8.0.20, mysqlpump read\nthe [mysqldump] group rather than [mysqlpump]. As of 8.0.20, [mysqldump] is still accepted\nbut is deprecated.) For information about option files used by MySQL programs, see\nSection 6.2.2.2, “Using Option Files”.  mysqlpump Option Descriptions\n\n•   --help, -?\n┌─────────────────────┬────────┐\n│ Command-Line Format │ --help │\n└─────────────────────┴────────┘\n\nDisplay a help message and exit.\n\n•   --add-drop-database\n┌─────────────────────┬─────────────────────┐\n│ Command-Line Format │ --add-drop-database │\n└─────────────────────┴─────────────────────┘\n\nWrite a DROP DATABASE statement before each CREATE DATABASE statement.\n\nNote\nIn MySQL 8.0, the mysql schema is considered a system schema that cannot be dropped\nby end users. If --add-drop-database is used with --all-databases or with --databases\nwhere the list of schemas to be dumped includes mysql, the dump file contains a DROP\nDATABASE `mysql` statement that causes an error when the dump file is reloaded.\n\nInstead, to use --add-drop-database, use --databases with a list of schemas to be\ndumped, where the list does not include mysql.\n\n•   --add-drop-table\n┌─────────────────────┬──────────────────┐\n│ Command-Line Format │ --add-drop-table │\n└─────────────────────┴──────────────────┘\n\nWrite a DROP TABLE statement before each CREATE TABLE statement.\n\n•   --add-drop-user\n┌─────────────────────┬─────────────────┐\n│ Command-Line Format │ --add-drop-user │\n└─────────────────────┴─────────────────┘\n\nWrite a DROP USER statement before each CREATE USER statement.\n\n•   --add-locks\n┌─────────────────────┬─────────────┐\n│ Command-Line Format │ --add-locks │\n└─────────────────────┴─────────────┘\n\nSurround each table dump with LOCK TABLES and UNLOCK TABLES statements. This results in\nfaster inserts when the dump file is reloaded. See Section 10.2.5.1, “Optimizing INSERT\nStatements”.\n\nThis option does not work with parallelism because INSERT statements from different\ntables can be interleaved and UNLOCK TABLES following the end of the inserts for one\ntable could release locks on tables for which inserts remain.\n\n--add-locks and --single-transaction are mutually exclusive.\n\n•   --all-databases, -A\n┌─────────────────────┬─────────────────┐\n│ Command-Line Format │ --all-databases │\n└─────────────────────┴─────────────────┘\n\nDump all databases (with certain exceptions noted in mysqlpump Restrictions). This is the\ndefault behavior if no other is specified explicitly.\n\n--all-databases and --databases are mutually exclusive.\n\nNote\nSee the --add-drop-database description for information about an incompatibility of\nthat option with --all-databases.\nPrior to MySQL 8.0, the --routines and --events options for mysqldump and mysqlpump were\nnot required to include stored routines and events when using the --all-databases option:\nThe dump included the mysql system database, and therefore also the mysql.proc and\nmysql.event tables containing stored routine and event definitions. As of MySQL 8.0, the\nmysql.event and mysql.proc tables are not used. Definitions for the corresponding objects\nare stored in data dictionary tables, but those tables are not dumped. To include stored\nroutines and events in a dump made using --all-databases, use the --routines and --events\noptions explicitly.\n\n•   --bind-address=ipaddress\n┌─────────────────────┬───────────────────────────┐\n│ Command-Line Format │ --bind-address=ipaddress │\n└─────────────────────┴───────────────────────────┘\n\nOn a computer having multiple network interfaces, use this option to select which\ninterface to use for connecting to the MySQL server.\n\n•   --character-sets-dir=path\n┌─────────────────────┬───────────────────────────────┐\n│ Command-Line Format │ --character-sets-dir=dirname │\n├─────────────────────┼───────────────────────────────┤\n│ Type                │ Directory name                │\n└─────────────────────┴───────────────────────────────┘\n\nThe directory where character sets are installed. See Section 12.15, “Character Set\nConfiguration”.\n\n•   --column-statistics\n┌─────────────────────┬─────────────────────┐\n│ Command-Line Format │ --column-statistics │\n├─────────────────────┼─────────────────────┤\n│ Type                │ Boolean             │\n├─────────────────────┼─────────────────────┤\n│ Default Value       │ OFF                 │\n└─────────────────────┴─────────────────────┘\n\nAdd ANALYZE TABLE statements to the output to generate histogram statistics for dumped\ntables when the dump file is reloaded. This option is disabled by default because\nhistogram generation for large tables can take a long time.\n\n•   --complete-insert\n┌─────────────────────┬───────────────────┐\n│ Command-Line Format │ --complete-insert │\n└─────────────────────┴───────────────────┘\n\nWrite complete INSERT statements that include column names.\n\n•   --compress, -C\n┌─────────────────────┬───────────────────────┐\n│ Command-Line Format │ --compress[={OFF|ON}] │\n├─────────────────────┼───────────────────────┤\n│ Deprecated          │ 8.0.18                │\n├─────────────────────┼───────────────────────┤\n│ Type                │ Boolean               │\n├─────────────────────┼───────────────────────┤\n│ Default Value       │ OFF                   │\n└─────────────────────┴───────────────────────┘\n\nCompress all information sent between the client and the server if possible. See\nSection 6.2.8, “Connection Compression Control”.\n\nAs of MySQL 8.0.18, this option is deprecated. Expect it to be removed in a future\nversion of MySQL. See the section called “Configuring Legacy Connection Compression”.\n\n•   --compress-output=algorithm\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --compress-output=algorithm │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ Enumeration                 │\n├─────────────────────┼─────────────────────────────┤\n│ Valid Values        │                             │\n│                     │            LZ4              │\n│                     │                             │\n│                     │            ZLIB             │\n└─────────────────────┴─────────────────────────────┘\n\nBy default, mysqlpump does not compress output. This option specifies output compression\nusing the specified algorithm. Permitted algorithms are LZ4 and ZLIB.\n\nTo uncompress compressed output, you must have an appropriate utility. If the system\ncommands lz4 and openssl zlib are not available, MySQL distributions include\nlz4decompress and zlibdecompress utilities that can be used to decompress mysqlpump\noutput that was compressed using the --compress-output=LZ4 and --compress-output=ZLIB\noptions. For more information, see lz4decompress(1), and zlibdecompress(1).\n\n•   --compression-algorithms=value\n┌─────────────────────┬────────────────────────────────┐\n│ Command-Line Format │ --compression-algorithms=value │\n├─────────────────────┼────────────────────────────────┤\n│ Introduced          │ 8.0.18                         │\n├─────────────────────┼────────────────────────────────┤\n│ Type                │ Set                            │\n├─────────────────────┼────────────────────────────────┤\n│ Default Value       │ uncompressed                   │\n├─────────────────────┼────────────────────────────────┤\n│ Valid Values        │                                │\n│                     │            zlib                │\n│                     │                                │\n│                     │            zstd                │\n│                     │                                │\n│                     │            uncompressed        │\n└─────────────────────┴────────────────────────────────┘\n\nThe permitted compression algorithms for connections to the server. The available\nalgorithms are the same as for the protocolcompressionalgorithms system variable. The\ndefault value is uncompressed.\n\nFor more information, see Section 6.2.8, “Connection Compression Control”.\n\nThis option was added in MySQL 8.0.18.\n\n•   --databases, -B\n┌─────────────────────┬─────────────┐\n│ Command-Line Format │ --databases │\n└─────────────────────┴─────────────┘\n\nNormally, mysqlpump treats the first name argument on the command line as a database name\nand any following names as table names. With this option, it treats all name arguments as\ndatabase names.  CREATE DATABASE statements are included in the output before each new\ndatabase.\n\n--all-databases and --databases are mutually exclusive.\n\nNote\nSee the --add-drop-database description for information about an incompatibility of\nthat option with --databases.\n\n•   --debug[=debugoptions], -# [debugoptions]\n┌─────────────────────┬────────────────────────────┐\n│ Command-Line Format │ --debug[=debugoptions]    │\n├─────────────────────┼────────────────────────────┤\n│ Type                │ String                     │\n├─────────────────────┼────────────────────────────┤\n│ Default Value       │ d:t:O,/tmp/mysqlpump.trace │\n└─────────────────────┴────────────────────────────┘\n\nWrite a debugging log. A typical debugoptions string is d:t:o,filename. The default is\nd:t:O,/tmp/mysqlpump.trace.\n\nThis option is available only if MySQL was built using WITHDEBUG. MySQL release binaries\nprovided by Oracle are not built using this option.\n\n•   --debug-check\n┌─────────────────────┬───────────────┐\n│ Command-Line Format │ --debug-check │\n├─────────────────────┼───────────────┤\n│ Type                │ Boolean       │\n├─────────────────────┼───────────────┤\n│ Default Value       │ FALSE         │\n└─────────────────────┴───────────────┘\n\nPrint some debugging information when the program exits.\n\nThis option is available only if MySQL was built using WITHDEBUG. MySQL release binaries\nprovided by Oracle are not built using this option.\n\n•   --debug-info, -T\n┌─────────────────────┬──────────────┐\n│ Command-Line Format │ --debug-info │\n├─────────────────────┼──────────────┤\n│ Type                │ Boolean      │\n├─────────────────────┼──────────────┤\n│ Default Value       │ FALSE        │\n└─────────────────────┴──────────────┘\n\nPrint debugging information and memory and CPU usage statistics when the program exits.\n\nThis option is available only if MySQL was built using WITHDEBUG. MySQL release binaries\nprovided by Oracle are not built using this option.\n\n•   --default-auth=plugin\n┌─────────────────────┬───────────────────────┐\n│ Command-Line Format │ --default-auth=plugin │\n├─────────────────────┼───────────────────────┤\n│ Type                │ String                │\n└─────────────────────┴───────────────────────┘\n\nA hint about which client-side authentication plugin to use. See Section 8.2.17,\n“Pluggable Authentication”.\n\n•   --default-character-set=charsetname\n┌─────────────────────┬──────────────────────┐\n│ Command-Line Format │ --default-character- │\n│                     │ set=charsetname     │\n├─────────────────────┼──────────────────────┤\n│ Type                │ String               │\n├─────────────────────┼──────────────────────┤\n│ Default Value       │ utf8                 │\n└─────────────────────┴──────────────────────┘\n\nUse charsetname as the default character set. See Section 12.15, “Character Set\nConfiguration”. If no character set is specified, mysqlpump uses utf8mb4.\n\n•   --default-parallelism=N\n┌─────────────────────┬─────────────────────────┐\n│ Command-Line Format │ --default-parallelism=N │\n├─────────────────────┼─────────────────────────┤\n│ Type                │ Integer                 │\n├─────────────────────┼─────────────────────────┤\n│ Default Value       │ 2                       │\n└─────────────────────┴─────────────────────────┘\n\nThe default number of threads for each parallel processing queue. The default is 2.\n\nThe --parallel-schemas option also affects parallelism and can be used to override the\ndefault number of threads. For more information, see mysqlpump Parallel Processing.\n\nWith --default-parallelism=0 and no --parallel-schemas options, mysqlpump runs as a\nsingle-threaded process and creates no queues.\n\nWith parallelism enabled, it is possible for output from different databases to be\ninterleaved.\n\n•   --defaults-extra-file=filename\n┌─────────────────────┬─────────────────────────────────┐\n│ Command-Line Format │ --defaults-extra-file=filename │\n├─────────────────────┼─────────────────────────────────┤\n│ Type                │ File name                       │\n└─────────────────────┴─────────────────────────────────┘\n\nRead this option file after the global option file but (on Unix) before the user option\nfile. If the file does not exist or is otherwise inaccessible, an error occurs. If\nfilename is not an absolute path name, it is interpreted relative to the current\ndirectory.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --defaults-file=filename\n┌─────────────────────┬───────────────────────────┐\n│ Command-Line Format │ --defaults-file=filename │\n├─────────────────────┼───────────────────────────┤\n│ Type                │ File name                 │\n└─────────────────────┴───────────────────────────┘\n\nUse only the given option file. If the file does not exist or is otherwise inaccessible,\nan error occurs. If filename is not an absolute path name, it is interpreted relative to\nthe current directory.\n\nException: Even with --defaults-file, client programs read .mylogin.cnf.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --defaults-group-suffix=str\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --defaults-group-suffix=str │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nRead not only the usual option groups, but also groups with the usual names and a suffix\nof str. For example, mysqlpump normally reads the [client] and [mysqlpump] groups. If\nthis option is given as --defaults-group-suffix=other, mysqlpump also reads the\n[clientother] and [mysqlpumpother] groups.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --defer-table-indexes\n┌─────────────────────┬───────────────────────┐\n│ Command-Line Format │ --defer-table-indexes │\n├─────────────────────┼───────────────────────┤\n│ Type                │ Boolean               │\n├─────────────────────┼───────────────────────┤\n│ Default Value       │ TRUE                  │\n└─────────────────────┴───────────────────────┘\n\nIn the dump output, defer index creation for each table until after its rows have been\nloaded. This works for all storage engines, but for InnoDB applies only for secondary\nindexes.\n\nThis option is enabled by default; use --skip-defer-table-indexes to disable it.\n\n•   --events\n┌─────────────────────┬──────────┐\n│ Command-Line Format │ --events │\n├─────────────────────┼──────────┤\n│ Type                │ Boolean  │\n├─────────────────────┼──────────┤\n│ Default Value       │ TRUE     │\n└─────────────────────┴──────────┘\n\nInclude Event Scheduler events for the dumped databases in the output. Event dumping\nrequires the EVENT privileges for those databases.\n\nThe output generated by using --events contains CREATE EVENT statements to create the\nevents.\n\nThis option is enabled by default; use --skip-events to disable it.\n\n•   --exclude-databases=dblist\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --exclude-databases=dblist │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nDo not dump the databases in dblist, which is a list of one or more comma-separated\ndatabase names. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --exclude-events=eventlist\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --exclude-events=eventlist │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nDo not dump the databases in eventlist, which is a list of one or more comma-separated\nevent names. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --exclude-routines=routinelist\n┌─────────────────────┬─────────────────────────────────┐\n│ Command-Line Format │ --exclude-routines=routinelist │\n├─────────────────────┼─────────────────────────────────┤\n│ Type                │ String                          │\n└─────────────────────┴─────────────────────────────────┘\n\nDo not dump the events in routinelist, which is a list of one or more comma-separated\nroutine (stored procedure or function) names. Multiple instances of this option are\nadditive. For more information, see mysqlpump Object Selection.\n\n•   --exclude-tables=tablelist\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --exclude-tables=tablelist │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nDo not dump the tables in tablelist, which is a list of one or more comma-separated\ntable names. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --exclude-triggers=triggerlist\n┌─────────────────────┬─────────────────────────────────┐\n│ Command-Line Format │ --exclude-triggers=triggerlist │\n├─────────────────────┼─────────────────────────────────┤\n│ Type                │ String                          │\n└─────────────────────┴─────────────────────────────────┘\n\nDo not dump the triggers in triggerlist, which is a list of one or more comma-separated\ntrigger names. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --exclude-users=userlist\n┌─────────────────────┬───────────────────────────┐\n│ Command-Line Format │ --exclude-users=userlist │\n├─────────────────────┼───────────────────────────┤\n│ Type                │ String                    │\n└─────────────────────┴───────────────────────────┘\n\nDo not dump the user accounts in userlist, which is a list of one or more\ncomma-separated account names. Multiple instances of this option are additive. For more\ninformation, see mysqlpump Object Selection.\n\n•   --extended-insert=N\n┌─────────────────────┬─────────────────────┐\n│ Command-Line Format │ --extended-insert=N │\n└─────────────────────┴─────────────────────┘\n\nWrite INSERT statements using multiple-row syntax that includes several VALUES lists.\nThis results in a smaller dump file and speeds up inserts when the file is reloaded.\n\nThe option value indicates the number of rows to include in each INSERT statement. The\ndefault is 250. A value of 1 produces one INSERT statement per table row.\n\n•   --get-server-public-key\n┌─────────────────────┬─────────────────────────┐\n│ Command-Line Format │ --get-server-public-key │\n├─────────────────────┼─────────────────────────┤\n│ Type                │ Boolean                 │\n└─────────────────────┴─────────────────────────┘\n\nRequest from the server the public key required for RSA key pair-based password exchange.\nThis option applies to clients that authenticate with the cachingsha2password\nauthentication plugin. For that plugin, the server does not send the public key unless\nrequested. This option is ignored for accounts that do not authenticate with that plugin.\nIt is also ignored if RSA-based password exchange is not used, as is the case when the\nclient connects to the server using a secure connection.\n\nIf --server-public-key-path=filename is given and specifies a valid public key file, it\ntakes precedence over --get-server-public-key.\n\nFor information about the cachingsha2password plugin, see Section 8.4.1.2, “Caching\nSHA-2 Pluggable Authentication”.\n\n•   --hex-blob\n┌─────────────────────┬────────────┐\n│ Command-Line Format │ --hex-blob │\n└─────────────────────┴────────────┘\n\nDump binary columns using hexadecimal notation (for example, 'abc' becomes 0x616263). The\naffected data types are BINARY, VARBINARY, BLOB types, BIT, all spatial data types, and\nother non-binary data types when used with the binary character set.\n\n•   --host=hostname, -h hostname\n┌─────────────────────┬────────┐\n│ Command-Line Format │ --host │\n└─────────────────────┴────────┘\n\nDump data from the MySQL server on the given host.\n\n•   --include-databases=dblist\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --include-databases=dblist │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nDump the databases in dblist, which is a list of one or more comma-separated database\nnames. The dump includes all objects in the named databases. Multiple instances of this\noption are additive. For more information, see mysqlpump Object Selection.\n\n•   --include-events=eventlist\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --include-events=eventlist │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nDump the events in eventlist, which is a list of one or more comma-separated event\nnames. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --include-routines=routinelist\n┌─────────────────────┬─────────────────────────────────┐\n│ Command-Line Format │ --include-routines=routinelist │\n├─────────────────────┼─────────────────────────────────┤\n│ Type                │ String                          │\n└─────────────────────┴─────────────────────────────────┘\n\nDump the routines in routinelist, which is a list of one or more comma-separated routine\n(stored procedure or function) names. Multiple instances of this option are additive. For\nmore information, see mysqlpump Object Selection.\n\n•   --include-tables=tablelist\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --include-tables=tablelist │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ String                      │\n└─────────────────────┴─────────────────────────────┘\n\nDump the tables in tablelist, which is a list of one or more comma-separated table\nnames. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --include-triggers=triggerlist\n┌─────────────────────┬─────────────────────────────────┐\n│ Command-Line Format │ --include-triggers=triggerlist │\n├─────────────────────┼─────────────────────────────────┤\n│ Type                │ String                          │\n└─────────────────────┴─────────────────────────────────┘\n\nDump the triggers in triggerlist, which is a list of one or more comma-separated trigger\nnames. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --include-users=userlist\n┌─────────────────────┬───────────────────────────┐\n│ Command-Line Format │ --include-users=userlist │\n├─────────────────────┼───────────────────────────┤\n│ Type                │ String                    │\n└─────────────────────┴───────────────────────────┘\n\nDump the user accounts in userlist, which is a list of one or more comma-separated user\nnames. Multiple instances of this option are additive. For more information, see\nmysqlpump Object Selection.\n\n•   --insert-ignore\n┌─────────────────────┬─────────────────┐\n│ Command-Line Format │ --insert-ignore │\n└─────────────────────┴─────────────────┘\n\nWrite INSERT IGNORE statements rather than INSERT statements.\n\n•   --log-error-file=filename\n┌─────────────────────┬────────────────────────────┐\n│ Command-Line Format │ --log-error-file=filename │\n├─────────────────────┼────────────────────────────┤\n│ Type                │ File name                  │\n└─────────────────────┴────────────────────────────┘\n\nLog warnings and errors by appending them to the named file. If this option is not given,\nmysqlpump writes warnings and errors to the standard error output.\n\n•   --login-path=name\n┌─────────────────────┬───────────────────┐\n│ Command-Line Format │ --login-path=name │\n├─────────────────────┼───────────────────┤\n│ Type                │ String            │\n└─────────────────────┴───────────────────┘\n\nRead options from the named login path in the .mylogin.cnf login path file. A “login\npath” is an option group containing options that specify which MySQL server to connect to\nand which account to authenticate as. To create or modify a login path file, use the\nmysqlconfigeditor utility. See mysqlconfigeditor(1).\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --max-allowed-packet=N\n┌─────────────────────┬────────────────────────┐\n│ Command-Line Format │ --max-allowed-packet=N │\n├─────────────────────┼────────────────────────┤\n│ Type                │ Numeric                │\n├─────────────────────┼────────────────────────┤\n│ Default Value       │ 25165824               │\n└─────────────────────┴────────────────────────┘\n\nThe maximum size of the buffer for client/server communication. The default is 24MB, the\nmaximum is 1GB.\n\n•   --net-buffer-length=N\n┌─────────────────────┬───────────────────────┐\n│ Command-Line Format │ --net-buffer-length=N │\n├─────────────────────┼───────────────────────┤\n│ Type                │ Numeric               │\n├─────────────────────┼───────────────────────┤\n│ Default Value       │ 1047552               │\n└─────────────────────┴───────────────────────┘\n\nThe initial size of the buffer for client/server communication. When creating\nmultiple-row INSERT statements (as with the --extended-insert option), mysqlpump creates\nrows up to N bytes long. If you use this option to increase the value, ensure that the\nMySQL server netbufferlength system variable has a value at least this large.\n\n•   --no-create-db\n┌─────────────────────┬────────────────┐\n│ Command-Line Format │ --no-create-db │\n└─────────────────────┴────────────────┘\n\nSuppress any CREATE DATABASE statements that might otherwise be included in the output.\n\n•   --no-create-info, -t\n┌─────────────────────┬──────────────────┐\n│ Command-Line Format │ --no-create-info │\n└─────────────────────┴──────────────────┘\n\nDo not write CREATE TABLE statements that create each dumped table.\n\n•   --no-defaults\n┌─────────────────────┬───────────────┐\n│ Command-Line Format │ --no-defaults │\n└─────────────────────┴───────────────┘\n\nDo not read any option files. If program startup fails due to reading unknown options\nfrom an option file, --no-defaults can be used to prevent them from being read.\n\nThe exception is that the .mylogin.cnf file is read in all cases, if it exists. This\npermits passwords to be specified in a safer way than on the command line even when\n--no-defaults is used. To create .mylogin.cnf, use the mysqlconfigeditor utility. See\nmysqlconfigeditor(1).\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --parallel-schemas=[N:]dblist\n┌─────────────────────┬─────────────────────────┐\n│ Command-Line Format │ --parallel-             │\n│                     │ schemas=[N:]schemalist │\n├─────────────────────┼─────────────────────────┤\n│ Type                │ String                  │\n└─────────────────────┴─────────────────────────┘\n\nCreate a queue for processing the databases in dblist, which is a list of one or more\ncomma-separated database names. If N is given, the queue uses N threads. If N is not\ngiven, the --default-parallelism option determines the number of queue threads.\n\nMultiple instances of this option create multiple queues.  mysqlpump also creates a\ndefault queue to use for databases not named in any --parallel-schemas option, and for\ndumping user definitions if command options select them. For more information, see\nmysqlpump Parallel Processing.\n\n•   --password[=password], -p[password]\n┌─────────────────────┬───────────────────────┐\n│ Command-Line Format │ --password[=password] │\n├─────────────────────┼───────────────────────┤\n│ Type                │ String                │\n└─────────────────────┴───────────────────────┘\n\nThe password of the MySQL account used for connecting to the server. The password value\nis optional. If not given, mysqlpump prompts for one. If given, there must be no space\nbetween --password= or -p and the password following it. If no password option is\nspecified, the default is to send no password.\n\nSpecifying a password on the command line should be considered insecure. To avoid giving\nthe password on the command line, use an option file. See Section 8.1.2.1, “End-User\nGuidelines for Password Security”.\n\nTo explicitly specify that there is no password and that mysqlpump should not prompt for\none, use the --skip-password option.\n\n•   --password1[=passval] The password for multifactor authentication factor 1 of the MySQL\naccount used for connecting to the server. The password value is optional. If not given,\nmysqlpump prompts for one. If given, there must be no space between --password1= and the\npassword following it. If no password option is specified, the default is to send no\npassword.\n\nSpecifying a password on the command line should be considered insecure. To avoid giving\nthe password on the command line, use an option file. See Section 8.1.2.1, “End-User\nGuidelines for Password Security”.\n\nTo explicitly specify that there is no password and that mysqlpump should not prompt for\none, use the --skip-password1 option.\n\n--password1 and --password are synonymous, as are --skip-password1 and --skip-password.\n\n•   --password2[=passval] The password for multifactor authentication factor 2 of the MySQL\naccount used for connecting to the server. The semantics of this option are similar to\nthe semantics for --password1; see the description of that option for details.\n\n•   --password3[=passval] The password for multifactor authentication factor 3 of the MySQL\naccount used for connecting to the server. The semantics of this option are similar to\nthe semantics for --password1; see the description of that option for details.\n\n•   --plugin-dir=dirname\n┌─────────────────────┬───────────────────────┐\n│ Command-Line Format │ --plugin-dir=dirname │\n├─────────────────────┼───────────────────────┤\n│ Type                │ Directory name        │\n└─────────────────────┴───────────────────────┘\n\nThe directory in which to look for plugins. Specify this option if the --default-auth\noption is used to specify an authentication plugin but mysqlpump does not find it. See\nSection 8.2.17, “Pluggable Authentication”.\n\n•   --port=portnum, -P portnum\n┌─────────────────────┬─────────────────┐\n│ Command-Line Format │ --port=portnum │\n├─────────────────────┼─────────────────┤\n│ Type                │ Numeric         │\n├─────────────────────┼─────────────────┤\n│ Default Value       │ 3306            │\n└─────────────────────┴─────────────────┘\n\nFor TCP/IP connections, the port number to use.\n\n•   --print-defaults\n┌─────────────────────┬──────────────────┐\n│ Command-Line Format │ --print-defaults │\n└─────────────────────┴──────────────────┘\n\nPrint the program name and all options that it gets from option files.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --protocol={TCP|SOCKET|PIPE|MEMORY}\n┌─────────────────────┬───────────────────┐\n│ Command-Line Format │ --protocol=type   │\n├─────────────────────┼───────────────────┤\n│ Type                │ String            │\n├─────────────────────┼───────────────────┤\n│ Default Value       │ [see text]        │\n├─────────────────────┼───────────────────┤\n│ Valid Values        │                   │\n│                     │            TCP    │\n│                     │                   │\n│                     │            SOCKET │\n│                     │                   │\n│                     │            PIPE   │\n│                     │                   │\n│                     │            MEMORY │\n└─────────────────────┴───────────────────┘\n\nThe transport protocol to use for connecting to the server. It is useful when the other\nconnection parameters normally result in use of a protocol other than the one you want.\nFor details on the permissible values, see Section 6.2.7, “Connection Transport\nProtocols”.\n\n•   --replace\n┌─────────────────────┬───────────┐\n│ Command-Line Format │ --replace │\n└─────────────────────┴───────────┘\n\nWrite REPLACE statements rather than INSERT statements.\n\n•   --result-file=filename\n┌─────────────────────┬─────────────────────────┐\n│ Command-Line Format │ --result-file=filename │\n├─────────────────────┼─────────────────────────┤\n│ Type                │ File name               │\n└─────────────────────┴─────────────────────────┘\n\nDirect output to the named file. The result file is created and its previous contents\noverwritten, even if an error occurs while generating the dump.\n\nThis option should be used on Windows to prevent newline \\n characters from being\nconverted to \\r\\n carriage return/newline sequences.\n\n•   --routines\n┌─────────────────────┬────────────┐\n│ Command-Line Format │ --routines │\n├─────────────────────┼────────────┤\n│ Type                │ Boolean    │\n├─────────────────────┼────────────┤\n│ Default Value       │ TRUE       │\n└─────────────────────┴────────────┘\n\nInclude stored routines (procedures and functions) for the dumped databases in the\noutput. This option requires the global SELECT privilege.\n\nThe output generated by using --routines contains CREATE PROCEDURE and CREATE FUNCTION\nstatements to create the routines.\n\nThis option is enabled by default; use --skip-routines to disable it.\n\n•   --server-public-key-path=filename\n┌─────────────────────┬──────────────────────┐\n│ Command-Line Format │ --server-public-key- │\n│                     │ path=filename       │\n├─────────────────────┼──────────────────────┤\n│ Type                │ File name            │\n└─────────────────────┴──────────────────────┘\n\nThe path name to a file in PEM format containing a client-side copy of the public key\nrequired by the server for RSA key pair-based password exchange. This option applies to\nclients that authenticate with the sha256password or cachingsha2password\nauthentication plugin. This option is ignored for accounts that do not authenticate with\none of those plugins. It is also ignored if RSA-based password exchange is not used, as\nis the case when the client connects to the server using a secure connection.\n\nIf --server-public-key-path=filename is given and specifies a valid public key file, it\ntakes precedence over --get-server-public-key.\n\nFor sha256password, this option applies only if MySQL was built using OpenSSL.\n\nFor information about the sha256password and cachingsha2password plugins, see\nSection 8.4.1.3, “SHA-256 Pluggable Authentication”, and Section 8.4.1.2, “Caching SHA-2\nPluggable Authentication”.\n\n•   --set-charset\n┌─────────────────────┬───────────────┐\n│ Command-Line Format │ --set-charset │\n└─────────────────────┴───────────────┘\n\nWrite SET NAMES defaultcharacterset to the output.\n\nThis option is enabled by default. To disable it and suppress the SET NAMES statement,\nuse --skip-set-charset.\n\n•   --set-gtid-purged=value\n┌─────────────────────┬─────────────────────────┐\n│ Command-Line Format │ --set-gtid-purged=value │\n├─────────────────────┼─────────────────────────┤\n│ Type                │ Enumeration             │\n├─────────────────────┼─────────────────────────┤\n│ Default Value       │ AUTO                    │\n├─────────────────────┼─────────────────────────┤\n│ Valid Values        │                         │\n│                     │            OFF          │\n│                     │                         │\n│                     │            ON           │\n│                     │                         │\n│                     │            AUTO         │\n└─────────────────────┴─────────────────────────┘\n\nThis option enables control over global transaction ID (GTID) information written to the\ndump file, by indicating whether to add a SET @@GLOBAL.gtidpurged statement to the\noutput. This option may also cause a statement to be written to the output that disables\nbinary logging while the dump file is being reloaded.\n\nThe following table shows the permitted option values. The default value is AUTO.\n┌───────┬───────────────────────────────────┐\n│ Value │ Meaning                           │\n├───────┼───────────────────────────────────┤\n│ OFF   │ Add no SET statement to the       │\n│       │ output.                           │\n├───────┼───────────────────────────────────┤\n│ ON    │ Add a SET statement to the        │\n│       │ output. An error occurs if        │\n│       │                   GTIDs are not   │\n│       │ enabled on the server.            │\n├───────┼───────────────────────────────────┤\n│ AUTO  │ Add a SET statement to the output │\n│       │ if GTIDs are                      │\n│       │                   enabled on the  │\n│       │ server.                           │\n└───────┴───────────────────────────────────┘\n\nThe --set-gtid-purged option has the following effect on binary logging when the dump\nfile is reloaded:\n\n•   --set-gtid-purged=OFF: SET @@SESSION.SQLLOGBIN=0; is not added to the output.\n\n•   --set-gtid-purged=ON: SET @@SESSION.SQLLOGBIN=0; is added to the output.\n\n•   --set-gtid-purged=AUTO: SET @@SESSION.SQLLOGBIN=0; is added to the output if GTIDs\nare enabled on the server you are backing up (that is, if AUTO evaluates to ON).\n\n•   --single-transaction\n┌─────────────────────┬──────────────────────┐\n│ Command-Line Format │ --single-transaction │\n└─────────────────────┴──────────────────────┘\n\nThis option sets the transaction isolation mode to REPEATABLE READ and sends a START\nTRANSACTION SQL statement to the server before dumping data. It is useful only with\ntransactional tables such as InnoDB, because then it dumps the consistent state of the\ndatabase at the time when START TRANSACTION was issued without blocking any applications.\n\nWhen using this option, you should keep in mind that only InnoDB tables are dumped in a\nconsistent state. For example, any MyISAM or MEMORY tables dumped while using this option\nmay still change state.\n\nWhile a --single-transaction dump is in process, to ensure a valid dump file (correct\ntable contents and binary log coordinates), no other connection should use the following\nstatements: ALTER TABLE, CREATE TABLE, DROP TABLE, RENAME TABLE, TRUNCATE TABLE. A\nconsistent read is not isolated from those statements, so use of them on a table to be\ndumped can cause the SELECT that is performed by mysqlpump to retrieve the table contents\nto obtain incorrect contents or fail.\n\n--add-locks and --single-transaction are mutually exclusive.\n\n•   --skip-definer\n┌─────────────────────┬────────────────┐\n│ Command-Line Format │ --skip-definer │\n├─────────────────────┼────────────────┤\n│ Type                │ Boolean        │\n├─────────────────────┼────────────────┤\n│ Default Value       │ FALSE          │\n└─────────────────────┴────────────────┘\n\nOmit DEFINER and SQL SECURITY clauses from the CREATE statements for views and stored\nprograms. The dump file, when reloaded, creates objects that use the default DEFINER and\nSQL SECURITY values. See Section 27.6, “Stored Object Access Control”.\n\n•   --skip-dump-rows, -d\n┌─────────────────────┬──────────────────┐\n│ Command-Line Format │ --skip-dump-rows │\n├─────────────────────┼──────────────────┤\n│ Type                │ Boolean          │\n├─────────────────────┼──────────────────┤\n│ Default Value       │ FALSE            │\n└─────────────────────┴──────────────────┘\n\nDo not dump table rows.\n\n•   --skip-generated-invisible-primary-key\n┌─────────────────────┬─────────────────────────────┐\n│ Command-Line Format │ --skip-generated-invisible- │\n│                     │ primary-key                 │\n├─────────────────────┼─────────────────────────────┤\n│ Introduced          │ 8.0.30                      │\n├─────────────────────┼─────────────────────────────┤\n│ Type                │ Boolean                     │\n├─────────────────────┼─────────────────────────────┤\n│ Default Value       │ FALSE                       │\n└─────────────────────┴─────────────────────────────┘\n\nThis option is available beginning with MySQL 8.0.30, and causes generated invisible\nprimary keys (GIPKs) to be excluded from the dump. See Section 15.1.20.11, “Generated\nInvisible Primary Keys”, for more information about GIPKs and GIPK mode.\n\n•   --socket=path, -S path\n┌─────────────────────┬────────────────────────────────┐\n│ Command-Line Format │ --socket={filename|pipename} │\n├─────────────────────┼────────────────────────────────┤\n│ Type                │ String                         │\n└─────────────────────┴────────────────────────────────┘\n\nFor connections to localhost, the Unix socket file to use, or, on Windows, the name of\nthe named pipe to use.\n\nOn Windows, this option applies only if the server was started with the namedpipe system\nvariable enabled to support named-pipe connections. In addition, the user making the\nconnection must be a member of the Windows group specified by the\nnamedpipefullaccessgroup system variable.\n\n•   --ssl* Options that begin with --ssl specify whether to connect to the server using\nencryption and indicate where to find SSL keys and certificates. See the section called\n“Command Options for Encrypted Connections”.\n\n•   --ssl-fips-mode={OFF|ON|STRICT}\n┌─────────────────────┬─────────────────────────────────┐\n│ Command-Line Format │ --ssl-fips-mode={OFF|ON|STRICT} │\n├─────────────────────┼─────────────────────────────────┤\n│ Deprecated          │ 8.0.34                          │\n├─────────────────────┼─────────────────────────────────┤\n│ Type                │ Enumeration                     │\n├─────────────────────┼─────────────────────────────────┤\n│ Default Value       │ OFF                             │\n├─────────────────────┼─────────────────────────────────┤\n│ Valid Values        │                                 │\n│                     │            OFF                  │\n│                     │                                 │\n│                     │            ON                   │\n│                     │                                 │\n│                     │            STRICT               │\n└─────────────────────┴─────────────────────────────────┘\n\nControls whether to enable FIPS mode on the client side. The --ssl-fips-mode option\ndiffers from other --ssl-xxx options in that it is not used to establish encrypted\nconnections, but rather to affect which cryptographic operations to permit. See\nSection 8.8, “FIPS Support”.\n\nThese --ssl-fips-mode values are permitted:\n\n•   OFF: Disable FIPS mode.\n\n•   ON: Enable FIPS mode.\n\n•   STRICT: Enable “strict” FIPS mode.\n\n\nNote\nIf the OpenSSL FIPS Object Module is not available, the only permitted value for\n--ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes\nthe client to produce a warning at startup and to operate in non-FIPS mode.\nAs of MySQL 8.0.34, this option is deprecated. Expect it to be removed in a future\nversion of MySQL.\n\n•   --tls-ciphersuites=ciphersuitelist\n┌─────────────────────┬───────────────────────────────┐\n│ Command-Line Format │ --tls-                        │\n│                     │ ciphersuites=ciphersuitelist │\n├─────────────────────┼───────────────────────────────┤\n│ Introduced          │ 8.0.16                        │\n├─────────────────────┼───────────────────────────────┤\n│ Type                │ String                        │\n└─────────────────────┴───────────────────────────────┘\n\nThe permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a\nlist of one or more colon-separated ciphersuite names. The ciphersuites that can be named\nfor this option depend on the SSL library used to compile MySQL. For details, see\nSection 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.\n\nThis option was added in MySQL 8.0.16.\n\n•   --tls-version=protocollist\n┌──────────────────────────┬──────────────────────────────────────────┐\n│ Command-Line Format      │ --tls-version=protocollist              │\n├──────────────────────────┼──────────────────────────────────────────┤\n│ Type                     │ String                                   │\n├──────────────────────────┼──────────────────────────────────────────┤\n│ Default Value (≥ 8.0.16) │                                          │\n│                          │            TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 │\n│                          │            (OpenSSL 1.1.1 or             │\n│                          │            higher)                       │\n│                          │                                          │\n│                          │            TLSv1,TLSv1.1,TLSv1.2         │\n│                          │            (otherwise)                   │\n├──────────────────────────┼──────────────────────────────────────────┤\n│ Default Value (≤ 8.0.15) │ TLSv1,TLSv1.1,TLSv1.2                    │\n└──────────────────────────┴──────────────────────────────────────────┘\n\nThe permissible TLS protocols for encrypted connections. The value is a list of one or\nmore comma-separated protocol names. The protocols that can be named for this option\ndepend on the SSL library used to compile MySQL. For details, see Section 8.3.2,\n“Encrypted Connection TLS Protocols and Ciphers”.\n\n•   --triggers\n┌─────────────────────┬────────────┐\n│ Command-Line Format │ --triggers │\n├─────────────────────┼────────────┤\n│ Type                │ Boolean    │\n├─────────────────────┼────────────┤\n│ Default Value       │ TRUE       │\n└─────────────────────┴────────────┘\n\nInclude triggers for each dumped table in the output.\n\nThis option is enabled by default; use --skip-triggers to disable it.\n\n•   --tz-utc\n┌─────────────────────┬──────────┐\n│ Command-Line Format │ --tz-utc │\n└─────────────────────┴──────────┘\n\nThis option enables TIMESTAMP columns to be dumped and reloaded between servers in\ndifferent time zones.  mysqlpump sets its connection time zone to UTC and adds SET\nTIMEZONE='+00:00' to the dump file. Without this option, TIMESTAMP columns are dumped\nand reloaded in the time zones local to the source and destination servers, which can\ncause the values to change if the servers are in different time zones.  --tz-utc also\nprotects against changes due to daylight saving time.\n\nThis option is enabled by default; use --skip-tz-utc to disable it.\n\n•   --user=username, -u username\n┌─────────────────────┬──────────────────┐\n│ Command-Line Format │ --user=username │\n├─────────────────────┼──────────────────┤\n│ Type                │ String           │\n└─────────────────────┴──────────────────┘\n\nThe user name of the MySQL account to use for connecting to the server.\n\nIf you are using the Rewriter plugin with MySQL 8.0.31 or later, you should grant this\nuser the SKIPQUERYREWRITE privilege.\n\n•   --users\n┌─────────────────────┬─────────┐\n│ Command-Line Format │ --users │\n├─────────────────────┼─────────┤\n│ Type                │ Boolean │\n├─────────────────────┼─────────┤\n│ Default Value       │ FALSE   │\n└─────────────────────┴─────────┘\n\nDump user accounts as logical definitions in the form of CREATE USER and GRANT\nstatements.\n\nUser definitions are stored in the grant tables in the mysql system database. By default,\nmysqlpump does not include the grant tables in mysql database dumps. To dump the contents\nof the grant tables as logical definitions, use the --users option and suppress all\ndatabase dumping:\n\nmysqlpump --exclude-databases=% --users\n\n•   --version, -V\n┌─────────────────────┬───────────┐\n│ Command-Line Format │ --version │\n└─────────────────────┴───────────┘\n\nDisplay version information and exit.\n\n•   --watch-progress\n┌─────────────────────┬──────────────────┐\n│ Command-Line Format │ --watch-progress │\n├─────────────────────┼──────────────────┤\n│ Type                │ Boolean          │\n├─────────────────────┼──────────────────┤\n│ Default Value       │ TRUE             │\n└─────────────────────┴──────────────────┘\n\nPeriodically display a progress indicator that provides information about the completed\nand total number of tables, rows, and other objects.\n\nThis option is enabled by default; use --skip-watch-progress to disable it.\n\n•   --zstd-compression-level=level\n┌─────────────────────┬────────────────────────────┐\n│ Command-Line Format │ --zstd-compression-level=# │\n├─────────────────────┼────────────────────────────┤\n│ Introduced          │ 8.0.18                     │\n├─────────────────────┼────────────────────────────┤\n│ Type                │ Integer                    │\n└─────────────────────┴────────────────────────────┘\n\nThe compression level to use for connections to the server that use the zstd compression\nalgorithm. The permitted levels are from 1 to 22, with larger values indicating\nincreasing levels of compression. The default zstd compression level is 3. The\ncompression level setting has no effect on connections that do not use zstd compression.\n\nFor more information, see Section 6.2.8, “Connection Compression Control”.\n\nThis option was added in MySQL 8.0.18.\nmysqlpump Object Selection\n\nmysqlpump has a set of inclusion and exclusion options that enable filtering of several\nobject types and provide flexible control over which objects to dump:\n\n•   --include-databases and --exclude-databases apply to databases and all objects within\nthem.\n\n•   --include-tables and --exclude-tables apply to tables. These options also affect triggers\nassociated with tables unless the trigger-specific options are given.\n\n•   --include-triggers and --exclude-triggers apply to triggers.\n\n•   --include-routines and --exclude-routines apply to stored procedures and functions. If a\nroutine option matches a stored procedure name, it also matches a stored function of the\nsame name.\n\n•   --include-events and --exclude-events apply to Event Scheduler events.\n\n•   --include-users and --exclude-users apply to user accounts.\n\nAny inclusion or exclusion option may be given multiple times. The effect is additive. Order\nof these options does not matter.\n\nThe value of each inclusion and exclusion option is a list of comma-separated names of the\nappropriate object type. For example:\n\n--exclude-databases=test,world\n--include-tables=customer,invoice\n\nWildcard characters are permitted in the object names:\n\n•   % matches any sequence of zero or more characters.\n\n•    matches any single character.\n\nFor example, --include-tables=t%,tmp matches all table names that begin with t and all\nfive-character table names that end with tmp.\n\nFor users, a name specified without a host part is interpreted with an implied host of %. For\nexample, u1 and u1@% are equivalent. This is the same equivalence that applies in MySQL\ngenerally (see Section 8.2.4, “Specifying Account Names”).\n\nInclusion and exclusion options interact as follows:\n\n•   By default, with no inclusion or exclusion options, mysqlpump dumps all databases (with\ncertain exceptions noted in mysqlpump Restrictions).\n\n•   If inclusion options are given in the absence of exclusion options, only the objects\nnamed as included are dumped.\n\n•   If exclusion options are given in the absence of inclusion options, all objects are\ndumped except those named as excluded.\n\n•   If inclusion and exclusion options are given, all objects named as excluded and not named\nas included are not dumped. All other objects are dumped.\n\nIf multiple databases are being dumped, it is possible to name tables, triggers, and routines\nin a specific database by qualifying the object names with the database name. The following\ncommand dumps databases db1 and db2, but excludes tables db1.t1 and db2.t2:\n\nmysqlpump --include-databases=db1,db2 --exclude-tables=db1.t1,db2.t2\n\nThe following options provide alternative ways to specify which databases to dump:\n\n•   The --all-databases option dumps all databases (with certain exceptions noted in\nmysqlpump Restrictions). It is equivalent to specifying no object options at all (the\ndefault mysqlpump action is to dump everything).\n\n--include-databases=% is similar to --all-databases, but selects all databases for\ndumping, even those that are exceptions for --all-databases.\n\n•   The --databases option causes mysqlpump to treat all name arguments as names of databases\nto dump. It is equivalent to an --include-databases option that names the same databases.\nmysqlpump Parallel Processing\n\nmysqlpump can use parallelism to achieve concurrent processing. You can select concurrency\nbetween databases (to dump multiple databases simultaneously) and within databases (to dump\nmultiple objects from a given database simultaneously).\n\nBy default, mysqlpump sets up one queue with two threads. You can create additional queues\nand control the number of threads assigned to each one, including the default queue:\n\n•   --default-parallelism=N specifies the default number of threads used for each queue. In\nthe absence of this option, N is 2.\n\nThe default queue always uses the default number of threads. Additional queues use the\ndefault number of threads unless you specify otherwise.\n\n•   --parallel-schemas=[N:]dblist sets up a processing queue for dumping the databases named\nin dblist and optionally specifies how many threads the queue uses.  dblist is a list\nof comma-separated database names. If the option argument begins with N:, the queue uses\nN threads. Otherwise, the --default-parallelism option determines the number of queue\nthreads.\n\nMultiple instances of the --parallel-schemas option create multiple queues.\n\nNames in the database list are permitted to contain the same % and  wildcard characters\nsupported for filtering options (see mysqlpump Object Selection).\n\nmysqlpump uses the default queue for processing any databases not named explicitly with a\n--parallel-schemas option, and for dumping user definitions if command options select them.\n\nIn general, with multiple queues, mysqlpump uses parallelism between the sets of databases\nprocessed by the queues, to dump multiple databases simultaneously. For a queue that uses\nmultiple threads, mysqlpump uses parallelism within databases, to dump multiple objects from\na given database simultaneously. Exceptions can occur; for example, mysqlpump may block\nqueues while it obtains from the server lists of objects in databases.\n\nWith parallelism enabled, it is possible for output from different databases to be\ninterleaved. For example, INSERT statements from multiple tables dumped in parallel can be\ninterleaved; the statements are not written in any particular order. This does not affect\nreloading because output statements qualify object names with database names or are preceded\nby USE statements as required.\n\nThe granularity for parallelism is a single database object. For example, a single table\ncannot be dumped in parallel using multiple threads.\n\nExamples:\n\nmysqlpump --parallel-schemas=db1,db2 --parallel-schemas=db3\n\nmysqlpump sets up a queue to process db1 and db2, another queue to process db3, and a default\nqueue to process all other databases. All queues use two threads.\n\nmysqlpump --parallel-schemas=db1,db2 --parallel-schemas=db3\n--default-parallelism=4\n\nThis is the same as the previous example except that all queues use four threads.\n\nmysqlpump --parallel-schemas=5:db1,db2 --parallel-schemas=3:db3\n\nThe queue for db1 and db2 uses five threads, the queue for db3 uses three threads, and the\ndefault queue uses the default of two threads.\n\nAs a special case, with --default-parallelism=0 and no --parallel-schemas options, mysqlpump\nruns as a single-threaded process and creates no queues.  mysqlpump Restrictions\n\nmysqlpump does not dump the performanceschema, ndbinfo, or sys schema by default. To dump\nany of these, name them explicitly on the command line. You can also name them with the\n--databases or --include-databases option.\n\nmysqlpump does not dump the INFORMATIONSCHEMA schema.\n\nmysqlpump does not dump InnoDB CREATE TABLESPACE statements.\n\nmysqlpump dumps user accounts in logical form using CREATE USER and GRANT statements (for\nexample, when you use the --include-users or --users option). For this reason, dumps of the\nmysql system database do not by default include the grant tables that contain user\ndefinitions: user, db, tablespriv, columnspriv, procspriv, or proxiespriv. To dump any of\nthe grant tables, name the mysql database followed by the table names:\n\nmysqlpump mysql user db ...\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright © 1997, 2026, Oracle and/or its affiliates.\n\nThis documentation is free software; you can redistribute it and/or modify it only under the\nterms of the GNU General Public License as published by the Free Software Foundation; version\n2 of the License.\n\nThis documentation is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR\nPURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with the program; if\nnot, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA\n02110-1301 USA or see http://www.gnu.org/licenses/.\n\n",
                "subsections": []
            },
            "NOTES": {
                "content": "1. MySQL Shell dump utilities\nhttps://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-utilities-dump-instance-schema.html\n\n2. MySQL Shell load dump utilities\nhttps://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-utilities-load-dump.html\n\n3. here\nhttps://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-install.html\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "For  more  information,  please  refer  to  the  MySQL Reference Manual, which may already be\ninstalled locally and which is also available online at http://dev.mysql.com/doc/.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Oracle Corporation (http://dev.mysql.com/).\n\nMySQL 8.0                                    03/23/2026                                 MYSQLPUMP(1)",
                "subsections": []
            }
        }
    }
}