BF.LOADCHUNK

Syntax text Syntax diagram API methods

BF.LOADCHUNK key iterator data

Client:

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

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

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

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

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

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

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

bf_loadchunk(
    key: K,  // The name of the Bloom filter to restore
    chunk: BloomFilterDumpChunk  // A chunk previously produced by bf_scandump
) → (())  // Unit on success

bf_loadchunk(
    key: K,  // The name of the Bloom filter to restore
    chunk: BloomFilterDumpChunk  // A chunk previously produced by bf_scandump
) → (())  // Unit on success

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

Restores a Bloom filter previously saved using BF.SCANDUMP.

See the BF.SCANDUMP command for example usage.

Notes

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

Required arguments

key

is key name for a Bloom filter to restore.

iterator

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

data

Current data chunk (returned by BF.SCANDUMP)

Examples

See BF.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.

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.

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference