Skip to content

Support read from replica on clsuter pubsub subscribe #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 15, 2025
Merged

Support read from replica on clsuter pubsub subscribe #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions redis/cluster.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1646,7 +1646,7 @@ class ClusterPubSub(PubSub):
https://redis-py-cluster.readthedocs.io/en/stable/pubsub.html
"""

def __init__(self, redis_cluster, node=None, host=None, port=None, **kwargs):
def __init__(self, redis_cluster, node=None, host=None, port=None, replica=False, **kwargs):
"""
When a pubsub instance is created without specifying a node, a single
node will be transparently chosen for the pubsub connection on the
Expand All @@ -1661,6 +1661,7 @@ def __init__(self, redis_cluster, node=None, host=None, port=None, **kwargs):
:type port: int
"""
self.node = None
self.replica = replica
self.set_pubsub_node(redis_cluster, node, host, port)
connection_pool = (
None
Expand Down Expand Up @@ -1794,7 +1795,7 @@ def get_sharded_message(
if message["channel"] in self.pending_unsubscribe_shard_channels:
self.pending_unsubscribe_shard_channels.remove(message["channel"])
self.shard_channels.pop(message["channel"], None)
node = self.cluster.get_node_from_key(message["channel"])
node = self.cluster.get_node_from_key(message["channel"], self.replica)
if self.node_pubsub_mapping[node.name].subscribed is False:
self.node_pubsub_mapping.pop(node.name)
if not self.channels and not self.patterns and not self.shard_channels:
Expand All @@ -1811,7 +1812,7 @@ def ssubscribe(self, *args, **kwargs):
s_channels = dict.fromkeys(args)
s_channels.update(kwargs)
for s_channel, handler in s_channels.items():
node = self.cluster.get_node_from_key(s_channel)
node = self.cluster.get_node_from_key(s_channel, self.replica)
pubsub = self._get_node_pubsub(node)
if handler:
pubsub.ssubscribe(**{s_channel: handler})
Expand All @@ -1832,7 +1833,7 @@ def sunsubscribe(self, *args):
args = self.shard_channels

for s_channel in args:
node = self.cluster.get_node_from_key(s_channel)
node = self.cluster.get_node_from_key(s_channel, self.replica)
p = self._get_node_pubsub(node)
p.sunsubscribe(s_channel)
self.pending_unsubscribe_shard_channels.update(
Expand Down