org.springframework.data.redis.core.ReactiveValueOperations 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.Mono;
import java.time.Duration;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.springframework.data.redis.connection.BitFieldSubCommands;
/**
* Reactive Redis operations for simple (or in Redis terminology 'string') values.
*
* @author Mark Paluch
* @author Jiahe Cai
* @since 2.0
*/
public interface ReactiveValueOperations {
/**
* Set {@code value} for {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @see Redis Documentation: SET
*/
Mono set(K key, V value);
/**
* Set the {@code value} and expiration {@code timeout} for {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @param timeout must not be {@literal null}.
* @see Redis Documentation: SETEX
*/
Mono set(K key, V value, Duration timeout);
/**
* Set {@code key} to hold the string {@code value} if {@code key} is absent.
*
* @param key must not be {@literal null}.
* @param value
* @see Redis Documentation: SETNX
*/
Mono setIfAbsent(K key, V value);
/**
* Set {@code key} to hold the string {@code value} and expiration {@code timeout} if {@code key} is absent.
*
* @param key must not be {@literal null}.
* @param value
* @param timeout must not be {@literal null}.
* @since 2.1
* @see Redis Documentation: SET
*/
Mono setIfAbsent(K key, V value, Duration timeout);
/**
* Set {@code key} to hold the string {@code value} if {@code key} is present.
*
* @param key must not be {@literal null}.
* @param value
* @see Redis Documentation: SET
*/
Mono setIfPresent(K key, V value);
/**
* Set {@code key} to hold the string {@code value} and expiration {@code timeout} if {@code key} is present.
*
* @param key must not be {@literal null}.
* @param value
* @param timeout must not be {@literal null}.
* @since 2.1
* @see Redis Documentation: SET
*/
Mono setIfPresent(K key, V value, Duration timeout);
/**
* Set multiple keys to multiple values using key-value pairs provided in {@code tuple}.
*
* @param map must not be {@literal null}.
* @see Redis Documentation: MSET
*/
Mono multiSet(Map map);
/**
* Set multiple keys to multiple values using key-value pairs provided in {@code tuple} only if the provided key does
* not exist.
*
* @param map must not be {@literal null}.
* @see Redis Documentation: MSETNX
*/
Mono multiSetIfAbsent(Map map);
/**
* Get the value of {@code key}.
*
* @param key must not be {@literal null}.
* @see Redis Documentation: GET
*/
Mono get(Object key);
/**
* Set {@code value} of {@code key} and return its old value.
*
* @param key must not be {@literal null}.
* @see Redis Documentation: GETSET
*/
Mono getAndSet(K key, V value);
/**
* Get multiple {@code keys}. Values are returned in the order of the requested keys.
*
* @param keys must not be {@literal null}.
* @see Redis Documentation: MGET
*/
Mono> multiGet(Collection keys);
/**
* Increments the number stored at {@code key} by one.
*
* @param key must not be {@literal null}.
* @since 2.1
* @see Redis Documentation: INCR
*/
Mono increment(K key);
/**
* Increments the number stored at {@code key} by {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @since 2.1
* @see Redis Documentation: INCRBY
*/
Mono increment(K key, long delta);
/**
* Increment the string representing a floating point number stored at {@code key} by {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @since 2.1
* @see Redis Documentation: INCRBYFLOAT
*/
Mono increment(K key, double delta);
/**
* Decrements the number stored at {@code key} by one.
*
* @param key must not be {@literal null}.
* @since 2.1
* @see Redis Documentation: DECR
*/
Mono decrement(K key);
/**
* Decrements the number stored at {@code key} by {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @since 2.1
* @see Redis Documentation: DECRBY
*/
Mono decrement(K key, long delta);
/**
* Append a {@code value} to {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @see Redis Documentation: APPEND
*/
Mono append(K key, String value);
/**
* Get a substring of value of {@code key} between {@code begin} and {@code end}.
*
* @param key must not be {@literal null}.
* @param start
* @param end
* @see Redis Documentation: GETRANGE
*/
Mono get(K key, long start, long end);
/**
* Overwrite parts of {@code key} starting at the specified {@code offset} with given {@code value}.
*
* @param key must not be {@literal null}.
* @param value
* @param offset
* @see Redis Documentation: SETRANGE
*/
Mono set(K key, V value, long offset);
/**
* Get the length of the value stored at {@code key}.
*
* @param key must not be {@literal null}.
* @see Redis Documentation: STRLEN
*/
Mono size(K key);
/**
* Sets the bit at {@code offset} in value stored at {@code key}.
*
* @param key must not be {@literal null}.
* @param offset
* @param value
* @see Redis Documentation: SETBIT
*/
Mono setBit(K key, long offset, boolean value);
/**
* « Get the bit value at {@code offset} of value at {@code key}.
*
* @param key must not be {@literal null}.
* @param offset
* @see Redis Documentation: GETBIT
*/
Mono getBit(K key, long offset);
/**
* Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored
* at a given {@code key}.
*
* @param key must not be {@literal null}.
* @param command must not be {@literal null}.
* @return
* @since 2.1
*/
Mono> bitField(K key, BitFieldSubCommands command);
/**
* Removes the given {@literal key}.
*
* @param key must not be {@literal null}.
*/
Mono delete(K key);
}