bionic (1) mysqlserverclone.1.gz
NAME
mysqlserverclone - Clone Existing Server to Create New Server
SYNOPSIS
mysqlserverclone [options]
DESCRIPTION
This utility enables you to clone an existing MySQL server instance to create a new server instance on
the same host. The utility creates a new datadir (--new-data), and, on Unix systems, starts the server
with a socket file. You can optionally add a password for the login user account on the new instance.
If the user does not have read and write access to the folder specified by the --new-data option, the
utility will issue an error.
Similarly, if the folder specified by
--new-data exists and is not empty, the utility will not delete the folder and will issue an error
message. Users must specify the --delete-data option to permit the utility to remove the folder prior to
starting the cloned server.
The utility does not copy any data. It merely creates a new running instance of the cloned server with
the same options (or additional options if specified). Thus, to create a copy of a server, you must copy
the data after the server is cloned. OPTIONS.PP mysqlserverclone accepts the following command-line
options:
• --help
Display a help message and exit.
• --license
Display license information and exit.
• --delete-data
Delete the folder specified by --new-data if it exists and is not empty.
• --basedir
The base directory for the MySQL server source, as an alternative to the --server option.
shell> mysqlserverclone --basedir=/source/mysql-5.6 \
--new-data=/source/temp_3007 --new-port=3007 --new-id=101 \
--root=root --mysqld="--log-bin --gtid-mode=on --log-slave-updates \
--enforce-gtid-consistency --master-info-repository=table \
--report-host=localhost --report-port=3007" --delete
• --force
Ignore the maximum path length and the low space checks for the --new-data option.
• --mysqld=<options>
Additional options for mysqld. To specify multiple options, separate them by spaces. Use appropriate
quoting as necessary. For example, to specify --log-bin=binlog and --general-log-file="mylogfile",
use:
If the option --skip-innodb is included when connecting to a MySQL server version 5.7.5 or higher,
the option is ignored and a warning is issued.
--mysqld="--log-bin=binlog --general-log-file='my log file'"
• --new-data=<path_to_new_datadir>
The full path to the location of the data directory for the new instance. The path size must be 200
characters or less and it requires at least 120 MB of free space.
• --new-id=<server_id>
The server_id value for the new server instance. The default is 2.
• --new-port=<port>
The port number for the new server instance. The default is 3307.
• --quiet, -q
Turn off all messages for quiet execution.
• --root-password=<password>
The password for the root user of the new server instance.
• --server=<source>
Connection information for the server to be cloned.
To connect to a server, it is necessary to specify connection parameters such as the user name, host
name, password, and either a port or socket. MySQL Utilities provides a number of ways to supply this
information. All of the methods require specifying your choice via a command-line option such as
--server, --master, --slave, etc. The methods include the following in order of most secure to least
secure.
• Use login-paths from your .mylogin.cnf file (encrypted, not visible). Example :
<login-path>[:<port>][:<socket>]
• Use a configuration file (unencrypted, not visible) Note: available in release-1.5.0. Example :
<configuration-file-path>[:<section>]
• Specify the data on the command-line (unencrypted, visible). Example :
<user>[:<passwd>]@<host>[:<port>][:<socket>]
• --ssl-ca
The path to a file that contains a list of trusted SSL CAs.
• --ssl-cert
The name of the SSL certificate file to use for establishing a secure connection.
• --ssl-cert
The name of the SSL key file to use for establishing a secure connection.
• --ssl
Specifies if the server connection requires use of SSL. If an encrypted connection cannot be
established, the connection attempt fails. Default setting is 0 (SSL not required).
• --start-timeout=<timeout_in_seconds>
Number of seconds to wait for server to start. Default = 10 seconds.
• --verbose, -v
Specify how much information to display. Use this option multiple times to increase the amount of
information. For example, -v = verbose, -vv = more verbose, -vvv = debug.
• --version
Display version information and exit.
• --write-command=<file_name>, -w<file_name>
Path name of file in which to write the command used to launch the new server instance.
EXAMPLES.PP The following command demonstrates how to create a new instance of a running server, set the
root user password and enable binary logging:
shell> mkdir /source/test123
shell> mysqlserverclone --server=root:pass@localhost \
--new-data=/Users/cbell/source/test123 --new-port=3310 \
--root-password=pass --mysqld=--log-bin=mysql-bin
# Cloning the MySQL server running on localhost.
# Creating new data directory...
# Configuring new instance...
# Locating mysql tools...
# Setting up empty database and mysql tables...
# Starting new instance of the server...
# Testing connection to new instance...
# Success!
# Setting the root password...
# ...done.
PERMISSIONS REQUIRED.PP The user must have permission to read all databases. Since we are using the root
account for these examples (and you typically would), permissions are not generally a problem.
You also need permissions to create the new data directory and write data to it.
COPYRIGHT
Copyright © 2006, 2016, Oracle and/or its affiliates. All rights reserved.
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-1301 USA or see
http://www.gnu.org/licenses/.
SEE ALSO
For more information, please refer to the MySQL Utilities and Fabric documentation, which is available
online at http://dev.mysql.com/doc/index-utils-fabric.html
AUTHOR
Oracle Corporation (http://dev.mysql.com/). MYSQLSERVERCLONE()