Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
:Download: https://pypi.org/project/kombu/
:Source: https://github.com/celery/kombu/
:DeepWiki: |deepwiki|
:Keywords: messaging, amqp, rabbitmq, redis, mongodb, python, queue
:Keywords: messaging, amqp, rabbitmq, redis, valkey, mongodb, python, queue

About
=====
Expand All @@ -33,7 +33,7 @@ Features
* AMQP transport using the `py-amqp`_, or `qpid-python`_ libraries.

* Virtual transports makes it really easy to add support for non-AMQP
transports. There is already built-in support for `Redis`_,
transports. There is already built-in support for `Redis`_, `Valkey`_,
`Amazon SQS`_, `ZooKeeper`_, `SoftLayer MQ`_, `MongoDB`_ and `Pyro`_.

* In-memory transport for unit testing.
Expand All @@ -60,6 +60,7 @@ and the `Wikipedia article about AMQP`_.
.. _`py-amqp`: https://pypi.org/project/amqp/
.. _`qpid-python`: https://pypi.org/project/qpid-python/
.. _`Redis`: https://redis.io
.. _`Valkey`: https://valkey.io
.. _`Amazon SQS`: https://aws.amazon.com/sqs/
.. _`Zookeeper`: https://zookeeper.apache.org/
.. _`Rabbits and warrens`: http://web.archive.org/web/20160323134044/http://blogs.digitar.com/jjww/2009/01/rabbits-and-warrens/
Expand All @@ -85,6 +86,8 @@ Transport Comparison
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
| *redis* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes | No |
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
| *valkey* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes | No |
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
| *mongodb* | Virtual | Yes | Yes | Yes | Yes | Yes |
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
| *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ | No | No |
Expand Down
5 changes: 5 additions & 0 deletions docs/userguide/connections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,9 @@ All of these are valid URLs:
# Using Redis sentinel
sentinel://sentinel1:26379;sentinel://sentinel2:26379

# Using Valkey
valkey://localhost:6379/

# Using Qpid
qpid://localhost/

Expand Down Expand Up @@ -230,6 +233,8 @@ Transport Comparison
+---------------+----------+------------+------------+---------------+--------------+
| *redis* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes |
+---------------+----------+------------+------------+---------------+--------------+
| *valkey* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes |
+---------------+----------+------------+------------+---------------+--------------+
| *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ | No |
+---------------+----------+------------+------------+---------------+--------------+
| *zookeeper* | Virtual | Yes | Yes [#f1]_ | No | Yes |
Expand Down
2 changes: 2 additions & 0 deletions kombu/transport/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ def supports_librabbitmq() -> bool | None:
'memory': 'kombu.transport.memory:Transport',
'redis': 'kombu.transport.redis:Transport',
'rediss': 'kombu.transport.redis:Transport',
'valkey': 'kombu.transport.redis:Transport',
'valkeys': 'kombu.transport.redis:Transport',
'SQS': 'kombu.transport.SQS:Transport',
'sqs': 'kombu.transport.SQS:Transport',
'mongodb': 'kombu.transport.mongodb:Transport',
Expand Down
10 changes: 10 additions & 0 deletions kombu/transport/redis.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@

sentinel://[USER:PASSWORD@]SENTINEL_ADDRESS[:PORT]


To use Valkey (which was originally a Redis fork),
the connection string has the following format:

.. code-block::

valkey://[USER:PASSWORD@]VALKEY_ADDRESS[:PORT][/VIRTUALHOST]
valkeys://[USER:PASSWORD@]VALKEY_ADDRESS[:PORT][/VIRTUALHOST]


Transport Options
=================
* ``sep``
Expand Down