Test YugaByte Dictionary Service (YEDIS) API
After creating a local cluster, follow the instructions below to test YugaByte DB’s Redis-compatible YEDIS API.
redis-cli is a command line interface to interact with a Redis server. For ease of use, YugaByte DB ships with the 4.0.1 version of redis-cli in its bin directory.
1. Connect with redis-cli
- Initialize YugaByte DB’s YEDIS API.
Setup the redis_keyspace keyspace and the .redis table so that this cluster becomes ready for redis clients. Detailed output for the setup_redis command is available in the yb-ctl Reference.
$ ./bin/yb-ctl setup_redis
- Run redis-cli to connect to the service.
$ ./bin/redis-cli
127.0.0.1:6379>
- Run a Redis command to verify it is working.
127.0.0.1:6379> PING
"PONG"
- Initialize YugaByte DB’s YEDIS API.
Setup the redis_keyspace keyspace and the .redis table so that this cluster becomes ready for redis clients. Detailed output for the setup_redis command is available in the yb-ctl Reference.
$ ./bin/yb-ctl setup_redis
- Run redis-cli to connect to the service.
$ ./bin/redis-cli
127.0.0.1:6379>
- Run a Redis command to verify it is working.
127.0.0.1:6379> PING
"PONG"
- Run redis-cli to connect to the service.
$ docker exec -it yb-tserver-n3 /home/yugabyte/bin/redis-cli
127.0.0.1:6379>
- Run a Redis command to verify it is working.
127.0.0.1:6379> PING
"PONG"
- Run redis-cli to connect to the service.
$ kubectl exec -it yb-tserver-0 /home/yugabyte/bin/redis-cli
127.0.0.1:6379>
- Run a Redis command to verify it is working.
127.0.0.1:6379> PING
"PONG"
2. Simple key-value types
Insert a key and a value.
127.0.0.1:6379> set mykey somevalue
OK
Query the value by the key.
127.0.0.1:6379> get mykey
"somevalue"
Check if the key exists.
127.0.0.1:6379> exists mykey
(integer) 1
If the value is a number, it can be incremented.
127.0.0.1:6379> set counter 100
OK
127.0.0.1:6379> incr counter
(integer) 101
127.0.0.1:6379> incr counter
(integer) 102
127.0.0.1:6379> get counter
"102"
3. Hash data types
You can create a Redis Hash data type as follows. This models the data for user id 1000 with the following attributes {username : john, birthyear : 1977, verified : 1}.
127.0.0.1:6379> hmset user:1000 username john birthyear 1977 verified 1
OK
You can retrieve specific attributes for user id 1000 as follows.
127.0.0.1:6379> hget user:1000 username
"john"
127.0.0.1:6379> hget user:1000 birthyear
"1977"
You can fetch multiple attributes with a single command as follows.
127.0.0.1:6379> hmget user:1000 username birthyear no-such-field
1) "john"
2) "1977"
3) (nil)
You can fetch all attributes by using the hgetall command.
127.0.0.1:6379> hgetall user:1000
1) "birthyear"
2) "1977"
3) "username"
4) "john"
5) "verified"
6) "1"