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
use crate::{
client::{prepare_command, PreparedCommand},
resp::{
cmd, FromSingleValue, FromValueArray, FromValue, HashMapExt, KeyValueArgsCollection,
SingleArg, SingleArgCollection, Value,
},
Result,
};
use std::collections::HashMap;
/// A group of Redis commands related to [`Top-K`](https://redis.io/docs/stack/bloom/)
///
/// # See Also
/// [Top-K Commands](https://redis.io/commands/?group=topk)
pub trait TopKCommands {
/// Adds an item to the data structure.
///
/// Multiple items can be added at once.
/// If an item enters the Top-K list, the item which is expelled is returned.
/// This allows dynamic heavy-hitter detection of items being entered or expelled from Top-K list.
///
/// # Arguments
/// * `key` - Name of sketch where item is added.
/// * `items` - Item/s to be added.
///
/// # Return
/// Collection of items if an element was dropped from the TopK list, Null reply otherwise.
///
/// # See Also
/// * [<https://redis.io/commands/topk.add/>](https://redis.io/commands/topk.add/)
#[must_use]
fn topk_add<I: SingleArg, R: FromSingleValue, RR: FromValueArray<R>>(
&mut self,
key: impl SingleArg,
items: impl SingleArgCollection<I>,
) -> PreparedCommand<Self, RR>
where
Self: Sized,
{
prepare_command(self, cmd("TOPK.ADD").arg(key).arg(items))
}
/// Increase the score of an item in the data structure by increment.
///
/// Multiple items' score can be increased at once.
/// If an item enters the Top-K list, the item which is expelled is returned.
///
/// # Arguments
/// * `key` - Name of sketch where item is added.
/// * `items` - collection of tuples:
/// * `item` - Item to be added
/// * `increment` - increment to current item score. \
/// Increment must be greater or equal to 1. \
/// Increment is limited to 100,000 to avoid server freeze.
///
/// # Return
/// Collection of items if an element was dropped from the TopK list, Null reply otherwise.
///
/// # See Also
/// * [<https://redis.io/commands/topk.incrby/>](https://redis.io/commands/topk.incrby/)
#[must_use]
fn topk_incrby<I: SingleArg, R: FromSingleValue, RR: FromValueArray<R>>(
&mut self,
key: impl SingleArg,
items: impl KeyValueArgsCollection<I, i64>,
) -> PreparedCommand<Self, RR>
where
Self: Sized,
{
prepare_command(self, cmd("TOPK.INCRBY").arg(key).arg(items))
}
/// Returns number of required items (k), width, depth and decay values.
///
/// # Arguments
/// * `key` - Name of sketch
///
/// # Return
/// An instance of [`TopKInfoResult`](TopKInfoResult)
///
/// # See Also
/// * [<https://redis.io/commands/topk.info/>](https://redis.io/commands/topk.info/)
#[must_use]
fn topk_info(&mut self, key: impl SingleArg) -> PreparedCommand<Self, TopKInfoResult>
where
Self: Sized,
{
prepare_command(self, cmd("TOPK.INFO").arg(key))
}
/// Return full list of items in Top K list.
///
/// # Arguments
/// * `key` - Key under which the sketch is to be found.
///
/// # Return
/// a collection of k (or less) items in Top K list.
///
/// # See Also
/// * [<https://redis.io/commands/topk.list/>](https://redis.io/commands/topk.list/)
#[must_use]
fn topk_list<R: FromSingleValue, RR: FromValueArray<R>>(
&mut self,
key: impl SingleArg,
) -> PreparedCommand<Self, RR>
where
Self: Sized,
{
prepare_command(self, cmd("TOPK.LIST").arg(key))
}
/// Return full list of items in Top K list.
///
/// # Arguments
/// * `key` - Key under which the sketch is to be found.
///
/// # Return
/// a collection of k (or less) pairs of items in Top K list. Each pair holds:
/// * the name of the item
/// * the count of the item
///
/// # See Also
/// * [<https://redis.io/commands/topk.list/>](https://redis.io/commands/topk.list/)
#[must_use]
fn topk_list_with_count<R: FromSingleValue, RR: FromValueArray<(R, usize)>>(
&mut self,
key: impl SingleArg,
) -> PreparedCommand<Self, RR>
where
Self: Sized,
{
prepare_command(self, cmd("TOPK.LIST").arg(key).arg("WITHCOUNT"))
}
/// Return full list of items in Top K list.
///
/// # Arguments
/// * `key` - Key under which the sketch is to be found.
/// * `items` - Item/s to be queried.
///
/// # Return
/// a collection of k boolean:
/// * `true` - if item is in Top-K
/// * `false` - otherwise
///
/// # See Also
/// * [<https://redis.io/commands/topk.query/>](https://redis.io/commands/topk.query/)
#[must_use]
fn topk_query<I: SingleArg, R: FromValueArray<bool>>(
&mut self,
key: impl SingleArg,
items: impl SingleArgCollection<I>,
) -> PreparedCommand<Self, R>
where
Self: Sized,
{
prepare_command(self, cmd("TOPK.QUERY").arg(key).arg(items))
}
/// Initializes a TopK with specified parameters.
///
/// # Arguments
/// * `key` - Key under which the sketch is to be found.
/// * `topk` - Number of top occurring items to keep.
/// * `width_depth_decay` - Optional paramaters:
/// * `width` - Number of counters kept in each array. (Default 8)
/// * `depth` - Number of arrays. (Default 7)
/// * `decay` - The probability of reducing a counter in an occupied bucket. \
/// It is raised to power of it's counter (decay ^ bucket\[i\].counter). \
/// Therefore, as the counter gets higher, the chance of a reduction is being reduced. (Default 0.9)
///
/// # See Also
/// * [<https://redis.io/commands/topk.reserve/>](https://redis.io/commands/topk.reserve/)
#[must_use]
fn topk_reserve(
&mut self,
key: impl SingleArg,
topk: usize,
width_depth_decay: Option<(usize, usize, f64)>,
) -> PreparedCommand<Self, ()>
where
Self: Sized,
{
prepare_command(
self,
cmd("TOPK.RESERVE")
.arg(key)
.arg(topk)
.arg(width_depth_decay),
)
}
}
/// Result for the [`topk_info`](TopKCommands::topk_info) command.
#[derive(Debug)]
pub struct TopKInfoResult {
/// The number of required items
pub k: usize,
/// Number of counters kept in each array.
pub width: usize,
/// Number of arrays. (
pub depth: usize,
/// The probability of reducing a counter in an occupied bucket.
///
/// It is raised to power of it's counter (decay ^ bucket\[i\].counter).
/// Therefore, as the counter gets higher, the chance of a reduction is being reduced.
pub decay: f64,
}
impl FromValue for TopKInfoResult {
fn from_value(value: Value) -> Result<Self> {
let mut values: HashMap<String, Value> = value.into()?;
Ok(Self {
k: values.remove_or_default("k").into()?,
width: values.remove_or_default("width").into()?,
depth: values.remove_or_default("depth").into()?,
decay: values.remove_or_default("decay").into()?,
})
}
}