CF.LOADCHUNK

Syntax text Syntax diagram API methods

CF.LOADCHUNK key iterator data

Client:

loadchunk(
    key: str,  // The name of the Cuckoo filter
    iter: int,  // Iterator from SCANDUMP
    data: bytes  // Data from SCANDUMP
) → str  // OK on success

CF.LOADCHUNK(
    key: RedisArgument,  // The name of the Cuckoo filter
    iterator: number,  // Iterator from SCANDUMP
    data: RedisArgument  // Data from SCANDUMP
) → SimpleStringReply<'OK'>  // OK on success

cfLoadChunk(
    key: String,  // The name of the Cuckoo filter
    iterator: long,  // Iterator from SCANDUMP
    data: byte[]  // Data from SCANDUMP
) → String  // OK on success

CFLoadChunk(
    ctx: context.Context,  // Context
    key: string,  // The name of the Cuckoo filter
    iterator: int64,  // Iterator from SCANDUMP
    data: interface{}  // Data from SCANDUMP
) → *StatusCmd  // Status command result

LoadChunk(
    key: RedisKey,  // The name of the Cuckoo filter
    iterator: long,  // Iterator from SCANDUMP
    data: Byte[]  // Data from SCANDUMP
) → bool  // true on success

LoadChunkAsync(
    key: RedisKey,  // The name of the Cuckoo filter
    iterator: long,  // Iterator from SCANDUMP
    data: Byte[]  // Data from SCANDUMP
) → Task<bool>  // true on success

cfloadchunk(
    $key: string,  // The name of the Cuckoo filter
    $iterator: int,  // Iterator from SCANDUMP
    $data: mixed  // Data from SCANDUMP
) → Status  // OK on success

Available in:: Redis Open Source / Bloom 1.0.0
Time complexity:: O(n), where n is the capacity
ACL categories:: @cuckoo, @write, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Restores a cuckoo filter previously saved using CF.SCANDUMP.

See the CF.SCANDUMP command for example usage.

Notes

This command overwrites the cuckoo filter stored under key.
Make sure that the cuckoo filter is not changed between invocations.

Required arguments

key

is key name for a cuckoo filter to restore.

iterator

Iterator value associated with data (returned by CF.SCANDUMP)

data

Current data chunk (returned by CF.SCANDUMP)

Examples

See CF.SCANDUMP for an example.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Supported	✅ Flexible & Annual ✅ Free & Fixed

Return information

RESP2 RESP3

One of the following:

Simple string reply: OK if executed correctly.
Simple error reply in these cases: invalid arguments, wrong key type, or when invalid data was passed.