1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
| '''Help on class Redis in module redis.client:'''
class Redis(builtins.object) Redis( host='localhost', port=6379, db=0, password=None, socket_timeout=None, socket_connect_timeout=None, socket_keepalive=None, socket_keepalive_options=None, connection_pool=None, unix_socket_path=None, encoding='utf-8', encoding_errors='strict', charset=None, errors=None, decode_responses=False, retry_on_timeout=False, ssl=False, ssl_keyfile=None, ssl_certfile=None, ssl_cert_reqs='required', ssl_ca_certs=None, max_connections=None ) ''' Implementation of the Redis protocol. This abstract class provides a Python interface to all Redis commands and an implementation of the Redis protocol. Connection and Pipeline derive from this, implementing how the commands are sent and received to the Redis server Methods defined here: ''' __contains__ = exists(self, *names) __delitem__(self, name) __getitem__(self, name) '''Return the value at key ``name``, raises a KeyError if the key doesn't exist.''' __init__(self, host='localhost', port=6379, db=0, password=None, socket_timeout=None, socket_connect_timeout=None, socket_keepalive=None, socket_keepalive_options=None, connection_pool=None, unix_socket_path=None, encoding='utf-8', encoding_errors='strict', charset=None, errors=None, decode_responses=False, retry_on_timeout=False, ssl=False, ssl_keyfile=None, ssl_certfile=None, ssl_cert_reqs='required', ssl_ca_certs=None, max_connections=None) '''Initialize self. See help(type(self)) for accurate signature.''' __repr__(self) '''Return repr(self).''' __setitem__(self, name, value) append(self, key, value) ''' Appends the string ``value`` to the value at ``key``. If ``key`` doesn't already exist, create it with a value of ``value``. Returns the new length of the value at ``key``. '''
bgrewriteaof(self) ''' Tell the Redis server to rewrite the AOF file from data in memory. '''
bgsave(self) ''' Tell the Redis server to save its data to disk. Unlike save(), this method is asynchronous and returns immediately. '''
bitcount(self, key, start=None, end=None) ''' Returns the count of set bits in the value of ``key``. Optional ``start`` and ``end`` paramaters indicate which bytes to consider '''
bitfield(self, key, default_overflow=None) ''' Return a BitFieldOperation instance to conveniently construct one or more bitfield operations on ``key``. '''
bitop(self, operation, dest, *keys) ''' Perform a bitwise operation using ``operation`` between ``keys`` and store the result in ``dest``. '''
bitpos(self, key, bit, start=None, end=None) ''' Return the position of the first bit set to 1 or 0 in a string. ``start`` and ``end`` difines search range. The range is interpreted as a range of bytes and not a range of bits, so start=0 and end=2 means to look at the first three bytes. '''
blpop(self, keys, timeout=0) ''' LPOP a value off of the first non-empty list named in the ``keys`` list. If none of the lists in ``keys`` has a value to LPOP, then block for ``timeout`` seconds, or until a value gets pushed on to one of the lists. If timeout is 0, then block indefinitely. '''
brpop(self, keys, timeout=0) ''' RPOP a value off of the first non-empty list named in the ``keys`` list. If none of the lists in ``keys`` has a value to RPOP, then block for ``timeout`` seconds, or until a value gets pushed on to one of the lists. If timeout is 0, then block indefinitely. ''' brpoplpush(self, src, dst, timeout=0) ''' Pop a value off the tail of ``src``, push it on the head of ``dst`` and then return it. This command blocks until a value is in ``src`` or until ``timeout`` seconds elapse, whichever is first. A ``timeout`` value of 0 blocks forever. '''
bzpopmax(self, keys, timeout=0) ''' ZPOPMAX a value off of the first non-empty sorted set named in the ``keys`` list. If none of the sorted sets in ``keys`` has a value to ZPOPMAX, then block for ``timeout`` seconds, or until a member gets added to one of the sorted sets. If timeout is 0, then block indefinitely. '''
bzpopmin(self, keys, timeout=0) ''' ZPOPMIN a value off of the first non-empty sorted set named in the ``keys`` list. If none of the sorted sets in ``keys`` has a value to ZPOPMIN, then block for ``timeout`` seconds, or until a member gets added to one of the sorted sets. If timeout is 0, then block indefinitely. '''
client_getname(self) '''Returns the current connection name''' client_id(self) '''Returns the current connection id''' client_kill(self, address) '''Disconnects the client at ``address`` (ip:port)''' client_kill_filter(self, _id=None, _type=None, addr=None, skipme=None) ''' Disconnects client(s) using a variety of filter options :param id: Kills a client by its unique ID field :param type: Kills a client by type where type is one of 'normal', 'master', 'slave' or 'pubsub' :param addr: Kills a client by its 'address:port' :param skipme: If True, then the client calling the command will not get killed even if it is identified by one of the filter options. If skipme is not provided, the server defaults to skipme=True '''
client_list(self, _type=None) ''' Returns a list of currently connected clients. If type of client specified, only that type will be returned. :param _type: optional. one of the client types (normal, master, replica, pubsub) '''
client_pause(self, timeout) ''' Suspend all the Redis clients for the specified amount of time :param timeout: milliseconds to pause clients '''
client_setname(self, name) '''Sets the current connection name''' client_unblock(self, client_id, error=False) ''' Unblocks a connection by its client id. If ``error`` is True, unblocks the client with a special error message. If ``error`` is False (default), the client is unblocked using the regular timeout mechanism. ''' cluster(self, cluster_arg, *args) config_get(self, pattern='*') '''Return a dictionary of configuration based on the ``pattern``''' config_resetstat(self) '''Reset runtime statistics''' config_rewrite(self) '''Rewrite config file with the minimal change to reflect running config''' config_set(self, name, value) '''Set config item ``name`` with ``value``''' dbsize(self) '''Returns the number of keys in the current database''' debug_object(self, key) '''Returns version specific meta information about a given key''' decr(self, name, amount=1) ''' Decrements the value of ``key`` by ``amount``. If no key exists, the value will be initialized as 0 - ``amount`` '''
decrby(self, name, amount=1) ''' Decrements the value of ``key`` by ``amount``. If no key exists, the value will be initialized as 0 - ``amount`` '''
delete(self, *names) '''Delete one or more keys specified by ``names``''' dump(self, name) ''' Return a serialized version of the value stored at the specified key. If key does not exist a nil bulk reply is returned. '''
echo(self, value) '''Echo the string back from the server''' eval(self, script, numkeys, *keys_and_args) ''' Execute the Lua ``script``, specifying the ``numkeys`` the script will touch and the key names and argument values in ``keys_and_args``. Returns the result of the script. In practice, use the object returned by ``register_script``. This function exists purely for Redis API completion. '''
evalsha(self, sha, numkeys, *keys_and_args) ''' Use the ``sha`` to execute a Lua script already registered via EVAL or SCRIPT LOAD. Specify the ``numkeys`` the script will touch and the key names and argument values in ``keys_and_args``. Returns the result of the script. In practice, use the object returned by ``register_script``. This function exists purely for Redis API completion. '''
execute_command(self, *args, **options) '''Execute a command and return a parsed response''' exists(self, *names) ''' Returns the number of ``names`` that exist''' expire(self, name, time) ''' Set an expire flag on key ``name`` for ``time`` seconds. ``time`` can be represented by an integer or a Python timedelta object. '''
expireat(self, name, when) ''' Set an expire flag on key ``name``. ``when`` can be represented as an integer indicating unix time or a Python datetime object. '''
flushall(self, asynchronous=False) ''' Delete all keys in all databases on the current host. ``asynchronous`` indicates whether the operation is executed asynchronously by the server. '''
flushdb(self, asynchronous=False) ''' Delete all keys in the current database. ``asynchronous`` indicates whether the operation is executed asynchronously by the server. '''
geoadd(self, name, *values) ''' Add the specified geospatial items to the specified key identified by the ``name`` argument. The Geospatial items are given as ordered members of the ``values`` argument, each item or place is formed by the triad longitude, latitude and name. '''
geodist(self, name, place1, place2, unit=None) ''' Return the distance between ``place1`` and ``place2`` members of the ``name`` key. The units must be one of the following : m, km mi, ft. By default meters are used. '''
geohash(self, name, *values) ''' Return the geo hash string for each item of ``values`` members of the specified key identified by the ``name`` argument. '''
geopos(self, name, *values) ''' Return the positions of each item of ``values`` as members of the specified key identified by the ``name`` argument. Each position is represented by the pairs lon and lat. '''
georadius(self, name, longitude, latitude, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None) ''' Return the members of the specified key identified by the ``name`` argument which are within the borders of the area specified with the ``latitude`` and ``longitude`` location and the maximum distance from the center specified by the ``radius`` value. The units must be one of the following : m, km mi, ft. By default ``withdist`` indicates to return the distances of each place. ``withcoord`` indicates to return the latitude and longitude of each place. ``withhash`` indicates to return the geohash string of each place. ``count`` indicates to return the number of elements up to N. ``sort`` indicates to return the places in a sorted way, ASC for nearest to fairest and DESC for fairest to nearest. ``store`` indicates to save the places names in a sorted set named with a specific key, each element of the destination sorted set is populated with the score got from the original geo sorted set. ``store_dist`` indicates to save the places names in a sorted set named with a specific key, instead of ``store`` the sorted set destination score is set with the distance. '''
georadiusbymember(self, name, member, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None) ''' This command is exactly like ``georadius`` with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set. '''
get(self, name) '''Return the value at key ``name``, or None if the key doesn't exist''' getbit(self, name, offset) '''Returns a boolean indicating the value of ``offset`` in ``name``''' getrange(self, key, start, end) ''' Returns the substring of the string value stored at ``key``, determined by the offsets ``start`` and ``end`` (both are inclusive) '''
getset(self, name, value) ''' Sets the value at key ``name`` to ``value`` and returns the old value at key ``name`` atomically. '''
hdel(self, name, *keys) '''Delete ``keys`` from hash ``name``''' hexists(self, name, key) '''Returns a boolean indicating if ``key`` exists within hash ``name``''' hget(self, name, key) '''Return the value of ``key`` within the hash ``name``''' hgetall(self, name) '''Return a Python dict of the hash's name/value pairs''' hincrby(self, name, key, amount=1) '''Increment the value of ``key`` in hash ``name`` by ``amount``''' hincrbyfloat(self, name, key, amount=1.0) '''Increment the value of ``key`` in hash ``name`` by floating ``amount``''' hkeys(self, name) '''Return the list of keys within hash ``name``''' hlen(self, name) '''Return the number of elements in hash ``name``''' hmget(self, name, keys, *args) '''Returns a list of values ordered identically to ``keys``''' hmset(self, name, mapping) ''' Set key to value within hash ``name`` for each corresponding key and value from the ``mapping`` dict. ''' hscan(self, name, cursor=0, match=None, count=None) ''' Incrementally return key/value slices in a hash. Also return a cursor indicating the scan position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns ''' hscan_iter(self, name, match=None, count=None) ''' Make an iterator using the HSCAN command so that the client doesn't need to remember the cursor position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns '''
hset(self, name, key, value) ''' Set ``key`` to ``value`` within hash ``name`` Returns 1 if HSET created a new field, otherwise 0 '''
hsetnx(self, name, key, value) ''' Set ``key`` to ``value`` within hash ``name`` if ``key`` does not exist. Returns 1 if HSETNX created a field, otherwise 0. '''
hstrlen(self, name, key) ''' Return the number of bytes stored in the value of ``key`` within hash ``name`` '''
hvals(self, name) '''Return the list of values within hash ``name``''' incr(self, name, amount=1) ''' Increments the value of ``key`` by ``amount``. If no key exists, the value will be initialized as ``amount`` '''
incrby(self, name, amount=1) ''' Increments the value of ``key`` by ``amount``. If no key exists, the value will be initialized as ``amount`` '''
incrbyfloat(self, name, amount=1.0) ''' Increments the value at key ``name`` by floating ``amount``. If no key exists, the value will be initialized as ``amount`` '''
info(self, section=None) ''' Returns a dictionary containing information about the Redis server The ``section`` option can be used to select a specific section of information The section option is not supported by older versions of Redis Server, and will generate ResponseError '''
keys(self, pattern='*') '''Returns a list of keys matching ``pattern``''' lastsave(self) ''' Return a Python datetime object representing the last time the Redis database was saved to disk ''' lindex(self, name, index) ''' Return the item from list ``name`` at position ``index`` Negative indexes are supported and will return an item at the end of the list ''' linsert(self, name, where, refvalue, value) ''' Insert ``value`` in list ``name`` either immediately before or after [``where``] ``refvalue`` Returns the new length of the list on success or -1 if ``refvalue`` is not in the list. ''' llen(self, name) '''Return the length of the list ``name``''' lock(self, name, timeout=None, sleep=0.1, blocking_timeout=None, lock_class=None, thread_local=True) ''' Return a new Lock object using key ``name`` that mimics the behavior of threading.Lock. If specified, ``timeout`` indicates a maximum life for the lock. By default, it will remain locked until release() is called. ``sleep`` indicates the amount of time to sleep per loop iteration when the lock is in blocking mode and another client is currently holding the lock. ``blocking_timeout`` indicates the maximum amount of time in seconds to spend trying to acquire the lock. A value of ``None`` indicates continue trying forever. ``blocking_timeout`` can be specified as a float or integer, both representing the number of seconds to wait. ``lock_class`` forces the specified lock implementation. ``thread_local`` indicates whether the lock token is placed in thread-local storage. By default, the token is placed in thread local storage so that a thread only sees its token, not a token set by another thread. Consider the following timeline: time: 0, thread-1 acquires `my-lock`, with a timeout of 5 seconds. thread-1 sets the token to "abc" time: 1, thread-2 blocks trying to acquire `my-lock` using the Lock instance. time: 5, thread-1 has not yet completed. redis expires the lock key. time: 5, thread-2 acquired `my-lock` now that it's available. thread-2 sets the token to "xyz" time: 6, thread-1 finishes its work and calls release(). if the token is *not* stored in thread local storage, then thread-1 would see the token value as "xyz" and would be able to successfully release the thread-2's lock. In some use cases it's necessary to disable thread local storage. For example, if you have code where one thread acquires a lock and passes that lock instance to a worker thread to release later. If thread local storage isn't disabled in this case, the worker thread won't see the token set by the thread that acquired the lock. Our assumption is that these cases aren't common and as such default to using thread local storage. '''
lpop(self, name) '''Remove and return the first item of the list ``name``''' lpush(self, name, *values) '''Push ``values`` onto the head of the list ``name``''' lpushx(self, name, value) '''Push ``value`` onto the head of the list ``name`` if ``name`` exists''' lrange(self, name, start, end) ''' Return a slice of the list ``name`` between position ``start`` and ``end`` ``start`` and ``end`` can be negative numbers just like Python slicing notation ''' lrem(self, name, count, value) ''' Remove the first ``count`` occurrences of elements equal to ``value`` from the list stored at ``name``. The count argument influences the operation in the following ways: count > 0: Remove elements equal to value moving from head to tail. count < 0: Remove elements equal to value moving from tail to head. count = 0: Remove all elements equal to value. ''' lset(self, name, index, value) '''Set ``position`` of list ``name`` to ``value``''' ltrim(self, name, start, end) ''' Trim the list ``name``, removing all values not within the slice between ``start`` and ``end`` ``start`` and ``end`` can be negative numbers just like Python slicing notation '''
memory_purge(self) '''Attempts to purge dirty pages for reclamation by allocator''' memory_usage(self, key, samples=None) ''' Return the total memory usage for key, its value and associated administrative overheads. For nested data structures, ``samples`` is the number of elements to sample. If left unspecified, the server's default is 5. Use 0 to sample all elements. ''' mget(self, keys, *args) ''' Returns a list of values ordered identically to ``keys``''' migrate(self, host, port, keys, destination_db, timeout, copy=False, replace=False, auth=None) ''' Migrate 1 or more keys from the current Redis server to a different server specified by the ``host``, ``port`` and ``destination_db``. The ``timeout``, specified in milliseconds, indicates the maximum time the connection between the two servers can be idle before the command is interrupted. If ``copy`` is True, the specified ``keys`` are NOT deleted from the source server. If ``replace`` is True, this operation will overwrite the keys on the destination server if they exist. If ``auth`` is specified, authenticate to the destination server with the password provided. '''
move(self, name, db) '''Moves the key ``name`` to a different Redis database ``db``''' mset(self, mapping) ''' Sets key/values based on a mapping. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str(). ''' msetnx(self, mapping) ''' Sets key/values based on a mapping if none of the keys are already set. Mapping is a dictionary of key/value pairs. Both keys and values should be strings or types that can be cast to a string via str(). Returns a boolean indicating if the operation was successful. ''' object(self, infotype, key) '''Return the encoding, idletime, or refcount about the key''' parse_response(self, connection, command_name, **options) '''Parses a response from the Redis server''' persist(self, name) '''Removes an expiration on ``name``''' pexpire(self, name, time) ''' Set an expire flag on key ``name`` for ``time`` milliseconds. ``time`` can be represented by an integer or a Python timedelta object. ''' pexpireat(self, name, when) ''' Set an expire flag on key ``name``. ``when`` can be represented as an integer representing unix time in milliseconds (unix time * 1000) or a Python datetime object. ''' pfadd(self, name, *values) '''Adds the specified elements to the specified HyperLogLog.''' pfcount(self, *sources) ''' Return the approximated cardinality of the set observed by the HyperLogLog at key(s). ''' pfmerge(self, dest, *sources) '''Merge N different HyperLogLogs into a single one.''' ping(self) '''Ping the Redis server''' pipeline(self, transaction=True, shard_hint=None) ''' Return a new pipeline object that can queue multiple commands for later execution. ``transaction`` indicates whether all commands should be executed atomically. Apart from making a group of operations atomic, pipelines are useful for reducing the back-and-forth overhead between the client and server. ''' psetex(self, name, time_ms, value) ''' Set the value of key ``name`` to ``value`` that expires in ``time_ms`` milliseconds. ``time_ms`` can be represented by an integer or a Python timedelta object ''' pttl(self, name) '''Returns the number of milliseconds until the key ``name`` will expire''' publish(self, channel, message) ''' Publish ``message`` on ``channel``. Returns the number of subscribers the message was delivered to. '''
pubsub(self, **kwargs) ''' Return a Publish/Subscribe object. With this object, you can subscribe to channels and listen for messages that get published to them. ''' pubsub_channels(self, pattern='*') '''Return a list of channels that have at least one subscriber''' pubsub_numpat(self) '''Returns the number of subscriptions to patterns''' pubsub_numsub(self, *args) ''' Return a list of (channel, number of subscribers) tuples for each channel given in ``*args`` '''
randomkey(self) '''Returns the name of a random key''' register_script(self, script) ''' Register a Lua ``script`` specifying the ``keys`` it will touch. Returns a Script object that is callable and hides the complexity of deal with scripts, keys, and shas. This is the preferred way to work with Lua scripts. ''' rename(self, src, dst) '''Rename key ``src`` to ``dst``''' renamenx(self, src, dst) '''Rename key ``src`` to ``dst`` if ``dst`` doesn't already exist''' restore(self, name, ttl, value, replace=False) ''' Create a key using the provided serialized value, previously obtained using DUMP. '''
rpop(self, name) '''Remove and return the last item of the list ``name``''' rpoplpush(self, src, dst) ''' RPOP a value off of the ``src`` list and atomically LPUSH it on to the ``dst`` list. Returns the value. ''' rpush(self, name, *values) '''Push ``values`` onto the tail of the list ``name``''' rpushx(self, name, value) '''Push ``value`` onto the tail of the list ``name`` if ``name`` exists''' sadd(self, name, *values) '''Add ``value(s)`` to set ``name``''' save(self) ''' Tell the Redis server to save its data to disk, blocking until the save is complete ''' scan(self, cursor=0, match=None, count=None) ''' Incrementally return lists of key names. Also return a cursor indicating the scan position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns ''' scan_iter(self, match=None, count=None) ''' Make an iterator using the SCAN command so that the client doesn't need to remember the cursor position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns ''' scard(self, name) '''Return the number of elements in set ``name``''' script_exists(self, *args) ''' Check if a script exists in the script cache by specifying the SHAs of each script as ``args``. Returns a list of boolean values indicating if if each already script exists in the cache. '''
script_flush(self) '''Flush all scripts from the script cache''' script_kill(self) '''Kill the currently executing Lua script''' script_load(self, script) '''Load a Lua ``script`` into the script cache. Returns the SHA.''' sdiff(self, keys, *args) '''Return the difference of sets specified by ``keys``''' sdiffstore(self, dest, keys, *args) ''' Store the difference of sets specified by ``keys`` into a new set named ``dest``. Returns the number of keys in the new set. '''
sentinel(self, *args) '''Redis Sentinel's SENTINEL command.''' sentinel_get_master_addr_by_name(self, service_name) '''Returns a (host, port) pair for the given ``service_name``''' sentinel_master(self, service_name) '''Returns a dictionary containing the specified masters state.''' sentinel_masters(self) '''Returns a list of dictionaries containing each master's state.''' sentinel_monitor(self, name, ip, port, quorum) '''Add a new master to Sentinel to be monitored''' sentinel_remove(self, name) '''Remove a master from Sentinel's monitoring''' sentinel_sentinels(self, service_name) '''Returns a list of sentinels for ``service_name``''' sentinel_set(self, name, option, value) '''Set Sentinel monitoring parameters for a given master''' sentinel_slaves(self, service_name) '''Returns a list of slaves for ``service_name``''' set(self, name, value, ex=None, px=None, nx=False, xx=False) ''' Set the value at key ``name`` to ``value`` ``ex`` sets an expire flag on key ``name`` for ``ex`` seconds. ``px`` sets an expire flag on key ``name`` for ``px`` milliseconds. ``nx`` if set to True, set the value at key ``name`` to ``value`` only if it does not exist. ``xx`` if set to True, set the value at key ``name`` to ``value`` only if it already exists. '''
set_response_callback(self, command, callback) '''Set a custom Response Callback''' setbit(self, name, offset, value) ''' Flag the ``offset`` in ``name`` as ``value``. Returns a boolean indicating the previous value of ``offset``. '''
setex(self, name, time, value) ''' Set the value of key ``name`` to ``value`` that expires in ``time`` seconds. ``time`` can be represented by an integer or a Python timedelta object. '''
setnx(self, name, value) '''Set the value of key ``name`` to ``value`` if key doesn't exist''' setrange(self, name, offset, value) ''' Overwrite bytes in the value of ``name`` starting at ``offset`` with ``value``. If ``offset`` plus the length of ``value`` exceeds the length of the original value, the new value will be larger than before. If ``offset`` exceeds the length of the original value, null bytes will be used to pad between the end of the previous value and the start of what's being injected. Returns the length of the new string. '''
shutdown(self, save=False, nosave=False) ''' Shutdown the Redis server. If Redis has persistence configured, data will be flushed before shutdown. If the "save" option is set, a data flush will be attempted even if there is no persistence configured. If the "nosave" option is set, no data flush will be attempted. The "save" and "nosave" options cannot both be set. ''' sinter(self, keys, *args) '''Return the intersection of sets specified by ``keys``''' sinterstore(self, dest, keys, *args) ''' Store the intersection of sets specified by ``keys`` into a new set named ``dest``. Returns the number of keys in the new set. '''
sismember(self, name, value) '''Return a boolean indicating if ``value`` is a member of set ``name``''' slaveof(self, host=None, port=None) ''' Set the server to be a replicated slave of the instance identified by the ``host`` and ``port``. If called without arguments, the instance is promoted to a master instead. '''
slowlog_get(self, num=None) ''' Get the entries from the slowlog. If ``num`` is specified, get the most recent ``num`` items. '''
slowlog_len(self) '''Get the number of items in the slowlog''' slowlog_reset(self) '''Remove all items in the slowlog''' smembers(self, name) '''Return all members of the set ``name``''' smove(self, src, dst, value) '''Move ``value`` from set ``src`` to set ``dst`` atomically''' sort(self, name, start=None, num=None, by=None, get=None, desc=False, alpha=False, store=None, groups=False) ''' Sort and return the list, set or sorted set at ``name``. ``start`` and ``num`` allow for paging through the sorted data ``by`` allows using an external key to weight and sort the items. Use an "*" to indicate where in the key the item value is located ``get`` allows for returning items from external keys rather than the sorted data itself. Use an "*" to indicate where int he key the item value is located ``desc`` allows for reversing the sort ``alpha`` allows for sorting lexicographically rather than numerically ``store`` allows for storing the result of the sort into the key ``store`` ``groups`` if set to True and if ``get`` contains at least two elements, sort will return a list of tuples, each containing the values fetched from the arguments to ``get``. '''
spop(self, name, count=None) '''Remove and return a random member of set ``name``''' srandmember(self, name, number=None) ''' If ``number`` is None, returns a random member of set ``name``. If ``number`` is supplied, returns a list of ``number`` random memebers of set ``name``. Note this is only available when running Redis 2.6+. '''
srem(self, name, *values) '''Remove ``values`` from set ``name``''' sscan(self, name, cursor=0, match=None, count=None) ''' Incrementally return lists of elements in a set. Also return a cursor indicating the scan position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns '''
sscan_iter(self, name, match=None, count=None) ''' Make an iterator using the SSCAN command so that the client doesn't need to remember the cursor position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns '''
strlen(self, name) '''Return the number of bytes stored in the value of ``name``''' substr(self, name, start, end=-1) ''' Return a substring of the string at key ``name``. ``start`` and ``end`` are 0-based integers specifying the portion of the string to return. '''
sunion(self, keys, *args) '''Return the union of sets specified by ``keys``''' sunionstore(self, dest, keys, *args) ''' Store the union of sets specified by ``keys`` into a new set named ``dest``. Returns the number of keys in the new set. '''
swapdb(self, first, second) '''Swap two databases''' time(self) ''' Returns the server time as a 2-item tuple of ints: (seconds since epoch, microseconds into this second). '''
touch(self, *args) ''' Alters the last access time of a key(s) ``*args``. A key is ignored if it does not exist. '''
transaction(self, func, *watches, **kwargs) ''' Convenience method for executing the callable `func` as a transaction while watching all keys specified in `watches`. The 'func' callable should expect a single argument which is a Pipeline object. '''
ttl(self, name) '''Returns the number of seconds until the key ``name`` will expire''' type(self, name) '''Returns the type of key ``name``''' unlink(self, *names) '''Unlink one or more keys specified by ``names``''' unwatch(self) '''Unwatches the value at key ``name``, or None of the key doesn't exist''' wait(self, num_replicas, timeout) ''' Redis synchronous replication That returns the number of replicas that processed the query when we finally have at least ``num_replicas``, or when the ``timeout`` was reached. '''
watch(self, *names) '''Watches the values at keys ``names``, or None if the key doesn't exist''' xack(self, name, groupname, *ids) ''' Acknowledges the successful processing of one or more messages. name: name of the stream. groupname: name of the consumer group. *ids: message ids to acknowlege. '''
xadd(self, name, fields, id='*', maxlen=None, approximate=True) ''' Add to a stream. name: name of the stream fields: dict of field/value pairs to insert into the stream id: Location to insert this record. By default it is appended. maxlen: truncate old stream members beyond this size approximate: actual stream length may be slightly more than maxlen '''
xclaim(self, name, groupname, consumername, min_idle_time, message_ids, idle=None, time=None, retrycount=None, force=False, justid=False) ''' Changes the ownership of a pending message. name: name of the stream. groupname: name of the consumer group. consumername: name of a consumer that claims the message. min_idle_time: filter messages that were idle less than this amount of milliseconds message_ids: non-empty list or tuple of message IDs to claim idle: optional. Set the idle time (last time it was delivered) of the message in ms time: optional integer. This is the same as idle but instead of a relative amount of milliseconds, it sets the idle time to a specific Unix time (in milliseconds). retrycount: optional integer. set the retry counter to the specified value. This counter is incremented every time a message is delivered again. force: optional boolean, false by default. Creates the pending message entry in the PEL even if certain specified IDs are not already in the PEL assigned to a different client. justid: optional boolean, false by default. Return just an array of IDs of messages successfully claimed, without returning the actual message '''
xdel(self, name, *ids) ''' Deletes one or more messages from a stream. name: name of the stream. *ids: message ids to delete. '''
xgroup_create(self, name, groupname, id='$', mkstream=False) ''' Create a new consumer group associated with a stream. name: name of the stream. groupname: name of the consumer group. id: ID of the last item in the stream to consider already delivered. '''
xgroup_delconsumer(self, name, groupname, consumername) ''' Remove a specific consumer from a consumer group. Returns the number of pending messages that the consumer had before it was deleted. name: name of the stream. groupname: name of the consumer group. consumername: name of consumer to delete '''
xgroup_destroy(self, name, groupname) ''' Destroy a consumer group. name: name of the stream. groupname: name of the consumer group. '''
xgroup_setid(self, name, groupname, id) ''' Set the consumer group last delivered ID to something else. name: name of the stream. groupname: name of the consumer group. id: ID of the last item in the stream to consider already delivered. '''
xinfo_consumers(self, name, groupname) ''' Returns general information about the consumers in the group. name: name of the stream. groupname: name of the consumer group. '''
xinfo_groups(self, name) ''' Returns general information about the consumer groups of the stream. name: name of the stream. '''
xinfo_stream(self, name) ''' Returns general information about the stream. name: name of the stream. '''
xlen(self, name) '''Returns the number of elements in a given stream.''' xpending(self, name, groupname) ''' Returns information about pending messages of a group. name: name of the stream. groupname: name of the consumer group. '''
xpending_range(self, name, groupname, min, max, count, consumername=None) ''' Returns information about pending messages, in a range. name: name of the stream. groupname: name of the consumer group. min: minimum stream ID. max: maximum stream ID. count: number of messages to return consumername: name of a consumer to filter by (optional). '''
xrange(self, name, min='-', max='+', count=None) ''' Read stream values within an interval. name: name of the stream. start: first stream ID. defaults to '-', meaning the earliest available. finish: last stream ID. defaults to '+', meaning the latest available. count: if set, only return this many items, beginning with the earliest available. '''
xread(self, streams, count=None, block=None) ''' Block and monitor multiple streams for new data. streams: a dict of stream names to stream IDs, where IDs indicate the last ID already seen. count: if set, only return this many items, beginning with the earliest available. block: number of milliseconds to wait, if nothing already present. '''
xreadgroup(self, groupname, consumername, streams, count=None, block=None, noack=False) ''' Read from a stream via a consumer group. groupname: name of the consumer group. consumername: name of the requesting consumer. streams: a dict of stream names to stream IDs, where IDs indicate the last ID already seen. count: if set, only return this many items, beginning with the earliest available. block: number of milliseconds to wait, if nothing already present. noack: do not add messages to the PEL '''
xrevrange(self, name, max='+', min='-', count=None) ''' Read stream values within an interval, in reverse order. name: name of the stream start: first stream ID. defaults to '+', meaning the latest available. finish: last stream ID. defaults to '-', meaning the earliest available. count: if set, only return this many items, beginning with the latest available. '''
xtrim(self, name, maxlen, approximate=True) ''' Trims old messages from a stream. name: name of the stream. maxlen: truncate old stream messages beyond this size approximate: actual stream length may be slightly more than maxlen '''
zadd(self, name, mapping, nx=False, xx=False, ch=False, incr=False) ''' Set any number of element-name, score pairs to the key ``name``. Pairs are specified as a dict of element-names keys to score values.
mapping {'element-name':'score'} ``nx`` forces ZADD to only create new elements and not to update scores for elements that already exist. ``xx`` forces ZADD to only update scores of elements that already exist. New elements will not be added. ``ch`` modifies the return value to be the numbers of elements changed. Changed elements include new elements that were added and elements whose scores changed. ``incr`` modifies ZADD to behave like ZINCRBY. In this mode only a single element/score pair can be specified and the score is the amount the existing score will be incremented by. When using this mode the return value of ZADD will be the new score of the element. The return value of ZADD varies based on the mode specified. With no options, ZADD returns the number of new elements added to the sorted set. '''
zcard(self, name) '''Return the number of elements in the sorted set ``name``''' zcount(self, name, min, max) ''' Returns the number of elements in the sorted set at key ``name`` with a score between ``min`` and ``max``. '''
zincrby(self, name, amount, value) '''Increment the score of ``value`` in sorted set ``name`` by ``amount``''' zinterstore(self, dest, keys, aggregate=None) ''' Intersect multiple sorted sets specified by ``keys`` into a new sorted set, ``dest``. Scores in the destination will be aggregated based on the ``aggregate``, or SUM if none is provided. '''
zlexcount(self, name, min, max) ''' Return the number of items in the sorted set ``name`` between the lexicographical range ``min`` and ``max``. '''
zpopmax(self, name, count=None) ''' Remove and return up to ``count`` members with the highest scores from the sorted set ``name``. '''
zpopmin(self, name, count=None) ''' Remove and return up to ``count`` members with the lowest scores from the sorted set ``name``. '''
zrange(self, name, start, end, desc=False, withscores=False, score_cast_func=<class 'float'>) ''' Return a range of values from sorted set ``name`` between ``start`` and ``end`` sorted in ascending order. ``start`` and ``end`` can be negative, indicating the end of the range. ``desc`` a boolean indicating whether to sort the results descendingly ``withscores`` indicates to return the scores along with the values. The return type is a list of (value, score) pairs ``score_cast_func`` a callable used to cast the score return value '''
zrangebylex(self, name, min, max, start=None, num=None) ''' Return the lexicographical range of values from sorted set ``name`` between ``min`` and ``max``. If ``start`` and ``num`` are specified, then return a slice of the range. '''
zrangebyscore(self, name, min, max, start=None, num=None, withscores=False, score_cast_func=<class 'float'>) ''' Return a range of values from the sorted set ``name`` with scores between ``min`` and ``max``. If ``start`` and ``num`` are specified, then return a slice of the range. ``withscores`` indicates to return the scores along with the values. The return type is a list of (value, score) pairs `score_cast_func`` a callable used to cast the score return value '''
zrank(self, name, value) ''' Returns a 0-based value indicating the rank of ``value`` in sorted set ``name`` '''
zrem(self, name, *values) '''Remove member ``values`` from sorted set ``name``''' zremrangebylex(self, name, min, max) ''' Remove all elements in the sorted set ``name`` between the lexicographical range specified by ``min`` and ``max``. Returns the number of elements removed. '''
zremrangebyrank(self, name, min, max) ''' Remove all elements in the sorted set ``name`` with ranks between ``min`` and ``max``. Values are 0-based, ordered from smallest score to largest. Values can be negative indicating the highest scores. Returns the number of elements removed '''
zremrangebyscore(self, name, min, max) ''' Remove all elements in the sorted set ``name`` with scores between ``min`` and ``max``. Returns the number of elements removed. '''
zrevrange(self, name, start, end, withscores=False, score_cast_func=<class 'float'>) ''' Return a range of values from sorted set ``name`` between ``start`` and ``end`` sorted in descending order. ``start`` and ``end`` can be negative, indicating the end of the range. ``withscores`` indicates to return the scores along with the values The return type is a list of (value, score) pairs ``score_cast_func`` a callable used to cast the score return value '''
zrevrangebylex(self, name, max, min, start=None, num=None) ''' Return the reversed lexicographical range of values from sorted set ``name`` between ``max`` and ``min``. If ``start`` and ``num`` are specified, then return a slice of the range. '''
zrevrangebyscore(self, name, max, min, start=None, num=None, withscores=False, score_cast_func=<class 'float'>) ''' Return a range of values from the sorted set ``name`` with scores between ``min`` and ``max`` in descending order. If ``start`` and ``num`` are specified, then return a slice of the range. ``withscores`` indicates to return the scores along with the values. The return type is a list of (value, score) pairs ``score_cast_func`` a callable used to cast the score return value '''
zrevrank(self, name, value) ''' Returns a 0-based value indicating the descending rank of ``value`` in sorted set ``name`` '''
zscan(self, name, cursor=0, match=None, count=None, score_cast_func=<class 'float'>) ''' Incrementally return lists of elements in a sorted set. Also return a cursor indicating the scan position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns ``score_cast_func`` a callable used to cast the score return value '''
zscan_iter(self, name, match=None, count=None, score_cast_func=<class 'float'>) ''' Make an iterator using the ZSCAN command so that the client doesn't need to remember the cursor position. ``match`` allows for filtering the keys by pattern ``count`` allows for hint the minimum number of returns ``score_cast_func`` a callable used to cast the score return value '''
zscore(self, name, value) '''Return the score of element ``value`` in sorted set ``name``''' zunionstore(self, dest, keys, aggregate=None) ''' Union multiple sorted sets specified by ``keys`` into a new sorted set, ``dest``. Scores in the destination will be aggregated based on the ``aggregate``, or SUM if none is provided. '''
'''Class methods defined here:''' from_url(url, db=None, **kwargs) from builtins.type ''' Return a Redis client object configured from the given URL For example:: redis://[:password]@localhost:6379/0 rediss://[:password]@localhost:6379/0 unix://[:password]@/path/to/socket.sock?db=0 Three URL schemes are supported: - ```redis://`` <http://www.iana.org/assignments/uri-schemes/prov/redis>`_ creates a normal TCP socket connection - ```rediss://`` <http://www.iana.org/assignments/uri-schemes/prov/rediss>`_ creates a SSL wrapped TCP socket connection - ``unix://`` creates a Unix Domain Socket connection There are several ways to specify a database number. The parse function will return the first specified option: 1. A ``db`` querystring option, e.g. redis://localhost?db=0 2. If using the redis:// scheme, the path argument of the url, e.g. redis://localhost/0 3. The ``db`` argument to this function. If none of these options are specified, db=0 is used. Any additional querystring arguments and keyword arguments will be passed along to the ConnectionPool class's initializer. In the case of conflicting arguments, querystring arguments always win. '''
'''Data descriptors defined here:''' __dict__ '''dictionary for instance variables (if defined)''' __weakref__ '''list of weak references to the object (if defined)''' '''Data and other attributes defined here:''' RESPONSE_CALLBACKS = {'AUTH': <class 'bool'>, 'BGREWRITEAOF': <functio...
|