Spring/spring-data-redis
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Scripting Documentation for imperative Lua scripts.

Browse Source 
See #3010
This commit is contained in:
Mark Paluch
2024-10-10 14:30:05 +02:00
parent 2df0361a93
commit 8fe72a0840
3 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/antora/modules/ROOT/pages/redis/scripting.adoc
View File

@@ -34,7 +34,7 @@ public class Example {
RedisScript<Boolean> script;
public boolean checkAndSet(String expectedValue, String newValue) {
return redisOperations.execute(script, singletonList("key"), asList(expectedValue, newValue));
return redisOperations.execute(script, singletonList("key"), expectedValue, newValue);
}
}
----

16
src/main/java/org/springframework/data/redis/core/script/ReactiveScriptExecutor.java
View File

@@ -30,8 +30,8 @@ import org.springframework.data.redis.serializer.RedisSerializer;
* <p>
* Streams of methods returning {@code Mono<K>} or {@code Flux<M>} are terminated with
* {@link org.springframework.dao.InvalidDataAccessApiUsageException} when
* {@link org.springframework.data.redis.serializer.RedisElementReader#read(ByteBuffer)} returns {@code null} for a
* particular element as Reactive Streams prohibit the usage of {@code null} values.
* {@link org.springframework.data.redis.serializer.RedisElementReader#read(ByteBuffer)} returns {@literal null} for a
* particular element as Reactive Streams prohibit the usage of {@literal null} values.
*
* @author Mark Paluch
* @author Christoph Strobl
@@ -45,7 +45,7 @@ public interface ReactiveScriptExecutor<K> {
*
* @param script must not be {@literal null}.
* @return the return value of the script or {@link Flux#empty()} if {@link RedisScript#getResultType()} is
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK")
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK").
*/
default <T> Flux<T> execute(RedisScript<T> script) {
return execute(script, Collections.emptyList());
@@ -57,7 +57,7 @@ public interface ReactiveScriptExecutor<K> {
* @param script must not be {@literal null}.
* @param keys must not be {@literal null}.
* @return the return value of the script or {@link Flux#empty()} if {@link RedisScript#getResultType()} is
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK")
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK").
*/
default <T> Flux<T> execute(RedisScript<T> script, List<K> keys) {
return execute(script, keys, Collections.emptyList());
@@ -67,8 +67,8 @@ public interface ReactiveScriptExecutor<K> {
* Executes the given {@link RedisScript}
*
* @param script The script to execute. Must not be {@literal null}.
* @param keys Any keys that need to be passed to the script. Must not be {@literal null}.
* @param args Any args that need to be passed to the script. Can be {@literal empty}.
* @param keys any keys that need to be passed to the script. Must not be {@literal null}.
* @param args any args that need to be passed to the script. Can be {@literal empty}.
* @return The return value of the script or {@link Flux#empty()} if {@link RedisScript#getResultType()} is
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK")
*/
@@ -79,8 +79,8 @@ public interface ReactiveScriptExecutor<K> {
* arguments and result.
*
* @param script The script to execute. must not be {@literal null}.
* @param keys Any keys that need to be passed to the script
* @param args Any args that need to be passed to the script
* @param keys any keys that need to be passed to the script.
* @param args any args that need to be passed to the script.
* @param argsWriter The {@link RedisElementWriter} to use for serializing args. Must not be {@literal null}.
* @param resultReader The {@link RedisElementReader} to use for serializing the script return value. Must not be
* {@literal null}.

24
src/main/java/org/springframework/data/redis/core/script/ScriptExecutor.java
View File

@@ -30,11 +30,11 @@ public interface ScriptExecutor<K> {
/**
* Executes the given {@link RedisScript}
*
* @param script The script to execute
* @param keys Any keys that need to be passed to the script
* @param args Any args that need to be passed to the script
* @return The return value of the script or null if {@link RedisScript#getResultType()} is null, likely indicating a
* throw-away status reply (i.e. "OK")
* @param script the script to execute.
* @param keys any keys that need to be passed to the script.
* @param args any args that need to be passed to the script.
* @return The return value of the script or {@literal null} if {@link RedisScript#getResultType()} is
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK").
*/
<T> T execute(RedisScript<T> script, List<K> keys, Object... args);
@@ -42,13 +42,13 @@ public interface ScriptExecutor<K> {
* Executes the given {@link RedisScript}, using the provided {@link RedisSerializer}s to serialize the script
* arguments and result.
*
* @param script The script to execute
* @param argsSerializer The {@link RedisSerializer} to use for serializing args
* @param resultSerializer The {@link RedisSerializer} to use for serializing the script return value
* @param keys Any keys that need to be passed to the script
* @param args Any args that need to be passed to the script
* @return The return value of the script or null if {@link RedisScript#getResultType()} is null, likely indicating a
* throw-away status reply (i.e. "OK")
* @param script the script to execute.
* @param argsSerializer The {@link RedisSerializer} to use for serializing args.
* @param resultSerializer The {@link RedisSerializer} to use for serializing the script return value.
* @param keys any keys that need to be passed to the script.
* @param args any args that need to be passed to the script.
* @return The return value of the script or {@literal null} if {@link RedisScript#getResultType()} is
* {@literal null}, likely indicating a throw-away status reply (i.e. "OK").
*/
<T> T execute(RedisScript<T> script, RedisSerializer<?> argsSerializer, RedisSerializer<T> resultSerializer,
List<K> keys, Object... args);