FUNCTION RESTORE

Syntax text Syntax diagram API methods

FUNCTION RESTORE serialized-value [FLUSH | APPEND | REPLACE]

Client:

function_restore(
    payload: str,  // Serialized payload from FUNCTION DUMP
    policy: Optional[str]  // Restore policy (APPEND, FLUSH, or REPLACE)
) → Union[Awaitable[str], str]  // Status response

functionRestore(
    dump: RedisArgument,  // Serialized payload of functions to restore
    options: FunctionRestoreOptions  // Options for the restore operation
) → Promise<SimpleStringReply<'OK'>>  // Status response

functionRestore(
    serializedValue: byte[]  // Serialized payload from FUNCTION DUMP
) → String  // Status response

functionRestore(
    serializedValue: byte[],  // Serialized payload from FUNCTION DUMP
    policy: FunctionRestorePolicy  // Restore policy
) → String  // Status response

functionRestore(
    dump: byte[]  // Serialized payload from FUNCTION DUMP
) → String  // Status response

functionRestore(
    dump: byte[],  // Serialized payload from FUNCTION DUMP
    mode: FunctionRestoreMode  // Restore mode
) → String  // Status response

functionRestore(
    dump: byte[]  // Serialized payload from FUNCTION DUMP
) → RedisFuture<String>  // Status response

functionRestore(
    dump: byte[],  // Serialized payload from FUNCTION DUMP
    mode: FunctionRestoreMode  // Restore mode
) → RedisFuture<String>  // Status response

functionRestore(
    dump: byte[]  // Serialized payload from FUNCTION DUMP
) → Mono<String>  // Status response

functionRestore(
    dump: byte[],  // Serialized payload from FUNCTION DUMP
    mode: FunctionRestoreMode  // Restore mode
) → Mono<String>  // Status response

FunctionRestore(
    ctx: context.Context,  // Context for the operation
    libDump: string  // Serialized payload from FUNCTION DUMP
) → *StringCmd  // Status response

Available since:: Redis Open Source 7.0.0
Time complexity:: O(N) where N is the number of functions on the payload
ACL categories:: @write, @slow, @scripting,
Compatibility:: Redis Software and Redis Cloud compatibility

Restore libraries from serialized payload.

You can use the optional policy argument to provide a policy for handling existing libraries.

For more information see Introduction to Redis Functions.

Required arguments

serialized-value

The payload produced by FUNCTION DUMP.

Optional arguments

FLUSH | APPEND | REPLACE

Policies for handling existing libraries:

APPEND: appends the restored libraries to the existing libraries and aborts on collision. This is the default policy.
FLUSH: deletes all existing libraries before restoring the payload.
REPLACE: appends the restored libraries to the existing libraries, replacing any existing ones in case of name collisions. Note that this policy doesn't prevent function name collisions, only libraries.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Simple string reply: OK.