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
|
# frozen_string_literal: true
class Redis
module Commands
module Sets
# Get the number of members in a set.
#
# @param [String] key
# @return [Integer]
def scard(key)
send_command([:scard, key])
end
# Add one or more members to a set.
#
# @param [String] key
# @param [String, Array<String>] member one member, or array of members
# @return [Integer] The number of members that were successfully added
def sadd(key, *members)
members.flatten!(1)
send_command([:sadd, key].concat(members))
end
# Add one or more members to a set.
#
# @param [String] key
# @param [String, Array<String>] member one member, or array of members
# @return [Boolean] Wether at least one member was successfully added.
def sadd?(key, *members)
members.flatten!(1)
send_command([:sadd, key].concat(members), &Boolify)
end
# Remove one or more members from a set.
#
# @param [String] key
# @param [String, Array<String>] member one member, or array of members
# @return [Integer] The number of members that were successfully removed
def srem(key, *members)
members.flatten!(1)
send_command([:srem, key].concat(members))
end
# Remove one or more members from a set.
#
# @param [String] key
# @param [String, Array<String>] member one member, or array of members
# @return [Boolean] Wether at least one member was successfully removed.
def srem?(key, *members)
members.flatten!(1)
send_command([:srem, key].concat(members), &Boolify)
end
# Remove and return one or more random member from a set.
#
# @param [String] key
# @return [String]
# @param [Integer] count
def spop(key, count = nil)
if count.nil?
send_command([:spop, key])
else
send_command([:spop, key, Integer(count)])
end
end
# Get one or more random members from a set.
#
# @param [String] key
# @param [Integer] count
# @return [String]
def srandmember(key, count = nil)
if count.nil?
send_command([:srandmember, key])
else
send_command([:srandmember, key, count])
end
end
# Move a member from one set to another.
#
# @param [String] source source key
# @param [String] destination destination key
# @param [String] member member to move from `source` to `destination`
# @return [Boolean]
def smove(source, destination, member)
send_command([:smove, source, destination, member], &Boolify)
end
# Determine if a given value is a member of a set.
#
# @param [String] key
# @param [String] member
# @return [Boolean]
def sismember(key, member)
send_command([:sismember, key, member], &Boolify)
end
# Determine if multiple values are members of a set.
#
# @param [String] key
# @param [String, Array<String>] members
# @return [Array<Boolean>]
def smismember(key, *members)
members.flatten!(1)
send_command([:smismember, key].concat(members)) do |reply|
reply.map(&Boolify)
end
end
# Get all the members in a set.
#
# @param [String] key
# @return [Array<String>]
def smembers(key)
send_command([:smembers, key])
end
# Subtract multiple sets.
#
# @param [String, Array<String>] keys keys pointing to sets to subtract
# @return [Array<String>] members in the difference
def sdiff(*keys)
keys.flatten!(1)
send_command([:sdiff].concat(keys))
end
# Subtract multiple sets and store the resulting set in a key.
#
# @param [String] destination destination key
# @param [String, Array<String>] keys keys pointing to sets to subtract
# @return [Integer] number of elements in the resulting set
def sdiffstore(destination, *keys)
keys.flatten!(1)
send_command([:sdiffstore, destination].concat(keys))
end
# Intersect multiple sets.
#
# @param [String, Array<String>] keys keys pointing to sets to intersect
# @return [Array<String>] members in the intersection
def sinter(*keys)
keys.flatten!(1)
send_command([:sinter].concat(keys))
end
# Intersect multiple sets and store the resulting set in a key.
#
# @param [String] destination destination key
# @param [String, Array<String>] keys keys pointing to sets to intersect
# @return [Integer] number of elements in the resulting set
def sinterstore(destination, *keys)
keys.flatten!(1)
send_command([:sinterstore, destination].concat(keys))
end
# Add multiple sets.
#
# @param [String, Array<String>] keys keys pointing to sets to unify
# @return [Array<String>] members in the union
def sunion(*keys)
keys.flatten!(1)
send_command([:sunion].concat(keys))
end
# Add multiple sets and store the resulting set in a key.
#
# @param [String] destination destination key
# @param [String, Array<String>] keys keys pointing to sets to unify
# @return [Integer] number of elements in the resulting set
def sunionstore(destination, *keys)
keys.flatten!(1)
send_command([:sunionstore, destination].concat(keys))
end
# Scan a set
#
# @example Retrieve the first batch of keys in a set
# redis.sscan("set", 0)
#
# @param [String, Integer] cursor the cursor of the iteration
# @param [Hash] options
# - `:match => String`: only return keys matching the pattern
# - `:count => Integer`: return count keys at most per iteration
#
# @return [String, Array<String>] the next cursor and all found members
#
# See the [Redis Server SSCAN documentation](https://redis.io/docs/latest/commands/sscan/) for further details
def sscan(key, cursor, **options)
_scan(:sscan, cursor, [key], **options)
end
# Scan a set
#
# @example Retrieve all of the keys in a set
# redis.sscan_each("set").to_a
# # => ["key1", "key2", "key3"]
#
# @param [Hash] options
# - `:match => String`: only return keys matching the pattern
# - `:count => Integer`: return count keys at most per iteration
#
# @return [Enumerator] an enumerator for all keys in the set
#
# See the [Redis Server SSCAN documentation](https://redis.io/docs/latest/commands/sscan/) for further details
def sscan_each(key, **options, &block)
return to_enum(:sscan_each, key, **options) unless block_given?
cursor = 0
loop do
cursor, keys = sscan(key, cursor, **options)
keys.each(&block)
break if cursor == "0"
end
end
end
end
end
|