Documentation Home
MySQL 8.4 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.2Mb
PDF (A4) - 40.3Mb
Man Pages (TGZ) - 262.0Kb
Man Pages (Zip) - 367.6Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


19.1.2.6 Setting Up Replicas

The following sections describe how to set up replicas. Before you proceed, ensure that you have:

The next steps depend on whether you have existing data to import to the replica or not. SeeSection 19.1.2.5, “Choosing a Method for Data Snapshots” for more information. Choose one of the following:

19.1.2.6.1 Setting Up Replication with New Source and Replicas

When there is no snapshot of a previous database to import, configure the replica to start replication from the new source.

To set up replication between a source and a new replica:

  1. Start up the replica.

  2. Execute aCHANGE REPLICATION SOURCE TO statement on the replica to set the source configuration. SeeSection 19.1.2.7, “Setting the Source Configuration on the Replica”.

Perform these replica setup steps on each replica.

This method can also be used if you are setting up new servers but have an existing dump of the databases from a different server that you want to load into your replication configuration. By loading the data into a new source, the data is automatically replicated to the replicas.

If you are setting up a new replication environment using the data from a different existing database server to create a new source, run the dump file generated from that server on the new source. The database updates are automatically propagated to the replicas:

$> mysql -h source < fulldb.dump
19.1.2.6.2 Setting Up Replication with Existing Data

When setting up replication with existing data, transfer the snapshot from the source to the replica before starting replication. The process for importing data to the replica depends on how you created the snapshot of data on the source.

Tip

To deploy multiple instances of MySQL, you can useInnoDB Cluster which enables you to easily administer a group of MySQL server instances inMySQL Shell. InnoDB Cluster wraps MySQL Group Replication in a programmatic environment that enables you easily deploy a cluster of MySQL instances to achieve high availability. In addition, InnoDB Cluster interfaces seamlessly withMySQL Router, which enables your applications to connect to the cluster without writing your own failover process. For similar use cases that do not require high availability, however, you can useInnoDB ReplicaSet. Installation instructions for MySQL Shell can be foundhere.

Note

If the replication source server or existing replica that you are copying to create the new replica has any scheduled events, ensure that these are disabled on the new replica before you start it. If an event runs on the new replica that has already run on the source, the duplicated operation causes an error. The Event Scheduler is controlled by theevent_scheduler system variable (defaultON), so events that are active on the original server run by default when the new replica starts up. To stop all events from running on the new replica, set theevent_scheduler system variable toOFF orDISABLED on the new replica. Alternatively, you can use theALTER EVENT statement to set individual events toDISABLE orDISABLE ON REPLICA to prevent them from running on the new replica. You can list the events on a server using theSHOW statement or the Information SchemaEVENTS table. For more information, seeSection 19.5.1.16, “Replication of Invoked Features”.

As an alternative to creating a new replica in this way, MySQL Server's clone plugin can be used to transfer all the data and replication settings from an existing replica to a clone. For instructions to use this method, seeSection 7.6.7.7, “Cloning for Replication”.

Follow this procedure to set up replication with existing data:

  1. If you used MySQL Server's clone plugin to create a clone from an existing replica (seeSection 7.6.7.7, “Cloning for Replication”), the data is already transferred. Otherwise, import the data to the replica using one of the following methods.

    1. If you usedmysqldump, start the replica server, ensuring that replication does not start by starting the server with--skip-replica-start. Then import the dump file:

      $> mysql < fulldb.dump

    2. If you created a snapshot using the raw data files, extract the data files into your replica's data directory. For example:

      $> tar xvf dbdump.tar

      You may need to set permissions and ownership on the files so that the replica server can access and modify them. Then start the replica server, ensuring that replication does not start by using--skip-replica-start.

  2. Configure the replica with the replication coordinates from the source. This tells the replica the binary log file and position within the file where replication needs to start. Also, configure the replica with the login credentials and host name of the source. For more information on theCHANGE REPLICATION SOURCE TO statement required, seeSection 19.1.2.7, “Setting the Source Configuration on the Replica”.

  3. Start the replication threads by issuing aSTART REPLICA statement.

After you have performed this procedure, the replica connects to the source and replicates any updates that have occurred on the source since the snapshot was taken. Error messages are issued to the replica's error log if it is not able to replicate for any reason.

The replica uses information logged in its connection metadata repository and applier metadata repository to keep track of how much of the source's binary log it has processed. By default, these repositories are tables namedslave_master_info andslave_relay_log_info in themysql database. Donot remove or edit these tables unless you know exactly what you are doing and fully understand the implications. Even in that case, it is preferred that you use theCHANGE REPLICATION SOURCE TO statement to change replication parameters. The replica uses the values specified in the statement to update the replication metadata repositories automatically. SeeSection 19.2.4, “Relay Log and Replication Metadata Repositories”, for more information.

Note

The contents of the replica's connection metadata repository override some of the server options specified on the command line or inmy.cnf. SeeSection 19.1.6, “Replication and Binary Logging Options and Variables”, for more details.

A single snapshot of the source suffices for multiple replicas. To set up additional replicas, use the same source snapshot and follow the replica portion of the procedure just described.