org.springframework.data.redis.core.ReactiveSetOperations Maven / Gradle / Ivy
/*
* Copyright 2017-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.core;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.util.Collection;
/**
* Redis set specific operations.
*
* @author Mark Paluch
* @author Christoph Strobl
* @see Redis Documentation: Set Commands
* @since 2.0
*/
public interface ReactiveSetOperations {
/**
* Add given {@code values} to set at {@code key}.
*
* @param key must not be {@literal null}.
* @param values
* @return
* @see Redis Documentation: SADD
*/
Mono add(K key, V... values);
/**
* Remove given {@code values} from set at {@code key} and return the number of removed elements.
*
* @param key must not be {@literal null}.
* @param values
* @return
* @see Redis Documentation: SREM
*/
Mono remove(K key, Object... values);
/**
* Remove and return a random member from set at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SPOP
*/
Mono pop(K key);
/**
* Remove and return {@code count} random members from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count number of random members to pop from the set.
* @return {@link Flux} emitting random members.
* @see Redis Documentation: SPOP
*/
Flux pop(K key, long count);
/**
* Move {@code value} from {@code key} to {@code destKey}
*
* @param sourceKey must not be {@literal null}.
* @param value
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SMOVE
*/
Mono move(K sourceKey, V value, K destKey);
/**
* Get size of set at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SCARD
*/
Mono size(K key);
/**
* Check if set at {@code key} contains {@code value}.
*
* @param key must not be {@literal null}.
* @param o
* @return
* @see Redis Documentation: SISMEMBER
*/
Mono isMember(K key, Object o);
/**
* Returns the members intersecting all given sets at {@code key} and {@code otherKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @return
* @see Redis Documentation: SINTER
*/
Flux intersect(K key, K otherKey);
/**
* Returns the members intersecting all given sets at {@code key} and {@code otherKeys}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @return
* @see Redis Documentation: SINTER
*/
Flux intersect(K key, Collection otherKeys);
/**
* Intersect all given sets at {@code key} and {@code otherKey} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SINTERSTORE
*/
Mono intersectAndStore(K key, K otherKey, K destKey);
/**
* Intersect all given sets at {@code key} and {@code otherKeys} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SINTERSTORE
*/
Mono intersectAndStore(K key, Collection otherKeys, K destKey);
/**
* Union all sets at given {@code keys} and {@code otherKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @return
* @see Redis Documentation: SUNION
*/
Flux union(K key, K otherKey);
/**
* Union all sets at given {@code keys} and {@code otherKeys}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @return
* @see Redis Documentation: SUNION
*/
Flux union(K key, Collection otherKeys);
/**
* Union all sets at given {@code key} and {@code otherKey} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SUNIONSTORE
*/
Mono unionAndStore(K key, K otherKey, K destKey);
/**
* Union all sets at given {@code key} and {@code otherKeys} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SUNIONSTORE
*/
Mono unionAndStore(K key, Collection otherKeys, K destKey);
/**
* Diff all sets for given {@code key} and {@code otherKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFF
*/
Flux difference(K key, K otherKey);
/**
* Diff all sets for given {@code key} and {@code otherKeys}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFF
*/
Flux difference(K key, Collection otherKeys);
/**
* Diff all sets for given {@code key} and {@code otherKey} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKey must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFFSTORE
*/
Mono differenceAndStore(K key, K otherKey, K destKey);
/**
* Diff all sets for given {@code key} and {@code otherKeys} and store result in {@code destKey}.
*
* @param key must not be {@literal null}.
* @param otherKeys must not be {@literal null}.
* @param destKey must not be {@literal null}.
* @return
* @see Redis Documentation: SDIFFSTORE
*/
Mono differenceAndStore(K key, Collection otherKeys, K destKey);
/**
* Get all elements of set at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SMEMBERS
*/
Flux members(K key);
/**
* Use a {@link Flux} to iterate over entries in the set at {@code key}. The resulting {@link Flux} acts as a cursor
* and issues {@code SSCAN} commands itself as long as the subscriber signals demand.
*
* @param key must not be {@literal null}.
* @return the {@link Flux} emitting the {@literal values} one by one or an {@link Flux#empty() empty Flux} if none
* exist.
* @throws IllegalArgumentException when given {@code key} is {@literal null}.
* @see Redis Documentation: SSCAN
* @since 2.1
*/
default Flux scan(K key) {
return scan(key, ScanOptions.NONE);
}
/**
* Use a {@link Flux} to iterate over entries in the set at {@code key} given {@link ScanOptions}. The resulting
* {@link Flux} acts as a cursor and issues {@code SSCAN} commands itself as long as the subscriber signals demand.
*
* @param key must not be {@literal null}.
* @param options must not be {@literal null}. Use {@link ScanOptions#NONE} instead.
* @return the {@link Flux} emitting the {@literal values} one by one or an {@link Flux#empty() empty Flux} if the key
* does not exist.
* @throws IllegalArgumentException when one of the required arguments is {@literal null}.
* @see Redis Documentation: SSCAN
* @since 2.1
*/
Flux scan(K key, ScanOptions options);
/**
* Get random element from set at {@code key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: SRANDMEMBER
*/
Mono randomMember(K key);
/**
* Get {@code count} distinct random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count number of members to return.
* @return
* @see Redis Documentation: SRANDMEMBER
*/
Flux distinctRandomMembers(K key, long count);
/**
* Get {@code count} random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count number of members to return.
* @return
* @see Redis Documentation: SRANDMEMBER
*/
Flux randomMembers(K key, long count);
/**
* Removes the given {@literal key}.
*
* @param key must not be {@literal null}.
*/
Mono delete(K key);
}