mysqlhotcopy is a Perl script that was
originally written and contributed by Tim Bunce. It uses
LOCK TABLES, and
scp to make a
database backup. It is a fast way to make a backup of the
database or single tables, but it can be run only on the same
machine where the database directories are located.
mysqlhotcopy works only for backing up
It runs on Unix.
To use mysqlhotcopy, you must have read
access to the files for the tables that you are backing up, the
SELECT privilege for those
RELOAD privilege (to
be able to execute
LOCK TABLES privilege (to
be able to lock the tables).
shell> mysqlhotcopy db_name [/path/to/new_directory]
shell> mysqlhotcopy db_name_1 ... db_name_n /path/to/new_directory
Back up tables in the given database that match a regular expression:
shell> mysqlhotcopy db_name./regex/
The regular expression for the table name can be negated by
prefixing it with a tilde (
shell> mysqlhotcopy db_name./~regex/
mysqlhotcopy supports the following options,
which can be specified on the command line or in the
[client] groups of an option file. For
information about option files used by MySQL programs, see
Section 4.2.6, “Using Option Files”.
|--addtodest||Do not rename target directory (if it exists); merely add files to it|
|--allowold||Do not abort if a target exists; rename it by adding an _old suffix|
|--checkpoint||Insert checkpoint entries|
|--chroot||Base directory of the chroot jail in which mysqld operates|
|--debug||Write debugging log|
|--dryrun||Report actions without performing them|
|--flushlog||Flush logs after all tables are locked|
|--help||Display help message and exit|
|--host||Connect to MySQL server on given host|
|--keepold||Do not delete previous (renamed) target when done|
|--method||The method for copying files|
|--noindices||Do not include full index files in the backup|
|--old_server||Connect to server that does not support FLUSH TABLES tbl_list WITH READ LOCK||5.5.3|
|--password||Password to use when connecting to server|
|--port||TCP/IP port number for connection|
|--quiet||Be silent except for errors|
|--regexp||Copy all databases with names that match the given regular expression|
|--resetmaster||Reset the binary log after locking all the tables|
|--resetslave||Reset the master.info file after locking all the tables|
|--socket||For connections to localhost, the Unix socket file to use|
|--tmpdir||The temporary directory|
|--user||MySQL user name to use when connecting to server|
Display a help message and exit.
Do not rename target directory (if it exists); merely add files to it.
Do not abort if a target exists; rename it by adding an
Insert checkpoint entries into the specified database
Enable debug output.
Report actions without performing them.
Flush logs after all tables are locked.
The host name of the local host to use for making a TCP/IP connection to the local server. By default, the connection is made to
localhostusing a Unix socket file.
Do not delete previous (renamed) target when done.
The method for copying files (
scp). The default is
The password to use when connecting to the server. The password value is not optional for this option, unlike for other MySQL programs.
Specifying a password on the command line should be considered insecure. See Section 22.214.171.124, “End-User Guidelines for Password Security”. You can use an option file to avoid giving the password on the command line.
The TCP/IP port number to use when connecting to the local server.
As of MySQL 5.5.3, mysqlhotcopy uses
FLUSH TABLESto flush and lock tables. Use the
tbl_listWITH READ LOCK
--old_serveroption if the server is older than 5.5.3, which is when that statement was introduced. This option was added in MySQL 5.5.3.
Be silent except for errors.
Record master and slave status in the specified database
Copy all databases with names that match the given regular expression.
Reset the binary log after locking all the tables.
master.infofile after locking all the tables.
The Unix socket file to use for connections to
The suffix to use for names of copied databases.
The temporary directory. The default is
The MySQL user name to use when connecting to the server.
shell> perldoc mysqlhotcopy