Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2016-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.connection;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.reactivestreams.Publisher;
import org.springframework.data.domain.Range;
import org.springframework.data.domain.Sort.Direction;
import org.springframework.data.redis.connection.ReactiveRedisConnection.CommandResponse;
import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand;
import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyScanCommand;
import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
import org.springframework.data.redis.connection.RedisZSetCommands.Aggregate;
import org.springframework.data.redis.connection.RedisZSetCommands.Limit;
import org.springframework.data.redis.connection.RedisZSetCommands.Tuple;
import org.springframework.data.redis.connection.RedisZSetCommands.Weights;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.data.redis.util.ByteUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Redis Sorted Set commands executed using reactive infrastructure.
*
* @author Christoph Strobl
* @author Mark Paluch
* @since 2.0
*/
public interface ReactiveZSetCommands {
/**
* {@code ZADD} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZADD
*/
class ZAddCommand extends KeyCommand {
private final List tuples;
private final boolean upsert;
private final boolean returnTotalChanged;
private final boolean incr;
private ZAddCommand(@Nullable ByteBuffer key, List tuples, boolean upsert, boolean returnTotalChanged,
boolean incr) {
super(key);
this.tuples = tuples;
this.upsert = upsert;
this.returnTotalChanged = returnTotalChanged;
this.incr = incr;
}
/**
* Creates a new {@link ZAddCommand} given a {@link Tuple}.
*
* @param tuple must not be {@literal null}.
* @return a new {@link ZAddCommand} for {@link Tuple}.
*/
public static ZAddCommand tuple(Tuple tuple) {
Assert.notNull(tuple, "Tuple must not be null!");
return tuples(Collections.singletonList(tuple));
}
/**
* Creates a new {@link ZAddCommand} given a {@link Collection} of {@link Tuple}.
*
* @param tuples must not be {@literal null}.
* @return a new {@link ZAddCommand} for {@link Tuple}.
*/
public static ZAddCommand tuples(Collection tuples) {
Assert.notNull(tuples, "Tuples must not be null!");
return new ZAddCommand(null, new ArrayList<>(tuples), false, false, false);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZAddCommand} with {@literal key} applied.
*/
public ZAddCommand to(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZAddCommand(key, tuples, upsert, returnTotalChanged, incr);
}
/**
* Applies {@literal xx} mode (Only update elements that already exist. Never add elements). Constructs a new
* command instance with all previously configured properties.
*
* @return a new {@link ZAddCommand} with {@literal xx} applied.
*/
public ZAddCommand xx() {
return new ZAddCommand(getKey(), tuples, false, returnTotalChanged, incr);
}
/**
* Applies {@literal nx} mode (Don't update already existing elements. Always add new elements). Constructs a new
* command instance with all previously configured properties.
*
* @return a new {@link ZAddCommand} with {@literal nx} applied.
*/
public ZAddCommand nx() {
return new ZAddCommand(getKey(), tuples, true, returnTotalChanged, incr);
}
/**
* Applies {@literal ch} mode (Modify the return value from the number of new elements added, to the total number of
* elements changed). Constructs a new command instance with all previously configured properties.
*
* @return a new {@link ZAddCommand} with {@literal ch} applied.
*/
public ZAddCommand ch() {
return new ZAddCommand(getKey(), tuples, upsert, true, incr);
}
/**
* Applies {@literal incr} mode (When this option is specified ZADD acts like ZINCRBY). Constructs a new command
* instance with all previously configured properties.
*
* @return a new {@link ZAddCommand} with {@literal incr} applied.
*/
public ZAddCommand incr() {
return new ZAddCommand(getKey(), tuples, upsert, upsert, true);
}
/**
* @return
*/
public List getTuples() {
return tuples;
}
/**
* @return
*/
public boolean isUpsert() {
return upsert;
}
/**
* @return
*/
public boolean isIncr() {
return incr;
}
/**
* @return
*/
public boolean isReturnTotalChanged() {
return returnTotalChanged;
}
}
/**
* Add {@literal value} to a sorted set at {@literal key}, or update its {@literal score} if it already exists.
*
* @param key must not be {@literal null}.
* @param score must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: ZADD
*/
default Mono zAdd(ByteBuffer key, Double score, ByteBuffer value) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(score, "Score must not be null!");
Assert.notNull(value, "Value must not be null!");
return zAdd(Mono.just(ZAddCommand.tuple(new DefaultTuple(ByteUtils.getBytes(value), score)).to(key))).next()
.map(resp -> resp.getOutput().longValue());
}
/**
* Add a {@literal tuples} to a sorted set at {@literal key}, or update their score if it already exists.
*
* @param key must not be {@literal null}.
* @param tuples must not be {@literal null}.
* @return
* @see Redis Documentation: ZADD
*/
default Mono zAdd(ByteBuffer key, Collection tuples) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(tuples, "Tuples must not be null!");
return zAdd(Mono.just(ZAddCommand.tuples(tuples).to(key))).next().map(resp -> resp.getOutput().longValue());
}
/**
* Add {@link ZAddCommand#getTuples()} to a sorted set at {@link ZAddCommand#getKey()}, or update its {@literal score}
* if it already exists.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZADD
*/
Flux> zAdd(Publisher commands);
/**
* {@code ZREM} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZREM
*/
class ZRemCommand extends KeyCommand {
private final List values;
private ZRemCommand(@Nullable ByteBuffer key, List values) {
super(key);
this.values = values;
}
/**
* Creates a new {@link ZRemCommand} given a {@link Tuple}.
*
* @param value must not be {@literal null}.
* @return a new {@link ZAddCommand} for {@link Tuple}.
*/
public static ZRemCommand values(ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return new ZRemCommand(null, Collections.singletonList(value));
}
/**
* Creates a new {@link ZRemCommand} given a {@link Collection} of {@link Tuple}.
*
* @param values must not be {@literal null}.
* @return a new {@link ZAddCommand} for {@link Tuple}.
*/
public static ZRemCommand values(Collection values) {
Assert.notNull(values, "Values must not be null!");
return new ZRemCommand(null, new ArrayList<>(values));
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRemCommand} with {@literal key} applied.
*/
public ZRemCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRemCommand(key, values);
}
/**
* @return
*/
public List getValues() {
return values;
}
}
/**
* Remove {@literal value} from sorted set. Return number of removed elements.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: ZREM
*/
default Mono zRem(ByteBuffer key, ByteBuffer value) {
Assert.notNull(value, "Value must not be null!");
return zRem(key, Collections.singletonList(value));
}
/**
* Remove {@literal values} from sorted set. Return number of removed elements.
*
* @param key must not be {@literal null}.
* @param values must not be {@literal null}.
* @return
* @see Redis Documentation: ZREM
*/
default Mono zRem(ByteBuffer key, Collection values) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(values, "Values must not be null!");
return zRem(Mono.just(ZRemCommand.values(values).from(key))).next().map(NumericResponse::getOutput);
}
/**
* Remove {@link ZRemCommand#getValues()} from sorted set. Return number of removed elements.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZREM
*/
Flux> zRem(Publisher commands);
/**
* {@code ZINCRBY} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZINCRBY
*/
class ZIncrByCommand extends KeyCommand {
private final ByteBuffer value;
private final @Nullable Number increment;
private ZIncrByCommand(@Nullable ByteBuffer key, ByteBuffer value, @Nullable Number increment) {
super(key);
this.value = value;
this.increment = increment;
}
/**
* Creates a new {@link ZIncrByCommand} given a {@link ByteBuffer member}.
*
* @param member must not be {@literal null}.
* @return a new {@link ZAddCommand} for {@link Tuple}.
*/
public static ZIncrByCommand scoreOf(ByteBuffer member) {
Assert.notNull(member, "Member must not be null!");
return new ZIncrByCommand(null, member, null);
}
/**
* Applies the numeric {@literal increment}. Constructs a new command instance with all previously configured
* properties.
*
* @param increment must not be {@literal null}.
* @return a new {@link ZIncrByCommand} with {@literal increment} applied.
*/
public ZIncrByCommand by(Number increment) {
Assert.notNull(increment, "Increment must not be null!");
return new ZIncrByCommand(getKey(), value, increment);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZIncrByCommand} with {@literal key} applied.
*/
public ZIncrByCommand storedWithin(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZIncrByCommand(key, value, increment);
}
/**
* @return never {@literal null}.
*/
public ByteBuffer getValue() {
return value;
}
/**
* @return can be {@literal null}.
*/
@Nullable
public Number getIncrement() {
return increment;
}
}
/**
* Increment the score of element with {@literal value} in sorted set by {@literal increment}.
*
* @param key must not be {@literal null}.
* @param increment must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: ZINCRBY
*/
default Mono zIncrBy(ByteBuffer key, Number increment, ByteBuffer value) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(increment, "Increment must not be null!");
Assert.notNull(value, "Value must not be null!");
return zIncrBy(Mono.just(ZIncrByCommand.scoreOf(value).by(increment).storedWithin(key))).next()
.map(NumericResponse::getOutput);
}
/**
* Increment the score of element with {@link ZIncrByCommand#getValue()} in sorted set by
* {@link ZIncrByCommand#getIncrement()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZINCRBY
*/
Flux> zIncrBy(Publisher commands);
/**
* {@code ZRANK}/{@literal ZREVRANK} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZRANK
* @see Redis Documentation: ZREVRANK
*/
class ZRankCommand extends KeyCommand {
private final ByteBuffer value;
private final Direction direction;
private ZRankCommand(@Nullable ByteBuffer key, ByteBuffer value, Direction direction) {
super(key);
this.value = value;
this.direction = direction;
}
/**
* Creates a new {@link ZRankCommand} given a {@link ByteBuffer member} to obtain its rank (ordering low to high).
*
* @param member must not be {@literal null}.
* @return a new {@link ZRankCommand} for {@link Tuple}.
*/
public static ZRankCommand indexOf(ByteBuffer member) {
Assert.notNull(member, "Member must not be null!");
return new ZRankCommand(null, member, Direction.ASC);
}
/**
* Creates a new {@link ZIncrByCommand} given a {@link ByteBuffer member} to obtain its reversed rank (ordering high
* to low).
*
* @param member must not be {@literal null}.
* @return a new {@link ZRankCommand} for {@link Tuple}.
*/
public static ZRankCommand reverseIndexOf(ByteBuffer member) {
Assert.notNull(member, "Member must not be null!");
return new ZRankCommand(null, member, Direction.DESC);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRankCommand} with {@literal key} applied.
*/
public ZRankCommand storedWithin(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRankCommand(key, value, direction);
}
/**
* @return
*/
public ByteBuffer getValue() {
return value;
}
/**
* @return
*/
public Direction getDirection() {
return direction;
}
}
/**
* Determine the index of element with {@literal value} in a sorted set.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANK
*/
default Mono zRank(ByteBuffer key, ByteBuffer value) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(value, "Value must not be null!");
return zRank(Mono.just(ZRankCommand.indexOf(value).storedWithin(key))).next().map(NumericResponse::getOutput);
}
/**
* Determine the index of element with {@literal value} in a sorted set when scored high to low.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANK
*/
default Mono zRevRank(ByteBuffer key, ByteBuffer value) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(value, "Value must not be null!");
return zRank(Mono.just(ZRankCommand.reverseIndexOf(value).storedWithin(key))).next()
.map(NumericResponse::getOutput);
}
/**
* Determine the index of element with {@literal value} in a sorted set when scored by
* {@link ZRankCommand#getDirection()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANK
* @see Redis Documentation: ZREVRANK
*/
Flux> zRank(Publisher commands);
/**
* {@code ZRANGE}/{@literal ZREVRANGE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZRANGE
* @see Redis Documentation: ZREVRANGE
*/
class ZRangeCommand extends KeyCommand {
private final Range range;
private final boolean withScores;
private final Direction direction;
private ZRangeCommand(@Nullable ByteBuffer key, Range range, Direction direction, boolean withScores) {
super(key);
this.range = range;
this.withScores = withScores;
this.direction = direction;
}
/**
* Creates a new {@link ZRangeCommand} given a {@link Range} to obtain elements ordered from the lowest to the
* highest score.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRangeCommand} for {@link Tuple}.
*/
public static ZRangeCommand valuesWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRangeCommand(null, range, Direction.ASC, false);
}
/**
* Creates a new {@link ZRangeCommand} given a {@link Range} to obtain elements ordered from the highest to the
* lowest score.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRangeCommand} for {@link Tuple}.
*/
public static ZRangeCommand reverseValuesWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRangeCommand(null, range, Direction.DESC, false);
}
/**
* Return the score along with each returned element. Constructs a new command instance with all previously
* configured properties.
*
* @return a new {@link ZRangeCommand} with score retrieval applied.
*/
public ZRangeCommand withScores() {
return new ZRangeCommand(getKey(), range, direction, true);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRangeCommand} with {@literal key} applied.
*/
public ZRangeCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRangeCommand(key, range, direction, withScores);
}
/**
* @return
*/
public Range getRange() {
return range;
}
/**
* @return
*/
public boolean isWithScores() {
return withScores;
}
/**
* @return
*/
public Direction getDirection() {
return direction;
}
}
/**
* Get elements in {@literal range} from sorted set.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGE
*/
default Flux zRange(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRange(Mono.just(ZRangeCommand.valuesWithin(range).from(key))) //
.flatMap(CommandResponse::getOutput).map(tuple -> ByteBuffer.wrap(tuple.getValue()));
}
/**
* Get set of {@link Tuple}s in {@literal range} from sorted set.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGE
*/
default Flux zRangeWithScores(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
return zRange(Mono.just(ZRangeCommand.valuesWithin(range).withScores().from(key)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get elements in {@literal range} from sorted set in reverse {@literal score} ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGE
*/
default Flux zRevRange(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
return zRange(Mono.just(ZRangeCommand.reverseValuesWithin(range).from(key))).flatMap(CommandResponse::getOutput)
.map(tuple -> ByteBuffer.wrap(tuple.getValue()));
}
/**
* Get set of {@link Tuple}s in {@literal range} from sorted set in reverse {@literal score} ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGE
*/
default Flux zRevRangeWithScores(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
return zRange(Mono.just(ZRangeCommand.reverseValuesWithin(range).withScores().from(key)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get set of {@link Tuple}s in {@literal range} from sorted set.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGE
* @see Redis Documentation: ZREVRANGE
*/
Flux>> zRange(Publisher commands);
/**
* {@literal ZRANGEBYSCORE}/{@literal ZREVRANGEBYSCORE}.
*
* @author Christoph Strobl
* @see Redis Documentation: ZRANGEBYSCORE
* @see Redis Documentation: ZREVRANGEBYSCORE
*/
class ZRangeByScoreCommand extends KeyCommand {
private final Range range;
private final boolean withScores;
private final Direction direction;
private final @Nullable Limit limit;
private ZRangeByScoreCommand(@Nullable ByteBuffer key, Range range, Direction direction, boolean withScores,
@Nullable Limit limit) {
super(key);
this.range = range;
this.withScores = withScores;
this.direction = direction;
this.limit = limit;
}
/**
* Creates a new {@link ZRangeByScoreCommand} given a {@link Range} to obtain elements ordered from the lowest to
* the highest score.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRangeByScoreCommand} for {@link Tuple}.
*/
public static ZRangeByScoreCommand scoresWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRangeByScoreCommand(null, range, Direction.ASC, false, null);
}
/**
* Creates a new {@link ZRangeByScoreCommand} given a {@link Range} to obtain elements ordered from the highest to
* the lowest score.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRangeByScoreCommand} for {@link Tuple}.
*/
public static ZRangeByScoreCommand reverseScoresWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRangeByScoreCommand(null, range, Direction.DESC, false, null);
}
/**
* Return the score along with each returned element. Constructs a new command instance with all previously
* configured properties.
*
* @return a new {@link ZRangeByScoreCommand} with score retrieval applied.
*/
public ZRangeByScoreCommand withScores() {
return new ZRangeByScoreCommand(getKey(), range, direction, true, limit);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRangeByScoreCommand} with {@literal key} applied.
*/
public ZRangeByScoreCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRangeByScoreCommand(key, range, direction, withScores, limit);
}
/**
* Applies the {@link Limit}. Constructs a new command instance with all previously configured properties.
*
* @param limit must not be {@literal null}.
* @return a new {@link ZRangeByScoreCommand} with {@link Limit} applied.
*/
public ZRangeByScoreCommand limitTo(Limit limit) {
Assert.notNull(limit, "Limit must not be null!");
return new ZRangeByScoreCommand(getKey(), range, direction, withScores, limit);
}
/**
* @return
*/
public Range getRange() {
return range;
}
/**
* @return
*/
public boolean isWithScores() {
return withScores;
}
/**
* @return
*/
public Direction getDirection() {
return direction;
}
/**
* @return
*/
public Optional getLimit() {
return Optional.ofNullable(limit);
}
}
/**
* Get elements in {@literal range} from sorted set.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYSCORE
*/
default Flux zRangeByScore(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.scoresWithin(range).from(key))) //
.flatMap(CommandResponse::getOutput) //
.map(tuple -> ByteBuffer.wrap(tuple.getValue()));
}
/**
* Get elements in {@literal range} from sorted set.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYSCORE
*/
default Flux zRangeByScore(ByteBuffer key, Range range, Limit limit) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
Assert.notNull(limit, "Limit must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.scoresWithin(range).from(key).limitTo(limit))) //
.flatMap(CommandResponse::getOutput) //
.map(tuple -> ByteBuffer.wrap(tuple.getValue()));
}
/**
* Get {@link Tuple}s in {@literal range} from sorted set.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYSCORE
*/
default Flux zRangeByScoreWithScores(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.scoresWithin(range).withScores().from(key)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get {@link Tuple}s in {@literal range} from sorted set.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYSCORE
*/
default Flux zRangeByScoreWithScores(ByteBuffer key, Range range, Limit limit) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
Assert.notNull(limit, "Limit must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.scoresWithin(range).withScores().from(key).limitTo(limit)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get elements in {@literal range} from sorted set in reverse {@literal score} ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGEBYSCORE
*/
default Flux zRevRangeByScore(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.reverseScoresWithin(range).from(key))) //
.flatMap(CommandResponse::getOutput) //
.map(tuple -> ByteBuffer.wrap(tuple.getValue()));
}
/**
* Get elements in {@literal range} from sorted set in reverse {@literal score} ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGEBYSCORE
*/
default Flux zRevRangeByScore(ByteBuffer key, Range range, Limit limit) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
Assert.notNull(limit, "Limit must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.reverseScoresWithin(range).from(key).limitTo(limit))) //
.flatMap(CommandResponse::getOutput) //
.map(tuple -> ByteBuffer.wrap(tuple.getValue()));
}
/**
* Get set of {@link Tuple}s in {@literal range} from sorted set in reverse {@literal score} ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGEBYSCORE
*/
default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRangeByScore(Mono.just(ZRangeByScoreCommand.reverseScoresWithin(range).withScores().from(key)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get {@link Tuple}s in {@literal range} from sorted set in reverse {@literal score} ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGEBYSCORE
*/
default Flux zRevRangeByScoreWithScores(ByteBuffer key, Range range, Limit limit) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
Assert.notNull(limit, "Limit must not be null!");
return zRangeByScore(
Mono.just(ZRangeByScoreCommand.reverseScoresWithin(range).withScores().from(key).limitTo(limit)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get {@link Tuple}s in {@literal range} from sorted set.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYSCORE
* @see Redis Documentation: ZREVRANGEBYSCORE
*/
Flux>> zRangeByScore(Publisher commands);
/**
* Use a {@link Flux} to iterate over members in the sorted set at {@code key}. The resulting {@link Flux} acts as a
* cursor and issues {@code ZSCAN} commands itself as long as the subscriber signals demand.
*
* @param key must not be {@literal null}.
* @return the {@link Flux} emitting the raw {@link Tuple tuples} one by one.
* @throws IllegalArgumentException when key is {@literal null}.
* @see Redis Documentation: ZSCAN
* @since 2.1
*/
default Flux zScan(ByteBuffer key) {
return zScan(key, ScanOptions.NONE);
}
/**
* Use a {@link Flux} to iterate over members in the sorted set at {@code key} given {@link ScanOptions}. The
* resulting {@link Flux} acts as a cursor and issues {@code ZSCAN} commands itself as long as the subscriber signals.
*
* @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 raw {@link Tuple tuples} one by one.
* @throws IllegalArgumentException when one of the required arguments is {@literal null}.
* @see Redis Documentation: ZSCAN
* @since 2.1
*/
default Flux zScan(ByteBuffer key, ScanOptions options) {
return zScan(Mono.just(KeyScanCommand.key(key).withOptions(options))).map(CommandResponse::getOutput)
.flatMap(it -> it);
}
/**
* Use a {@link Flux} to iterate over members in the sorted set at {@code key}. The resulting {@link Flux} acts as a
* cursor and issues {@code ZSCAN} commands itself as long as the subscriber signals demand.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZSCAN
* @since 2.1
*/
Flux>> zScan(Publisher commands);
/**
* {@code ZCOUNT} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZCOUNT
*/
class ZCountCommand extends KeyCommand {
private final Range range;
private ZCountCommand(@Nullable ByteBuffer key, Range range) {
super(key);
this.range = range;
}
/**
* Creates a new {@link ZCountCommand} given a {@link Range}.
*
* @param range must not be {@literal null}.
* @return a new {@link ZCountCommand} for {@link Range}.
*/
public static ZCountCommand scoresWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZCountCommand(null, range);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZCountCommand} with {@literal key} applied.
*/
public ZCountCommand forKey(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZCountCommand(key, range);
}
/**
* @return
*/
public Range getRange() {
return range;
}
}
/**
* Count number of elements within sorted set with scores within {@link Range}.
* NOTE please use {@link Double#NEGATIVE_INFINITY} for {@literal -inf} and {@link Double#POSITIVE_INFINITY}
* for {@literal +inf}.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZCOUNT
*/
default Mono zCount(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zCount(Mono.just(ZCountCommand.scoresWithin(range).forKey(key))).next().map(NumericResponse::getOutput);
}
/**
* Count number of elements within sorted set with scores within {@link Range}.
* NOTE please use {@link Double#NEGATIVE_INFINITY} for {@literal -inf} and {@link Double#POSITIVE_INFINITY}
* for {@literal +inf}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZCOUNT
*/
Flux> zCount(Publisher commands);
/**
* Get the size of sorted set with {@literal key}.
*
* @param key must not be {@literal null}.
* @return
* @see Redis Documentation: ZCARD
*/
default Mono zCard(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return zCard(Mono.just(new KeyCommand(key))).next().map(NumericResponse::getOutput);
}
/**
* Get the size of sorted set with {@link KeyCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZCARD
*/
Flux> zCard(Publisher commands);
/**
* {@code ZSCORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZSCORE
*/
class ZScoreCommand extends KeyCommand {
private final ByteBuffer value;
private ZScoreCommand(@Nullable ByteBuffer key, ByteBuffer value) {
super(key);
this.value = value;
}
/**
* Creates a new {@link ZScoreCommand} given a {@link ByteBuffer member}.
*
* @param member must not be {@literal null}.
* @return a new {@link ZScoreCommand} for {@link Range}.
*/
public static ZScoreCommand scoreOf(ByteBuffer member) {
Assert.notNull(member, "Member must not be null!");
return new ZScoreCommand(null, member);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZScoreCommand} with {@literal key} applied.
*/
public ZScoreCommand forKey(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZScoreCommand(key, value);
}
/**
* @return
*/
public ByteBuffer getValue() {
return value;
}
}
/**
* Get the score of element with {@literal value} from sorted set with key {@literal key}.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return
* @see Redis Documentation: ZSCORE
*/
default Mono zScore(ByteBuffer key, ByteBuffer value) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(value, "Value must not be null!");
return zScore(Mono.just(ZScoreCommand.scoreOf(value).forKey(key))).next().map(NumericResponse::getOutput);
}
/**
* Get the score of element with {@link ZScoreCommand#getValue()} from sorted set with key
* {@link ZScoreCommand#getKey()}
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZSCORE
*/
Flux> zScore(Publisher commands);
/**
* {@code ZREMRANGEBYRANK} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZREMRANGEBYRANK
*/
class ZRemRangeByRankCommand extends KeyCommand {
private final Range range;
private ZRemRangeByRankCommand(ByteBuffer key, Range range) {
super(key);
this.range = range;
}
/**
* Creates a new {@link ZRemRangeByRankCommand} given a {@link Range}.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRemRangeByRankCommand} for {@link Range}.
*/
public static ZRemRangeByRankCommand valuesWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRemRangeByRankCommand(null, range);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRemRangeByRankCommand} with {@literal key} applied.
*/
public ZRemRangeByRankCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRemRangeByRankCommand(key, range);
}
/**
* @return
*/
public Range getRange() {
return range;
}
}
/**
* Remove elements in {@link Range} from sorted set with {@literal key}.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREMRANGEBYRANK
*/
default Mono zRemRangeByRank(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRemRangeByRank(Mono.just(ZRemRangeByRankCommand.valuesWithin(range).from(key))).next()
.map(NumericResponse::getOutput);
}
/**
* Remove elements in {@link Range} from sorted set with {@link ZRemRangeByRankCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZREMRANGEBYRANK
*/
Flux> zRemRangeByRank(Publisher commands);
/**
* {@code ZREMRANGEBYSCORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZREMRANGEBYSCORE
*/
class ZRemRangeByScoreCommand extends KeyCommand {
private final Range range;
private ZRemRangeByScoreCommand(@Nullable ByteBuffer key, Range range) {
super(key);
this.range = range;
}
/**
* Creates a new {@link ZRemRangeByScoreCommand} given a {@link Range}.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRemRangeByScoreCommand} for {@link Range}.
*/
public static ZRemRangeByScoreCommand scoresWithin(Range range) {
return new ZRemRangeByScoreCommand(null, range);
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRemRangeByRankCommand} with {@literal key} applied.
*/
public ZRemRangeByScoreCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRemRangeByScoreCommand(key, range);
}
/**
* @return
*/
public Range getRange() {
return range;
}
}
/**
* Remove elements in {@link Range} from sorted set with {@literal key}.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREMRANGEBYSCORE
*/
default Mono zRemRangeByScore(ByteBuffer key, Range range) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRemRangeByScore(Mono.just(ZRemRangeByScoreCommand.scoresWithin(range).from(key))).next()
.map(NumericResponse::getOutput);
}
/**
* Remove elements in {@link Range} from sorted set with {@link ZRemRangeByRankCommand#getKey()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZREMRANGEBYSCORE
*/
Flux> zRemRangeByScore(Publisher commands);
/**
* {@code ZUNIONSTORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZUNIONSTORE
*/
class ZUnionStoreCommand extends KeyCommand {
private final List sourceKeys;
private final List weights;
private final @Nullable Aggregate aggregateFunction;
private ZUnionStoreCommand(@Nullable ByteBuffer key, List sourceKeys, List weights,
@Nullable Aggregate aggregate) {
super(key);
this.sourceKeys = sourceKeys;
this.weights = weights;
this.aggregateFunction = aggregate;
}
/**
* Creates a new {@link ZUnionStoreCommand} given a {@link List} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link ZUnionStoreCommand} for {@link Range}.
*/
public static ZUnionStoreCommand sets(List keys) {
Assert.notNull(keys, "Keys must not be null!");
return new ZUnionStoreCommand(null, new ArrayList<>(keys), Collections.emptyList(), null);
}
/**
* Applies the {@link List} of weights. Constructs a new command instance with all previously configured properties.
*
* @param weights must not be {@literal null}.
* @return a new {@link ZUnionStoreCommand} with {@literal weights} applied.
*/
public ZUnionStoreCommand applyWeights(List weights) {
return new ZUnionStoreCommand(getKey(), sourceKeys, weights, aggregateFunction);
}
/**
* Applies the {@link Weights}. Constructs a new command instance with all previously configured properties.
*
* @param weights must not be {@literal null}.
* @return a new {@link ZUnionStoreCommand} with {@literal weights} applied.
* @since 2.1
*/
public ZUnionStoreCommand applyWeights(Weights weights) {
return applyWeights(weights.toList());
}
/**
* Applies a specific {@link Aggregate} function. Constructs a new command instance with all previously configured
* properties.
*
* @param aggregateFunction can be {@literal null}.
* @return a new {@link ZUnionStoreCommand} with {@link Aggregate} applied.
*/
public ZUnionStoreCommand aggregateUsing(@Nullable Aggregate aggregateFunction) {
return new ZUnionStoreCommand(getKey(), sourceKeys, weights, aggregateFunction);
}
/**
* Applies the {@literal key} at which the result is stored. Constructs a new command instance with all previously
* configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZUnionStoreCommand} with {@literal key} applied.
*/
public ZUnionStoreCommand storeAs(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZUnionStoreCommand(key, sourceKeys, weights, aggregateFunction);
}
/**
* @return never {@literal null}.
*/
public List getSourceKeys() {
return sourceKeys;
}
/**
* @return never {@literal null}.
*/
public List getWeights() {
return weights;
}
/**
* @return never {@literal null}.
*/
public Optional getAggregateFunction() {
return Optional.ofNullable(aggregateFunction);
}
}
/**
* Union sorted {@literal sets} and store result in destination {@literal destinationKey}.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @return
* @see Redis Documentation: ZUNIONSTORE
*/
default Mono zUnionStore(ByteBuffer destinationKey, List sets) {
return zUnionStore(destinationKey, sets, Collections.emptyList());
}
/**
* Union sorted {@literal sets} and store result in destination {@literal destinationKey} and apply weights to
* individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights must not be {@literal null}.
* @return
* @see Redis Documentation: ZUNIONSTORE
*/
default Mono zUnionStore(ByteBuffer destinationKey, List sets, List weights) {
return zUnionStore(destinationKey, sets, weights, null);
}
/**
* Union sorted {@literal sets} and store result in destination {@literal destinationKey} and apply weights to
* individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights must not be {@literal null}.
* @return
* @since 2.1
* @see Redis Documentation: ZUNIONSTORE
*/
default Mono zUnionStore(ByteBuffer destinationKey, List sets, Weights weights) {
return zUnionStore(destinationKey, sets, weights, null);
}
/**
* Union sorted {@literal sets} by applying {@literal aggregateFunction} and store result in destination
* {@literal destinationKey} and apply weights to individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights can be {@literal null}.
* @param aggregateFunction can be {@literal null}.
* @return
* @see Redis Documentation: ZUNIONSTORE
*/
default Mono zUnionStore(ByteBuffer destinationKey, List sets, List weights,
@Nullable Aggregate aggregateFunction) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(sets, "Sets must not be null!");
return zUnionStore(Mono.just(
ZUnionStoreCommand.sets(sets).aggregateUsing(aggregateFunction).applyWeights(weights).storeAs(destinationKey)))
.next().map(NumericResponse::getOutput);
}
/**
* Union sorted {@literal sets} by applying {@literal aggregateFunction} and store result in destination
* {@literal destinationKey} and apply weights to individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights can be {@literal null}.
* @param aggregateFunction can be {@literal null}.
* @return
* @since 2.1
* @see Redis Documentation: ZUNIONSTORE
*/
default Mono zUnionStore(ByteBuffer destinationKey, List sets, Weights weights,
@Nullable Aggregate aggregateFunction) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(sets, "Sets must not be null!");
return zUnionStore(Mono.just(
ZUnionStoreCommand.sets(sets).aggregateUsing(aggregateFunction).applyWeights(weights).storeAs(destinationKey)))
.next().map(NumericResponse::getOutput);
}
/**
* Union sorted {@literal sets} by applying {@literal aggregateFunction} and store result in destination
* {@literal destinationKey} and apply weights to individual sets.
*
* @param commands
* @return
* @see Redis Documentation: ZUNIONSTORE
*/
Flux> zUnionStore(Publisher commands);
/**
* {@code ZINTERSTORE} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZINTERSTORE
*/
class ZInterStoreCommand extends KeyCommand {
private final List sourceKeys;
private final List weights;
private final @Nullable Aggregate aggregateFunction;
private ZInterStoreCommand(ByteBuffer key, List sourceKeys, List weights,
@Nullable Aggregate aggregate) {
super(key);
this.sourceKeys = sourceKeys;
this.weights = weights;
this.aggregateFunction = aggregate;
}
/**
* Creates a new {@link ZInterStoreCommand} given a {@link List} of keys.
*
* @param keys must not be {@literal null}.
* @return a new {@link ZInterStoreCommand} for {@link Range}.
*/
public static ZInterStoreCommand sets(List keys) {
Assert.notNull(keys, "Keys must not be null!");
return new ZInterStoreCommand(null, new ArrayList<>(keys), Collections.emptyList(), null);
}
/**
* Applies the {@link Collection} of weights. Constructs a new command instance with all previously configured
* properties.
*
* @param weights must not be {@literal null}.
* @return a new {@link ZInterStoreCommand} with {@literal weights} applied.
*/
public ZInterStoreCommand applyWeights(List weights) {
return new ZInterStoreCommand(getKey(), sourceKeys, weights, aggregateFunction);
}
/**
* Applies the {@link Weights}. Constructs a new command instance with all previously configured properties.
*
* @param weights must not be {@literal null}.
* @return a new {@link ZInterStoreCommand} with {@literal weights} applied.
* @since 2.1
*/
public ZInterStoreCommand applyWeights(Weights weights) {
return applyWeights(weights.toList());
}
/**
* Applies a specific {@link Aggregate} function. Constructs a new command instance with all previously configured
* properties.
*
* @param aggregateFunction can be {@literal null}.
* @return a new {@link ZInterStoreCommand} with {@link Aggregate} applied.
*/
public ZInterStoreCommand aggregateUsing(@Nullable Aggregate aggregateFunction) {
return new ZInterStoreCommand(getKey(), sourceKeys, weights, aggregateFunction);
}
/**
* Applies the {@literal key} at which the result is stored. Constructs a new command instance with all previously
* configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZInterStoreCommand} with {@literal key} applied.
*/
public ZInterStoreCommand storeAs(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZInterStoreCommand(key, sourceKeys, weights, aggregateFunction);
}
/**
* @return never {@literal null}.
*/
public List getSourceKeys() {
return sourceKeys;
}
/**
* @return never {@literal null}.
*/
public List getWeights() {
return weights;
}
/**
* @return never {@literal null}.ø
*/
public Optional getAggregateFunction() {
return Optional.ofNullable(aggregateFunction);
}
}
/**
* Intersect sorted {@literal sets} and store result in destination {@literal destinationKey}.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @return
* @see Redis Documentation: ZINTERSTORE
*/
default Mono zInterStore(ByteBuffer destinationKey, List sets) {
return zInterStore(destinationKey, sets, Collections.emptyList());
}
/**
* Intersect sorted {@literal sets} and store result in destination {@literal destinationKey} and apply weights to
* individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights must not be {@literal null}.
* @return
* @see Redis Documentation: ZINTERSTORE
*/
default Mono zInterStore(ByteBuffer destinationKey, List sets, List weights) {
return zInterStore(destinationKey, sets, weights, null);
}
/**
* Intersect sorted {@literal sets} and store result in destination {@literal destinationKey} and apply weights to
* individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights must not be {@literal null}.
* @return
* @since 2.1
* @see Redis Documentation: ZINTERSTORE
*/
default Mono zInterStore(ByteBuffer destinationKey, List sets, Weights weights) {
return zInterStore(destinationKey, sets, weights, null);
}
/**
* Intersect sorted {@literal sets} by applying {@literal aggregateFunction} and store result in destination
* {@literal destinationKey} and apply weights to individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights must not be {@literal null}.
* @param aggregateFunction can be {@literal null}.
* @return
* @see Redis Documentation: ZINTERSTORE
*/
default Mono zInterStore(ByteBuffer destinationKey, List sets, List weights,
@Nullable Aggregate aggregateFunction) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(sets, "Sets must not be null!");
return zInterStore(Mono.just(
ZInterStoreCommand.sets(sets).aggregateUsing(aggregateFunction).applyWeights(weights).storeAs(destinationKey)))
.next().map(NumericResponse::getOutput);
}
/**
* Intersect sorted {@literal sets} by applying {@literal aggregateFunction} and store result in destination
* {@literal destinationKey} and apply weights to individual sets.
*
* @param destinationKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @param weights must not be {@literal null}.
* @param aggregateFunction can be {@literal null}.
* @return
* @since 2.1
* @see Redis Documentation: ZINTERSTORE
*/
default Mono zInterStore(ByteBuffer destinationKey, List sets, Weights weights,
@Nullable Aggregate aggregateFunction) {
Assert.notNull(destinationKey, "DestinationKey must not be null!");
Assert.notNull(sets, "Sets must not be null!");
return zInterStore(Mono.just(
ZInterStoreCommand.sets(sets).aggregateUsing(aggregateFunction).applyWeights(weights).storeAs(destinationKey)))
.next().map(NumericResponse::getOutput);
}
/**
* Intersect sorted {@literal sets} by applying {@literal aggregateFunction} and store result in destination
* {@literal destinationKey} and apply weights to individual sets.
*
* @param commands
* @return
* @see Redis Documentation: ZINTERSTORE
*/
Flux> zInterStore(Publisher commands);
/**
* {@code ZRANGEBYLEX}/{@literal ZREVRANGEBYLEX} command parameters.
*
* @author Christoph Strobl
* @see Redis Documentation: ZRANGEBYLEX
* @see Redis Documentation: ZREVRANGEBYLEX
*/
class ZRangeByLexCommand extends KeyCommand {
private final Range range;
private final Direction direction;
private final Limit limit;
private ZRangeByLexCommand(@Nullable ByteBuffer key, Range range, Direction direction, Limit limit) {
super(key);
this.range = range;
this.direction = direction;
this.limit = limit;
}
/**
* Creates a new {@link ZRangeByLexCommand} given a {@link Range} of {@link String} to retrieve elements
* lexicographical ordering.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRangeByLexCommand} for {@link Tuple}.
*/
public static ZRangeByLexCommand stringsWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRangeByLexCommand(null, range, Direction.ASC, Limit.unlimited());
}
/**
* Creates a new {@link ZRangeByLexCommand} given a {@link Range} of {@link String} to obtain elements in reverse
* lexicographical ordering.
*
* @param range must not be {@literal null}.
* @return a new {@link ZRangeByLexCommand} for {@link Tuple}.
*/
public static ZRangeByLexCommand reverseStringsWithin(Range range) {
Assert.notNull(range, "Range must not be null!");
return new ZRangeByLexCommand(null, range, Direction.DESC, Limit.unlimited());
}
/**
* Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
*
* @param key must not be {@literal null}.
* @return a new {@link ZRangeByLexCommand} with {@literal key} applied.
*/
public ZRangeByLexCommand from(ByteBuffer key) {
Assert.notNull(key, "Key must not be null!");
return new ZRangeByLexCommand(key, range, direction, limit);
}
/**
* Applies the {@link Limit}. Constructs a new command instance with all previously configured properties.
*
* @param limit must not be {@literal null}.
* @return a new {@link ZRangeByLexCommand} with {@link Limit} applied.
*/
public ZRangeByLexCommand limitTo(Limit limit) {
Assert.notNull(limit, "Limit must not be null!");
return new ZRangeByLexCommand(getKey(), range, direction, limit);
}
/**
* @return
*/
public Range getRange() {
return range;
}
/**
* @return
*/
public Limit getLimit() {
return limit;
}
/**
* @return
*/
public Direction getDirection() {
return direction;
}
}
/**
* Get all elements in {@link Range} from the sorted set at {@literal key} in lexicographical ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYLEX
*/
default Flux zRangeByLex(ByteBuffer key, Range range) {
return zRangeByLex(key, range, Limit.unlimited());
}
/**
* Get all elements in {@link Range} from the sorted set at {@literal key} in lexicographical ordering. Result is
* limited via {@link Limit}.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit can be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYLEX
*/
default Flux zRangeByLex(ByteBuffer key, Range range, Limit limit) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
return zRangeByLex(Mono.just(ZRangeByLexCommand.stringsWithin(range).from(key).limitTo(limit)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get all elements in {@link Range} from the sorted set at {@literal key} in lexicographical ordering.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGEBYLEX
*/
default Flux zRevRangeByLex(ByteBuffer key, Range range) {
return zRevRangeByLex(key, range, Limit.unlimited());
}
/**
* Get all elements in {@link Range} from the sorted set at {@literal key} in lexicographical ordering. Result is
* limited via {@link Limit}.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit must not be {@literal null}.
* @return
* @see Redis Documentation: ZREVRANGEBYLEX
*/
default Flux zRevRangeByLex(ByteBuffer key, Range range, Limit limit) {
Assert.notNull(key, "Key must not be null!");
Assert.notNull(range, "Range must not be null!");
Assert.notNull(limit, "Limit must not be null!");
return zRangeByLex(Mono.just(ZRangeByLexCommand.reverseStringsWithin(range).from(key).limitTo(limit)))
.flatMap(CommandResponse::getOutput);
}
/**
* Get all elements in {@link Range} from the sorted set at {@literal key} in lexicographical ordering. Result is
* limited via {@link Limit} and sorted by {@link ZRangeByLexCommand#getDirection()}.
*
* @param commands must not be {@literal null}.
* @return
* @see Redis Documentation: ZRANGEBYLEX
* @see Redis Documentation: ZREVRANGEBYLEX
*/
Flux>> zRangeByLex(Publisher commands);
}
