CMS.MERGE

Syntax text Syntax diagram API methods

CMS.MERGE destination numKeys source [source ...] [WEIGHTS weight
  [weight ...]]

Client:

merge(
    destKey: str,
    numKeys: int,
    srcKeys: List,  // Source sketch keys
    weights: List  // Optional weights for each source
) → bool  // True if merged successfully

CMS.MERGE(
    destination: RedisArgument,
    source: BfMergeSketches  // Array of sketch names or sketches with weights
) → SimpleStringReply<'OK'>  // OK on success

cmsMerge(
    destKey: String,
    keys: String...
) → String  // OK

cmsMerge(
    destKey: String,
    keysAndWeights: Map<String, Long>
) → String  // OK

CMSMerge(
    ctx: context.Context,
    destKey: string,
    sourceKeys: ...string
) → *StatusCmd  // Status command result

CMSMergeWithWeight(
    ctx: context.Context,
    destKey: string,
    sourceKeys: map[string]int64
) → *StatusCmd  // Status command result

Merge(
    destination: RedisValue,
    numKeys: long,
    source: RedisValue[],
    weight: long[]?  // Optional weights
) → bool  // True if merged successfully

MergeAsync(
    destination: RedisValue,
    numKeys: long,
    source: RedisValue[],
    weight: long[]?  // Optional weights
) → Task<bool>  // True if merged successfully

cmsmerge(
    destKey: string,
    sourceKeys: string...
) → string  // OK

Available in:: Redis Open Source / Bloom 2.0.0
Time complexity:: O(n) where n is the number of sketches
ACL categories:: @cms, @write,
Compatibility:: Redis Software and Redis Cloud compatibility

Note:

This command's behavior varies in clustered Redis environments. See the multi-key operations page for more information.

Merges several sketches into one sketch. All sketches must have identical width and depth. Weights can be used to multiply certain sketches. Default weight is 1.

Parameters:

dest: The name of destination sketch. Must be initialized.
numKeys: Number of sketches to be merged.
src: Names of source sketches to be merged.
weight: Multiple of each sketch. Default =1.

Examples

redis> CMS.MERGE dest 2 test1 test2 WEIGHTS 1 3
OK

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: non-existent key or destination key is not of the same width and/or depth.

Products

Tools

Get Redis

Connect

Learn

Latest

See how it works

CMS.MERGE

Parameters:

Examples

Redis Software and Redis Cloud compatibility

Return information