Package org.redisson.api

Interface RScript

All Superinterfaces:

RScriptAsync

All Known Implementing Classes:

RedissonScript

public interface RScript
extends RScriptAsync

Interface for Redis Script feature

Author:

Nikita Koksharov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RScript.Mode
static class	RScript.ReturnType

Method Summary

Modifier and Type	Method	Description
<R> R	eval(String key, RScript.Mode mode, String luaScript, RScript.ReturnType returnType, List<Object> keys, Object... values)	Executes Lua script
<R> R	eval(RScript.Mode mode, String luaScript, RScript.ReturnType returnType)	Executes Lua script
<R> R	eval(RScript.Mode mode, String luaScript, RScript.ReturnType returnType, List<Object> keys, Object... values)	Executes Lua script
<R> R	eval(RScript.Mode mode, Codec codec, String luaScript, RScript.ReturnType returnType)	Deprecated.
<R> R	eval(RScript.Mode mode, Codec codec, String luaScript, RScript.ReturnType returnType, List<Object> keys, Object... values)	Deprecated.
<R> R	evalSha(String key, RScript.Mode mode, String shaDigest, RScript.ReturnType returnType, List<Object> keys, Object... values)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> R	evalSha(RScript.Mode mode, String shaDigest, RScript.ReturnType returnType)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> R	evalSha(RScript.Mode mode, String shaDigest, RScript.ReturnType returnType, List<Object> keys, Object... values)	Executes Lua script stored in Redis scripts cache by SHA-1 digest
<R> R	evalSha(RScript.Mode mode, Codec codec, String shaDigest, RScript.ReturnType returnType)	Deprecated.
<R> R	evalSha(RScript.Mode mode, Codec codec, String shaDigest, RScript.ReturnType returnType, List<Object> keys, Object... values)	Deprecated.
List<Boolean>	scriptExists(String... shaDigests)	Checks for presence Lua scripts in Redis script cache by SHA-1 digest.
void	scriptFlush()	Flushes Lua script cache.
void	scriptKill()	Kills currently executed Lua script
String	scriptLoad(String luaScript)	Loads Lua script into Redis scripts cache and returns its SHA-1 digest

Methods inherited from interface org.redisson.api.RScriptAsync

evalAsync, evalAsync, evalAsync, evalAsync, evalAsync, evalAsync, evalShaAsync, evalShaAsync, evalShaAsync, evalShaAsync, evalShaAsync, evalShaAsync, scriptExistsAsync, scriptExistsAsync, scriptFlushAsync, scriptKillAsync, scriptLoadAsync, scriptLoadAsync

Method Detail

evalSha

<R> R evalSha(RScript.Mode mode,
              String shaDigest,
              RScript.ReturnType returnType,
              List<Object> keys,
              Object... values)

Executes Lua script stored in Redis scripts cache by SHA-1 digest

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

evalSha

<R> R evalSha(String key,
              RScript.Mode mode,
              String shaDigest,
              RScript.ReturnType returnType,
              List<Object> keys,
              Object... values)

Executes Lua script stored in Redis scripts cache by SHA-1 digest

Type Parameters:

R - - type of result

Parameters:

key - - used to locate Redis node in Cluster which stores cached Lua script

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

evalSha

@Deprecated
<R> R evalSha(RScript.Mode mode,
              Codec codec,
              String shaDigest,
              RScript.ReturnType returnType,
              List<Object> keys,
              Object... values)

Deprecated.

evalSha

<R> R evalSha(RScript.Mode mode,
              String shaDigest,
              RScript.ReturnType returnType)

Executes Lua script stored in Redis scripts cache by SHA-1 digest

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

shaDigest - - SHA-1 digest

returnType - - return type

Returns:

result object

evalSha

@Deprecated
<R> R evalSha(RScript.Mode mode,
              Codec codec,
              String shaDigest,
              RScript.ReturnType returnType)

Deprecated.

eval

<R> R eval(String key,
           RScript.Mode mode,
           String luaScript,
           RScript.ReturnType returnType,
           List<Object> keys,
           Object... values)

Executes Lua script

Type Parameters:

R - - type of result

Parameters:

key - - used to locate Redis node in Cluster which stores cached Lua script

mode - - execution mode

luaScript - - lua script

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

eval

<R> R eval(RScript.Mode mode,
           String luaScript,
           RScript.ReturnType returnType,
           List<Object> keys,
           Object... values)

Executes Lua script

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

luaScript - - lua script

returnType - - return type

keys - - keys available through KEYS param in script

values - - values available through VALUES param in script

Returns:

result object

eval

@Deprecated
<R> R eval(RScript.Mode mode,
           Codec codec,
           String luaScript,
           RScript.ReturnType returnType,
           List<Object> keys,
           Object... values)

Deprecated.

eval

<R> R eval(RScript.Mode mode,
           String luaScript,
           RScript.ReturnType returnType)

Executes Lua script

Type Parameters:

R - - type of result

Parameters:

mode - - execution mode

luaScript - - lua script

returnType - - return type

Returns:

result object

eval

@Deprecated
<R> R eval(RScript.Mode mode,
           Codec codec,
           String luaScript,
           RScript.ReturnType returnType)

Deprecated.

scriptLoad

String scriptLoad(String luaScript)

Loads Lua script into Redis scripts cache and returns its SHA-1 digest

Parameters:

luaScript - - lua script

Returns:

SHA-1 digest

scriptExists

List<Boolean> scriptExists(String... shaDigests)

Checks for presence Lua scripts in Redis script cache by SHA-1 digest.

Parameters:

shaDigests - - collection of SHA-1 digests

Returns:

list of booleans corresponding to collection SHA-1 digests

scriptKill

void scriptKill()

Kills currently executed Lua script

scriptFlush

void scriptFlush()

Flushes Lua script cache.