]> git.saurik.com Git - redis.git/blame - redis-cli.c
dict.c fixed to play well with enabling/disabling of the hash table
[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},
01426b05 153 {"hincrby",4,REDIS_CMD_INLINE},
978c2c94 154 {"hget",3,REDIS_CMD_BULK},
07efaf74 155 {"hdel",3,REDIS_CMD_BULK},
92b27fe9 156 {"hlen",2,REDIS_CMD_INLINE},
78409a0f 157 {"hkeys",2,REDIS_CMD_INLINE},
158 {"hvals",2,REDIS_CMD_INLINE},
159 {"hgetall",2,REDIS_CMD_INLINE},
a86f14b1 160 {"hexists",3,REDIS_CMD_BULK},
500ece7c 161 {"config",-2,REDIS_CMD_BULK},
befec3cd 162 {"subscribe",-2,REDIS_CMD_INLINE},
163 {"unsubscribe",-1,REDIS_CMD_INLINE},
164 {"publish",3,REDIS_CMD_BULK},
ed9b544e 165 {NULL,0,0}
166};
167
c937aa89 168static int cliReadReply(int fd);
a9158272 169static void usage();
c937aa89 170
ed9b544e 171static struct redisCommand *lookupCommand(char *name) {
172 int j = 0;
173 while(cmdTable[j].name != NULL) {
174 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
175 j++;
176 }
177 return NULL;
178}
179
180static int cliConnect(void) {
181 char err[ANET_ERR_LEN];
6fa24622 182 static int fd = ANET_ERR;
ed9b544e 183
ed9b544e 184 if (fd == ANET_ERR) {
6fa24622
DJMM
185 fd = anetTcpConnect(err,config.hostip,config.hostport);
186 if (fd == ANET_ERR) {
187 fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
188 return -1;
189 }
190 anetTcpNoDelay(NULL,fd);
ed9b544e 191 }
ed9b544e 192 return fd;
193}
194
195static sds cliReadLine(int fd) {
196 sds line = sdsempty();
197
198 while(1) {
199 char c;
b91f03a4 200 ssize_t ret;
ed9b544e 201
b91f03a4
LH
202 ret = read(fd,&c,1);
203 if (ret == -1) {
ed9b544e 204 sdsfree(line);
205 return NULL;
b91f03a4 206 } else if ((ret == 0) || (c == '\n')) {
ed9b544e 207 break;
208 } else {
209 line = sdscatlen(line,&c,1);
210 }
211 }
212 return sdstrim(line,"\r\n");
213}
214
62e920df 215static int cliReadSingleLineReply(int fd, int quiet) {
ed9b544e 216 sds reply = cliReadLine(fd);
217
218 if (reply == NULL) return 1;
62e920df 219 if (!quiet)
220 printf("%s\n", reply);
621d5c19 221 sdsfree(reply);
ed9b544e 222 return 0;
223}
224
c937aa89 225static int cliReadBulkReply(int fd) {
ed9b544e 226 sds replylen = cliReadLine(fd);
227 char *reply, crlf[2];
c937aa89 228 int bulklen;
ed9b544e 229
230 if (replylen == NULL) return 1;
ed9b544e 231 bulklen = atoi(replylen);
c937aa89 232 if (bulklen == -1) {
ed9b544e 233 sdsfree(replylen);
060f6be6 234 printf("(nil)\n");
ed9b544e 235 return 0;
236 }
ed9b544e 237 reply = zmalloc(bulklen);
238 anetRead(fd,reply,bulklen);
239 anetRead(fd,crlf,2);
240 if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
241 zfree(reply);
242 return 1;
243 }
c937aa89 244 if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
ed9b544e 245 printf("\n");
246 zfree(reply);
c937aa89 247 return 0;
ed9b544e 248}
249
250static int cliReadMultiBulkReply(int fd) {
251 sds replylen = cliReadLine(fd);
252 int elements, c = 1;
253
254 if (replylen == NULL) return 1;
c937aa89 255 elements = atoi(replylen);
256 if (elements == -1) {
ed9b544e 257 sdsfree(replylen);
258 printf("(nil)\n");
259 return 0;
260 }
c937aa89 261 if (elements == 0) {
262 printf("(empty list or set)\n");
263 }
ed9b544e 264 while(elements--) {
265 printf("%d. ", c);
c937aa89 266 if (cliReadReply(fd)) return 1;
ed9b544e 267 c++;
268 }
269 return 0;
270}
271
c937aa89 272static int cliReadReply(int fd) {
273 char type;
274
275 if (anetRead(fd,&type,1) <= 0) exit(1);
276 switch(type) {
277 case '-':
278 printf("(error) ");
62e920df 279 cliReadSingleLineReply(fd,0);
c937aa89 280 return 1;
281 case '+':
62e920df 282 return cliReadSingleLineReply(fd,0);
c937aa89 283 case ':':
443c6409 284 printf("(integer) ");
62e920df 285 return cliReadSingleLineReply(fd,0);
c937aa89 286 case '$':
287 return cliReadBulkReply(fd);
288 case '*':
289 return cliReadMultiBulkReply(fd);
290 default:
291 printf("protocol error, got '%c' as reply type byte\n", type);
292 return 1;
293 }
294}
295
6cf5882c 296static int selectDb(int fd) {
62e920df 297 int retval;
298 sds cmd;
299 char type;
300
301 if (config.dbnum == 0)
302 return 0;
303
304 cmd = sdsempty();
305 cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
306 anetWrite(fd,cmd,sdslen(cmd));
307 anetRead(fd,&type,1);
308 if (type <= 0 || type != '+') return 1;
309 retval = cliReadSingleLineReply(fd,1);
310 if (retval) {
6cf5882c 311 return retval;
62e920df 312 }
313 return 0;
314}
315
aab055ae 316static int cliSendCommand(int argc, char **argv, int repeat) {
ed9b544e 317 struct redisCommand *rc = lookupCommand(argv[0]);
318 int fd, j, retval = 0;
621d5c19 319 int read_forever = 0;
5762b7f0 320 sds cmd;
ed9b544e 321
322 if (!rc) {
323 fprintf(stderr,"Unknown command '%s'\n",argv[0]);
324 return 1;
325 }
326
327 if ((rc->arity > 0 && argc != rc->arity) ||
a74f2af6 328 (rc->arity < 0 && argc < -rc->arity)) {
ed9b544e 329 fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
330 return 1;
331 }
621d5c19 332 if (!strcasecmp(rc->name,"monitor")) read_forever = 1;
ed9b544e 333 if ((fd = cliConnect()) == -1) return 1;
334
62e920df 335 /* Select db number */
336 retval = selectDb(fd);
337 if (retval) {
338 fprintf(stderr,"Error setting DB num\n");
339 return 1;
340 }
6cf5882c 341
aab055ae 342 while(repeat--) {
5762b7f0 343 /* Build the command to send */
344 cmd = sdsempty();
345 if (rc->flags & REDIS_CMD_MULTIBULK) {
346 cmd = sdscatprintf(cmd,"*%d\r\n",argc);
347 for (j = 0; j < argc; j++) {
83c6a618 348 cmd = sdscatprintf(cmd,"$%lu\r\n",
349 (unsigned long)sdslen(argv[j]));
8165a5f2 350 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
5762b7f0 351 cmd = sdscatlen(cmd,"\r\n",2);
352 }
353 } else {
354 for (j = 0; j < argc; j++) {
355 if (j != 0) cmd = sdscat(cmd," ");
356 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
83c6a618 357 cmd = sdscatprintf(cmd,"%lu",
358 (unsigned long)sdslen(argv[j]));
5762b7f0 359 } else {
360 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
361 }
362 }
363 cmd = sdscat(cmd,"\r\n");
364 if (rc->flags & REDIS_CMD_BULK) {
365 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
366 cmd = sdscatlen(cmd,"\r\n",2);
8165a5f2 367 }
ed9b544e 368 }
5762b7f0 369 anetWrite(fd,cmd,sdslen(cmd));
370 sdsfree(cmd);
621d5c19 371
372 while (read_forever) {
373 cliReadSingleLineReply(fd,0);
374 }
375
5762b7f0 376 retval = cliReadReply(fd);
377 if (retval) {
5762b7f0 378 return retval;
8165a5f2 379 }
ed9b544e 380 }
ed9b544e 381 return 0;
382}
383
384static int parseOptions(int argc, char **argv) {
385 int i;
386
387 for (i = 1; i < argc; i++) {
388 int lastarg = i==argc-1;
6cf5882c 389
ed9b544e 390 if (!strcmp(argv[i],"-h") && !lastarg) {
391 char *ip = zmalloc(32);
392 if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
393 printf("Can't resolve %s\n", argv[i]);
394 exit(1);
395 }
396 config.hostip = ip;
397 i++;
a9158272 398 } else if (!strcmp(argv[i],"-h") && lastarg) {
399 usage();
ed9b544e 400 } else if (!strcmp(argv[i],"-p") && !lastarg) {
401 config.hostport = atoi(argv[i+1]);
402 i++;
5762b7f0 403 } else if (!strcmp(argv[i],"-r") && !lastarg) {
404 config.repeat = strtoll(argv[i+1],NULL,10);
405 i++;
62e920df 406 } else if (!strcmp(argv[i],"-n") && !lastarg) {
407 config.dbnum = atoi(argv[i+1]);
408 i++;
fdfdae0f 409 } else if (!strcmp(argv[i],"-a") && !lastarg) {
288799e0 410 config.auth = argv[i+1];
fdfdae0f 411 i++;
6cf5882c
MMDJ
412 } else if (!strcmp(argv[i],"-i")) {
413 config.interactive = 1;
ed9b544e 414 } else {
415 break;
416 }
417 }
418 return i;
419}
420
421static sds readArgFromStdin(void) {
422 char buf[1024];
423 sds arg = sdsempty();
424
425 while(1) {
426 int nread = read(fileno(stdin),buf,1024);
427
428 if (nread == 0) break;
429 else if (nread == -1) {
430 perror("Reading from standard input");
431 exit(1);
432 }
433 arg = sdscatlen(arg,buf,nread);
434 }
435 return arg;
436}
437
a9158272 438static void usage() {
fdfdae0f 439 fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
440 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 441 fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
442 fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
443 fprintf(stderr, "example: redis-cli get my_passwd\n");
444 fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
d239ec59 445 fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
a9158272 446 exit(1);
447}
448
6cf5882c
MMDJ
449/* Turn the plain C strings into Sds strings */
450static char **convertToSds(int count, char** args) {
451 int j;
452 char **sds = zmalloc(sizeof(char*)*count+1);
453
454 for(j = 0; j < count; j++)
455 sds[j] = sdsnew(args[j]);
456
457 return sds;
458}
459
6cf5882c
MMDJ
460static void repl() {
461 int size = 4096, max = size >> 1, argc;
cf87ebf2 462 char *line;
6cf5882c
MMDJ
463 char **ap, *args[max];
464
bc86d88e 465 while((line = linenoise("redis> ")) != NULL) {
cf87ebf2
MM
466 if (line[0] != '\0') {
467 linenoiseHistoryAdd(line);
468 argc = 0;
469
470 for (ap = args; (*ap = strsep(&line, " \t")) != NULL;) {
471 if (**ap != '\0') {
472 if (argc >= max) break;
473 if (strcasecmp(*ap,"quit") == 0 || strcasecmp(*ap,"exit") == 0)
474 exit(0);
475 ap++;
476 argc++;
477 }
478 }
479
480 cliSendCommand(argc, convertToSds(argc, args), 1);
6cf5882c
MMDJ
481 }
482
cf87ebf2 483 free(line);
6cf5882c
MMDJ
484 }
485
486 exit(0);
487}
488
ed9b544e 489int main(int argc, char **argv) {
6cf5882c 490 int firstarg;
ed9b544e 491 char **argvcopy;
2073a849 492 struct redisCommand *rc;
ed9b544e 493
494 config.hostip = "127.0.0.1";
495 config.hostport = 6379;
5762b7f0 496 config.repeat = 1;
62e920df 497 config.dbnum = 0;
6cf5882c 498 config.interactive = 0;
288799e0 499 config.auth = NULL;
ed9b544e 500
501 firstarg = parseOptions(argc,argv);
502 argc -= firstarg;
503 argv += firstarg;
ed9b544e 504
aab055ae
MMDJ
505 if (config.auth != NULL) {
506 char *authargv[2];
507
508 authargv[0] = "AUTH";
509 authargv[1] = config.auth;
510 cliSendCommand(2, convertToSds(2, authargv), 1);
511 }
512
d239ec59 513 if (argc == 0 || config.interactive == 1) repl();
ed9b544e 514
6cf5882c
MMDJ
515 argvcopy = convertToSds(argc, argv);
516
2073a849 517 /* Read the last argument from stdandard input if needed */
518 if ((rc = lookupCommand(argv[0])) != NULL) {
6cf5882c
MMDJ
519 if (rc->arity > 0 && argc == rc->arity-1) {
520 sds lastarg = readArgFromStdin();
521 argvcopy[argc] = lastarg;
522 argc++;
523 }
2073a849 524 }
525
aab055ae 526 return cliSendCommand(argc, argvcopy, config.repeat);
ed9b544e 527}