All Products
Search

This Product

    PolarDB:Manage the endpoints of Orca

    Document Center

    PolarDB:Manage the endpoints of Orca

    Last Updated:Mar 28, 2025

    This topic describes how to manage the endpoints of Orca in a PolarDB for MySQL cluster.

    Default and custom endpoints

    Endpoint type

    Description

    Scenario

    Default endpoint

    If you specify to enable Orca when you create a PolarDB for MySQL cluster, a default Orca endpoint is assigned to the cluster. The default Orca endpoint service is provided by PolarProxy.

    The default Orca endpoint supports automatic read/write splitting. Write requests to the Orca endpoint are routed to the primary node and read requests to the endpoint are routed to read-only nodes. For information about PolarProxy, see PolarProxy.

    You can use the default endpoint for business that requires read/write splitting. If you use the default endpoint, you can add read-only nodes to the cluster to enable fast, real-time business expansion.

    Custom endpoint

    PolarDB for MySQL allows you to create custom Orca endpoints. The services of the Orca endpoints are provided by PolarProxy.

    • You can configure the read/write mode and the load balancing policy for a custom endpoint. A custom endpoint supports read/write splitting and read-only services. For more information, see Configure PolarProxy.

    • You can associate one or more read-only nodes to a custom endpoint. All requests to a custom endpoint are routed to its associated read-only nodes.

    • You can use custom endpoints to isolate access to database nodes for different services.

    • If you set the Read/Write parameter to Read-only for a custom endpoint, the endpoint supports only read-only services.

    Note

    In-Memory Column Index (IMCI) nodes do not support the Orca feature. Requests to the Orca endpoints cannot be routed to IMCI nodes.

    Create an Orca custom endpoint

    1. Log on to the PolarDB console.

    2. In the left-side navigation pane, click Clusters.

    3. In the upper-left corner, select the region in which the cluster is deployed.

    4. Find the cluster and click its ID.

    5. In the Database Connections section of the Basic Information page, click Create Custom Cluster Endpoint. Set the Endpoint Type parameter to Orca Endpoint, configure the Endpoint Name parameter, and then configure PolarProxy. For more information, see Configure PolarProxy. image

      Note

      • Set the Endpoint Type parameter to Orca Endpoint.

      • For an Orca endpoint, you can only configure the load balancing policy and specify whether the primary node accepts read requests for load balancing, and configure the consistency level for the consistency settings. You cannot configure the connection pool, hybrid transactional and analytical processing (HTAP) optimization, or security protection settings.

    Modify an Orca endpoint

    1. Log on to the PolarDB console.

    2. In the left-side navigation pane, click Clusters.

    3. In the upper-left corner, select the region in which the cluster is deployed.

    4. Find the cluster and click its ID.

    5. In the Database Connection section of the Basic Information page, find the endpoint that you want to manage and click image > Edit to the right of Private or Public endpoint to modify the endpoint.imageimage

    Important

    • The prefix of the endpoint must meet the following requirements:

      • It must be 6 to 40 characters in length and can contain lowercase letters, digits, and hyphens (-).

      • It must start with a lowercase letter and end with a digit or letter.

    • The port number must be within the range of 3000 to 5999.

    • If SSL is enabled for the endpoint, the cluster restarts after you modify the endpoint.

    • If SSL is enabled for the endpoint, the total length of the new endpoint cannot exceed 64 characters.

    Release an Orca endpoint

    Important

    • Before you release an endpoint, make sure that your application is using a new endpoint to access the database.

    • After you release an endpoint, you cannot restore the endpoint. You can only recreate the endpoint.

    1. Log on to the PolarDB console.

    2. In the left-side navigation pane, click Clusters.

    3. In the upper-left corner, select the region in which the cluster is deployed.

    4. Find the cluster and click its ID.

    5. In the Database Connection section of the Basic Information page, find the endpoint you want to release and click Release in the upper-right corner to release the endpoint.image

    6. In the dialog box that appears, click OK.