Redis Iris

Redis install Data types

Tools Community Docs

Login Sign up

Develop with Redis Libraries and tools Redis products

Commands

Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	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

ZINTERSTORE

Syntax text Syntax diagram API methods

ZINTERSTORE destination numkeys key [key ...] [WEIGHTS weight
  [weight ...]] [AGGREGATE <SUM | MIN | MAX | COUNT>]

Client:

zinterstore(
    dest: KeyT,
    keys: Union[Sequence[KeyT], Mapping[AnyKeyT, float]],
    aggregate: Optional[str] = None
) → ResponseT

Possible errors

ERR value is not an integer: ResponseError
ERR syntax error: ResponseError

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

zInterStore(
    destination: RedisArgument,
    keys: ZKeys,
    options?: ZInterOptions
) → NumberReply

Possible errors

ERR value is not an integer: SimpleError
ERR syntax error: SimpleError

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

zinterstore(
    destination: RedisKey,
    numkeys: number | string,
    ...keys: RedisKey[],
    callback: Callback<number>
) → Result<number, Context>

zinterstore(
    destination: RedisKey,
    numkeys: number | string,
    keys: RedisKey[],
    callback: Callback<number>
) → Result<number, Context>

zinterstore(
    destination: RedisKey,
    numkeys: number | string,
    ...keys: RedisKey[]
) → Result<number, Context>

zinterstore(
    destination: RedisKey,
    numkeys: number | string,
    keys: RedisKey[]
) → Result<number, Context>

zinterstore(
    destination: RedisKey,
    numkeys: number | string,
    ...keys: RedisKey[],
    aggregate: "AGGREGATE",
    sum: "SUM",
    callback: Callback<number>
) → Result<number, Context>

Possible errors

ERR value is not an integer: ReplyError
ERR syntax error: ReplyError

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

zinterstore(
    dstkey: byte[],
    sets: byte[]...
) → long  // The number of elements in the sorted set at dstkey

zinterstore(
    dstkey: byte[],
    params: ZParams,
    sets: byte[]...
) → long  // The number of elements in the sorted set at dstkey

zinterstore(
    dstkey: String,
    sets: String...
) → long  // The number of elements in the sorted set at dstkey

zinterstore(
    dstkey: String,
    params: ZParams,
    sets: String...
) → long  // The number of elements in the sorted set at dstkey

Possible errors

ERR value is not an integer: JedisDataException
ERR syntax error: JedisDataException

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

zinterstore(
    destination: K,  // the destination.
    keys: K...  // the keys.
) → Long  // Long integer-reply the number of elements in the resulting sorted set at destination.

zinterstore(
    destination: K,  // the destination.
    storeArgs: ZStoreArgs,  // arguments to define aggregation and weights.
    keys: K...  // the keys.
) → Long  // Long integer-reply the number of elements in the resulting sorted set at destination.

Possible errors

ERR value is not an integer: RedisCommandExecutionException
ERR syntax error: RedisCommandExecutionException

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

zinterstore(
    destination: K,  // the destination.
    keys: K...  // the keys.
) → RedisFuture<Long>  // Long integer-reply the number of elements in the resulting sorted set at destination.

zinterstore(
    destination: K,  // the destination.
    storeArgs: ZStoreArgs,  // arguments to define aggregation and weights.
    keys: K...  // the keys.
) → RedisFuture<Long>  // Long integer-reply the number of elements in the resulting sorted set at destination.

Possible errors

ERR value is not an integer: RedisCommandExecutionException
ERR syntax error: RedisCommandExecutionException

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

zinterstore(
    destination: K,  // the destination.
    keys: K...  // the keys.
) → Mono<Long>  // Long integer-reply the number of elements in the resulting sorted set at destination.

zinterstore(
    destination: K,  // the destination.
    storeArgs: ZStoreArgs,  // arguments to define aggregation and weights.
    keys: K...  // the keys.
) → Mono<Long>  // Long integer-reply the number of elements in the resulting sorted set at destination.

Possible errors

ERR value is not an integer: RedisCommandExecutionException
ERR syntax error: RedisCommandExecutionException

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

ZInterStore(
    ctx: context.Context,
    destination: string,
    store: *ZStore
) → *IntCmd

Possible errors

ERR value is not an integer: redis.Error
ERR syntax error: redis.Error

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

