Set Up PolarProxy Custom Endpoints for Workload Isolation - PolarDB - Alibaba Cloud - PolarDB

This topic describes how to manage Orca endpoints for PolarDB for MySQL.

Default and custom endpoints

Address Type

Address Description

Scenarios

Default address

When you create a PolarDB for MySQL cluster and select Enable Orca, a default Orca endpoint is assigned to the cluster. The service for this endpoint is provided by the database proxy.

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

This endpoint is suitable for services that require read/write splitting. It lets you quickly scale out services in real time by adding read-only nodes.

Custom Address

PolarDB for MySQL supports custom Orca endpoints. The services for these endpoints are provided by the database proxy.

Custom endpoints let you configure the read/write mode and load balancing policy. This supports both read/write splitting and read-only services. For more information about the configurations, see Configure the database proxy.
A custom endpoint can be attached to one or more read-only nodes. Requests sent to the endpoint are routed only to the attached nodes.

Use custom endpoints to isolate database node access for different services.
Set the Read-write mode to Read-only to configure the endpoint to support only read-only services.

Note

In-Memory Column Index (IMCI) nodes do not support the Orca feature. Therefore, Orca endpoints cannot route requests to IMCI nodes.

Create a custom Orca endpoint

Log on to the PolarDB console.
In the navigation pane on the left, click Clusters.
In the upper-left corner, select the region where the cluster is deployed.
Find the target cluster and click its ID.
On the Basic Information page of the cluster, in the Database Connections section, click Create Custom Cluster Endpoint. Set Endpoint Type to ORCA Endpoint, specify a custom Connection Name, and configure the database proxy features. For more information, see Configure the database proxy.
Note
- Set Endpoint Type to ORCA Endpoint.
- For an ORCA Endpoint, the proxy settings for Load Balancing Settings are limited to the Load Balancing Policy and Primary Node Accepts Read Requests. The Consistency Settings are limited to the Consistency Level. You cannot configure Connection Pool Settings, HTAP Optimization, or Security Protection.

Modify an Orca endpoint

Log on to the PolarDB console.
In the navigation pane on the left, click Clusters.
In the upper-left corner, select the region where the cluster is deployed.
Find the target cluster and click its ID.
On the Basic Information page of the cluster, in the Database Connections section, click > Edit to the right of the Private or Public endpoint that you want to modify.

Important

The endpoint prefix must meet the following requirements:
- It must be 6 to 40 characters long and contain only lowercase letters, digits, and hyphens (-).
- It must start with a lowercase letter and end with a digit or a letter.
The port number must be in the range of 3000 to 5999.
If SSL is enabled for the endpoint, modifying the endpoint causes the cluster to restart.
If SSL is enabled for the endpoint, the total length of the modified endpoint cannot exceed 64 characters.

Release an Orca endpoint

Important

Before you release an endpoint, make sure that your application is updated to use a new endpoint.
After an endpoint is released, it cannot be recovered. You must create a new one.

Log on to the PolarDB console.
In the navigation pane on the left, click Clusters.
In the upper-left corner, select the region where the cluster is deployed.
Find the target cluster and click its ID.
On the Basic Information page of the cluster, in the Database Connections section, find the destination endpoint and click Release in its upper-right corner.
In the dialog box that appears, click OK.