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