git.saurik.com Git - redis.git/blob

1 /* Automatically generated by utils/generate-command-help.rb, do not edit. */

3 #ifndef __REDIS_HELP_H

4 #define __REDIS_HELP_H

6 static char *commandGroups[] = {

7 "generic",

8 "string",

9 "list",

10 "set",

11 "sorted_set",

12 "hash",

13 "pubsub",

14 "transactions",

15 "connection",

16 "server",

17 "scripting"

18 };

20 struct commandHelp {

21 char *name;

22 char *params;

23 char *summary;

24 int group;

25 char *since;

26 } commandHelp[] = {

27 { "APPEND",

28 "key value",

29 "Append a value to a key",

30 1,

31 "2.0.0" },

32 { "AUTH",

33 "password",

34 "Authenticate to the server",

35 8,

36 "1.0.0" },

37 { "BGREWRITEAOF",

38 "-",

39 "Asynchronously rewrite the append-only file",

40 9,

41 "1.0.0" },

42 { "BGSAVE",

43 "-",

44 "Asynchronously save the dataset to disk",

45 9,

46 "1.0.0" },

47 { "BITCOUNT",

48 "key [start] [end]",

49 "Count set bits in a string",

50 1,

51 "2.6.0" },

52 { "BITOP",

53 "operation destkey key [key ...]",

54 "Perform bitwise operations between strings",

55 1,

56 "2.6.0" },

57 { "BLPOP",

58 "key [key ...] timeout",

59 "Remove and get the first element in a list, or block until one is available",

60 2,

61 "2.0.0" },

62 { "BRPOP",

63 "key [key ...] timeout",

64 "Remove and get the last element in a list, or block until one is available",

65 2,

66 "2.0.0" },

67 { "BRPOPLPUSH",

68 "source destination timeout",

69 "Pop a value from a list, push it to another list and return it; or block until one is available",

70 2,

71 "2.2.0" },

72 { "CLIENT KILL",

73 "ip:port",

74 "Kill the connection of a client",

75 9,

76 "2.4.0" },

77 { "CLIENT LIST",

78 "-",

79 "Get the list of client connections",

80 9,

81 "2.4.0" },

82 { "CONFIG GET",

83 "parameter",

84 "Get the value of a configuration parameter",

85 9,

86 "2.0.0" },

87 { "CONFIG RESETSTAT",

88 "-",

89 "Reset the stats returned by INFO",

90 9,

91 "2.0.0" },

92 { "CONFIG SET",

93 "parameter value",

94 "Set a configuration parameter to the given value",

95 9,

96 "2.0.0" },

97 { "DBSIZE",

98 "-",

99 "Return the number of keys in the selected database",

100 9,

101 "1.0.0" },

102 { "DEBUG OBJECT",

103 "key",

104 "Get debugging information about a key",

105 9,

106 "1.0.0" },

107 { "DEBUG SEGFAULT",

108 "-",

109 "Make the server crash",

110 9,

111 "1.0.0" },

112 { "DECR",

113 "key",

114 "Decrement the integer value of a key by one",

115 1,

116 "1.0.0" },

117 { "DECRBY",

118 "key decrement",

119 "Decrement the integer value of a key by the given number",

120 1,

121 "1.0.0" },

122 { "DEL",

123 "key [key ...]",

124 "Delete a key",

125 0,

126 "1.0.0" },

127 { "DISCARD",

128 "-",

129 "Discard all commands issued after MULTI",

130 7,

131 "2.0.0" },

132 { "DUMP",

133 "key",

134 "Return a serialized version of the value stored at the specified key.",

135 0,

136 "2.6.0" },

137 { "ECHO",

138 "message",

139 "Echo the given string",

140 8,

141 "1.0.0" },

142 { "EVAL",

143 "script numkeys key [key ...] arg [arg ...]",

144 "Execute a Lua script server side",

145 10,

146 "2.6.0" },

147 { "EVALSHA",

148 "sha1 numkeys key [key ...] arg [arg ...]",

149 "Execute a Lua script server side",

150 10,

151 "2.6.0" },

152 { "EXEC",

153 "-",

154 "Execute all commands issued after MULTI",

155 7,

156 "1.2.0" },

157 { "EXISTS",

158 "key",

159 "Determine if a key exists",

160 0,

161 "1.0.0" },

162 { "EXPIRE",

163 "key seconds",

164 "Set a key's time to live in seconds",

165 0,

166 "1.0.0" },

167 { "EXPIREAT",

168 "key timestamp",

169 "Set the expiration for a key as a UNIX timestamp",

170 0,

171 "1.2.0" },

172 { "FLUSHALL",

173 "-",

174 "Remove all keys from all databases",

175 9,

176 "1.0.0" },

177 { "FLUSHDB",

178 "-",

179 "Remove all keys from the current database",

180 9,

181 "1.0.0" },

182 { "GET",

183 "key",

184 "Get the value of a key",

185 1,

186 "1.0.0" },

187 { "GETBIT",

188 "key offset",

189 "Returns the bit value at offset in the string value stored at key",

190 1,

191 "2.2.0" },

192 { "GETRANGE",

193 "key start end",

194 "Get a substring of the string stored at a key",

195 1,

196 "2.4.0" },

197 { "GETSET",

198 "key value",

199 "Set the string value of a key and return its old value",

200 1,

201 "1.0.0" },

202 { "HDEL",

203 "key field [field ...]",

204 "Delete one or more hash fields",

205 5,

206 "2.0.0" },

207 { "HEXISTS",

208 "key field",

209 "Determine if a hash field exists",

210 5,

211 "2.0.0" },

212 { "HGET",

213 "key field",

214 "Get the value of a hash field",

215 5,

216 "2.0.0" },

217 { "HGETALL",

218 "key",

219 "Get all the fields and values in a hash",

220 5,

221 "2.0.0" },

222 { "HINCRBY",

223 "key field increment",

224 "Increment the integer value of a hash field by the given number",

225 5,

226 "2.0.0" },

227 { "HINCRBYFLOAT",

228 "key field increment",

229 "Increment the float value of a hash field by the given amount",

230 5,

231 "2.6.0" },

232 { "HKEYS",

233 "key",

234 "Get all the fields in a hash",

235 5,

236 "2.0.0" },

237 { "HLEN",

238 "key",

239 "Get the number of fields in a hash",

240 5,

241 "2.0.0" },

242 { "HMGET",

243 "key field [field ...]",

244 "Get the values of all the given hash fields",

245 5,

246 "2.0.0" },

247 { "HMSET",

248 "key field value [field value ...]",

249 "Set multiple hash fields to multiple values",

250 5,

251 "2.0.0" },

252 { "HSET",

253 "key field value",

254 "Set the string value of a hash field",

255 5,

256 "2.0.0" },

257 { "HSETNX",

258 "key field value",

259 "Set the value of a hash field, only if the field does not exist",

260 5,

261 "2.0.0" },

262 { "HVALS",

263 "key",

264 "Get all the values in a hash",

265 5,

266 "2.0.0" },

267 { "INCR",

268 "key",

269 "Increment the integer value of a key by one",

270 1,

271 "1.0.0" },

272 { "INCRBY",

273 "key increment",

274 "Increment the integer value of a key by the given amount",

275 1,

276 "1.0.0" },

277 { "INCRBYFLOAT",

278 "key increment",

279 "Increment the float value of a key by the given amount",

280 1,

281 "2.6.0" },

282 { "INFO",

283 "-",

284 "Get information and statistics about the server",

285 9,

286 "1.0.0" },

287 { "KEYS",

288 "pattern",

289 "Find all keys matching the given pattern",

290 0,

291 "1.0.0" },

292 { "LASTSAVE",

293 "-",

294 "Get the UNIX time stamp of the last successful save to disk",

295 9,

296 "1.0.0" },

297 { "LINDEX",

298 "key index",

299 "Get an element from a list by its index",

300 2,

301 "1.0.0" },

302 { "LINSERT",

303 "key BEFORE|AFTER pivot value",

304 "Insert an element before or after another element in a list",

305 2,

306 "2.2.0" },

307 { "LLEN",

308 "key",

309 "Get the length of a list",

310 2,

311 "1.0.0" },

312 { "LPOP",

313 "key",

314 "Remove and get the first element in a list",

315 2,

316 "1.0.0" },

317 { "LPUSH",

318 "key value [value ...]",

319 "Prepend one or multiple values to a list",

320 2,

321 "1.0.0" },

322 { "LPUSHX",

323 "key value",

324 "Prepend a value to a list, only if the list exists",

325 2,

326 "2.2.0" },

327 { "LRANGE",

328 "key start stop",

329 "Get a range of elements from a list",

330 2,

331 "1.0.0" },

332 { "LREM",

333 "key count value",

334 "Remove elements from a list",

335 2,

336 "1.0.0" },

337 { "LSET",

338 "key index value",

339 "Set the value of an element in a list by its index",

340 2,

341 "1.0.0" },

342 { "LTRIM",

343 "key start stop",

344 "Trim a list to the specified range",

345 2,

346 "1.0.0" },

347 { "MGET",

348 "key [key ...]",

349 "Get the values of all the given keys",

350 1,

351 "1.0.0" },

352 { "MIGRATE",

353 "host port key destination-db timeout",

354 "Atomically transfer a key from a Redis instance to another one.",

355 0,

356 "2.6.0" },

357 { "MONITOR",

358 "-",

359 "Listen for all requests received by the server in real time",

360 9,

361 "1.0.0" },

362 { "MOVE",

363 "key db",

364 "Move a key to another database",

365 0,

366 "1.0.0" },

367 { "MSET",

368 "key value [key value ...]",

369 "Set multiple keys to multiple values",

370 1,

371 "1.0.1" },

372 { "MSETNX",

373 "key value [key value ...]",

374 "Set multiple keys to multiple values, only if none of the keys exist",

375 1,

376 "1.0.1" },

377 { "MULTI",

378 "-",

379 "Mark the start of a transaction block",

380 7,

381 "1.2.0" },

382 { "OBJECT",

383 "subcommand [arguments [arguments ...]]",

384 "Inspect the internals of Redis objects",

385 0,

386 "2.2.3" },

387 { "PERSIST",

388 "key",

389 "Remove the expiration from a key",

390 0,

391 "2.2.0" },

392 { "PEXPIRE",

393 "key milliseconds",

394 "Set a key's time to live in milliseconds",

395 0,

396 "2.6.0" },

397 { "PEXPIREAT",

398 "key milliseconds-timestamp",

399 "Set the expiration for a key as a UNIX timestamp specified in milliseconds",

400 0,

401 "2.6.0" },

402 { "PING",

403 "-",

404 "Ping the server",

405 8,

406 "1.0.0" },

407 { "PSETEX",

408 "key milliseconds value",

409 "Set the value and expiration in milliseconds of a key",

410 1,

411 "2.6.0" },

412 { "PSUBSCRIBE",

413 "pattern [pattern ...]",

414 "Listen for messages published to channels matching the given patterns",

415 6,

416 "2.0.0" },

417 { "PTTL",

418 "key",

419 "Get the time to live for a key in milliseconds",

420 0,

421 "2.6.0" },

422 { "PUBLISH",

423 "channel message",

424 "Post a message to a channel",

425 6,

426 "2.0.0" },

427 { "PUNSUBSCRIBE",

428 "[pattern [pattern ...]]",

429 "Stop listening for messages posted to channels matching the given patterns",

430 6,

431 "2.0.0" },

432 { "QUIT",

433 "-",

434 "Close the connection",

435 8,

436 "1.0.0" },

437 { "RANDOMKEY",

438 "-",

439 "Return a random key from the keyspace",

440 0,

441 "1.0.0" },

442 { "RENAME",

443 "key newkey",

444 "Rename a key",

445 0,

446 "1.0.0" },

447 { "RENAMENX",

448 "key newkey",

449 "Rename a key, only if the new key does not exist",

450 0,

451 "1.0.0" },

452 { "RESTORE",

453 "key ttl serialized-value",

454 "Create a key using the provided serialized value, previously obtained using DUMP.",

455 0,

456 "2.6.0" },

457 { "RPOP",

458 "key",

459 "Remove and get the last element in a list",

460 2,

461 "1.0.0" },

462 { "RPOPLPUSH",

463 "source destination",

464 "Remove the last element in a list, append it to another list and return it",

465 2,

466 "1.2.0" },

467 { "RPUSH",

468 "key value [value ...]",

469 "Append one or multiple values to a list",

470 2,

471 "1.0.0" },

472 { "RPUSHX",

473 "key value",

474 "Append a value to a list, only if the list exists",

475 2,

476 "2.2.0" },

477 { "SADD",

478 "key member [member ...]",

479 "Add one or more members to a set",

480 3,

481 "1.0.0" },

482 { "SAVE",

483 "-",

484 "Synchronously save the dataset to disk",

485 9,

486 "1.0.0" },

487 { "SCARD",

488 "key",

489 "Get the number of members in a set",

490 3,

491 "1.0.0" },

492 { "SCRIPT EXISTS",

493 "script [script ...]",

494 "Check existence of scripts in the script cache.",

495 10,

496 "2.6.0" },

497 { "SCRIPT FLUSH",

498 "-",

499 "Remove all the scripts from the script cache.",

500 10,

501 "2.6.0" },

502 { "SCRIPT KILL",

503 "-",

504 "Kill the script currently in execution.",

505 10,

506 "2.6.0" },

507 { "SCRIPT LOAD",

508 "script",

509 "Load the specified Lua script into the script cache.",

510 10,

511 "2.6.0" },

512 { "SDIFF",

513 "key [key ...]",

514 "Subtract multiple sets",

515 3,

516 "1.0.0" },

517 { "SDIFFSTORE",

518 "destination key [key ...]",

519 "Subtract multiple sets and store the resulting set in a key",

520 3,

521 "1.0.0" },

522 { "SELECT",

523 "index",

524 "Change the selected database for the current connection",

525 8,

526 "1.0.0" },

527 { "SET",

528 "key value",

529 "Set the string value of a key",

530 1,

531 "1.0.0" },

532 { "SETBIT",

533 "key offset value",

534 "Sets or clears the bit at offset in the string value stored at key",

535 1,

536 "2.2.0" },

537 { "SETEX",

538 "key seconds value",

539 "Set the value and expiration of a key",

540 1,

541 "2.0.0" },

542 { "SETNX",

543 "key value",

544 "Set the value of a key, only if the key does not exist",

545 1,

546 "1.0.0" },

547 { "SETRANGE",

548 "key offset value",

549 "Overwrite part of a string at key starting at the specified offset",

550 1,

551 "2.2.0" },

552 { "SHUTDOWN",

553 "[NOSAVE] [SAVE]",

554 "Synchronously save the dataset to disk and then shut down the server",

555 9,

556 "1.0.0" },

557 { "SINTER",

558 "key [key ...]",

559 "Intersect multiple sets",

560 3,

561 "1.0.0" },

562 { "SINTERSTORE",

563 "destination key [key ...]",

564 "Intersect multiple sets and store the resulting set in a key",

565 3,

566 "1.0.0" },

567 { "SISMEMBER",

568 "key member",

569 "Determine if a given value is a member of a set",

570 3,

571 "1.0.0" },

572 { "SLAVEOF",

573 "host port",

574 "Make the server a slave of another instance, or promote it as master",

575 9,

576 "1.0.0" },

577 { "SLOWLOG",

578 "subcommand [argument]",

579 "Manages the Redis slow queries log",

580 9,

581 "2.2.12" },

582 { "SMEMBERS",

583 "key",

584 "Get all the members in a set",

585 3,

586 "1.0.0" },

587 { "SMOVE",

588 "source destination member",

589 "Move a member from one set to another",

590 3,

591 "1.0.0" },

592 { "SORT",

593 "key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]",

594 "Sort the elements in a list, set or sorted set",

595 0,

596 "1.0.0" },

597 { "SPOP",

598 "key",

599 "Remove and return a random member from a set",

600 3,

601 "1.0.0" },

602 { "SRANDMEMBER",

603 "key [count]",

604 "Get one or multiple random members from a set",

605 3,

606 "1.0.0" },

607 { "SREM",

608 "key member [member ...]",

609 "Remove one or more members from a set",

610 3,

611 "1.0.0" },

612 { "STRLEN",

613 "key",

614 "Get the length of the value stored in a key",

615 1,

616 "2.2.0" },

617 { "SUBSCRIBE",

618 "channel [channel ...]",

619 "Listen for messages published to the given channels",

620 6,

621 "2.0.0" },

622 { "SUNION",

623 "key [key ...]",

624 "Add multiple sets",

625 3,

626 "1.0.0" },

627 { "SUNIONSTORE",

628 "destination key [key ...]",

629 "Add multiple sets and store the resulting set in a key",

630 3,

631 "1.0.0" },

632 { "SYNC",

633 "-",

634 "Internal command used for replication",

635 9,

636 "1.0.0" },

637 { "TIME",

638 "-",

639 "Return the current server time",

640 9,

641 "2.6.0" },

642 { "TTL",

643 "key",

644 "Get the time to live for a key",

645 0,

646 "1.0.0" },

647 { "TYPE",

648 "key",

649 "Determine the type stored at key",

650 0,

651 "1.0.0" },

652 { "UNSUBSCRIBE",

653 "[channel [channel ...]]",

654 "Stop listening for messages posted to the given channels",

655 6,

656 "2.0.0" },

657 { "UNWATCH",

658 "-",

659 "Forget about all watched keys",

660 7,

661 "2.2.0" },

662 { "WATCH",

663 "key [key ...]",

664 "Watch the given keys to determine execution of the MULTI/EXEC block",

665 7,

666 "2.2.0" },

667 { "ZADD",

668 "key score member [score] [member]",

669 "Add one or more members to a sorted set, or update its score if it already exists",

670 4,

671 "1.2.0" },

672 { "ZCARD",

673 "key",

674 "Get the number of members in a sorted set",

675 4,

676 "1.2.0" },

677 { "ZCOUNT",

678 "key min max",

679 "Count the members in a sorted set with scores within the given values",

680 4,

681 "2.0.0" },

682 { "ZINCRBY",

683 "key increment member",

684 "Increment the score of a member in a sorted set",

685 4,

686 "1.2.0" },

687 { "ZINTERSTORE",

688 "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",

689 "Intersect multiple sorted sets and store the resulting sorted set in a new key",

690 4,

691 "2.0.0" },

692 { "ZRANGE",

693 "key start stop [WITHSCORES]",

694 "Return a range of members in a sorted set, by index",

695 4,

696 "1.2.0" },

697 { "ZRANGEBYSCORE",

698 "key min max [WITHSCORES] [LIMIT offset count]",

699 "Return a range of members in a sorted set, by score",

700 4,

701 "1.0.5" },

702 { "ZRANK",

703 "key member",

704 "Determine the index of a member in a sorted set",

705 4,

706 "2.0.0" },

707 { "ZREM",

708 "key member [member ...]",

709 "Remove one or more members from a sorted set",

710 4,

711 "1.2.0" },

712 { "ZREMRANGEBYRANK",

713 "key start stop",

714 "Remove all members in a sorted set within the given indexes",

715 4,

716 "2.0.0" },

717 { "ZREMRANGEBYSCORE",

718 "key min max",

719 "Remove all members in a sorted set within the given scores",

720 4,

721 "1.2.0" },

722 { "ZREVRANGE",

723 "key start stop [WITHSCORES]",

724 "Return a range of members in a sorted set, by index, with scores ordered from high to low",

725 4,

726 "1.2.0" },

727 { "ZREVRANGEBYSCORE",

728 "key max min [WITHSCORES] [LIMIT offset count]",

729 "Return a range of members in a sorted set, by score, with scores ordered from high to low",

730 4,

731 "2.2.0" },

732 { "ZREVRANK",

733 "key member",

734 "Determine the index of a member in a sorted set, with scores ordered from high to low",

735 4,

736 "2.0.0" },

737 { "ZSCORE",

738 "key member",

739 "Get the score associated with the given member in a sorted set",

740 4,

741 "1.2.0" },

742 { "ZUNIONSTORE",

743 "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",

744 "Add multiple sorted sets and store the resulting sorted set in a new key",

745 4,

746 "2.0.0" }

747 };

748

749 #endif