]> git.saurik.com Git - redis.git/blame - redis-cli.c
Merged ZREVRANK from Pietern
[redis.git] / redis-cli.c
CommitLineData
ed9b544e 1/* Redis CLI (command line interface)
2 *
12d090d2 3 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
ed9b544e 4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * * Neither the name of Redis nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without
16 * specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
23d4709d 31#include "fmacros.h"
32
ed9b544e 33#include <stdio.h>
34#include <string.h>
35#include <stdlib.h>
36#include <unistd.h>
37
38#include "anet.h"
39#include "sds.h"
40#include "adlist.h"
41#include "zmalloc.h"
42
43#define REDIS_CMD_INLINE 1
44#define REDIS_CMD_BULK 2
e17e0b05 45#define REDIS_CMD_MULTIBULK 4
ed9b544e 46
47#define REDIS_NOTUSED(V) ((void) V)
48
49static struct config {
50 char *hostip;
51 int hostport;
5762b7f0 52 long repeat;
62e920df 53 int dbnum;
6cf5882c 54 int interactive;
ed9b544e 55} config;
56
57struct redisCommand {
58 char *name;
59 int arity;
60 int flags;
61};
62
63static struct redisCommand cmdTable[] = {
c937aa89 64 {"get",2,REDIS_CMD_INLINE},
65 {"set",3,REDIS_CMD_BULK},
66 {"setnx",3,REDIS_CMD_BULK},
4b00bebd 67 {"append",3,REDIS_CMD_BULK},
39191553 68 {"substr",4,REDIS_CMD_INLINE},
5109cdff 69 {"del",-2,REDIS_CMD_INLINE},
c937aa89 70 {"exists",2,REDIS_CMD_INLINE},
71 {"incr",2,REDIS_CMD_INLINE},
72 {"decr",2,REDIS_CMD_INLINE},
73 {"rpush",3,REDIS_CMD_BULK},
74 {"lpush",3,REDIS_CMD_BULK},
75 {"rpop",2,REDIS_CMD_INLINE},
76 {"lpop",2,REDIS_CMD_INLINE},
b177fd30 77 {"brpop",-3,REDIS_CMD_INLINE},
78 {"blpop",-3,REDIS_CMD_INLINE},
c937aa89 79 {"llen",2,REDIS_CMD_INLINE},
80 {"lindex",3,REDIS_CMD_INLINE},
81 {"lset",4,REDIS_CMD_BULK},
82 {"lrange",4,REDIS_CMD_INLINE},
83 {"ltrim",4,REDIS_CMD_INLINE},
84 {"lrem",4,REDIS_CMD_BULK},
0f5f7e9a 85 {"rpoplpush",3,REDIS_CMD_BULK},
c937aa89 86 {"sadd",3,REDIS_CMD_BULK},
87 {"srem",3,REDIS_CMD_BULK},
a4460ef4 88 {"smove",4,REDIS_CMD_BULK},
c937aa89 89 {"sismember",3,REDIS_CMD_BULK},
90 {"scard",2,REDIS_CMD_INLINE},
12fea928 91 {"spop",2,REDIS_CMD_INLINE},
2abb95a9 92 {"srandmember",2,REDIS_CMD_INLINE},
c937aa89 93 {"sinter",-2,REDIS_CMD_INLINE},
94 {"sinterstore",-3,REDIS_CMD_INLINE},
40d224a9 95 {"sunion",-2,REDIS_CMD_INLINE},
96 {"sunionstore",-3,REDIS_CMD_INLINE},
f4f56e1d 97 {"sdiff",-2,REDIS_CMD_INLINE},
98 {"sdiffstore",-3,REDIS_CMD_INLINE},
c937aa89 99 {"smembers",2,REDIS_CMD_INLINE},
fd8ccf44 100 {"zadd",4,REDIS_CMD_BULK},
7db723ad 101 {"zincrby",4,REDIS_CMD_BULK},
1b7106e7 102 {"zrem",3,REDIS_CMD_BULK},
1807985b 103 {"zremrangebyscore",4,REDIS_CMD_INLINE},
752da584 104 {"zrange",-4,REDIS_CMD_INLINE},
3589e1a7 105 {"zrank",3,REDIS_CMD_BULK},
80181f78 106 {"zrangebyscore",-4,REDIS_CMD_INLINE},
f44dd428 107 {"zcount",4,REDIS_CMD_INLINE},
752da584 108 {"zrevrange",-4,REDIS_CMD_INLINE},
3c41331e 109 {"zcard",2,REDIS_CMD_INLINE},
6e333bbe 110 {"zscore",3,REDIS_CMD_BULK},
c937aa89 111 {"incrby",3,REDIS_CMD_INLINE},
112 {"decrby",3,REDIS_CMD_INLINE},
a431eb74 113 {"getset",3,REDIS_CMD_BULK},
c937aa89 114 {"randomkey",1,REDIS_CMD_INLINE},
115 {"select",2,REDIS_CMD_INLINE},
116 {"move",3,REDIS_CMD_INLINE},
117 {"rename",3,REDIS_CMD_INLINE},
118 {"renamenx",3,REDIS_CMD_INLINE},
119 {"keys",2,REDIS_CMD_INLINE},
120 {"dbsize",1,REDIS_CMD_INLINE},
121 {"ping",1,REDIS_CMD_INLINE},
122 {"echo",2,REDIS_CMD_BULK},
123 {"save",1,REDIS_CMD_INLINE},
124 {"bgsave",1,REDIS_CMD_INLINE},
9d65a1bb 125 {"rewriteaof",1,REDIS_CMD_INLINE},
126 {"bgrewriteaof",1,REDIS_CMD_INLINE},
c937aa89 127 {"shutdown",1,REDIS_CMD_INLINE},
128 {"lastsave",1,REDIS_CMD_INLINE},
129 {"type",2,REDIS_CMD_INLINE},
130 {"flushdb",1,REDIS_CMD_INLINE},
131 {"flushall",1,REDIS_CMD_INLINE},
132 {"sort",-2,REDIS_CMD_INLINE},
133 {"info",1,REDIS_CMD_INLINE},
134 {"mget",-2,REDIS_CMD_INLINE},
3305306f 135 {"expire",3,REDIS_CMD_INLINE},
802e8373 136 {"expireat",3,REDIS_CMD_INLINE},
fd88489a 137 {"ttl",2,REDIS_CMD_INLINE},
321b0e13 138 {"slaveof",3,REDIS_CMD_INLINE},
333298da 139 {"debug",-2,REDIS_CMD_INLINE},
8165a5f2 140 {"mset",-3,REDIS_CMD_MULTIBULK},
141 {"msetnx",-3,REDIS_CMD_MULTIBULK},
621d5c19 142 {"monitor",1,REDIS_CMD_INLINE},
6fa24622 143 {"multi",1,REDIS_CMD_INLINE},
978c2c94 144 {"exec",1,REDIS_CMD_INLINE},
6fa24622 145 {"discard",1,REDIS_CMD_INLINE},
978c2c94 146 {"hset",4,REDIS_CMD_MULTIBULK},
147 {"hget",3,REDIS_CMD_BULK},
ed9b544e 148 {NULL,0,0}
149};
150
c937aa89 151static int cliReadReply(int fd);
a9158272 152static void usage();
c937aa89 153
ed9b544e 154static struct redisCommand *lookupCommand(char *name) {
155 int j = 0;
156 while(cmdTable[j].name != NULL) {
157 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
158 j++;
159 }
160 return NULL;
161}
162
163static int cliConnect(void) {
164 char err[ANET_ERR_LEN];
6fa24622 165 static int fd = ANET_ERR;
ed9b544e 166
ed9b544e 167 if (fd == ANET_ERR) {
6fa24622
DJMM
168 fd = anetTcpConnect(err,config.hostip,config.hostport);
169 if (fd == ANET_ERR) {
170 fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
171 return -1;
172 }
173 anetTcpNoDelay(NULL,fd);
ed9b544e 174 }
ed9b544e 175 return fd;
176}
177
178static sds cliReadLine(int fd) {
179 sds line = sdsempty();
180
181 while(1) {
182 char c;
b91f03a4 183 ssize_t ret;
ed9b544e 184
b91f03a4
LH
185 ret = read(fd,&c,1);
186 if (ret == -1) {
ed9b544e 187 sdsfree(line);
188 return NULL;
b91f03a4 189 } else if ((ret == 0) || (c == '\n')) {
ed9b544e 190 break;
191 } else {
192 line = sdscatlen(line,&c,1);
193 }
194 }
195 return sdstrim(line,"\r\n");
196}
197
62e920df 198static int cliReadSingleLineReply(int fd, int quiet) {
ed9b544e 199 sds reply = cliReadLine(fd);
200
201 if (reply == NULL) return 1;
62e920df 202 if (!quiet)
203 printf("%s\n", reply);
621d5c19 204 sdsfree(reply);
ed9b544e 205 return 0;
206}
207
c937aa89 208static int cliReadBulkReply(int fd) {
ed9b544e 209 sds replylen = cliReadLine(fd);
210 char *reply, crlf[2];
c937aa89 211 int bulklen;
ed9b544e 212
213 if (replylen == NULL) return 1;
ed9b544e 214 bulklen = atoi(replylen);
c937aa89 215 if (bulklen == -1) {
ed9b544e 216 sdsfree(replylen);
060f6be6 217 printf("(nil)\n");
ed9b544e 218 return 0;
219 }
ed9b544e 220 reply = zmalloc(bulklen);
221 anetRead(fd,reply,bulklen);
222 anetRead(fd,crlf,2);
223 if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
224 zfree(reply);
225 return 1;
226 }
c937aa89 227 if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
ed9b544e 228 printf("\n");
229 zfree(reply);
c937aa89 230 return 0;
ed9b544e 231}
232
233static int cliReadMultiBulkReply(int fd) {
234 sds replylen = cliReadLine(fd);
235 int elements, c = 1;
236
237 if (replylen == NULL) return 1;
c937aa89 238 elements = atoi(replylen);
239 if (elements == -1) {
ed9b544e 240 sdsfree(replylen);
241 printf("(nil)\n");
242 return 0;
243 }
c937aa89 244 if (elements == 0) {
245 printf("(empty list or set)\n");
246 }
ed9b544e 247 while(elements--) {
248 printf("%d. ", c);
c937aa89 249 if (cliReadReply(fd)) return 1;
ed9b544e 250 c++;
251 }
252 return 0;
253}
254
c937aa89 255static int cliReadReply(int fd) {
256 char type;
257
258 if (anetRead(fd,&type,1) <= 0) exit(1);
259 switch(type) {
260 case '-':
261 printf("(error) ");
62e920df 262 cliReadSingleLineReply(fd,0);
c937aa89 263 return 1;
264 case '+':
62e920df 265 return cliReadSingleLineReply(fd,0);
c937aa89 266 case ':':
443c6409 267 printf("(integer) ");
62e920df 268 return cliReadSingleLineReply(fd,0);
c937aa89 269 case '$':
270 return cliReadBulkReply(fd);
271 case '*':
272 return cliReadMultiBulkReply(fd);
273 default:
274 printf("protocol error, got '%c' as reply type byte\n", type);
275 return 1;
276 }
277}
278
6cf5882c 279static int selectDb(int fd) {
62e920df 280 int retval;
281 sds cmd;
282 char type;
283
284 if (config.dbnum == 0)
285 return 0;
286
287 cmd = sdsempty();
288 cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
289 anetWrite(fd,cmd,sdslen(cmd));
290 anetRead(fd,&type,1);
291 if (type <= 0 || type != '+') return 1;
292 retval = cliReadSingleLineReply(fd,1);
293 if (retval) {
6cf5882c 294 return retval;
62e920df 295 }
296 return 0;
297}
298
ed9b544e 299static int cliSendCommand(int argc, char **argv) {
300 struct redisCommand *rc = lookupCommand(argv[0]);
301 int fd, j, retval = 0;
621d5c19 302 int read_forever = 0;
5762b7f0 303 sds cmd;
ed9b544e 304
305 if (!rc) {
306 fprintf(stderr,"Unknown command '%s'\n",argv[0]);
307 return 1;
308 }
309
310 if ((rc->arity > 0 && argc != rc->arity) ||
a74f2af6 311 (rc->arity < 0 && argc < -rc->arity)) {
ed9b544e 312 fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
313 return 1;
314 }
621d5c19 315 if (!strcasecmp(rc->name,"monitor")) read_forever = 1;
ed9b544e 316 if ((fd = cliConnect()) == -1) return 1;
317
62e920df 318 /* Select db number */
319 retval = selectDb(fd);
320 if (retval) {
321 fprintf(stderr,"Error setting DB num\n");
322 return 1;
323 }
6cf5882c 324
5762b7f0 325 while(config.repeat--) {
326 /* Build the command to send */
327 cmd = sdsempty();
328 if (rc->flags & REDIS_CMD_MULTIBULK) {
329 cmd = sdscatprintf(cmd,"*%d\r\n",argc);
330 for (j = 0; j < argc; j++) {
83c6a618 331 cmd = sdscatprintf(cmd,"$%lu\r\n",
332 (unsigned long)sdslen(argv[j]));
8165a5f2 333 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
5762b7f0 334 cmd = sdscatlen(cmd,"\r\n",2);
335 }
336 } else {
337 for (j = 0; j < argc; j++) {
338 if (j != 0) cmd = sdscat(cmd," ");
339 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
83c6a618 340 cmd = sdscatprintf(cmd,"%lu",
341 (unsigned long)sdslen(argv[j]));
5762b7f0 342 } else {
343 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
344 }
345 }
346 cmd = sdscat(cmd,"\r\n");
347 if (rc->flags & REDIS_CMD_BULK) {
348 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
349 cmd = sdscatlen(cmd,"\r\n",2);
8165a5f2 350 }
ed9b544e 351 }
5762b7f0 352 anetWrite(fd,cmd,sdslen(cmd));
353 sdsfree(cmd);
621d5c19 354
355 while (read_forever) {
356 cliReadSingleLineReply(fd,0);
357 }
358
5762b7f0 359 retval = cliReadReply(fd);
360 if (retval) {
5762b7f0 361 return retval;
8165a5f2 362 }
ed9b544e 363 }
ed9b544e 364 return 0;
365}
366
367static int parseOptions(int argc, char **argv) {
368 int i;
369
370 for (i = 1; i < argc; i++) {
371 int lastarg = i==argc-1;
6cf5882c 372
ed9b544e 373 if (!strcmp(argv[i],"-h") && !lastarg) {
374 char *ip = zmalloc(32);
375 if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
376 printf("Can't resolve %s\n", argv[i]);
377 exit(1);
378 }
379 config.hostip = ip;
380 i++;
a9158272 381 } else if (!strcmp(argv[i],"-h") && lastarg) {
382 usage();
ed9b544e 383 } else if (!strcmp(argv[i],"-p") && !lastarg) {
384 config.hostport = atoi(argv[i+1]);
385 i++;
5762b7f0 386 } else if (!strcmp(argv[i],"-r") && !lastarg) {
387 config.repeat = strtoll(argv[i+1],NULL,10);
388 i++;
62e920df 389 } else if (!strcmp(argv[i],"-n") && !lastarg) {
390 config.dbnum = atoi(argv[i+1]);
391 i++;
6cf5882c
MMDJ
392 } else if (!strcmp(argv[i],"-i")) {
393 config.interactive = 1;
ed9b544e 394 } else {
395 break;
396 }
397 }
398 return i;
399}
400
401static sds readArgFromStdin(void) {
402 char buf[1024];
403 sds arg = sdsempty();
404
405 while(1) {
406 int nread = read(fileno(stdin),buf,1024);
407
408 if (nread == 0) break;
409 else if (nread == -1) {
410 perror("Reading from standard input");
411 exit(1);
412 }
413 arg = sdscatlen(arg,buf,nread);
414 }
415 return arg;
416}
417
a9158272 418static void usage() {
6cf5882c 419 fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
a9158272 420 fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
421 fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
422 fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
423 fprintf(stderr, "example: redis-cli get my_passwd\n");
424 fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
d239ec59 425 fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
a9158272 426 exit(1);
427}
428
6cf5882c
MMDJ
429/* Turn the plain C strings into Sds strings */
430static char **convertToSds(int count, char** args) {
431 int j;
432 char **sds = zmalloc(sizeof(char*)*count+1);
433
434 for(j = 0; j < count; j++)
435 sds[j] = sdsnew(args[j]);
436
437 return sds;
438}
439
440static char *prompt(char *line, int size) {
441 char *retval;
442
443 do {
444 printf(">> ");
445 retval = fgets(line, size, stdin);
446 } while (retval && *line == '\n');
e3c7f002
DJMM
447 line[strlen(line) - 1] = '\0';
448
6cf5882c
MMDJ
449 return retval;
450}
451
452static void repl() {
453 int size = 4096, max = size >> 1, argc;
454 char buffer[size];
455 char *line = buffer;
456 char **ap, *args[max];
457
458 while (prompt(line, size)) {
459 argc = 0;
460
461 for (ap = args; (*ap = strsep(&line, " \t")) != NULL;) {
462 if (**ap != '\0') {
463 if (argc >= max) break;
2f4d2242 464 if (strcasecmp(*ap,"quit") == 0 || strcasecmp(*ap,"exit") == 0)
465 exit(0);
6cf5882c
MMDJ
466 ap++;
467 argc++;
468 }
469 }
470
471 config.repeat = 1;
472 cliSendCommand(argc, convertToSds(argc, args));
473 line = buffer;
474 }
475
476 exit(0);
477}
478
ed9b544e 479int main(int argc, char **argv) {
6cf5882c 480 int firstarg;
ed9b544e 481 char **argvcopy;
2073a849 482 struct redisCommand *rc;
ed9b544e 483
484 config.hostip = "127.0.0.1";
485 config.hostport = 6379;
5762b7f0 486 config.repeat = 1;
62e920df 487 config.dbnum = 0;
6cf5882c 488 config.interactive = 0;
ed9b544e 489
490 firstarg = parseOptions(argc,argv);
491 argc -= firstarg;
492 argv += firstarg;
ed9b544e 493
d239ec59 494 if (argc == 0 || config.interactive == 1) repl();
ed9b544e 495
6cf5882c
MMDJ
496 argvcopy = convertToSds(argc, argv);
497
2073a849 498 /* Read the last argument from stdandard input if needed */
499 if ((rc = lookupCommand(argv[0])) != NULL) {
6cf5882c
MMDJ
500 if (rc->arity > 0 && argc == rc->arity-1) {
501 sds lastarg = readArgFromStdin();
502 argvcopy[argc] = lastarg;
503 argc++;
504 }
2073a849 505 }
506
ed9b544e 507 return cliSendCommand(argc, argvcopy);
508}