org.springframework.data.redis.connection

Interface RedisSetCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisSetCommands

Set-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method and Description
Long	sAdd(byte[] key, byte[]... values) Add given values to set at key.
Long	sCard(byte[] key) Get size of set at key.
Set<byte[]>	sDiff(byte[]... keys) Diff all sets for given keys.
Long	sDiffStore(byte[] destKey, byte[]... keys) Diff all sets for given keys and store result in destKey.
Set<byte[]>	sInter(byte[]... keys) Returns the members intersecting all given sets at keys.
Long	sInterStore(byte[] destKey, byte[]... keys) Intersect all given sets at keys and store result in destKey.
Boolean	sIsMember(byte[] key, byte[] value) Check if set at key contains value.
Set<byte[]>	sMembers(byte[] key) Get all elements of set at key.
Boolean	sMove(byte[] srcKey, byte[] destKey, byte[] value) Move value from srcKey to destKey
byte[]	sPop(byte[] key) Remove and return a random member from set at key.
List<byte[]>	sPop(byte[] key, long count) Remove and return count random members from set at key.
byte[]	sRandMember(byte[] key) Get random element from set at key.
List<byte[]>	sRandMember(byte[] key, long count) Get count random elements from set at key.
Long	sRem(byte[] key, byte[]... values) Remove given values from set at key and return the number of removed elements.
Cursor<byte[]>	sScan(byte[] key, ScanOptions options) Use a Cursor to iterate over elements in set at key.
Set<byte[]>	sUnion(byte[]... keys) Union all sets at given keys.
Long	sUnionStore(byte[] destKey, byte[]... keys) Union all sets at given keys and store result in destKey.

Method Detail

sAdd

@Nullable
Long sAdd(byte[] key,
                    byte[]... values)

Add given values to set at key.

Parameters:

key - must not be null.

values - must not be empty.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SADD

sRem

@Nullable
Long sRem(byte[] key,
                    byte[]... values)

Remove given values from set at key and return the number of removed elements.

Parameters:

key - must not be null.

values - must not be empty.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SREM

sPop

@Nullable
byte[] sPop(byte[] key)

Remove and return a random member from set at key.

Parameters:

key - must not be null.

Returns:

null when key does not exist or used in pipeline / transaction.

See Also:

Redis Documentation: SPOP

sPop

@Nullable
List<byte[]> sPop(byte[] key,
                            long count)

Remove and return count random members from set at key.

Parameters:

key - must not be null.

count - number of random members to pop from the set.

Returns:

empty List if set does not exist. null when used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: SPOP

sMove

@Nullable
Boolean sMove(byte[] srcKey,
                        byte[] destKey,
                        byte[] value)

Move value from srcKey to destKey

Parameters:

srcKey - must not be null.

destKey - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SMOVE

sCard

@Nullable
Long sCard(byte[] key)

Get size of set at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SCARD

sIsMember

@Nullable
Boolean sIsMember(byte[] key,
                            byte[] value)

Check if set at key contains value.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SISMEMBER

sInter

@Nullable
Set<byte[]> sInter(byte[]... keys)

Returns the members intersecting all given sets at keys.

Parameters:

keys - must not be null.

Returns:

empty Set if no intersection found. null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTER

sInterStore

@Nullable
Long sInterStore(byte[] destKey,
                           byte[]... keys)

Intersect all given sets at keys and store result in destKey.

Parameters:

destKey - must not be null.

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SINTERSTORE

sUnion

@Nullable
Set<byte[]> sUnion(byte[]... keys)

Union all sets at given keys.

Parameters:

keys - must not be null.

Returns:

empty Set if keys do not exist. null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNION

sUnionStore

@Nullable
Long sUnionStore(byte[] destKey,
                           byte[]... keys)

Union all sets at given keys and store result in destKey.

Parameters:

destKey - must not be null.

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SUNIONSTORE

sDiff

@Nullable
Set<byte[]> sDiff(byte[]... keys)

Diff all sets for given keys.

Parameters:

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFF

sDiffStore

@Nullable
Long sDiffStore(byte[] destKey,
                          byte[]... keys)

Diff all sets for given keys and store result in destKey.

Parameters:

destKey - must not be null.

keys - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SDIFFSTORE

sMembers

@Nullable
Set<byte[]> sMembers(byte[] key)

Get all elements of set at key.

Parameters:

key - must not be null.

Returns:

empty Set when key does not exist. null when used in pipeline / transaction.

See Also:

Redis Documentation: SMEMBERS

sRandMember

@Nullable
byte[] sRandMember(byte[] key)

Get random element from set at key.

Parameters:

key - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: SRANDMEMBER

sRandMember

@Nullable
List<byte[]> sRandMember(byte[] key,
                                   long count)

Get count random elements from set at key.

Parameters:

key - must not be null.

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: SRANDMEMBER

sScan

Cursor<byte[]> sScan(byte[] key,
                     ScanOptions options)

Use a Cursor to iterate over elements in set at key.

Parameters:

key - must not be null.

options - must not be null.

Returns:

never null.

Since:

1.4

See Also:

Redis Documentation: SCAN