CMS.INITBYDIM

Syntax text Syntax diagram API methods

CMS.INITBYDIM key width depth

Client:

initbydim(
    key: str,
    width: int,  // Number of counters in each array
    depth: int  // Number of counter-arrays
) → bool  // True if created successfully

Possible errors

ERR wrong number of arguments: ResponseError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

client.cms.initByDim(
    key: RedisArgument,
    width: number,  // Number of counters in each array
    depth: number  // Number of counter arrays
) → SimpleStringReply<'OK'>  // OK on success

Possible errors

ERR wrong number of arguments: SimpleError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

cmsInitByDim(
    key: String,
    width: long,
    depth: long
) → String  // OK

Possible errors

ERR wrong number of arguments: JedisDataException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

CMSInitByDim(
    ctx: context.Context,
    key: string,
    width: int64,
    depth: int64
) → *StatusCmd  // Status command result

Possible errors

ERR wrong number of arguments: redis.Error

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

InitByDim(
    key: RedisKey,
    width: long,
    depth: long
) → bool  // True if created successfully

Possible errors

ERR wrong number of arguments: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

InitByDimAsync(
    key: RedisKey,
    width: long,
    depth: long
) → Task<bool>  // True if created successfully

Possible errors

ERR wrong number of arguments: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

cmsinitbydim(
    key: string,
    width: int,
    depth: int
) → string  // OK

Possible errors

ERR wrong number of arguments: Predis\Response\ServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

Available in:: Redis Open Source / Bloom 2.0.0
Time complexity:: O(1)
ACL categories:: @cms, @write, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Initializes a Count-Min Sketch to dimensions specified by user.

Required arguments

key

The name of the sketch.

width

Number of counters in each array. Reduces the error size.

depth

Number of counter-arrays. Reduces the probability for an error of a certain size (percentage of total count).

Examples

redis> CMS.INITBYDIM test 2000 5
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 if the given key already exists.

	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