MYSQLRPLMS(1)

NAME
mysqlrplms - Set Up and Start Replication from a Slave to Multiple Masters

SYNOPSIS

mysqlrplms [options]

DESCRIPTION

This utility permits a user to start replication from multiple master servers (also called multi-source replication) to a single slave. The user provides login information for the slave and each of the masters.

The utility reports conditions where the storage engines on the masters and the slave differ. It also reports a warning if the InnoDB storage engine differs on the master and slave. For InnoDB to be the same, both servers must be running the same "type" of InnoDB (built-in or the InnoDB Plugin), and InnoDB on both servers must have the same major and minor version numbers and enabled state. By default, the utility issues warnings for mismatches between the sets of storage engines, the default storage engine, and the InnoDB storage engine.

The -vv option displays any discrepancies between the storage engines and InnoDB values.

A round-robin scheduling is used to setup replication among the masters and slave.

The mysqlrplms utility follows these assumptions:

    • All servers must have GTIDs enabled.

    • There are no conflicts between transactions from different masters. For example, there are no updates to the same object from multiple masters.

    • Replication is asynchronous.
OPTIONS.PP mysqlrplms accepts the following command-line options:

    • --daemon=command

    Run as a daemon. The command can be start (start daemon), stop (stop daemon), restart (stop then start the daemon) or nodetach (start but do not detach the process). This option is only available for POSIX systems.

    • --format=format, -f format

    Display the replication health output in either grid (default), tab, csv, or vertical format.

    • --help

    Display a help message and exit.

    • --interval=seconds, -i seconds

    Interval in seconds for reporting health. Default = 15 seconds. Minimum is 5 seconds.

    • --license

    Display license information and exit.

    • --log=log_file

    Specify a log file to use for logging messages

    • --log-age=days

    Specify maximum age of log entries in days. Entries older than this are purged on startup. Default = 7 days.

    • --masters=master connections

    Connection information for master servers. List multiple masters in comma-separated list.

    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]

    • --report-values=report_values

    Report values used in mysqlrplms. It can be health, gtid or uuid. Multiple values can be used separated by commas.

        • health

        Display the replication health of the topology.

        • gtid

        Display the master's list of executed GTIDs, contents of the GTID variables; @@GLOBAL.GTID_EXECUTED, @@GLOBAL.GTID_PURGED and @@GLOBAL.GTID_OWNED.

        • uuid

        Display universally unique identifiers (UUIDs) for all servers.

    Default = health.

    • --rpl-user=replication_user

    The user and password for the replication user, in the format: user[:password] or login-path.

    • --slave=slave

    Connection information for the slave server. You may specify only one slave for this option.

    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-key

    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-from-beginning, -b

    Start replication at the beginning of events logged in the master binary log.

    • --switchover-interval=seconds

    Interval in seconds for switching masters. Default = 60 seconds. Minimum is 30 seconds.

    • --pidfile=pidfile

    Pidfile for running mysqlrplms as a daemon. This file contains the PID (process identifier), that uniquely identify a process. It is needed to identify and control the process forked by mysqlrplms.

    • --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.
NOTES.PP The login user for the master servers must have the appropriate permissions to grant access to all databases, and have the ability to create user accounts. For example, the user accounts used to connect to each of the masters must have the WITH GRANT OPTION privilege.

The server IDs on the masters and slave must be nonzero and unique. The utility reports an error if the server ID is 0 on either server or the same on the masters and slave. Set these values before starting this utility.

Mixing IP and hostnames is not recommended. The replication-specific utilities attempts to compare hostnames and IP addresses as aliases for checking slave connectivity to the master. However, if your installation does not support reverse name lookup, the comparison could fail. Without the ability to do a reverse name lookup, the replication utilities could report a false negative that the slave is (not) connected to the master.

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 permits 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).

Due to a known server issue, there are some limitations with the use of temporary tables with multi-source replication. In order to avoid problems, we recommend the execution of all statements for a temporary table in a single transaction. See Replication and Temporary Tables[1], for more information. EXAMPLES.PP To set up multi-source replication among two masters and a slave, running on different ports of the same host using the default settings, use this command:

    shell> mysqlrplms --slave=root:root@localhost:3306 \
           --masters=root:root@localhost:3307,root:root@localhost:3308
    # Starting multi-source replication...
    # Press CTRL+C to quit.
    # Switching to master 'localhost:3307'.
    # master on localhost: ... connected.
    # slave on localhost: ... connected.
    #
    # Current Master Information:
    +-------------------+-----------+---------------+-------------------+
    | Binary Log File   | Position  | Binlog_Do_DB  | Binlog_Ignore_DB  |
    +-------------------+-----------+---------------+-------------------+
    | clone-bin.000001  | 594       | N/A           | N/A               |
    +-------------------+-----------+---------------+-------------------+
    # GTID Executed Set: 00a4e027-a83a-11e3-8bd6-28d244017f26:1-2
    #
    # Health Status:
    +------------+-------+---------+--------+------------+---------+
    | host       | port  | role    | state  | gtid_mode  | health  |
    +------------+-------+---------+--------+------------+---------+
    | localhost  | 3307  | MASTER  | UP     | ON         | OK      |
    | localhost  | 3306  | SLAVE   | UP     | ON         | OK      |
    | localhost  | 3308  | MASTER  | UP     | ON         | OK      |
    +------------+-------+---------+--------+------------+---------+
    #
    (...)

