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
use crate::{
  commands,
  error::RedisError,
  interfaces::{ClientLike, RedisResult},
  protocol::types::ClusterRouting,
  types::{
    ClusterFailoverFlag,
    ClusterInfo,
    ClusterResetFlag,
    ClusterSetSlotState,
    FromRedis,
    MultipleHashSlots,
    RedisKey,
    RedisValue,
  },
};
use bytes_utils::Str;

/// Functions that implement the [cluster](https://redis.io/commands#cluster) interface.
#[async_trait]
pub trait ClusterInterface: ClientLike + Sized {
  /// Read the cached cluster state used for routing commands to the correct cluster nodes.
  fn cached_cluster_state(&self) -> Option<ClusterRouting> {
    self.inner().with_cluster_state(|state| Ok(state.clone())).ok()
  }

  /// Read the number of known primary cluster nodes, or `0` if the cluster state is not known.
  fn num_primary_cluster_nodes(&self) -> usize {
    self
      .inner()
      .with_cluster_state(|state| Ok(state.unique_primary_nodes().len()))
      .unwrap_or(0)
  }

  /// Update the cached cluster state and add or remove any changed cluster node connections.
  async fn sync_cluster(&self) -> Result<(), RedisError> {
    commands::cluster::sync_cluster(self).await
  }

  /// Advances the cluster config epoch.
  ///
  /// <https://redis.io/commands/cluster-bumpepoch>
  async fn cluster_bumpepoch<R>(&self) -> RedisResult<R>
  where
    R: FromRedis,
  {
    commands::cluster::cluster_bumpepoch(self).await?.convert()
  }

  /// Deletes all slots from a node.
  ///
  /// <https://redis.io/commands/cluster-flushslots>
  async fn cluster_flushslots(&self) -> RedisResult<()> {
    commands::cluster::cluster_flushslots(self).await
  }

  /// Returns the node's id.
  ///
  /// <https://redis.io/commands/cluster-myid>
  async fn cluster_myid<R>(&self) -> RedisResult<R>
  where
    R: FromRedis,
  {
    commands::cluster::cluster_myid(self).await?.convert()
  }

  /// Read the current cluster node configuration.
  ///
  /// Note: The client keeps a cached, parsed version of the cluster state in memory available at
  /// [cached_cluster_state](Self::cached_cluster_state).
  ///
  /// <https://redis.io/commands/cluster-nodes>
  async fn cluster_nodes(&self) -> RedisResult<String> {
    commands::cluster::cluster_nodes(self).await?.convert()
  }

  /// Forces a node to save the nodes.conf configuration on disk.
  ///
  /// <https://redis.io/commands/cluster-saveconfig>
  async fn cluster_saveconfig(&self) -> RedisResult<()> {
    commands::cluster::cluster_saveconfig(self).await
  }

  /// CLUSTER SLOTS returns details about which cluster slots map to which Redis instances.
  ///
  /// <https://redis.io/commands/cluster-slots>
  async fn cluster_slots(&self) -> RedisResult<RedisValue> {
    commands::cluster::cluster_slots(self).await
  }

  /// CLUSTER INFO provides INFO style information about Redis Cluster vital parameters.
  ///
  /// <https://redis.io/commands/cluster-info>
  async fn cluster_info(&self) -> RedisResult<ClusterInfo> {
    commands::cluster::cluster_info(self).await
  }

  /// This command is useful in order to modify a node's view of the cluster configuration. Specifically it assigns a
  /// set of hash slots to the node receiving the command.
  ///
  /// <https://redis.io/commands/cluster-addslots>
  async fn cluster_add_slots<S>(&self, slots: S) -> RedisResult<()>
  where
    S: Into<MultipleHashSlots> + Send,
  {
    into!(slots);
    commands::cluster::cluster_add_slots(self, slots).await
  }

  /// The command returns the number of failure reports for the specified node.
  ///
  /// <https://redis.io/commands/cluster-count-failure-reports>
  async fn cluster_count_failure_reports<R, S>(&self, node_id: S) -> RedisResult<R>
  where
    R: FromRedis,
    S: Into<Str> + Send,
  {
    into!(node_id);
    commands::cluster::cluster_count_failure_reports(self, node_id)
      .await?
      .convert()
  }

  /// Returns the number of keys in the specified Redis Cluster hash slot.
  ///
  /// <https://redis.io/commands/cluster-countkeysinslot>
  async fn cluster_count_keys_in_slot<R>(&self, slot: u16) -> RedisResult<R>
  where
    R: FromRedis,
  {
    commands::cluster::cluster_count_keys_in_slot(self, slot)
      .await?
      .convert()
  }

