io.lettuce.core.api.sync

Interface RedisSetCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterCommands<K,V>, RedisClusterCommands<K,V>, RedisClusterPubSubCommands<K,V>, RedisCommands<K,V>, RedisPubSubCommands<K,V>

public interface RedisSetCommands<K,V>

Synchronous executed commands for Sets.

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateSyncApi

Method Summary

Modifier and Type	Method and Description
Long	sadd(K key, V... members) Add one or more members to a set.
Long	scard(K key) Get the number of members in a set.
Set<V>	sdiff(K... keys) Subtract multiple sets.
Long	sdiff(ValueStreamingChannel<V> channel, K... keys) Subtract multiple sets.
Long	sdiffstore(K destination, K... keys) Subtract multiple sets and store the resulting set in a key.
Set<V>	sinter(K... keys) Intersect multiple sets.
Long	sinter(ValueStreamingChannel<V> channel, K... keys) Intersect multiple sets.
Long	sintercard(K... keys) This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.
Long	sintercard(long limit, K... keys) This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.
Long	sinterstore(K destination, K... keys) Intersect multiple sets and store the resulting set in a key.
Boolean	sismember(K key, V member) Determine if a given value is a member of a set.
Set<V>	smembers(K key) Get all the members in a set.
Long	smembers(ValueStreamingChannel<V> channel, K key) Get all the members in a set.
List<Boolean>	smismember(K key, V... members) Returns whether each member is a member of the set stored at key.
Boolean	smove(K source, K destination, V member) Move a member from one set to another.
V	spop(K key) Remove and return a random member from a set.
Set<V>	spop(K key, long count) Remove and return one or multiple random members from a set.
V	srandmember(K key) Get one random member from a set.
List<V>	srandmember(K key, long count) Get one or multiple random members from a set.
Long	srandmember(ValueStreamingChannel<V> channel, K key, long count) Get one or multiple random members from a set.
Long	srem(K key, V... members) Remove one or more members from a set.
ValueScanCursor<V>	sscan(K key) Incrementally iterate Set elements.
ValueScanCursor<V>	sscan(K key, ScanArgs scanArgs) Incrementally iterate Set elements.
ValueScanCursor<V>	sscan(K key, ScanCursor scanCursor) Incrementally iterate Set elements.
ValueScanCursor<V>	sscan(K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate Set elements.
StreamScanCursor	sscan(ValueStreamingChannel<V> channel, K key) Incrementally iterate Set elements.
StreamScanCursor	sscan(ValueStreamingChannel<V> channel, K key, ScanArgs scanArgs) Incrementally iterate Set elements.
StreamScanCursor	sscan(ValueStreamingChannel<V> channel, K key, ScanCursor scanCursor) Incrementally iterate Set elements.
StreamScanCursor	sscan(ValueStreamingChannel<V> channel, K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate Set elements.
Set<V>	sunion(K... keys) Add multiple sets.
Long	sunion(ValueStreamingChannel<V> channel, K... keys) Add multiple sets.
Long	sunionstore(K destination, K... keys) Add multiple sets and store the resulting set in a key.

Method Detail

sadd

Long sadd(K key,
          V... members)

Add one or more members to a set.

Parameters:

key - the key.

members - the member type: value.

Returns:

Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set.

scard

Long scard(K key)

Get the number of members in a set.

Parameters:

key - the key.

Returns:

Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist.

sdiff

Set<V> sdiff(K... keys)

Subtract multiple sets.

Parameters:

keys - the key.

Returns:

Set<V> array-reply list with members of the resulting set.

sdiff

Long sdiff(ValueStreamingChannel<V> channel,
           K... keys)

Subtract multiple sets.

Parameters:

channel - the channel.

keys - the keys.

Returns:

Long count of members of the resulting set.

sdiffstore

Long sdiffstore(K destination,
                K... keys)

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

Parameters:

destination - the destination type: key.

keys - the key.

Returns:

Long integer-reply the number of elements in the resulting set.

sinter

Set<V> sinter(K... keys)

Intersect multiple sets.

Parameters:

keys - the key.

Returns:

Set<V> array-reply list with members of the resulting set.

sinter

Long sinter(ValueStreamingChannel<V> channel,
            K... keys)

Intersect multiple sets.

Parameters:

channel - the channel.

keys - the keys.

Returns:

Long count of members of the resulting set.

sintercard

Long sintercard(K... keys)

This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.

Parameters:

keys - the keys.

Returns:

The cardinality of the set which would result from the intersection of all the given sets.

Since:

6.2

sintercard

Long sintercard(long limit,
                K... keys)

This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.

Parameters:

limit - If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality.

keys - the keys.

Returns:

The cardinality of the set which would result from the intersection of all the given sets.

Since:

6.2

sinterstore

Long sinterstore(K destination,
                 K... keys)

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

Parameters:

destination - the destination type: key.

keys - the key.

Returns:

Long integer-reply the number of elements in the resulting set.

sismember

Boolean sismember(K key,
                  V member)

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

Parameters:

key - the key.

member - the member type: value.

Returns:

Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist.

smembers

Set<V> smembers(K key)

Get all the members in a set.

Parameters:

key - the key.

Returns:

Set<V> array-reply all elements of the set.

smembers

Long smembers(ValueStreamingChannel<V> channel,
              K key)

Get all the members in a set.

Parameters:

channel - the channel.

key - the keys.

Returns:

Long count of members of the resulting set.

smismember

List<Boolean> smismember(K key,
                         V... members)

Returns whether each member is a member of the set stored at key.

Parameters:

key - the key.

members - the member type: value.

Returns:

List<Boolean> array-reply list representing the membership of the given elements, in the same order as they are requested.

Since:

6.1

smove

Boolean smove(K source,
              K destination,
              V member)

Move a member from one set to another.

Parameters:

source - the source key.

destination - the destination type: key.

member - the member type: value.

Returns:

Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed.

spop

V spop(K key)

Remove and return a random member from a set.

Parameters:

key - the key.

Returns:

V bulk-string-reply the removed element, or null when key does not exist.

spop

Set<V> spop(K key,
            long count)

Remove and return one or multiple random members from a set.

Parameters:

key - the key.

count - number of members to pop.

Returns:

V bulk-string-reply the removed element, or null when key does not exist.

srandmember

V srandmember(K key)

Get one random member from a set.

Parameters:

key - the key.

Returns:

V bulk-string-reply without the additional count argument the command returns a Bulk Reply with the randomly selected element, or null when key does not exist.

srandmember

List<V> srandmember(K key,
                    long count)

Get one or multiple random members from a set.

Parameters:

key - the key.

count - the count type: long.

Returns:

Set<V> bulk-string-reply without the additional count argument the command returns a Bulk Reply with the randomly selected element, or null when key does not exist.

srandmember

Long srandmember(ValueStreamingChannel<V> channel,
                 K key,
                 long count)

Get one or multiple random members from a set.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

count - the count.

Returns:

Long count of members of the resulting set.

srem

Long srem(K key,
          V... members)

Remove one or more members from a set.

Parameters:

key - the key.

members - the member type: value.

Returns:

Long integer-reply the number of members that were removed from the set, not including non existing members.

sunion

Set<V> sunion(K... keys)

Add multiple sets.

Parameters:

keys - the key.

Returns:

Set<V> array-reply list with members of the resulting set.

sunion

Long sunion(ValueStreamingChannel<V> channel,
            K... keys)

Add multiple sets.

Parameters:

channel - streaming channel that receives a call for every value.

keys - the keys.

Returns:

Long count of members of the resulting set.

sunionstore

Long sunionstore(K destination,
                 K... keys)

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

Parameters:

destination - the destination type: key.

keys - the key.

Returns:

Long integer-reply the number of elements in the resulting set.

sscan

ValueScanCursor<V> sscan(K key)

Incrementally iterate Set elements.

Parameters:

key - the key.

Returns:

ValueScanCursor<V> scan cursor.

sscan

ValueScanCursor<V> sscan(K key,
                         ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

key - the key.

scanArgs - scan arguments.

Returns:

ValueScanCursor<V> scan cursor.

sscan

ValueScanCursor<V> sscan(K key,
                         ScanCursor scanCursor,
                         ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

ValueScanCursor<V> scan cursor.

sscan

ValueScanCursor<V> sscan(K key,
                         ScanCursor scanCursor)

Incrementally iterate Set elements.

Parameters:

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

ValueScanCursor<V> scan cursor.

sscan

StreamScanCursor sscan(ValueStreamingChannel<V> channel,
                       K key)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

Returns:

StreamScanCursor scan cursor.

sscan

StreamScanCursor sscan(ValueStreamingChannel<V> channel,
                       K key,
                       ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

sscan

StreamScanCursor sscan(ValueStreamingChannel<V> channel,
                       K key,
                       ScanCursor scanCursor,
                       ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

sscan

StreamScanCursor sscan(ValueStreamingChannel<V> channel,
                       K key,
                       ScanCursor scanCursor)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

StreamScanCursor scan cursor.