'\" t
.\"     Title: \fBmysqlserverclone\fR
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 08/30/2013
.\"    Manual: MySQL Utilities
.\"    Source: MySQL 1.3.4
.\"  Language: English
.\"
.TH "\FBMYSQLSERVERCLONE\" "1" "08/30/2013" "MySQL 1\&.3\&.4" "MySQL Utilities"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" mysqlserverclone
.\" utilities: mysqlserverclone
.\" scripts
.SH "NAME"
mysqlserverclone \- Clone Existing Server to Create New Server
.SH "SYNOPSIS"
.HP \w'\fBmysqlserverclone\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysqlserverclone [\fR\fB\fIoptions\fR\fR\fB]\fR
.SH "DESCRIPTION"
.PP
This utility permits an administrator to clone an existing MySQL server instance to start a new server instance on the same host\&. The utility creates a new datadir (\fB\-\-new\-data\fR), and starts the server with a socket file\&. You can optionally add a password for the login user account on the new instance\&.
.PP
If the user does not have read and write access to the folder specified by the
\fB\-\-new\-data\fR
option, the utility shall issue an error\&.
.PP
Similarly, if the folder specified by
\fB \-\-new\-data\fR
exists and is not empty, the utility will not delete the folder and will issue an error message\&. Users must specify the
\fB\-\-delete\-data\fR
option to permit the utility to remove the folder prior to starting the cloned server\&.
      OPTIONS
.PP
\fBmysqlserverclone\fR
accepts the following command\-line options:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-help
.sp
Display a help message and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-delete\-data
.sp
Delete the folder specified by
\fB\-\-new\-data\fR
if it exists and is not empty\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-mysqld=<options>
.sp
Additional options for
\fBmysqld\fR\&. 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:
.sp
.if n \{\
.RS 4
.\}
.nf
\-\-mysqld="\-\-log\-bin=binlog \-\-general\-log\-file=\*(Aqmy log file\*(Aq"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-new\-data=<path_to_new_datadir>
.sp
The full path name of the location of the data directory for the new server instance\&. If the directory does not exist, the utility will create it\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-new\-id=<server_id>
.sp
The
server_id
value for the new server instance\&. The default is 2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-new\-port=<port>
.sp
The port number for the new server instance\&. The default is 3307\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-quiet, \-q
.sp
Turn off all messages for quiet execution\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-root\-password=<password>
.sp
The password for the
root
user of the new server instance\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-server=<source>
.sp
Connection information for the server to be cloned in <\fIuser\fR>[:<\fIpasswd\fR>]@<\fIhost\fR>[:<\fIport\fR>][:<\fIsocket\fR>] format\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-start\-timeout=<timeout_in_seconds>
.sp
Number of seconds to wait for server to start\&. Default = 10 seconds\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-verbose, \-v
.sp
Specify how much information to display\&. Use this option multiple times to increase the amount of information\&. For example,
\fB\-v\fR
= verbose,
\fB\-vv\fR
= more verbose,
\fB\-vvv\fR
= debug\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-version
.sp
Display version information and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\-\-write\-command=<file_name>, \-w<file_name>
.sp
Path name of file in which to write the command used to launch the new server instance\&.
.RE
      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:
.sp
.if n \{\
.RS 4
.\}
.nf
$ mkdir /source/test123
$ mysqlserverclone \-\-server=root:pass@localhost \e
  \-\-new\-data=/Users/cbell/source/test123 \-\-new\-port=3310 \e
  \-\-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\&.
.fi
.if n \{\
.RE
.\}
.SH "COPYRIGHT"
.br
.SH "SEE ALSO"
For more information, please refer to the MySQL Utilities section
of the MySQL Workbench Reference Manual, which is available online
at http://dev.mysql.com/doc/workbench/en/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).