ODP 支持 OBKV-Redis 协议能力

背景介绍

OBKV-Redis 是 OceanBase 数据库自 4.2.5 版本开始支持的能力，它是基于 OceanBase 数据库开发的完全兼容 Redis 协议的持久化缓存数据库。OBKV-Redis 旨在解决传统 Redis + RDS 成本高昂、可伸缩性差、运维和管理复杂、数据一致性和安全性难以保证等痛点。OBKV-Redis 的 P99 在 10 ms 以内，满足 80% 场景的时延以及吞吐。OBKV-Redis 的详细介绍可参见官网《OceanBase 数据库》文档 OBKV-Redis 章节。

ODP 自 V4.3.0 起增加了 RPC 服务端口（默认为 2885）来提供 no-SQL 请求的代理服务，自 V4.3.2 BP1 起支持 OBKV-Redis 的服务能力，正式提供 RESP 服务能力（复用当前的 RPC 服务端口），并且当前已经完整支持 RESP 协议兼容处理，支持用户使用原生的 RESP 协议访问 OBKV-Redis 持久化能力（业务不需要替换 SDK）。

主要特点

ODP 支持 OBKV-Redis 协议能力主要有如下特点：

• RPC 服务端口：在支持 OBKV 请求的基础上，也支持 RESP 连接进行访问。

• 协议命令支持：当前支持 OBKV-Redis 绝大部分的协议命令的处理。

• 原生兼容性：支持使用原生的 RESP 客户端或驱动进行访问。

使用场景

目前 ODP 中该功能主要有如下两类使用场景：

• 公有云未来持久化 Redis 服务能力的场景。

• 私有云、开源用户 RESP 协议业务场景。

操作示例

本节以 OBKV-Redis 用户为 obcluster 集群 test 租户下的 root 用户，且 ODP 的 IP 为 10.10.10.1，RPC 端口为 2885 为例，介绍如何通过 ODP 连接 OBKV-Redis。

• 连接默认用户

  redis-cli -h <ODP_IP> -p <RPC_PORT> -a <user_password>
  # example
  redis-cli -h 10.10.10.1 -p 2885 -a ********
  

  -a 用于指定用户密码，默认用户由 ODP 配置项 rpc_redis_default_user_name 设置。

• 通过 --user 选项指定用户

  redis-cli -h <ODP_IP> -p <RPC_PORT> --user <user_name>@<tenant_name>#<cluster_name> -a <user_password>
  # example
  redis-cli -h 10.10.10.1 -p 2885 --user root@test#obcluster -a ********
  

  --user 用于指定用户，-a 用于指定用户密码，您需根据实际情况将 --user 和 -a 配置为对应的用户名和密码。

• 通过 -a 选项指定用户

  ODP 自 V4.3.3 起支持在 -a 选项中配置租户名和集群名，格式为 tenant_name#cluster_name#user_password，当 user_password 为空时，-a 选项的配置格式为tenant_name#cluster_name。

  redis-cli -h <ODP_IP> -p <RPC_PORT> --user <user_name> -a <tenant_name>#<cluster_name>#<user_password>
  # example
  redis-cli -h 10.10.10.1 -p 2885 --user root -a test#obcluster#<user_password>
  

  注意

  通过 -a 选项配置租户名和集群名时，--user 选项中不能包含租户名和集群名，即仅可在 --user 选项和 -a 选项中选择一个来配置租户名和集群名。

  您可通过 --user 配置连接的用户，若未配置 --user 选项，用户默认为 ODP 配置项 rpc_redis_default_user_name 的值。

  若 -a 选项配置中不包含 # 字符，此时 ODP 会尝试从 --user 选项或 ODP 配置项 rpc_redis_default_user_name 中解析租户名和集群名，解析失败则登录失败。

支持的命令

ODP 支持如下 Redis 命令。

字符串相关命令

哈希相关命令

集合相关命令

有序集合相关命令

列表相关命令

键管理命令

服务器命令

客户端命令

ODP 自 V4.3.3 起支持 OBKV-Redis 客户端命令，具体介绍如下表：