Oracle Cloud Infrastructure Documentation

Editing a Read Replica

You can edit the details and settings of a read replica.

Use the Console, a command-line interface, or the REST API to edit a read replica.

Using the Console

Use the Console to edit a read replica of the DB system.

This task requires the following:
  • A running DB system.
  • A read replica.
Do the following to edit a read replica:
  1. On the DB systems list page, select the DB system that contains the read replica that you want to work with. If you need help finding the list page or the DB system, see Listing DB Systems - Using the Console.
  2. On the details page, select the Read replicas tab or resource.
  3. Select the read replica.
  4. In the Read replica details page, select the Details tab.
  5. In the Details tab, select Edit besides the Name, Description, Shape, Configuration or Delete protected.
  6. In the Edit read replica panel, change any of the following information:
    • Name: Change the name of the read replica if needed.
    • Description: (Optional) Change the description of the read replica if needed.
    • Select a shape: (Optional)
      • Select Select shape to override and change the shape of the read replica. You can select any shape with at least 8 ECPUs or 4 OCPUs. See Supported Shapes.
      • Select Default shape to inherit the shape from the DB system, the read replica will have the same shape as the DB system.
    • Configuration:
      • Select a configuration: (Optional)
        • Select Select configuration to override and change the configuration of the read replica.
          Note

          If you changed the shape of the read replica, you must select a configuration that matches the shape.
        • Select Reset configuration to inherit the configuration from the DB system, the read replica will have the same configuration as the DB system.
          Note

          The shape of the read replica must be the same as the DB system in order to inherit the DB system configuration.
      • Deletion plan: (Optional) Change the Delete protected setting if needed.
        Note

        The delete protected setting applies to individual read replica. If a read replica is delete protected, the DB system cannot be deleted.
  7. Select Save changes.

Using the CLI

Use the command-line interface to edit a read replica.

This task requires the following:
  • A read replica OCID.
  • A policy that permits you to edit read replicas in the compartment or tenancy.
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
Do the following on the CLI to edit a read replica:
  1. Open a command prompt, and run the following command:
    oci mysql replica update 
     --replica-id <ReplicaOCID> 
     --display-name <DisplayName>
     --description <Description>
     --is-delete-protected <Boolean>
     --replica-overrides '{ "configurationId": "<ConfigurationOCID>",
                            "mysqlVersion": "<Version>",
                            "nsgIds": [
                              "<NSG_OCID>", ...
                            ],
                            "shapeName": "<ShapeName>"
                          }'

    • replica-id: Specify the OCID of the read replica.

    • display-name: (Optional) Specify the new display name of the read replica. If you do not define a display name, the existing name is retained.
    • description: (Optional) Specify the new description of the read replica. If you do not define a description, the existing description is retained.
    • is-delete-protected: (Optional) Specify whether the read replica can be deleted. Set to true to prevent deletion, false to allow. If you do not define a delete protected value, the existing value is retained.
    • replica-overrides: (Optional) Specify a list of settings of the read replica which overrides the DB system settings. If you do not define any replica overrides, existing settings are used.
      • configurationId: The OCID of a configuration to use.
      • mysqlVersion: The database version to use.
        Note

        The version of the read replica must be the same or higher than the version of the DB system.
      • nsgIds: A list of network security group OCIDs to use.
      • shapeName: A shape name to use.
MySQL HeatWave Service updates the read replica.