]> git.saurik.com Git - redis.git/blame - redis-cli.c
Revert "version 1.3.10"
[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"
cf87ebf2 42#include "linenoise.h"
ed9b544e 43
44#define REDIS_CMD_INLINE 1
45#define REDIS_CMD_BULK 2
e17e0b05 46#define REDIS_CMD_MULTIBULK 4
ed9b544e 47
48#define REDIS_NOTUSED(V) ((void) V)
49
50static struct config {
51 char *hostip;
52 int hostport;
5762b7f0 53 long repeat;
62e920df 54 int dbnum;
6cf5882c 55 int interactive;
288799e0 56 char *auth;
ed9b544e 57} config;
58
59struct redisCommand {
60 char *name;
61 int arity;
62 int flags;
63};
64
65static struct redisCommand cmdTable[] = {
fdfdae0f 66 {"auth",2,REDIS_CMD_INLINE},
c937aa89 67 {"get",2,REDIS_CMD_INLINE},
68 {"set",3,REDIS_CMD_BULK},
69 {"setnx",3,REDIS_CMD_BULK},
4b00bebd 70 {"append",3,REDIS_CMD_BULK},
39191553 71 {"substr",4,REDIS_CMD_INLINE},
5109cdff 72 {"del",-2,REDIS_CMD_INLINE},
c937aa89 73 {"exists",2,REDIS_CMD_INLINE},
74 {"incr",2,REDIS_CMD_INLINE},
75 {"decr",2,REDIS_CMD_INLINE},
76 {"rpush",3,REDIS_CMD_BULK},
77 {"lpush",3,REDIS_CMD_BULK},
78 {"rpop",2,REDIS_CMD_INLINE},
79 {"lpop",2,REDIS_CMD_INLINE},
b177fd30 80 {"brpop",-3,REDIS_CMD_INLINE},
81 {"blpop",-3,REDIS_CMD_INLINE},
c937aa89 82 {"llen",2,REDIS_CMD_INLINE},
83 {"lindex",3,REDIS_CMD_INLINE},
84 {"lset",4,REDIS_CMD_BULK},
85 {"lrange",4,REDIS_CMD_INLINE},
86 {"ltrim",4,REDIS_CMD_INLINE},
87 {"lrem",4,REDIS_CMD_BULK},
0f5f7e9a 88 {"rpoplpush",3,REDIS_CMD_BULK},
c937aa89 89 {"sadd",3,REDIS_CMD_BULK},
90 {"srem",3,REDIS_CMD_BULK},
a4460ef4 91 {"smove",4,REDIS_CMD_BULK},
c937aa89 92 {"sismember",3,REDIS_CMD_BULK},
93 {"scard",2,REDIS_CMD_INLINE},
12fea928 94 {"spop",2,REDIS_CMD_INLINE},
2abb95a9 95 {"srandmember",2,REDIS_CMD_INLINE},
c937aa89 96 {"sinter",-2,REDIS_CMD_INLINE},
97 {"sinterstore",-3,REDIS_CMD_INLINE},
40d224a9 98 {"sunion",-2,REDIS_CMD_INLINE},
99 {"sunionstore",-3,REDIS_CMD_INLINE},
f4f56e1d 100 {"sdiff",-2,REDIS_CMD_INLINE},
101 {"sdiffstore",-3,REDIS_CMD_INLINE},
c937aa89 102 {"smembers",2,REDIS_CMD_INLINE},
fd8ccf44 103 {"zadd",4,REDIS_CMD_BULK},
7db723ad 104 {"zincrby",4,REDIS_CMD_BULK},
1b7106e7 105 {"zrem",3,REDIS_CMD_BULK},
1807985b 106 {"zremrangebyscore",4,REDIS_CMD_INLINE},
b287c9bb
PN
107 {"zmerge",-3,REDIS_CMD_INLINE},
108 {"zmergeweighed",-4,REDIS_CMD_INLINE},
752da584 109 {"zrange",-4,REDIS_CMD_INLINE},
3589e1a7 110 {"zrank",3,REDIS_CMD_BULK},
23d82148 111 {"zrevrank",3,REDIS_CMD_BULK},
80181f78 112 {"zrangebyscore",-4,REDIS_CMD_INLINE},
f44dd428 113 {"zcount",4,REDIS_CMD_INLINE},
752da584 114 {"zrevrange",-4,REDIS_CMD_INLINE},
3c41331e 115 {"zcard",2,REDIS_CMD_INLINE},
6e333bbe 116 {"zscore",3,REDIS_CMD_BULK},
c937aa89 117 {"incrby",3,REDIS_CMD_INLINE},
118 {"decrby",3,REDIS_CMD_INLINE},
a431eb74 119 {"getset",3,REDIS_CMD_BULK},
c937aa89 120 {"randomkey",1,REDIS_CMD_INLINE},
121 {"select",2,REDIS_CMD_INLINE},
122 {"move",3,REDIS_CMD_INLINE},
123 {"rename",3,REDIS_CMD_INLINE},
124 {"renamenx",3,REDIS_CMD_INLINE},
125 {"keys",2,REDIS_CMD_INLINE},
126 {"dbsize",1,REDIS_CMD_INLINE},
127 {"ping",1,REDIS_CMD_INLINE},
128 {"echo",2,REDIS_CMD_BULK},
129 {"save",1,REDIS_CMD_INLINE},
130 {"bgsave",1,REDIS_CMD_INLINE},
9d65a1bb 131 {"rewriteaof",1,REDIS_CMD_INLINE},
132 {"bgrewriteaof",1,REDIS_CMD_INLINE},
c937aa89 133 {"shutdown",1,REDIS_CMD_INLINE},
134 {"lastsave",1,REDIS_CMD_INLINE},
135 {"type",2,REDIS_CMD_INLINE},
136 {"flushdb",1,REDIS_CMD_INLINE},
137 {"flushall",1,REDIS_CMD_INLINE},
138 {"sort",-2,REDIS_CMD_INLINE},
139 {"info",1,REDIS_CMD_INLINE},
140 {"mget",-2,REDIS_CMD_INLINE},
3305306f 141 {"expire",3,REDIS_CMD_INLINE},
802e8373 142 {"expireat",3,REDIS_CMD_INLINE},
fd88489a 143 {"ttl",2,REDIS_CMD_INLINE},
321b0e13 144 {"slaveof",3,REDIS_CMD_INLINE},
333298da 145 {"debug",-2,REDIS_CMD_INLINE},
8165a5f2 146 {"mset",-3,REDIS_CMD_MULTIBULK},
147 {"msetnx",-3,REDIS_CMD_MULTIBULK},
621d5c19 148 {"monitor",1,REDIS_CMD_INLINE},
6fa24622 149 {"multi",1,REDIS_CMD_INLINE},
978c2c94 150 {"exec",1,REDIS_CMD_INLINE},
6fa24622 151 {"discard",1,REDIS_CMD_INLINE},
978c2c94 152 {"hset",4,REDIS_CMD_MULTIBULK},
09aeb579 153 {"hget",3,REDIS_CMD_BULK},
d33278d1 154 {"hmset",-4,REDIS_CMD_MULTIBULK},
09aeb579 155 {"hmget",-3,REDIS_CMD_MULTIBULK},
01426b05 156 {"hincrby",4,REDIS_CMD_INLINE},
07efaf74 157 {"hdel",3,REDIS_CMD_BULK},
92b27fe9 158 {"hlen",2,REDIS_CMD_INLINE},
78409a0f 159 {"hkeys",2,REDIS_CMD_INLINE},
160 {"hvals",2,REDIS_CMD_INLINE},
161 {"hgetall",2,REDIS_CMD_INLINE},
a86f14b1 162 {"hexists",3,REDIS_CMD_BULK},
500ece7c 163 {"config",-2,REDIS_CMD_BULK},
befec3cd 164 {"subscribe",-2,REDIS_CMD_INLINE},
165 {"unsubscribe",-1,REDIS_CMD_INLINE},
166 {"publish",3,REDIS_CMD_BULK},
ed9b544e 167 {NULL,0,0}
168};
169
c937aa89 170static int cliReadReply(int fd);
a9158272 171static void usage();
c937aa89 172
ed9b544e 173static struct redisCommand *lookupCommand(char *name) {
174 int j = 0;
175 while(cmdTable[j].name != NULL) {
176 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
177 j++;
178 }
179 return NULL;
180}
181
182static int cliConnect(void) {
183 char err[ANET_ERR_LEN];
6fa24622 184 static int fd = ANET_ERR;
ed9b544e 185
ed9b544e 186 if (fd == ANET_ERR) {
6fa24622
DJMM
187 fd = anetTcpConnect(err,config.hostip,config.hostport);
188 if (fd == ANET_ERR) {
189 fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
190 return -1;
191 }
192 anetTcpNoDelay(NULL,fd);
ed9b544e 193 }
ed9b544e 194 return fd;
195}
196
197static sds cliReadLine(int fd) {
198 sds line = sdsempty();
199
200 while(1) {
201 char c;
b91f03a4 202 ssize_t ret;
ed9b544e 203
b91f03a4
LH
204 ret = read(fd,&c,1);
205 if (ret == -1) {
ed9b544e 206 sdsfree(line);
207 return NULL;
b91f03a4 208 } else if ((ret == 0) || (c == '\n')) {
ed9b544e 209 break;
210 } else {
211 line = sdscatlen(line,&c,1);
212 }
213 }
214 return sdstrim(line,"\r\n");
215}
216
62e920df 217static int cliReadSingleLineReply(int fd, int quiet) {
ed9b544e 218 sds reply = cliReadLine(fd);
219
220 if (reply == NULL) return 1;
62e920df 221 if (!quiet)
222 printf("%s\n", reply);
621d5c19 223 sdsfree(reply);
ed9b544e 224 return 0;
225}
226
c937aa89 227static int cliReadBulkReply(int fd) {
ed9b544e 228 sds replylen = cliReadLine(fd);
229 char *reply, crlf[2];
c937aa89 230 int bulklen;
ed9b544e 231
232 if (replylen == NULL) return 1;
ed9b544e 233 bulklen = atoi(replylen);
c937aa89 234 if (bulklen == -1) {
ed9b544e 235 sdsfree(replylen);
060f6be6 236 printf("(nil)\n");
ed9b544e 237 return 0;
238 }
ed9b544e 239 reply = zmalloc(bulklen);
240 anetRead(fd,reply,bulklen);
241 anetRead(fd,crlf,2);
242 if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
243 zfree(reply);
244 return 1;
245 }
c937aa89 246 if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
ed9b544e 247 printf("\n");
248 zfree(reply);
c937aa89 249 return 0;
ed9b544e 250}
251
252static int cliReadMultiBulkReply(int fd) {
253 sds replylen = cliReadLine(fd);
254 int elements, c = 1;
255
256 if (replylen == NULL) return 1;
c937aa89 257 elements = atoi(replylen);
258 if (elements == -1) {
ed9b544e 259 sdsfree(replylen);
260 printf("(nil)\n");
261 return 0;
262 }
c937aa89 263 if (elements == 0) {
264 printf("(empty list or set)\n");
265 }
ed9b544e 266 while(elements--) {
267 printf("%d. ", c);
c937aa89 268 if (cliReadReply(fd)) return 1;
ed9b544e 269 c++;
270 }
271 return 0;
272}
273
c937aa89 274static int cliReadReply(int fd) {
275 char type;
276
277 if (anetRead(fd,&type,1) <= 0) exit(1);
278 switch(type) {
279 case '-':
280 printf("(error) ");
62e920df 281 cliReadSingleLineReply(fd,0);
c937aa89 282 return 1;
283 case '+':
62e920df 284 return cliReadSingleLineReply(fd,0);
c937aa89 285 case ':':
443c6409 286 printf("(integer) ");
62e920df 287 return cliReadSingleLineReply(fd,0);
c937aa89 288 case '$':
289 return cliReadBulkReply(fd);
290 case '*':
291 return cliReadMultiBulkReply(fd);
292 default:
293 printf("protocol error, got '%c' as reply type byte\n", type);
294 return 1;
295 }
296}
297
6cf5882c 298static int selectDb(int fd) {
62e920df 299 int retval;
300 sds cmd;
301 char type;
302
303 if (config.dbnum == 0)
304 return 0;
305
306 cmd = sdsempty();
307 cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
308 anetWrite(fd,cmd,sdslen(cmd));
309 anetRead(fd,&type,1);
310 if (type <= 0 || type != '+') return 1;
311 retval = cliReadSingleLineReply(fd,1);
312 if (retval) {
6cf5882c 313 return retval;
62e920df 314 }
315 return 0;
316}
317
aab055ae 318static int cliSendCommand(int argc, char **argv, int repeat) {
ed9b544e 319 struct redisCommand *rc = lookupCommand(argv[0]);
320 int fd, j, retval = 0;
621d5c19 321 int read_forever = 0;
5762b7f0 322 sds cmd;
ed9b544e 323
324 if (!rc) {
325 fprintf(stderr,"Unknown command '%s'\n",argv[0]);
326 return 1;
327 }
328
329 if ((rc->arity > 0 && argc != rc->arity) ||
a74f2af6 330 (rc->arity < 0 && argc < -rc->arity)) {
ed9b544e 331 fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
332 return 1;
333 }
621d5c19 334 if (!strcasecmp(rc->name,"monitor")) read_forever = 1;
ed9b544e 335 if ((fd = cliConnect()) == -1) return 1;
336
62e920df 337 /* Select db number */
338 retval = selectDb(fd);
339 if (retval) {
340 fprintf(stderr,"Error setting DB num\n");
341 return 1;
342 }
6cf5882c 343
aab055ae 344 while(repeat--) {
5762b7f0 345 /* Build the command to send */
346 cmd = sdsempty();
347 if (rc->flags & REDIS_CMD_MULTIBULK) {
348 cmd = sdscatprintf(cmd,"*%d\r\n",argc);
349 for (j = 0; j < argc; j++) {
83c6a618 350 cmd = sdscatprintf(cmd,"$%lu\r\n",
351 (unsigned long)sdslen(argv[j]));
8165a5f2 352 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
5762b7f0 353 cmd = sdscatlen(cmd,"\r\n",2);
354 }
355 } else {
356 for (j = 0; j < argc; j++) {
357 if (j != 0) cmd = sdscat(cmd," ");
358 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
83c6a618 359 cmd = sdscatprintf(cmd,"%lu",
360 (unsigned long)sdslen(argv[j]));
5762b7f0 361 } else {
362 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
363 }
364 }
365 cmd = sdscat(cmd,"\r\n");
366 if (rc->flags & REDIS_CMD_BULK) {
367 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
368 cmd = sdscatlen(cmd,"\r\n",2);
8165a5f2 369 }
ed9b544e 370 }
5762b7f0 371 anetWrite(fd,cmd,sdslen(cmd));
372 sdsfree(cmd);
621d5c19 373
374 while (read_forever) {
375 cliReadSingleLineReply(fd,0);
376 }
377
5762b7f0 378 retval = cliReadReply(fd);
379 if (retval) {
5762b7f0 380 return retval;
8165a5f2 381 }
ed9b544e 382 }
ed9b544e 383 return 0;
384}
385
386static int parseOptions(int argc, char **argv) {
387 int i;
388
389 for (i = 1; i < argc; i++) {
390 int lastarg = i==argc-1;
6cf5882c 391
ed9b544e 392 if (!strcmp(argv[i],"-h") && !lastarg) {
393 char *ip = zmalloc(32);
394 if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
395 printf("Can't resolve %s\n", argv[i]);
396 exit(1);
397 }
398 config.hostip = ip;
399 i++;
a9158272 400 } else if (!strcmp(argv[i],"-h") && lastarg) {
401 usage();
ed9b544e 402 } else if (!strcmp(argv[i],"-p") && !lastarg) {
403 config.hostport = atoi(argv[i+1]);
404 i++;
5762b7f0 405 } else if (!strcmp(argv[i],"-r") && !lastarg) {
406 config.repeat = strtoll(argv[i+1],NULL,10);
407 i++;
62e920df 408 } else if (!strcmp(argv[i],"-n") && !lastarg) {
409 config.dbnum = atoi(argv[i+1]);
410 i++;
fdfdae0f 411 } else if (!strcmp(argv[i],"-a") && !lastarg) {
288799e0 412 config.auth = argv[i+1];
fdfdae0f 413 i++;
6cf5882c
MMDJ
414 } else if (!strcmp(argv[i],"-i")) {
415 config.interactive = 1;
ed9b544e 416 } else {
417 break;
418 }
419 }
420 return i;
421}
422
423static sds readArgFromStdin(void) {
424 char buf[1024];
425 sds arg = sdsempty();
426
427 while(1) {
428 int nread = read(fileno(stdin),buf,1024);
429
430 if (nread == 0) break;
431 else if (nread == -1) {
432 perror("Reading from standard input");
433 exit(1);
434 }
435 arg = sdscatlen(arg,buf,nread);
436 }
437 return arg;
438}
439
a9158272 440static void usage() {
fdfdae0f 441 fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
442 fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-a authpw] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
a9158272 443 fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
444 fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
445 fprintf(stderr, "example: redis-cli get my_passwd\n");
446 fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
d239ec59 447 fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
a9158272 448 exit(1);
449}
450
6cf5882c
MMDJ
451/* Turn the plain C strings into Sds strings */
452static char **convertToSds(int count, char** args) {
453 int j;
454 char **sds = zmalloc(sizeof(char*)*count+1);
455
456 for(j = 0; j < count; j++)
457 sds[j] = sdsnew(args[j]);
458
459 return sds;
460}
461
6cf5882c
MMDJ
462static void repl() {
463 int size = 4096, max = size >> 1, argc;
cf87ebf2 464 char *line;
6cf5882c
MMDJ
465 char **ap, *args[max];
466
bc86d88e 467 while((line = linenoise("redis> ")) != NULL) {
cf87ebf2
MM
468 if (line[0] != '\0') {
469 linenoiseHistoryAdd(line);
470 argc = 0;
471
472 for (ap = args; (*ap = strsep(&line, " \t")) != NULL;) {
473 if (**ap != '\0') {
474 if (argc >= max) break;
475 if (strcasecmp(*ap,"quit") == 0 || strcasecmp(*ap,"exit") == 0)
476 exit(0);
477 ap++;
478 argc++;
479 }
480 }
481
482 cliSendCommand(argc, convertToSds(argc, args), 1);
6cf5882c
MMDJ
483 }
484
cf87ebf2 485 free(line);
6cf5882c
MMDJ
486 }
487
488 exit(0);
489}
490
ed9b544e 491int main(int argc, char **argv) {
6cf5882c 492 int firstarg;
ed9b544e 493 char **argvcopy;
2073a849 494 struct redisCommand *rc;
ed9b544e 495
496 config.hostip = "127.0.0.1";
497 config.hostport = 6379;
5762b7f0 498 config.repeat = 1;
62e920df 499 config.dbnum = 0;
6cf5882c 500 config.interactive = 0;
288799e0 501 config.auth = NULL;
ed9b544e 502
503 firstarg = parseOptions(argc,argv);
504 argc -= firstarg;
505 argv += firstarg;
ed9b544e 506
aab055ae
MMDJ
507 if (config.auth != NULL) {
508 char *authargv[2];
509
510 authargv[0] = "AUTH";
511 authargv[1] = config.auth;
512 cliSendCommand(2, convertToSds(2, authargv), 1);
513 }
514
d239ec59 515 if (argc == 0 || config.interactive == 1) repl();
ed9b544e 516
6cf5882c
MMDJ
517 argvcopy = convertToSds(argc, argv);
518
2073a849 519 /* Read the last argument from stdandard input if needed */
520 if ((rc = lookupCommand(argv[0])) != NULL) {
6cf5882c
MMDJ
521 if (rc->arity > 0 && argc == rc->arity-1) {
522 sds lastarg = readArgFromStdin();
523 argvcopy[argc] = lastarg;
524 argc++;
525 }
2073a849 526 }
527
aab055ae 528 return cliSendCommand(argc, argvcopy, config.repeat);
ed9b544e 529}