Interface RedisScriptingCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, RedisConnectionUtils.RedisConnectionProxy, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

@NullUnmarked
public interface RedisScriptingCommands

Scripting commands.

Author:

Costin Leau, Christoph Strobl, David Liu, Mark Paluch

See Also:

• RedisCommands

Method Summary

Modifier and Type	Method	Description
<T> T	eval(byte @NonNull [] script, @NonNull ReturnType returnType, int numKeys, byte @NonNull [] @NonNull ... keysAndArgs)	Evaluate given script.
<T> T	evalSha(byte @NonNull [] scriptSha, @NonNull ReturnType returnType, int numKeys, byte @NonNull [] @NonNull ... keysAndArgs)	Evaluate given scriptSha.
<T> T	evalSha(@NonNull String scriptSha, @NonNull ReturnType returnType, int numKeys, byte @NonNull [] @NonNull ... keysAndArgs)	Evaluate given scriptSha.
List<@NonNull Boolean>	scriptExists(@NonNull String @NonNull ... scriptShas)	Check if given scriptShas exist in script cache.
void	scriptFlush()	Flush lua script cache.
void	scriptKill()	Kill current lua script execution.
String	scriptLoad(byte @NonNull [] script)	Load lua script into scripts cache, without executing it. Execute the script by calling evalSha(byte[], ReturnType, int, byte[]...).

Method Details

scriptFlush

void scriptFlush()

Flush lua script cache.

See Also:

• Redis Documentation: SCRIPT FLUSH

scriptKill

void scriptKill()

Kill current lua script execution.

See Also:

• Redis Documentation: SCRIPT KILL

scriptLoad

String scriptLoad(byte @NonNull [] script)

Load lua script into scripts cache, without executing it.
Execute the script by calling evalSha(byte[], ReturnType, int, byte[]...).

Parameters:

script - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: SCRIPT LOAD

scriptExists

List<@NonNull Boolean> scriptExists(@NonNull String @NonNull ... scriptShas)

Check if given scriptShas exist in script cache.

Parameters:

scriptShas -

Returns:

one entry per given scriptSha in returned List or null when used in pipeline / transaction.

See Also:

• Redis Documentation: SCRIPT EXISTS

eval

<T> T eval(byte @NonNull [] script,
 @NonNull ReturnType returnType,
 int numKeys,
 byte @NonNull [] @NonNull ... keysAndArgs)

Evaluate given script.

Parameters:

script - must not be null.

returnType - must not be null.

numKeys -

keysAndArgs - must not be null.

Returns:

script result. null when used in pipeline / transaction.

See Also:

• Redis Documentation: EVAL

evalSha

<T> T evalSha(@NonNull String scriptSha,
 @NonNull ReturnType returnType,
 int numKeys,
 byte @NonNull [] @NonNull ... keysAndArgs)

Evaluate given scriptSha.

Parameters:

scriptSha - must not be null.

returnType - must not be null.

numKeys -

keysAndArgs - must not be null.

Returns:

script result. null when used in pipeline / transaction.

See Also:

• Redis Documentation: EVALSHA

evalSha

<T> T evalSha(byte @NonNull [] scriptSha,
 @NonNull ReturnType returnType,
 int numKeys,
 byte @NonNull [] @NonNull ... keysAndArgs)

Evaluate given scriptSha.

Parameters:

scriptSha - must not be null.

returnType - must not be null.

numKeys -

keysAndArgs - must not be null.

Returns:

script result. null when used in pipeline / transaction.

Since:

1.5

See Also:

• Redis Documentation: EVALSHA