Module: Valkey::Commands::SetCommands

Included in:
Valkey::Commands
Defined in:
lib/valkey/commands/set_commands.rb

Overview

this module contains commands related to set data type.

See Also:

Instance Method Summary collapse

Instance Method Details

#sadd(key, *members) ⇒ Integer

Add one or more members to a set.

Parameters:

  • key (String)
  • member (String, Array<String>) —

    one member, or array of members

Returns:

  • (Integer) —

    The number of members that were successfully added



23
24
25
26
 
# File 'lib/valkey/commands/set_commands.rb', line 23

def sadd(key, *members)
  members.flatten!(1)
  send_command(RequestType::SADD, [key].concat(members))
end

#sadd?(key, *members) ⇒ Boolean

Add one or more members to a set.

Parameters:

  • key (String)
  • member (String, Array<String>) —

    one member, or array of members

Returns:

  • (Boolean) —

    Whether at least one member was successfully added.



33
34
35
36
 
# File 'lib/valkey/commands/set_commands.rb', line 33

def sadd?(key, *members)
  members.flatten!(1)
  send_command(RequestType::SADD, [key].concat(members), &Utils::Boolify)
end

#scard(key) ⇒ Integer

Get the number of members in a set.

Parameters:

  • key (String)

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/valkey/commands/set_commands.rb', line 14

def scard(key)
  send_command(RequestType::SCARD, [key])
end

#sdiff(*keys) ⇒ Array<String>

Subtract multiple sets.

Parameters:

  • keys (String, Array<String>) —

    keys pointing to sets to subtract

Returns:

  • (Array<String>) —

    members in the difference



125
126
127
128
 
# File 'lib/valkey/commands/set_commands.rb', line 125

def sdiff(*keys)
  keys.flatten!(1)
  send_command(RequestType::SDIFF, keys)
end

#sdiffstore(destination, *keys) ⇒ Integer

Subtract multiple sets and store the resulting set in a key.

Parameters:

  • destination (String) —

    destination key

  • keys (String, Array<String>) —

    keys pointing to sets to subtract

Returns:

  • (Integer) —

    number of elements in the resulting set



135
136
137
138
 
# File 'lib/valkey/commands/set_commands.rb', line 135

def sdiffstore(destination, *keys)
  keys.flatten!(1)
  send_command(RequestType::SDIFF_STORE, [destination].concat(keys))
end

#sinter(*keys) ⇒ Array<String>

Intersect multiple sets.

Parameters:

  • keys (String, Array<String>) —

    keys pointing to sets to intersect

Returns:

  • (Array<String>) —

    members in the intersection



144
145
146
147
 
# File 'lib/valkey/commands/set_commands.rb', line 144

def sinter(*keys)
  keys.flatten!(1)
  send_command(RequestType::SINTER, keys)
end

#sinterstore(destination, *keys) ⇒ Integer

Intersect multiple sets and store the resulting set in a key.

Parameters:

  • destination (String) —

    destination key

  • keys (String, Array<String>) —

    keys pointing to sets to intersect

Returns:

  • (Integer) —

    number of elements in the resulting set



154
155
156
157
 
# File 'lib/valkey/commands/set_commands.rb', line 154

def sinterstore(destination, *keys)
  keys.flatten!(1)
  send_command(RequestType::SINTER_STORE, [destination].concat(keys))
end

#sismember(key, member) ⇒ Boolean

Determine if a given value is a member of a set.

Parameters:

  • key (String)
  • member (String)

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/valkey/commands/set_commands.rb', line 99

def sismember(key, member)
  send_command(RequestType::SISMEMBER, [key, member])
end

#smembers(key) ⇒ Array<String>

Get all the members in a set.

Parameters:

  • key (String)

Returns:

  • (Array<String>) 


117
118
119
 
# File 'lib/valkey/commands/set_commands.rb', line 117

def smembers(key)
  send_command(RequestType::SMEMBERS, [key])
end

#smismember(key, *members) ⇒ Array<Boolean>

Determine if multiple values are members of a set.

Parameters:

  • key (String)
  • members (String, Array<String>)

Returns:

  • (Array<Boolean>) 


108
109
110
111
 
# File 'lib/valkey/commands/set_commands.rb', line 108

def smismember(key, *members)
  members.flatten!(1)
  send_command(RequestType::SMISMEMBER, [key].concat(members))
end

#smove(source, destination, member) ⇒ Boolean

Move a member from one set to another.

