Routing parameters on nodes

2024-11-11 07:37:15  Updated
Parameter Description Recommended value/range
enable_index_route Specifies whether to enable routing for the global index table based on global index keys on OceanBase Database Proxy (ODP).
  • True: enable
  • False: disable. This is the default value.
  • We recommend that you use the default value.
    enable_pl_route Specifies whether to enable PL routing on ODP.
  • True: enable. This is the default value.
  • False: disable
  • We recommend that you set it to False.
    enable_reroute Specifies whether to enable secondary routing on ODP. If secondary routing is enabled, when routing fails for the first time, the request is forwarded to the corresponding OBServer node again.
  • True: enable
  • False: disable. This is the default value.
    Note:
    Secondary routing takes effect only after you enable the OceanBase 2.0 protocol between an ODP and an OBServer node by setting the enable_ob_protocol_v2 parameter.
  • We recommend that you use the default value.
    enable_partition_table_route Specifies whether to enable partition table routing on ODP.
  • True: enable. This is the default value.
  • False: disable
  • We recommend that you use the default value.
    server_routing_mode The routing mode of ODP. Valid values:
  • oceanbase: the OceanBase mode. This is the default value.
  • random: the random mode. The OBServer node is randomly selected to send requests.
  • mock: the mock mode. You can use the test_server_addr parameter on the OBServer node to specify an IP route in the format of "ip1:sql_port1;ip2:sql_port2".
  • mysql: the MySQL mode, which is used to connect to a MySQL cluster.
  • We recommend that you use the default value.
    enable_ob_protocol_v2 Specifies whether to enable the OceanBase 2.0 protocol (a transfer protocol developed by OceanBase based on the MySQL compression protocol) for transfer between ODP and the OBServer node.
  • True: enable.
  • False: disable. This is the default value.
  • We recommend that you use the default value.
    routing_cache_mem_limited Specifies the maximum memory for the ODP route cache, such as the table cache and address cache. Value range: [1 KB, 100 GB][]. Default value: 128 MB. We recommend that you use the default value.
    enable_bad_route_reject Specifies whether to reject requests that cannot be routed.
  • True: reject requests.
  • False: do not reject requests. This is the default value.
  • We recommend that you use the default value.

    You can view and modify the preceding parameters by executing the SHOW PROXYCONFIG LIKE and ALTER PROXYCONFIG SET statements in the sys tenant.

    Here is an example:

    obclient>ALTER PROXYCONFIG SET enable_pl_route = False;
    
    obclient> SHOW PROXYCONFIG LIKE 'enable_pl_route';
    

    Contact Us