Oracle Cloud Infrastructure Documentation

Enabling or Disabling the Database System Reader Endpoint

Enable the reader endpoint of an OCI Database with PostgreSQL database system with multiple nodes to create a single endpoint that distributes connections across all read-replica nodes.

Each node of a database system provides an endpoint used for direct connection and performing PSQL queries. For a multi-node database system, instead of implementing custom client-side load balancing to distribute connections across all replica nodes, you can enable the reader endpoint. Connections to the reader endpoint are distributed evenly to the available replica nodes of the database system. If the database system has only a single node, connections to the reader endpoint are routed to the primary node, the only node in the database system.

Note

The reader endpoint of a database system is limited to a throughput of 8 Gbps.
Important

A known issue can prevent the reader endpoint from being enabled on some existing database systems.

The reader endpoint of a database system offers higher availability when more than one replica node exists in the database system. To add more nodes to a database system, see Adding a Node.

    1. Open the navigation menu and select Databases. Under PostgreSQL, select DB Systems.
    2. (Optional) In the List scope section, under Compartment, select a compartment.
    3. Select the database system for which you want to enable or disable the reader endpoint.
    4. On the database system details page, in the Network configuration section, select Edit next to Reader endpoint.
    5. Select Submit to enable or disable the reader endpoint.

  • Use the oci psql db-system update command and required parameters to enable or disable the reader endpoint of a database system:

    oci psql db-system update --db-system-id <database_OCID> --network-details <network_details_json> [OPTIONS]

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the UpdateDbSystem operation with the networkDetails and isReaderEndpointEnabled attributes to enable or disable the reader endpoint of a database system.

    For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.