Parameters:

  • source (String) —

    source key

  • destination (String) —

    destination key

  • member (String) —

    member to move from ‘source` to `destination`

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/valkey/commands/set_commands.rb', line 90

def smove(source, destination, member)
  send_command(RequestType::S_MOVE, [source, destination, member])
end

#spop(key, count = nil) ⇒ String

Remove and return one or more random member from a set.

Parameters:

  • key (String)
  • count (Integer) (defaults to: nil)

Returns:

  • (String) 


63
64
65
66
67
68
69
 
# File 'lib/valkey/commands/set_commands.rb', line 63

def spop(key, count = nil)
  if count.nil?
    send_command(RequestType::S_POP, [key])
  else
    send_command(RequestType::S_POP, [key, Integer(count)])
  end
end

#srandmember(key, count = nil) ⇒ String

Get one or more random members from a set.

Parameters:

  • key (String)
  • count (Integer) (defaults to: nil)

Returns:

  • (String) 


76
77
78
79
80
81
82
 
# File 'lib/valkey/commands/set_commands.rb', line 76

def srandmember(key, count = nil)
  if count.nil?
    send_command(RequestType::S_RAND_MEMBER, [key])
  else
    send_command(RequestType::S_RAND_MEMBER, [key, count])
  end
end

#srem(key, *members) ⇒ Integer

Remove one or more members from a set.

Parameters:

  • key (String)
  • member (String, Array<String>) —

    one member, or array of members

Returns:

  • (Integer) —

    The number of members that were successfully removed



43
44
45
46
 
# File 'lib/valkey/commands/set_commands.rb', line 43

def srem(key, *members)
  members.flatten!(1)
  send_command(RequestType::S_REM, [key].concat(members))
end

#srem?(key, *members) ⇒ Boolean

Remove one or more members from a set.

Parameters:

  • key (String)
  • member (String, Array<String>) —

    one member, or array of members

Returns:

  • (Boolean) —

    Whether at least one member was successfully removed.



53
54
55
56
 
# File 'lib/valkey/commands/set_commands.rb', line 53

def srem?(key, *members)
  members.flatten!(1)
  send_command(RequestType::S_REM, [key].concat(members), &Utils::Boolify)
end

#sscan(key, cursor, **options) ⇒ String+

Scan a set

See the [Valkey Server SSCAN documentation](valkey.io/commands/sscan/) for further details

Examples:

Retrieve the first batch of keys in a set

valkey.sscan("set", 0)

Parameters:

  • cursor (String, Integer) —

    the cursor of the iteration

  • options (Hash) —

    • ‘:match => String`: only return keys matching the pattern

    • ‘:count => Integer`: return count keys at most per iteration

Returns:

  • (String, Array<String>) —

    the next cursor and all found members



191
192
193
 
# File 'lib/valkey/commands/set_commands.rb', line 191

def sscan(key, cursor, **options)
  _scan(RequestType::S_SCAN, cursor, [key], **options)
end

#sscan_each(key, **options, &block) ⇒ Enumerator

Scan a set

See the [Valkey Server SSCAN documentation](valkey.io/commands/sscan/) for further details

Examples:

Retrieve all of the keys in a set

valkey.sscan_each("set").to_a
# => ["key1", "key2", "key3"]

Parameters:

  • options (Hash) —

    • ‘:match => String`: only return keys matching the pattern

    • ‘:count => Integer`: return count keys at most per iteration

Returns:

  • (Enumerator) —

    an enumerator for all keys in the set



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/valkey/commands/set_commands.rb', line 208

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

#sunion(*keys) ⇒ Array<String>

Add multiple sets.

Parameters:

  • keys (String, Array<String>) —

    keys pointing to sets to unify

Returns:

  • (Array<String>) —

    members in the union



163
164
165
166
 
# File 'lib/valkey/commands/set_commands.rb', line 163

def sunion(*keys)
  keys.flatten!(1)
  send_command(RequestType::S_UNION, keys)
end

#sunionstore(destination, *keys) ⇒ Integer

Add multiple sets and store the resulting set in a key.

Parameters:

  • destination (String) —

    destination key

  • keys (String, Array<String>) —

    keys pointing to sets to unify

Returns:

  • (Integer) —

    number of elements in the resulting set



173
174
175
176
 
# File 'lib/valkey/commands/set_commands.rb', line 173

def sunionstore(destination, *keys)
  keys.flatten!(1)
  send_command(RequestType::S_UNION_STORE, [destination].concat(keys))
end