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

SSCAN

Syntax text Syntax diagram API methods

SSCAN key cursor [MATCH pattern] [COUNT count]

Client:

sscan(
    name: KeyT,
    cursor: int = 0,
    match: Union[PatternT, None] = None,
    count: Optional[int] = None
) → ResponseT

Possible errors

ERR syntax error: ResponseError

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

SSCAN(
    key: RedisArgument,
    cursor: RedisArgument,
    options?: ScanCommonOptions
) → Any

Possible errors

ERR syntax error: SimpleError

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

sscan(
    key: Any,
    cursor: Any,
    ScanParams(: new
) → return  // OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#px(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12.

sscan(
    key: String,
    cursor: String,
    params: ScanParams
) → ScanResult<String>  // OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#px(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12.

Possible errors

ERR syntax error: JedisDataException

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

sscan(
    key: K  // the key.
) → ValueScanCursor<V>  // StreamScanCursor scan cursor.

sscan(
    key: K,  // the key.
    scanArgs: ScanArgs
) → ValueScanCursor<V>  // StreamScanCursor scan cursor.

sscan(
    key: K,  // the key.
    scanCursor: ScanCursor,  // cursor to resume from a previous scan, must not be null.
    scanArgs: ScanArgs
) → ValueScanCursor<V>  // StreamScanCursor scan cursor.

sscan(
    key: K,  // the key.
    scanCursor: ScanCursor  // cursor to resume from a previous scan, must not be null.
) → ValueScanCursor<V>  // StreamScanCursor scan cursor.

sscan(
    channel: ValueStreamingChannel<V>,  // streaming channel that receives a call for every value.
    key: K  // the key.
) → StreamScanCursor  // StreamScanCursor scan cursor.

Possible errors

ERR syntax error: RedisCommandExecutionException

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

sscan(
    key: K  // the key.
) → RedisFuture<ValueScanCursor<V>>  // StreamScanCursor scan cursor.

sscan(
    key: K,  // the key.
    scanArgs: ScanArgs
) → RedisFuture<ValueScanCursor<V>>  // StreamScanCursor scan cursor.

sscan(
    key: K,  // the key.
    scanCursor: ScanCursor,  // cursor to resume from a previous scan, must not be null.
    scanArgs: ScanArgs
) → RedisFuture<ValueScanCursor<V>>  // StreamScanCursor scan cursor.

sscan(
    key: K,  // the key.
    scanCursor: ScanCursor  // cursor to resume from a previous scan, must not be null.
) → RedisFuture<ValueScanCursor<V>>  // StreamScanCursor scan cursor.

sscan(
    channel: ValueStreamingChannel<V>,  // streaming channel that receives a call for every value.
    key: K  // the key.
) → RedisFuture<StreamScanCursor>  // StreamScanCursor scan cursor.

Possible errors

ERR syntax error: RedisCommandExecutionException

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

sscan(
    key: K  // the key.
) → Mono<ValueScanCursor<V>>  // StreamScanCursor scan cursor. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sscan.

sscan(
    key: K,  // the key.
    scanArgs: ScanArgs
) → Mono<ValueScanCursor<V>>  // StreamScanCursor scan cursor. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sscan.

sscan(
    key: K,  // the key.
    scanCursor: ScanCursor,  // cursor to resume from a previous scan, must not be null.
    scanArgs: ScanArgs
) → Mono<ValueScanCursor<V>>  // StreamScanCursor scan cursor. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sscan.

sscan(
    key: K,  // the key.
    scanCursor: ScanCursor  // cursor to resume from a previous scan, must not be null.
) → Mono<ValueScanCursor<V>>  // StreamScanCursor scan cursor. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sscan.

sscan(
    channel: ValueStreamingChannel<V>,  // streaming channel that receives a call for every value.
    key: K  // the key.
) → Mono<StreamScanCursor>  // StreamScanCursor scan cursor. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sscan.

Possible errors

ERR syntax error: RedisCommandExecutionException

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

SScan(
    ctx: context.Context,
    key: string,
    cursor: uint64,
    match: string,
    count: int64
) → *ScanCmd

Possible errors

ERR syntax error: redis.Error

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

SetScan(
    key: RedisKey,  // The key of the set.
    pattern: RedisValue,  // The pattern to match.
    pageSize: int,  // The page size to iterate by.
    flags: CommandFlags  // The flags to use for this operation.
) → IEnumerable<RedisValue>  // Yields all matching elements of the set.

SetScan(
    key: RedisKey,  // The key of the set.
    pattern: RedisValue,  // The pattern to match.
    pageSize: int,  // The page size to iterate by.
    cursor: long,  // The cursor position to start at.
    pageOffset: int,  // The page offset to start at.
    flags: CommandFlags  // The flags to use for this operation.
) → IEnumerable<RedisValue>  // Yields all matching elements of the set.

Possible errors

ERR syntax error: RedisServerException

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

SetScan(
    key: RedisKey,  // The key of the set.
    pattern: RedisValue,  // The pattern to match.
    pageSize: int,  // The page size to iterate by.
    flags: CommandFlags  // The flags to use for this operation.
) → IEnumerable<RedisValue>  // Yields all matching elements of the set.

SetScan(
    key: RedisKey,  // The key of the set.
    pattern: RedisValue,  // The pattern to match.
    pageSize: int,  // The page size to iterate by.
    cursor: long,  // The cursor position to start at.
    pageOffset: int,  // The page offset to start at.
    flags: CommandFlags  // The flags to use for this operation.
) → IEnumerable<RedisValue>  // Yields all matching elements of the set.

Possible errors

ERR syntax error: RedisServerException

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

sscan(
    $key: string,
    $cursor: int,
    array $options = null: Any
) → array

Possible errors

ERR syntax error: Predis\Response\ServerException

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

Available since:: Redis Open Source 2.8.0
Time complexity:: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
ACL categories:: @read, @set, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

See SCAN for SSCAN documentation.

Required arguments

key

The name of the key that holds the set.

cursor

The cursor value. Start an iteration with 0, then use the cursor returned by each call as the argument to the next call.

Optional arguments

MATCH pattern

Only return members matching the given glob-style pattern.

COUNT count

A hint for the number of members to return per iteration. The default is 10.

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Array reply: specifically, an array with two elements:

The first element is a Bulk string reply that represents an unsigned 64-bit number, the cursor.
The second element is an Array reply with the names of scanned members.