manpagez: man pages & more
man mysqlhotcopy(1)
Home | html | info | man
mysqlhotcopy(1)              MySQL Database System             mysqlhotcopy(1)


       mysqlhotcopy - a database backup program


       mysqlhotcopy arguments


       mysqlhotcopy is a Perl script that was originally written and
       contributed by Tim Bunce. It uses LOCK TABLES, FLUSH TABLES, and cp or
       scp to make a database backup quickly. It is the fastest 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 MyISAM and ARCHIVE tables. It runs on Unix
       and NetWare.

           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:

       o   --help, -?

           Display a help message and exit.

       o   --addtodest

           Do not rename target directory (if it exists); merely add files to

       o   --allowold

           Do not abort if a target exists; rename it by adding an _old

       o   --checkpoint=db_name.tbl_name

           Insert checkpoint entries into the specified database db_name and
           table tbl_name.

       o   --chroot=path

           Base directory of the chroot jail in which mysqld operates. The
           path value should match that of the --chroot option given to

       o   --debug

           Enable debug output.

       o   --dryrun, -n

           Report actions without performing them.

       o   --flushlog

           Flush logs after all tables are locked.

       o   --host=host_name, -h host_name

           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 localhost using a Unix socket file.

       o   --keepold

           Do not delete previous (renamed) target when done.

       o   --method=command

           The method for copying files (cp or scp).

       o   --noindices

           Do not include full index files in the backup. This makes the
           backup smaller and faster. The indexes for reloaded tables can be
           reconstructed later with myisamchk -rq.

       o   --password=password, -ppassword

           The password to use when connecting to the server. Note that the
           password value is not optional for this option, unlike for other
           MySQL programs. You can use an option file to avoid giving the
           password on the command line.

           Specifying a password on the command line should be considered
           insecure. See Section, "End-User Guidelines for Password

       o   --port=port_num, -P port_num

           The TCP/IP port number to use when connecting to the local server.

       o   --quiet, -q

           Be silent except for errors.

       o   --record_log_pos=db_name.tbl_name

           Record master and slave status in the specified database db_name
           and table tbl_name.

       o   --regexp=expr

           Copy all databases with names that match the given regular

       o   --resetmaster

           Reset the binary log after locking all the tables.

       o   --resetslave

           Reset the file after locking all the tables.

       o   --socket=path, -S path

           The Unix socket file to use for the connection.

       o   --suffix=str

           The suffix for names of copied databases.

       o   --tmpdir=path

           The temporary directory. The default is /tmp.

       o   --user=user_name, -u user_name

           The MySQL user name to use when connecting to the server.

       mysqlhotcopy reads the [client] and [mysqlhotcopy] option groups from
       option files.

       To execute mysqlhotcopy, you must have access to the files for the
       tables that you are backing up, the SELECT privilege for those tables,
       the RELOAD privilege (to be able to execute FLUSH TABLES), and the LOCK
       TABLES privilege (to be able to lock the tables).

       Use perldoc for additional mysqlhotcopy documentation, including
       information about the structure of the tables needed for the
       --checkpoint and --record_log_pos options:

           shell> perldoc mysqlhotcopy


       Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.

       This documentation is free software; you can redistribute it and/or
       modify it only under the terms of the GNU General Public License as
       published by the Free Software Foundation; version 2 of the License.

       This documentation is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       General Public License for more details.

       You should have received a copy of the GNU General Public License along
       with the program; if not, write to the Free Software Foundation, Inc.,
       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see


       For more information, please refer to the MySQL Reference Manual, which
       may already be installed locally and which is also available online at


       Sun Microsystems, Inc. (

MySQL 5.0                         11/09/2009                   mysqlhotcopy(1)

Mac OS X 10.6Server - Generated Wed Apr 14 06:05:29 CDT 2010
© 2000-2024
Individual documents may contain additional copyright information.