Oracle Cloud Infrastructure Documentation

Managing a Replication Channel

Use the Console to enable, disable, resume, reset, or edit an inbound replication channel.

Enabling or Disabling a Channel

Enabling a replication channel that is in the Inactive state starts replication from the source if there are no errors. Disabling a replication channel stops replication and puts the channel into the Inactive state.

  • Using the Console
  • Using the CLI
  • Using the REST API, run the UpdateChannel operation:
    • Specify a TRUE value in the isEnabled attribute to enable the channel.
    • Specify a FALSE value in the isEnabled attribute to disable the channel.

Using the Console

Enable or disable an inbound replication channel using console actions.

  1. On the Channels list page, find the channel that you want to work with. If you need help finding the list page or the channel, see Listing Channels - Using the Console.
  2. From the Actions menu for the channel:
    • To enable the channel, select Enable.
    • To disable the channel, select Disable.

Using the CLI

Use the command-line interface to enable or disable a channel.

This task requires the following:
  • A channel OCID.
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql channel update-from-mysql --channel-id <ChannelOCID> 
        --is-enabled <Boolean>
    • channel-id: Specify the OCID of the channel which you want to enable or disable.
    • is-enabled: Specify true to enable the channel, and specify false to disable the channel.
MySQL HeatWave Service enables or disables the channel.

Resuming a Channel

When an inbound replication channel is in the Needs Attention state, fix the error then resume the channel to restart replication. The Details column on the Channels page explains why a replication channel needs attention.

The Needs Attention state may also be displayed because the DB system is in INACTIVE state. In that case, replication cannot restart until the DB system is active.

Using the Console

You can restart replication after an error is fixed by resuming the channel.

Do the following to resume a channel:
  1. On the Channels list page, select the channel that you want to work with. If you need help finding the list page or the channel, see Listing Channels - Using the Console.

    The details page opens and displays information about the channel.

  2. Select Resume at the top of the page.
The state of the channel changes to Updating, and if the error is resolved, changes to Active.

Using the CLI

Use the command-line interface to resume a channel.

This task requires the following:
  • A channel OCID.
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql channel resume --channel-id <ChannelOCID>
    • channel-id: Specify the OCID of the channel which you want to resume.
MySQL HeatWave Service resumes the channel.

Resetting a Channel

Resetting an inbound replication channel removes all data on the channel, except the channel configuration. It is equivalent to RESET REPLICA ALL FOR CHANNEL. When there is an unrecoverable issue, the reset operation clears the records associated with replication so that the channel can have a clean start.

The target DB system drops its position in the source binary log, clears the replication metadata repositories, deletes the relay log files, and starts a new relay log file.

Using the Console

Use the reset operation when there is an unrecoverable error in replication. Only the channel configuration is retained, and the records are removed.

To reset an inbound replication channel, it must be inactive. You cannot reset an active channel.

Do the following to reset a channel:
  1. On the Channels list page, find the channel that you want to work with. If you need help finding the list page or the channel, see Listing Channels - Using the Console.
  2. From the Actions menu for the channel, select Reset.
You can now enable the replication channel.

Using the CLI

Use the command-line interface to reset a channel.

This task requires the following:
  • A channel OCID.
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql channel reset --channel-id <ChannelOCID>
    • channel-id: Specify the OCID of the channel which you want to reset.
MySQL HeatWave Service resets the channel.

Editing a Channel

Edit an inbound replication channel if you need to change configuration items such as the channel name, description, or source connection details after you create it.

Using the Console

Use the Console to edit an inbound replication channel's configuration.

Do the following to edit a channel:
  1. On the Channels list page, select the channel that you want to work with. If you need help finding the list page or the channel, see Listing Channels - Using the Console.

    The details page opens and displays information about the channel.

  2. Select Edit on any of the fields to open the Edit channel panel.
  3. In the Edit Channel panel, edit the channel details. You cannot change the compartment and target DB system.
  4. Select Save Changes.

Using the CLI

Use the command-line interface to edit an inbound replication channel.

This task requires the following:
  • A channel OCID.
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql channel update-from-mysql --channel-id <ChannelOCID>
    • channel-id: Specify the OCID of the channel that you want to update.
MySQL HeatWave Service updates the channel.

Deleting a Channel

Deleting an inbound replication channel removes the channel.

Using the Console

Use the delete operation to remove a channel.

You cannot delete a channel that has an active, inactive, or needs attention state.

Do the following to delete a channel:
  1. On the Channels list page, find the channel that you want to work with. If you need help finding the list page or the channel, see Listing Channels - Using the Console.
  2. From the Actions menu for the channel, select Delete.
  3. Select Delete channel in the Delete channel dialog.
The state of the channel changes to Deleting and then to Deleted.

Using the CLI

Use the command-line interface to delete a channel.

This task requires the following:
  • A channel OCID.
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql channel delete --channel-id <ChannelOCID>
    • channel-id: Specify the OCID of the channel which you want to delete.
MySQL HeatWave Service initiates a deletion of the channel.