aioredis

asyncio (PEP 3156) Redis client library.

The library is intended to provide simple and clear interface to Redis based on asyncio.

Features

hiredis parser	Yes
Pure-python parser	Yes
Low-level & High-level APIs	Yes
Connections Pool	Yes
Pipelining support	Yes
Pub/Sub support	Yes
Sentinel support	Yes
Redis Cluster support	WIP
Trollius (python 2.7)	No
Tested CPython versions	3.5.3, 3.6, 3.7 1
Tested PyPy3 versions	pypy3.5-7.0 pypy3.6-7.1.1
Tested for Redis server	2.6, 2.8, 3.0, 3.2, 4.0 5.0
Support for dev Redis server	through low-level API

1

For Python 3.3, 3.4 support use aioredis v0.3.

Installation

The easiest way to install aioredis is by using the package on PyPi:

pip install aioredis

Requirements

• Python 3.5.3+

• hiredis

Benchmarks

Benchmarks can be found here: https://github.com/popravich/python-redis-benchmark

Contribute

• Issue Tracker: https://github.com/aio-libs/aioredis/issues

• Google Group: https://groups.google.com/forum/#!forum/aio-libs

• Gitter: https://gitter.im/aio-libs/Lobby

• Source Code: https://github.com/aio-libs/aioredis

• Contributor’s guide: Contributing

Feel free to file an issue or make pull request if you find any bugs or have some suggestions for library improvement.

License

The aioredis is offered under MIT license.

---

Contents

• Getting started
  • Installation
    • Without dependencies
    • Installing latest version from Git
  • Connecting
    • Connecting to specific DB
    • Connecting to password-protected Redis instance
  • Result messages decoding
  • Multi/Exec transactions
  • Pub/Sub mode
  • Sentinel client
• aioredis — API Reference
  • Connection
  • Connections Pool
  • Exceptions
    • Exceptions Hierarchy
  • Pub/Sub Channel object
  • Commands Interface
• aioredis.Redis — Commands Mixins Reference
  • Generic commands
  • Geo commands
    • Geo commands result wrappers
  • Strings commands
  • Hash commands
  • List commands
  • Set commands
  • Sorted Set commands
  • Server commands
  • HyperLogLog commands
  • Transaction commands
  • Scripting commands
  • Server commands
  • Pub/Sub commands
  • Cluster commands
  • Streams commands
• aioredis.abc — Interfaces Reference
• aioredis.pubsub — Pub/Sub Tools Reference
• aioredis.sentinel — Sentinel Client Reference
  • RedisSentinel
  • SentinelPool
• Examples of aioredis usage
  • Commands example
  • Transaction example
  • Pub/Sub example
  • Scan command example
  • Sentinel client
  • Low-level connection usage example
  • Connections pool example
• Contributing
  • Code style
  • Running tests
    • SSL tests
    • Different Redis server versions
    • UVLoop
  • Writing tests
    • Fixtures
    • redis_version tests helper
• Migrating from v0.3 to v1.0
  • aioredis.create_pool
  • aioredis.create_reconnecting_redis
  • aioredis.Redis
  • Blocking operations and connection sharing
  • Sorted set commands return values
  • Hash hscan command now returns list of tuples
• Releases
  • 1.3.1 (2019-12-02)
    • Bugfixes
    • Deprecations and Removals
    • Misc
  • 1.3.0 (2019-09-24)
    • Features
    • Bugfixes
    • Improved Documentation
    • Misc
  • 1.2.0 (2018-10-24)
  • 1.1.0 (2018-02-16)
  • 1.0.0 (2017-11-17)
  • 0.3.5 (2017-11-08)
  • 0.3.4 (2017-10-25)
  • 0.3.3 (2017-06-30)
  • 0.3.2 (2017-06-21)
  • 0.3.1 (2017-05-09)
  • 0.3.0 (2017-01-11)
  • 0.2.9 (2016-10-24)
  • 0.2.8 (2016-07-22)
  • 0.2.7 (2016-05-27)
  • 0.2.6 (2016-03-30)
  • 0.2.5 (2016-03-02)
  • 0.2.4 (2015-10-13)
  • 0.2.3 (2015-08-14)
  • 0.2.2 (2015-07-07)
  • 0.2.1 (2015-07-06)
  • 0.2.0 (2015-06-04)
  • 0.1.5 (2014-12-09)
  • 0.1.4 (2014-09-22)
  • 0.1.3 (2014-08-08)
  • 0.1.2 (2014-07-31)
  • 0.1.1 (2014-07-07)
  • 0.1.0 (2014-06-24)
• Glossary

Indices and tables

• Index

• Module Index

• Search Page