All Products
Search
Document Center

PolarDB:Manage binary logging in the console

Last Updated:Jun 21, 2026

The log engine for Change Data Capture (CDC) in PolarDB-X includes a binary logging feature. From the log engine page in the PolarDB-X console, you can view, enable, upgrade, change the configurations of, and release this feature.

Procedure

  1. Log on to the PolarDB-X console.

  2. In the upper-left corner of the page, select the region of your target instance.

  3. On the Instance List page, click the PolarDB-X 2.0 tab.

  4. Find your target instance and click its instance ID.

  5. In the left-side navigation pane, click log engine.

    On the log engine page, you can perform the following operations:

    • View

      The Configuration Information section displays key parameters of the binary logging feature, such as the checksum status, ServerId, latest version, binlog retention period (for example, 15 days), and binlog file size (for example, 500 MB). The Cluster List section lists all created single-stream and multi-stream CDC clusters and their node information, including the node ID, specification, version, availability zone, and status. The page provides an Enable Multi-stream button in the upper-right corner. For each cluster, you can use the Upgrade, Change Configurations, and Release options.

    • Upgrade a cluster

      Find the cluster that you want to upgrade and click Upgrade. In the dialog box that appears, select the target version and click OK.

      Important
      • The Version column in the cluster list shows the current version of the log node. An upgrade causes a transient interruption to binlog subscriptions.

      • When selecting a target version, we recommend choosing the latest version, which is displayed by default.

    • Release a cluster

      Find the cluster that you want to release, click Release, and then click OK. Wait for the task to complete.

      Important

      Single-stream binlog clusters cannot be released.

    • Change cluster configurations

      Find the cluster you want to configure, click Change Configurations, and then click OK. Wait for the task to complete.

      Important

      Changing configurations causes a transient interruption to binlog subscriptions.

    • Enable Multi-stream

      To meet the binlog subscription demands of large-scale, high-concurrency clusters, PolarDB-X allows you to enable the multi-stream binary logging feature from the console. For a detailed feature description, see binary logging feature.

      Important

      This feature requires your account to be on a whitelist. To request access, submit a ticket. After your request is approved, you can enable the feature directly in the console.

      Click Enable Multi-stream, follow the prompts to enter the parameters, and click Submit.

      Parameter

      Value

      Description

      A description to help you identify the cluster.

      Stream Group Name

      The name of the stream group for the multi-stream cluster. Each group contains multiple streams.

      Splitting Quantity

      The number of resulting streams. Recommended value: the number of data nodes (DNs). The value must be within the range of [2, 2 × number of DNs].

      Splitting Level

      The level at which to split data. You can choose to split data at the record, table, or database level. A hash function distributes data across the streams.