OBKV-Redis

Background information

OBKV-Redis is a Redis-compatible persistent cache database developed based on OceanBase Database. It is supported in OceanBase Database V4.2.5 and later. OBKV-Redis aims to address the pain points of the conventional solution that combines Redis and relational database service (RDS), such as high costs, poor scalability, complex O&M and management, and difficulties in ensuring data consistency and security. OBKV-Redis achieves a P99 latency of less than 10 ms, which can meet the requirements of 80% of scenarios.

OceanBase Database Proxy (ODP) V4.3.0 and later provide a remote procedure call (RPC) service port (2885 by default) to provide proxy services for NoSQL requests. ODP V4.3.2 BP1 and later reuse the RPC service port to provide Redis Serialization Protocol (RESP) services of OBKV-Redis. ODP is fully compatible with RESP and allows you to access OBKV-Redis based on the native RESP without replacing the SDK for your business.

Characteristics

ODP supports OBKV-Redis with the following characteristics:

• RPC service port: ODP supports OBKV requests and RESP connections for access.

• Protocol commands: ODP supports most protocol commands of OBKV-Redis.

• Native compatibility: ODP allows you to access OBKV-Redis by using native RESP clients or drivers.

Scenarios

ODP supports OBKV-Redis in the following scenarios:

• Future persistent Redis service scenarios for public cloud users

• RESP-based business scenarios for private cloud and open source users

Examples

This section provides examples to demonstrate how to use ODP to connect to OBKV-Redis. In the examples, the OBKV-Redis user is the root user of the test tenant in the obcluster cluster, the IP address of ODP is 10.10.10.1, and the RPC port number is 2885.

• Use the default user

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

  -a specifies the password of the user. The default user is specified by the rpc_redis_default_user_name parameter of ODP.

• Use the --user option to specify a 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 specifies the user, and -a specifies the password of the user. You need to configure --user and -a based on your actual situation.

• Use the -a option to specify a user

  ODP V4.3.3 and later allow you to use the -a option to specify the tenant name and cluster name in the format of tenant_name#cluster_name#user_password. If user_password is empty, specify the -a option in the format of 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>
  

  Notice

  When you use the -a option to specify the tenant name and cluster name, make sure that the --user option does not contain the tenant name or cluster name. You can use only one of the options to specify the tenant name and cluster name.

  You can use the --user option to specify the user for connection. If the --user option is not specified, the value of the rpc_redis_default_user_name parameter is used.

  If the -a option does not contain the # character, ODP attempts to parse the --user option or the rpc_redis_default_user_name parameter to obtain the the tenant name and cluster name. If the parsing fails, the login fails.

Supported commands

This section describes the Redis commands supported by ODP.

String-related commands

Hash-related commands

Set-related commands

Sorted set-related commands

List-related commands

Key management commands

Server commands

Client commands

ODP V4.3.3 and later support the following OBKV-Redis client commands.