The following command uses --report-values to report health, GTID and UUID status:

    shell> mysqlrplms --slave=root:root@localhost:3306 \
           --masters=root:root@localhost:3307,root:root@localhost:3308\n
           --report-values=health,gtid,uuid
    # Starting multi-source replication...
    # Press CTRL+C to quit.
    # Switching to master 'localhost:3307'.
    # master on localhost: ... connected.
    # slave on localhost: ... connected.
    #
    # Current Master Information:
    +-------------------+-----------+---------------+-------------------+
    | Binary Log File   | Position  | Binlog_Do_DB  | Binlog_Ignore_DB  |
    +-------------------+-----------+---------------+-------------------+
    | clone-bin.000001  | 594       | N/A           | N/A               |
    +-------------------+-----------+---------------+-------------------+
    # GTID Executed Set: 00a4e027-a83a-11e3-8bd6-28d244017f26:1-2
    #
    # Health Status:
    +------------+-------+---------+--------+------------+---------+
    | host       | port  | role    | state  | gtid_mode  | health  |
    +------------+-------+---------+--------+------------+---------+
    | localhost  | 3307  | MASTER  | UP     | ON         | OK      |
    | localhost  | 3306  | SLAVE   | UP     | ON         | OK      |
    | localhost  | 3308  | MASTER  | UP     | ON         | OK      |
    +------------+-------+---------+--------+------------+---------+
    #
    # GTID Status - Transactions executed on the servers:
    +------------+-------+---------+-------------------------------------------+
    | host       | port  | role    | gtid                                      |
    +------------+-------+---------+-------------------------------------------+
    | localhost  | 3307  | MASTER  | 00a4e027-a83a-11e3-8bd6-28d244017f26:1-2  |
    | localhost  | 3306  | SLAVE   | 00a4e027-a83a-11e3-8bd6-28d244017f26:1-2  |
    | localhost  | 3306  | SLAVE   | faf0874f-a839-11e3-8bd6-28d244017f26:1    |
    +------------+-------+---------+-------------------------------------------+
    #
    # UUID Status:
    +------------+-------+---------+---------------------------------------+
    | host       | port  | role    | uuid                                  |
    +------------+-------+---------+---------------------------------------+
    | localhost  | 3307  | MASTER  | 00a4e027-a83a-11e3-8bd6-28d244017f26  |
    | localhost  | 3306  | SLAVE   | faf0874f-a839-11e3-8bd6-28d244017f26  |
    +------------+-------+---------+---------------------------------------+
    #
    (...)

Start multi-source replication running as a daemon (POSIX only):

    shell> mysqlrplms --slave=root:root@localhost:3306 \
           --masters=root:root@localhost:3307,root:root@localhost:3308 \
           --log=rplms_daemon.log --pidfile=rplms_daemon.pid --daemon=start

Restart multi-source replication running as a daemon:

    shell> mysqlrplms --slave=root:root@localhost:3306 \
           --masters=root:root@localhost:3307,root:root@localhost:3308 \
           --log=rplms_daemon.log --pidfile=rplms_daemon.pid --daemon=restart

Stop multi-source replication running as a daemon:

    shell> mysqlrplms --slave=root:root@localhost:3306 \
           --masters=root:root@localhost:3307,root:root@localhost:3308 \
           --log=rplms_daemon.log --pidfile=rplms_daemon.pid --daemon=stop

RECOMMENDATIONS.PP You should set read_only=1 in the my.cnf file for the slave to ensure that no accidental data changes, such as INSERT, DELETE, UPDATE, and so forth, are permitted on the slave other than those produced by events read from the master. PERMISSIONS REQUIRED.PP The users on the masters need the following privileges: SELECT and INSERT privileges on mysql database, REPLICATION SLAVE, REPLICATION CLIENT and GRANT OPTION. The slave users need the SUPER privilege. The rpl user, used as the argument for the --rpl-user option, is either created automatically or if it exists, it needs the REPLICATION SLAVE privilege.

COPYRIGHT

Copyright © 2006, 2017, 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/.

NOTES

1.  Replication and Temporary Tables
    http://dev.mysql.com/doc/refman/5.7/en/replication-features-temptables.html

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/).