SortedSetCombineAndStore(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    first: RedisKey,
    second: RedisKey,
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of elements in the resulting sorted set at destination.

SortedSetCombineAndStore(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    keys: RedisKey[],  // The keys of the sorted sets.
    weights: double[]?,  // The optional weights per set that correspond to keys.
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of elements in the resulting sorted set at destination.

SortedSetCombineAndStore(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    first: RedisKey,
    second: RedisKey,
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of elements in the resulting sorted set at destination.

SortedSetCombineAndStore(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    keys: RedisKey[],  // The keys of the sorted sets.
    weights: double[]?,  // The optional weights per set that correspond to keys.
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of elements in the resulting sorted set at destination.

Possible errors

ERR value is not an integer: RedisServerException
ERR syntax error: RedisServerException

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

SortedSetCombineAndStoreAsync(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    first: RedisKey,
    second: RedisKey,
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → Task<long>  // The number of elements in the resulting sorted set at destination.

SortedSetCombineAndStoreAsync(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    keys: RedisKey[],  // The keys of the sorted sets.
    weights: double[]?,  // The optional weights per set that correspond to keys.
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → Task<long>  // The number of elements in the resulting sorted set at destination.

SortedSetCombineAndStoreAsync(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    first: RedisKey,
    second: RedisKey,
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → Task<long>  // The number of elements in the resulting sorted set at destination.

SortedSetCombineAndStoreAsync(
    operation: SetOperation,  // The operation to perform.
    destination: RedisKey,  // The key to store the results in.
    keys: RedisKey[],  // The keys of the sorted sets.
    weights: double[]?,  // The optional weights per set that correspond to keys.
    aggregate: Aggregate,  // The aggregation method (defaults to sum).
    flags: CommandFlags  // The flags to use for this operation.
) → Task<long>  // The number of elements in the resulting sorted set at destination.

Possible errors

ERR value is not an integer: RedisServerException
ERR syntax error: RedisServerException

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

zinterstore(
    $destination: string,
    $keys: array,
    int[] $weights = []: Any,
    string $aggregate = 'sum': Any
) → int

Possible errors

ERR value is not an integer: Predis\Response\ServerException
ERR syntax error: Predis\Response\ServerException

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

zinterstore(
    destination: String,  // destination key
    keys: Array<String>,  // source keys
    weights: Array<Float>,  // weights to associate with source sorted sets
    aggregate: String  // aggregate function to use (sum, min, max)
) → Integer  // number of elements in the resulting sorted set

Possible errors

ERR value is not an integer: Redis::CommandError
ERR syntax error: Redis::CommandError

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

zinterstore(
    dstkey: D,
    keys: K
) → (usize)

zinterstore_min(
    dstkey: D,
    keys: K
) → (usize)

zinterstore_max(
    dstkey: D,
    keys: K
) → (usize)

zinterstore_weights(
    dstkey: D,
    keys: &'a [(K, W)]
) → (usize)

zinterstore_min_weights(
    dstkey: D,
    keys: &'a [(K, W)]
) → (usize)

Possible errors

ERR value is not an integer: ErrorKind::Server(ServerErrorKind::ResponseError)
ERR syntax error: ErrorKind::Server(ServerErrorKind::ResponseError)

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

zinterstore(
    dstkey: D,
    keys: K
) → (usize)

zinterstore_min(
    dstkey: D,
    keys: K
) → (usize)

zinterstore_max(
    dstkey: D,
    keys: K
) → (usize)

zinterstore_weights(
    dstkey: D,
    keys: &'a [(K, W)]
) → (usize)

zinterstore_min_weights(
    dstkey: D,
    keys: &'a [(K, W)]
) → (usize)

Possible errors

ERR value is not an integer: ErrorKind::Server(ServerErrorKind::ResponseError)
ERR syntax error: ErrorKind::Server(ServerErrorKind::ResponseError)

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

Available since:: Redis Open Source 2.0.0
Time complexity:: O(N*K)+O(M*log(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
ACL categories:: @write, @sortedset, @slow,
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.

Computes the intersection of numkeys sorted sets given by the specified keys, and stores the result in destination. It is mandatory to provide the number of input keys (numkeys) before passing the input keys and the other (optional) arguments.

By default, the resulting score of an element is the sum of its scores in the sorted sets where it exists. Because intersection requires an element to be a member of every given sorted set, this results in the score of every element in the resulting sorted set to be equal to the number of input sorted sets.

For a description of the WEIGHTS and AGGREGATE options, see ZUNIONSTORE.

If destination already exists, it is overwritten.

Required arguments

destination

The key to store the resulting sorted set in.

numkeys

The number of keys that follow.

key [key ...]

One or more sorted-set keys to intersect.

Optional arguments

WEIGHTS weight [weight ...]

A multiplication factor for each input set; each set's scores are multiplied by its weight before aggregation. Defaults to 1 for every set.

AGGREGATE SUM | MIN | MAX | COUNT

How to combine the scores of members that exist in multiple sets: SUM (the default), MIN, MAX, or COUNT.

Examples

redis> ZADD zset1 1 "one"
(integer) 1
redis> ZADD zset1 2 "two"
(integer) 1
redis> ZADD zset2 1 "one"
(integer) 1
redis> ZADD zset2 2 "two"
(integer) 1
redis> ZADD zset2 3 "three"
(integer) 1
redis> ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3
(integer) 2
redis> ZRANGE out 0 -1 WITHSCORES
1) "one"
2) "5"
3) "two"
4) "10"

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Integer reply: the number of members in the resulting sorted set at the destination.

History

Starting with Redis version 8.8.0: Added COUNT aggregate option.