Skip to content

Commit 8d6ffe3

Browse files
committed
docs(valkey): add minimal docs for the new valkey protocol
1 parent f7ae642 commit 8d6ffe3

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

README.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
:Download: https://pypi.org/project/kombu/
1010
:Source: https://github.com/celery/kombu/
1111
:DeepWiki: |deepwiki|
12-
:Keywords: messaging, amqp, rabbitmq, redis, mongodb, python, queue
12+
:Keywords: messaging, amqp, rabbitmq, redis, valkey, mongodb, python, queue
1313

1414
About
1515
=====
@@ -33,7 +33,7 @@ Features
3333
* AMQP transport using the `py-amqp`_, or `qpid-python`_ libraries.
3434

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

3939
* In-memory transport for unit testing.
@@ -60,6 +60,7 @@ and the `Wikipedia article about AMQP`_.
6060
.. _`py-amqp`: https://pypi.org/project/amqp/
6161
.. _`qpid-python`: https://pypi.org/project/qpid-python/
6262
.. _`Redis`: https://redis.io
63+
.. _`Valkey`: https://valkey.io
6364
.. _`Amazon SQS`: https://aws.amazon.com/sqs/
6465
.. _`Zookeeper`: https://zookeeper.apache.org/
6566
.. _`Rabbits and warrens`: http://web.archive.org/web/20160323134044/http://blogs.digitar.com/jjww/2009/01/rabbits-and-warrens/
@@ -85,6 +86,8 @@ Transport Comparison
8586
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
8687
| *redis* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes | No |
8788
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
89+
| *valkey* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes | No |
90+
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
8891
| *mongodb* | Virtual | Yes | Yes | Yes | Yes | Yes |
8992
+---------------+----------+------------+------------+---------------+--------------+-----------------------+
9093
| *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ | No | No |

docs/userguide/connections.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,9 @@ All of these are valid URLs:
135135
# Using Redis sentinel
136136
sentinel://sentinel1:26379;sentinel://sentinel2:26379
137137
138+
# Using Valkey
139+
valkey://localhost:6379/
140+
138141
# Using Qpid
139142
qpid://localhost/
140143
@@ -230,6 +233,8 @@ Transport Comparison
230233
+---------------+----------+------------+------------+---------------+--------------+
231234
| *redis* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes |
232235
+---------------+----------+------------+------------+---------------+--------------+
236+
| *valkey* | Virtual | Yes | Yes | Yes (PUB/SUB) | Yes |
237+
+---------------+----------+------------+------------+---------------+--------------+
233238
| *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ | No |
234239
+---------------+----------+------------+------------+---------------+--------------+
235240
| *zookeeper* | Virtual | Yes | Yes [#f1]_ | No | Yes |

kombu/transport/redis.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@
2525
2626
sentinel://[USER:PASSWORD@]SENTINEL_ADDRESS[:PORT]
2727
28+
29+
To use Valkey (which was originally a redis fork),
30+
the connection string has the following format:
31+
32+
.. code-block::
33+
34+
valkey://[USER:PASSWORD@]VALKEY_ADDRESS[:PORT][/VIRTUALHOST]
35+
valkeys://[USER:PASSWORD@]VALKEY_ADDRESS[:PORT][/VIRTUALHOST]
36+
37+
2838
Transport Options
2939
=================
3040
* ``sep``

0 commit comments

Comments
 (0)