  /// The CLUSTER DELSLOTS command asks a particular Redis Cluster node to forget which master is serving the hash
  /// slots specified as arguments.
  ///
  /// <https://redis.io/commands/cluster-delslots>
  async fn cluster_del_slots<S>(&self, slots: S) -> RedisResult<()>
  where
    S: Into<MultipleHashSlots> + Send,
  {
    into!(slots);
    commands::cluster::cluster_del_slots(self, slots).await
  }

  /// This command, that can only be sent to a Redis Cluster replica node, forces the replica to start a manual
  /// failover of its master instance.
  ///
  /// <https://redis.io/commands/cluster-failover>
  async fn cluster_failover(&self, flag: Option<ClusterFailoverFlag>) -> RedisResult<()> {
    commands::cluster::cluster_failover(self, flag).await
  }

  /// The command is used in order to remove a node, specified via its node ID, from the set of known nodes of the
  /// Redis Cluster node receiving the command. In other words the specified node is removed from the nodes table of
  /// the node receiving the command.
  ///
  /// <https://redis.io/commands/cluster-forget>
  async fn cluster_forget<S>(&self, node_id: S) -> RedisResult<()>
  where
    S: Into<Str> + Send,
  {
    into!(node_id);
    commands::cluster::cluster_forget(self, node_id).await
  }

  /// The command returns an array of keys names stored in the contacted node and hashing to the specified hash slot.
  ///
  /// <https://redis.io/commands/cluster-getkeysinslot>
  async fn cluster_get_keys_in_slot<R>(&self, slot: u16, count: u64) -> RedisResult<R>
  where
    R: FromRedis,
  {
    commands::cluster::cluster_get_keys_in_slot(self, slot, count)
      .await?
      .convert()
  }

  /// Returns an integer identifying the hash slot the specified key hashes to.
  ///
  /// <https://redis.io/commands/cluster-keyslot>
  async fn cluster_keyslot<R, K>(&self, key: K) -> RedisResult<R>
  where
    R: FromRedis,
    K: Into<RedisKey> + Send,
  {
    into!(key);
    commands::cluster::cluster_keyslot(self, key).await?.convert()
  }

  /// CLUSTER MEET is used in order to connect different Redis nodes with cluster support enabled, into a working
  /// cluster.
  ///
  /// <https://redis.io/commands/cluster-meet>
  async fn cluster_meet<S>(&self, ip: S, port: u16) -> RedisResult<()>
  where
    S: Into<Str> + Send,
  {
    into!(ip);
    commands::cluster::cluster_meet(self, ip, port).await
  }

  /// The command reconfigures a node as a replica of the specified master. If the node receiving the command is an
  /// empty master, as a side effect of the command, the node role is changed from master to replica.
  ///
  /// <https://redis.io/commands/cluster-replicate>
  async fn cluster_replicate<S>(&self, node_id: S) -> RedisResult<()>
  where
    S: Into<Str> + Send,
  {
    into!(node_id);
    commands::cluster::cluster_replicate(self, node_id).await
  }

  /// The command provides a list of replica nodes replicating from the specified master node.
  ///
  /// <https://redis.io/commands/cluster-replicas>
  async fn cluster_replicas<S>(&self, node_id: S) -> RedisResult<String>
  where
    S: Into<Str> + Send,
  {
    into!(node_id);
    commands::cluster::cluster_replicas(self, node_id).await?.convert()
  }

  /// Reset a Redis Cluster node, in a more or less drastic way depending on the reset type, that can be hard or soft.
  /// Note that this command does not work for masters if they hold one or more keys, in that case to completely
  /// reset a master node keys must be removed first, e.g. by using FLUSHALL first, and then CLUSTER RESET.
  ///
  /// <https://redis.io/commands/cluster-reset>
  async fn cluster_reset(&self, mode: Option<ClusterResetFlag>) -> RedisResult<()> {
    commands::cluster::cluster_reset(self, mode).await
  }

  /// This command sets a specific config epoch in a fresh node.
  ///
  /// <https://redis.io/commands/cluster-set-config-epoch>
  async fn cluster_set_config_epoch(&self, epoch: u64) -> RedisResult<()> {
    commands::cluster::cluster_set_config_epoch(self, epoch).await
  }

  /// CLUSTER SETSLOT is responsible of changing the state of a hash slot in the receiving node in different ways.
  ///
  /// <https://redis.io/commands/cluster-setslot>
  async fn cluster_setslot(&self, slot: u16, state: ClusterSetSlotState) -> RedisResult<()> {
    commands::cluster::cluster_setslot(self, slot, state).await
  }
}