Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MARIADB-HOTCOPY(1)	     MariaDB Database System	      MARIADB-HOTCOPY(1)

NAME
     mariadb-hotcopy  - a database backup program (mariadb-hotcopy is now a sym-
     link to mariadb-hotcopy)

SYNOPSIS
     mariadb-hotcopy arguments

DESCRIPTION
     mariadb-hotcopy is a Perl script  that  was  originally  written  and  con-
     tributed  by Tim Bunce. It uses FLUSH TABLES, LOCK TABLES, and cp or 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.	mariadb-hotcopy works only  for  backing
     up MyISAM and ARCHIVE tables. It runs on Unix and NetWare.

     To  use mariadb-hotcopy, you must have read access to the files for the ta-
     bles 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).

	 shell> mariadb-hotcopy db_name [/path/to/new_directory]

	 shell> mariadb-hotcopy db_name_1 ... db_name_n /path/to/new_directory

     Back up tables in the given database that match a regular expression:

	 shell> mariadb-hotcopy db_name./regex/

     The regular expression for the table name can be negated  by  prefixing  it
     with a tilde ("~"):

	 shell> mariadb-hotcopy db_name./~regex/

     mariadb-hotcopy  supports	the following options, which can be specified on
     the command line or in  the  [mariadb-hotcopy]  and  [client]  option  file
     groups.

     *	 --help, -?

	 Display a help message and exit.

     *	 --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=db_name.tbl_name

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

     *	 --chroot=path

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

     *	 --debug

	 Enable debug output.

     *	 --dryrun, -n

	 Report actions without performing them.

     *	 --flushlog

	 Flush logs after all tables are locked.

     *	 --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.

     *	 --keepold

	 Do not delete previous (renamed) target when done.

     *	 --method=command

	 The method for copying files (cp or scp). The default is cp.

     *	 --noindices

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

     *	 --old-server

	 Connect to old MySQL-server (before v5.5) which doesn't have FLUSH  TA-
	 BLES WITH READ LOCK fully implemented..

     *	 --password=password, -ppassword

	 The  password	to use when connecting to the server. The password value
	 is not optional for this option, unlike for other MariaDB programs.

	 Specifying a password on the command line should  be  considered  inse-
	 cure.	You  can  use an option file to avoid giving the password on the
	 command line.

     *	 --port=port_num, -P port_num

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

     *	 --quiet, -q

	 Be silent except for errors.

     *	 --record_log_pos=db_name.tbl_name

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

     *	 --regexp=expr

	 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=path, -S path

	 The Unix socket file to use for connections to localhost.

     *	 --suffix=str

	 The suffix to use for names of copied databases.

     *	 --tmpdir=path

	 The temporary directory. The default is /tmp.

     *	 --user=user_name, -u user_name

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

     Use  perldoc for additional mariadb-hotcopy documentation, including infor-
     mation about the structure of the tables needed for  the  --checkpoint  and
     --record_log_pos options:

	 shell> perldoc mariadb-hotcopy

COPYRIGHT
     Copyright	2007-2008  MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2025
     MariaDB Foundation

     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 MERCHANTABILITY
     or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 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-1335   USA	or   see
     http://www.gnu.org/licenses/.

SEE ALSO
     For  more information, please refer to the MariaDB Documentation, available
     online at https://mariadb.com/docs/

AUTHOR
     MariaDB Foundation (http://www.mariadb.org/).

MariaDB 11.8			  5 March 2025		      MARIADB-HOTCOPY(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mariadb-hotcopy&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help