mysqluserclone (1) - Linux Manuals

mysqluserclone: Clone Existing User to Create New User


mysqluserclone - Clone Existing User to Create New User


mysqluserclone [options] base_usernew_user[:password][@host_name] ...


This utility uses an existing MySQL user account on one server as a template, and clones it to create one or more new user accounts with the same privileges as the original user. The new users can be created on the original server or a different server.

To list users for a server, specify the --list option. This prints a list of the users on the source (no destination is needed). To control how to display list output, use one of the following values with the --format option:

grid (default)

Display output in grid or table format like that of the mysql monitor.


Display output in comma-separated values format.


Display output in tab-separated format.


Display output in single-column format like that of the \G command for the mysql monitor.


mysqluserclone accepts the following command-line options:

• --help

Display a help message and exit.

• --destination=<destination>

Connection information for the destination server in the format: <user>[:<passwd>]@<host>[:<port>][:<socket>] or <login-path>[:<port>][:<socket>].

• --dump, -d

Display the GRANT statements to create the account rather than executing them. In this case, the utility does not connect to the destination server and no --destination option is needed.

• --format=<list_format>, -f<list_format>

Specify the user display format. Permitted format values are grid, csv, tab, and vertical. The default is grid. This option is valid only if --list is given.

• --force

Drop the new user account if it exists before creating the new account. Without this option, it is an error to try to create an account that already exists.

• --include-global-privileges

Include privileges that match base_user@% as well as base_user [at] host.

• --list

List all users on the source server. With this option, a destination server need not be specified.

• --quiet, -q

Turn off all messages for quiet execution.

• --source=<source>

Connection information for the source server in the format: <user>[:<passwd>]@<host>[:<port>][:<socket>]or <login-path>[:<port>][:<socket>].

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


You must provide connection parameters (user, host, password, and so forth) for an account that has the appropriate privileges to access all objects in the operation.

The account used to connect to the source server must have privileges to read the mysql database.

The account used to connect to the destination server must have privileges to execute CREATE USER (and DROP USER if the --force option is given), and privileges to execute GRANT for all privileges to be granted to the new accounts.

For the --format option, the permitted values are not case sensitive. In addition, values may be specified as any unambiguous prefix of a valid value. For example, --format=g specifies the grid format. An error occurs if a prefix matches more than one valid value.

The path to the MySQL client tools should be included in the PATH environment variable in order to use the authentication mechanism with login-paths. This will allow the utility to use the my_print_defaults tools which is required to read the login-path values from the login configuration file (.mylogin.cnf).

To clone joe as sam and sally with passwords and logging in as root on the local machine, use this command:

$ mysqluserclone --source=root [at] localhost \
  --destination=root [at] localhost \
  joe [at] localhost sam:secret1 [at] localhost sally:secret2 [at] localhost
# Source on localhost: ... connected.
# Destination on localhost: ... connected.
# Cloning 2 users...
# Cloning joe [at] localhost to user sam:secret1 [at] localhost
# Cloning joe [at] localhost to user sally:secret2 [at] localhost
# ...done.

The following command shows all users on the local server in the most verbose output in CSV format:

$ mysqluserclone --source=root [at] localhost --list --format=csv -vvv
# Source on localhost: ... connected.



Oracle Corporation (


For more information, please refer to the MySQL Utilities section of the MySQL Workbench Reference Manual, which is available online at