Oracle Cloud Infrastructure Documentation

Updating the Read Endpoint of a DB System

You can enable, disable, or update the read endpoint of a DB system.

To enable the read endpoint of a DB system, the DB system must have a shape with at least 4 OCPUs or 8 ECPUs and the DB system must be attached to an IPv4-only subnet. Read endpoint is not supported on an IPv6 enabled subnet.

To disable the read endpoint of a DB system, the DB system must not have any read replica. Disabling the read endpoint deletes the read endpoint and releases all resources including the IP address allocated to the read endpoint.

The read endpoint and the read replica load balancer share the same network load balancer. When you update the hostname or IP address of the read endpoint, the hostname or IP address of the read replica load balancer is also changed to the same value. When you update the IP address of the read endpoint, a free IP address is required temporarily in the subnet to which the DB system is attached.

Using the Console

You can enable, disable, or update the read endpoint using the Update read endpoint console action for the DB system.

This task requires the following:
  • The DB system shape has at least 4 OCPUs or 8 ECPUs.
  • The DB system is attached to an IPv4-only subnet.
  • If you update the IP address, a free IP address is required temporarily in the subnet to which the DB system is attached.

Do the following to update the read endpoint of a DB system:

  1. Open the navigation menu, and select Databases, and under HeatWave MySQL, select DB systems.
  2. Do one of the following:
    • Click the Actions menu present on the same line as your DB system, and click Update read endpoint.
    • Click the name of the DB system to open the DB system details page. Click More actions present at the top of the page, and click Update read endpoint.
    • Click the name of the DB system to open the DB system details page. Click the Connections tab to view the connection details. Click Edit present adjacent to Read endpoint under the Read endpoint section.
  3. In the Update read endpoint dialog box:
    • Enable read endpoint: Toggle the button to enable or disable the read endpoint. The following fields are shown when read endpoint is enabled.
      Note

      You cannot disable the read endpoint if the DB system has one or more read replicas.
      Note

      Enabling or disabling the read endpoint incurs downtime as the DB system has to be restarted. A high availability DB system will be restarted in a rolling manner reducing the duration of the downtime.
      • Hostname label: (Optional) Specify the hostname for the read endpoint of the DB system.
      • Read endpoint IP address: (Optional) Specify a private IP address to assign to the read endpoint of the DB system. The address must be available in the CIDR of the subnet. If you do not specify an IP address, Oracle automatically assigns a private IP address from the subnet.
      • Excluded IPs: (Optional) Specify a list of IP addresses of current or future read replicas to be excluded as backends to which new connections are forwarded. Existing connections that have been forwarded to any newly added IP address are not terminated, they can continue to run queries on the read replica they are connected to.
        Note

        You cannot exclude the IP address of the primary endpoint.
  4. Click Update.