KeyscopeClient class

The main client implementation for communicating with a Redis/Valkey server.

Implemented types

KeyscopeClientBase

Mixed-in types

JsonCommands

Available extensions

Constructors

KeyscopeClient({String host = '127.0.0.1', int port = 6379, String? username, String? password, Duration commandTimeout = const Duration(seconds: 10), Duration connectTimeout = const Duration(seconds: 10), bool useSsl = false, SecurityContext? sslContext, bool onBadCertificate(X509Certificate)?, int database = 0, ReadPreference readPreference = ReadPreference.master, LoadBalancingStrategy loadBalancingStrategy = LoadBalancingStrategy.roundRobin, List<KeyscopeConnectionSettings>? explicitReplicas, AddressMapper? addressMapper}): Creates a new TR client instance.
KeyscopeClient.fromSettings(KeyscopeConnectionSettings settings): Creates a client using a KeyscopeConnectionSettings object.
factory

Properties

allowRedisOnlyJsonMerge → bool: Implementation of JsonCommands Interface Exposes the private variable to the Mixin via a getter.
no setteroverride
currentConnectionConfig → KeyscopeConnectionSettings?: no setter
getServerName → Future<String>: Available on Commands, provided by the ServerVersionCheck extension

no setter
hashCode → int: The hash code for this object.
no setterinherited
isConnected → bool: Returns true if the client has an active socket connection.
no setter
isDragonfly → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension

no setter
isInTransaction → bool: no setterinherited
isRedis → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension

no setter
isStateful → bool: Returns true if the client is in a stateful mode that makes it unsuitable for reuse without a reset (e.g., Pub/Sub, Transaction).
no setter
isValkey → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension

no setter
lastUsedConnectionConfig → KeyscopeConnectionSettings?: Returns the configuration of the connection used for the last command. Useful for debugging load balancing strategies.
no setter
metadata → ServerMetadata?: Returns the metadata of the connected server.
no setter
onConnected → Future<void>: A Future that completes once the connection and authentication are successful.
no setteroverride
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
setAllowRedisOnlyJsonMerge ← bool: no getteroverride

Methods

append(String key, String value) → Future<int>: Available on StringCommands, provided by the AppendCommand extension
APPEND key value
auth(String password, {String? username, bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the AuthCommand extension
AUTH username password Authenticates the connection.
bfAdd(String key, String item, {bool forceRun = false}) → Future<bool>: Available on BloomFilterCommands, provided by the BfAddCommand extension
BF.ADD key item
bfCard(String key, {bool forceRun = false}) → Future<int>: Available on BloomFilterCommands, provided by the BfCardCommand extension
BF.CARD key
bfExists(String key, String item, {bool forceRun = false}) → Future<bool>: Available on BloomFilterCommands, provided by the BfExistsCommand extension
BF.EXISTS key item
bfInfo(String key, {String? option, bool forceRun = false}) → Future: Available on BloomFilterCommands, provided by the BfInfoCommand extension
BF.INFO key CAPACITY | SIZE | FILTERS | ITEMS | EXPANSION
bfInsert(String key, List<String> items, {int? capacity, double? error, int? expansion, bool noCreate = false, bool nonScaling = false, bool forceRun = false}) → Future<List<bool>>: Available on BloomFilterCommands, provided by the BfInsertCommand extension
BF.INSERT key CAPACITY capacity ERROR error EXPANSION expansion [NOCREATE] [NONSCALING] ITEMS item item ...
bfLoad(String key, int iterator, Object data, {bool forceRun = false}) → Future: Available on BloomFilterCommands, provided by the BfLoadCommand extension
BF.LOAD key iterator data
bfLoadChunk(String key, int iterator, Object data, {bool forceRun = false}) → Future: Available on BloomFilterCommands, provided by the BfLoadChunkCommand extension
BF.LOADCHUNK key iterator data
bfMAdd(String key, List<String> items, {bool forceRun = false}) → Future<List<bool>>: Available on BloomFilterCommands, provided by the BfMAddCommand extension
BF.MADD key item item ...
bfMExists(String key, List<String> items, {bool forceRun = false}) → Future<List<bool>>: Available on BloomFilterCommands, provided by the BfMExistsCommand extension
BF.MEXISTS key item item ...
bfReserve(String key, double errorRate, int capacity, {int? expansion, bool nonScaling = false, bool forceRun = false}) → Future: Available on BloomFilterCommands, provided by the BfReserveCommand extension
BF.RESERVE key error_rate capacity EXPANSION expansion [NONSCALING]
bfScandump(String key, int iterator, {bool forceRun = false}) → Future<List>: Available on BloomFilterCommands, provided by the BfScandumpCommand extension
BF.SCANDUMP key iterator
bitCount(String key, {int? start, int? end, bool useBit = false}) → Future<int>: Available on BitmapCommands, provided by the BitCountCommand extension
BITCOUNT key [start end BYTE | BIT]
bitField(String key, List<BitFieldOp> operations) → Future<List<int?>>: Available on BitmapCommands, provided by the BitFieldCommand extension
BITFIELD key GET type offset SET type offset value INCRBY type offset increment OVERFLOW WRAP|SAT|FAIL
bitFieldRo(String key, List<BitFieldOp> operations) → Future<List<int?>>: Available on BitmapCommands, provided by the BitFieldRoCommand extension
BITFIELD_RO key GET type offset
bitOp(String operation, String destKey, List<String> keys) → Future<int>: Available on BitmapCommands, provided by the BitOpCommand extension
BITOP operation destkey key key ...
bitPos(String key, int bit, {int? start, int? end, bool useBit = false}) → Future<int>: Available on BitmapCommands, provided by the BitPosCommand extension
BITPOS key bit [start [end BYTE | BIT]]
bLMove(String source, String destination, String whereFrom, String whereTo, double timeout) → Future<String?>: Available on ListCommands, provided by the BLMoveCommand extension
BLMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT> timeout
bLMPop(double timeout, List<String> keys, String direction, {int? count}) → Future: Available on ListCommands, provided by the BLMPopCommand extension
BLMPOP timeout numkeys key key ... <LEFT | RIGHT> COUNT count
bLPop(List<String> keys, double timeout) → Future<List<String>?>: Available on ListCommands, provided by the BLPopCommand extension
BLPOP key key ... timeout
bRPop(List<String> keys, double timeout) → Future<List<String>?>: Available on ListCommands, provided by the BRPopCommand extension
BRPOP key key ... timeout
bRPopLPush(String source, String destination, double timeout) → Future<String?>: Available on ListCommands, provided by the BRPopLPushCommand extension
BRPOPLPUSH source destination timeout
bzMPop(double timeout, List<String> keys, String modifier, {int? count}) → Future: Available on SortedSetCommands, provided by the BzMPopCommand extension
BZMPOP timeout numkeys key key ... <MIN | MAX> COUNT count
bzPopMax(List<String> keys, double timeout) → Future: Available on SortedSetCommands, provided by the BzPopMaxCommand extension
BZPOPMAX key key ... timeout
bzPopMin(List<String> keys, double timeout) → Future: Available on SortedSetCommands, provided by the BzPopMinCommand extension
BZPOPMIN key key ... timeout
cfAdd(String key, String item, {bool forceRun = false}) → Future<bool>: Available on CuckooFilterCommands, provided by the CfAddCommand extension
CF.ADD key item
cfAddNx(String key, String item, {bool forceRun = false}) → Future<bool>: Available on CuckooFilterCommands, provided by the CfAddNxCommand extension
CF.ADDNX key item
cfCount(String key, String item, {bool forceRun = false}) → Future<int>: Available on CuckooFilterCommands, provided by the CfCountCommand extension
CF.COUNT key item
cfDel(String key, String item, {bool forceRun = false}) → Future<bool>: Available on CuckooFilterCommands, provided by the CfDelCommand extension
CF.DEL key item
cfExists(String key, String item, {bool forceRun = false}) → Future<bool>: Available on CuckooFilterCommands, provided by the CfExistsCommand extension
CF.EXISTS key item
cfInfo(String key, {bool forceRun = false}) → Future: Available on CuckooFilterCommands, provided by the CfInfoCommand extension
CF.INFO key
cfInsert(String key, List<String> items, {int? capacity, bool noCreate = false, bool forceRun = false}) → Future<List<bool>>: Available on CuckooFilterCommands, provided by the CfInsertCommand extension
CF.INSERT key CAPACITY capacity [NOCREATE] ITEMS item item ...
cfInsertNx(String key, List<String> items, {int? capacity, bool noCreate = false, bool forceRun = false}) → Future<List<bool>>: Available on CuckooFilterCommands, provided by the CfInsertNxCommand extension
CF.INSERTNX key CAPACITY capacity [NOCREATE] ITEMS item item ...
cfLoadChunk(String key, int iterator, Object data, {bool forceRun = false}) → Future: Available on CuckooFilterCommands, provided by the CfLoadChunkCommand extension
CF.LOADCHUNK key iterator data (Accepts data as an Object to prevent binary corruption, identical to Bloom Filter approach)
cfMExists(String key, List<String> items, {bool forceRun = false}) → Future<List<bool>>: Available on CuckooFilterCommands, provided by the CfMExistsCommand extension
CF.MEXISTS key item item ...
cfReserve(String key, int capacity, {int? bucketSize, int? maxIterations, int? expansion, bool forceRun = false}) → Future: Available on CuckooFilterCommands, provided by the CfReserveCommand extension
CF.RESERVE key capacity BUCKETSIZE bucketsize MAXITERATIONS maxiterations EXPANSION expansion
cfScanDump(String key, int iterator, {bool forceRun = false}) → Future<List>: Available on CuckooFilterCommands, provided by the CfScanDumpCommand extension
CF.SCANDUMP key iterator
checkValkeySupport(String commandName, {bool forceRun = false}) → Future<void>: Available on Commands, provided by the ServerVersionCheck extension
Helper to check if the command is supported in Valkey.
checkValkeySupportExtended(String commandName, String subCommandName, {bool forceRun = false}) → Future<void>: Available on Commands, provided by the ServerVersionCheck extension
Helper to check if the command is supported in Valkey.
clearTransactionQueueInternal() → void: inherited
client(List<String> args, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientCommand extension
CLIENT ... Raw entry point for generic CLIENT commands if not covered by specific extensions.
clientCaching(bool enable, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientCachingCommand extension
CLIENT CACHING YES|NO Controls whether the client will receive tracking notifications for the next keys fetched.
clientCapa(List<String> capabilities, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientCapaCommand extension
CLIENT CAPA capability capability ... Notifies the Redis server of the client's capabilities.
clientGetName({bool forceRun = false}) → Future<String?>: Available on ConnectionCommands, provided by the ClientGetNameCommand extension
CLIENT GETNAME Returns the name of the current connection. Returns null if no name is set.
clientGetRedir({bool forceRun = false}) → Future<int>: Available on ConnectionCommands, provided by the ClientGetRedirCommand extension
CLIENT GETREDIR Returns the client ID we are redirecting our tracking notifications to.
clientHelp({bool forceRun = false}) → Future<List<String>>: Available on ConnectionCommands, provided by the ClientHelpCommand extension
CLIENT HELP Returns a summary of CLIENT subcommands.
clientId({bool forceRun = false}) → Future<int>: Available on ConnectionCommands, provided by the ClientIdCommand extension
CLIENT ID Returns the client ID for the current connection.
clientImportSource(List<String> args, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientImportSourceCommand extension
CLIENT IMPORT-SOURCE (Available in some Valkey/Redis environments for replication/import flows). We expose it generically as it often takes varying arguments depending on the context.
clientInfo({bool forceRun = false}) → Future<String>: Available on ConnectionCommands, provided by the ClientInfoCommand extension
CLIENT INFO Returns information and statistics about the current client connection.
clientKill({String? address, int? id, String? type, String? user, String? addr, String? laddr, String? skipMe, bool forceRun = false}) → Future<int>: Available on ConnectionCommands, provided by the ClientKillCommand extension
CLIENT KILL ip:port ID client-id TYPE normal|master|replica|pubsub USER username ADDR ip:port LADDR ip:port SKIPME yes/no Closes a given client connection. Returns the number of clients killed.
clientList({String? type, List<int>? ids, bool forceRun = false}) → Future<String>: Available on ConnectionCommands, provided by the ClientListCommand extension
CLIENT LIST TYPE type [ID client-id client-id ...] Returns information and statistics about the client connections server.
clientNoEvict(bool enable, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientNoEvictCommand extension
CLIENT NO-EVICT ON|OFF Sets the client eviction mode for the current connection.
clientNoTouch(bool enable, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientNoTouchCommand extension
CLIENT NO-TOUCH ON|OFF Controls whether commands sent by the client affect the LRU/LFU of accessed keys.
clientPause(int timeout, {String? mode, bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientPauseCommand extension
CLIENT PAUSE timeout WRITE|ALL Suspends all the Redis clients for the specified amount of milliseconds. mode can be 'WRITE' or 'ALL' (default).
clientReply(String mode, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientReplyCommand extension
CLIENT REPLY ON|OFF|SKIP Instructs the server whether to reply to commands.
clientSetInfo(String attr, String value, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientSetInfoCommand extension
CLIENT SETINFO attr value Assigns various info attributes to the current connection (e.g., lib-name, lib-ver).
clientSetName(String connectionName, {bool forceRun = false}) → Future<bool>: Available on ConnectionCommands, provided by the ClientSetNameCommand extension
CLIENT SETNAME connection-name Assigns a name to the current connection.
clientTracking(bool enable, {int? redirect, List<String>? prefixes, bool bcast = false, bool optIn = false, bool optOut = false, bool noLoop = false, bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientTrackingCommand extension
CLIENT TRACKING ON|OFF REDIRECT client-id PREFIX prefix ... [BCAST] [OPTIN] [OPTOUT] [NOLOOP] Enables or disables the tracking feature of the Redis server.
clientTrackingInfo({bool forceRun = false}) → Future<List>: Available on ConnectionCommands, provided by the ClientTrackingInfoCommand extension
CLIENT TRACKINGINFO Returns information about the current client's tracking state.
clientUnblock(int clientId, {String? type, bool forceRun = false}) → Future<int>: Available on ConnectionCommands, provided by the ClientUnblockCommand extension
CLIENT UNBLOCK client-id TIMEOUT|ERROR Unblocks a client blocked in a blocking command from a different connection.
clientUnpause({bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ClientUnpauseCommand extension
CLIENT UNPAUSE Resumes processing of clients that were paused by CLIENT PAUSE.
close() → Future<void>: Closes the connection to the server.
override
clusterSlots() → Future<List<ClusterSlotRange>>: Fetches the cluster topology information from the server.
override
cmsIncrBy(String key, Map<String, int> increments, {bool forceRun = false}) → Future<List<int>>: Available on CountMinSketchCommands, provided by the CmsIncrByCommand extension
CMS.INCRBY key item increment item increment ... Increases the count of one or more items by increment.
cmsInfo(String key, {bool forceRun = false}) → Future: Available on CountMinSketchCommands, provided by the CmsInfoCommand extension
CMS.INFO key Returns information about a sketch.
cmsInitByDim(String key, int width, int depth, {bool forceRun = false}) → Future: Available on CountMinSketchCommands, provided by the CmsInitByDimCommand extension
CMS.INITBYDIM key width depth Initializes a Count-Min Sketch to dimensions specified by width and depth.
cmsInitByProb(String key, double error, double probability, {bool forceRun = false}) → Future: Available on CountMinSketchCommands, provided by the CmsInitByProbCommand extension
CMS.INITBYPROB key error probability Initializes a Count-Min Sketch to accommodate requested error and probability.
cmsMerge(String dest, List<String> sources, {List<int>? weights, bool forceRun = false}) → Future: Available on CountMinSketchCommands, provided by the CmsMergeCommand extension
CMS.MERGE dest numKeys src src ... [WEIGHTS weight weight ...] Merges several sketches into one sketch.
cmsQuery(String key, List<String> items, {bool forceRun = false}) → Future<List<int>>: Available on CountMinSketchCommands, provided by the CmsQueryCommand extension
CMS.QUERY key item item ... Returns count for one or more items in a sketch.
configGet(String parameter) → Future<String?>: Available on ServerCommands, provided by the ConfigGetCommand extension
configSet(String parameter, String value) → Future<String>: Available on ServerCommands, provided by the ConfigSetCommand extension
CONFIG SET parameter value
connect({String? host, int? port, String? username, String? password}) → Future<void>: Connects to the Redis/Valkey server.
override
copy(String source, String destination, {int? destinationDb, bool replace = false}) → Future<bool>: Available on GenericCommands, provided by the CopyCommand extension
COPY source destination DB destination-db [REPLACE]
decr(String key) → Future<int>: Available on StringCommands, provided by the DecrCommand extension
DECR key
decr(String key) → Future<int>: Decrements the number stored at key by one.
override
decrBy(String key, int decrement) → Future<int>: Available on StringCommands, provided by the DecrByCommand extension
DECRBY key decrement
decrBy(String key, int amount) → Future<int>: Decrements the number stored at key by amount.
override
del(List<String> keys) → Future<int>: Available on GenericCommands, provided by the DelCommand extension
DEL key key ...
del(List<String> keys) → Future<int>: Deletes the specified keys.
override
delEx(String key, {String? ifEq, String? ifNe, String? ifDeq, String? ifDne, bool forceRun = false}) → Future<int>: Available on StringCommands, provided by the DelExCommand extension
DELEX key IFEQ ifeq-value | IFNE ifne-value | IFDEQ ifdeq-digest | IFDNE ifdne-digest
delIfEq(String key, String value, {bool forceRun = false}) → Future<int>: Available on StringCommands, provided by the DelIfEqCommand extension
DELIFEQ key value
deprecatedIsJsonModuleLoaded() → Future<bool>: Checks if the JSON module is loaded on the server.
inherited
deprecatedJsonGet({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonGetCommand extension
JSON.GET key path ...
deprecatedJsonSet({required String key, required String path, required dynamic data, bool nx = false, bool xx = false}) → Future<void>: Available on JsonCommands, provided by the JsonSetCommand extension
JSON.SET key path value NX | XX
digest(String key, {bool forceRun = false}) → Future<String?>: Available on StringCommands, provided by the DigestCommand extension
DIGEST key
discard() → Future<String>: Discards all commands queued after multi().
override
discard() → Future<String>: Available on TransactionsCommands, provided by the DiscardCommand extension
disconnect() → Future<void>: Provides a alternative name for close(). Internally calls close().
override
doIntegratedCommandChecker(String commandName, String? subCommandName, {bool useThrow = true}) → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
dump(String key) → Future<List<int>?>: Available on GenericCommands, provided by the DumpCommand extension
DUMP key
echo(String message) → Future<String>: Echoes the given message back from the server.
override
echo(String message, {bool forceRun = false}) → Future<String>: Available on ConnectionCommands, provided by the EchoCommand extension
ECHO message Echoes the given string.
exec() → Future<List?>: Executes all commands queued after multi().
override
exec() → Future<List?>: Available on TransactionsCommands, provided by the ExecCommand extension
execute(List command) → Future: v2.2.0 Routing Logic
override
executeInt(List<String> command) → Future<int>: Helper to execute a command that is expected to return an Integer.
inherited
executeString(List<String> command) → Future<String>: Helper: Execute command and expect a String result.
inherited
exists(dynamic keys) → Future<int>: Checks if keys exists.
override
exists(dynamic keys) → Future<int>: Available on GenericCommands, provided by the ExistsCommand extension
EXISTS key key ...
expire(String key, int seconds, {bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<int>: Sets a timeout on key in seconds.
override
expire(String key, int seconds, {bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<int>: Available on GenericCommands, provided by the ExpireCommand extension
EXPIRE key seconds NX|XX|GT|LT
expireAt(String key, int timestamp, {bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<bool>: Available on GenericCommands, provided by the ExpireAtCommand extension
EXPIREAT key timestamp NX|XX|GT|LT
expireTime(String key) → Future<int>: Available on GenericCommands, provided by the ExpireTimeCommand extension
EXPIRETIME key
fetchServerMetadata() → Future<ServerMetadata>: Abstract method to fetch metadata from the server (e.g., using INFO command). If not connected, this should throw an exception.
flushAll({bool async = false}) → Future<String>: Available on ServerCommands, provided by the FlushAllCommand extension
FLUSHALL ASYNC | SYNC
flushDb({bool async = false}) → Future<String>: Available on ServerCommands, provided by the FlushDbCommand extension
FLUSHDB ASYNC | SYNC
ftAggregate(String index, String query, {List options = const [], bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtAggregateCommand extension
FT.AGGREGATE index query options ...
ftAliasAdd(String alias, String index, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtAliasAddCommand extension
FT.ALIASADD alias index
ftAliasDel(String alias, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtAliasDelCommand extension
FT.ALIASDEL alias
ftAliasUpdate(String alias, String index, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtAliasUpdateCommand extension
FT.ALIASUPDATE alias index
ftAlter(String index, List options, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtAlterCommand extension
FT.ALTER index options ... SCHEMA ADD field options ...
ftConfigGet(String option, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtConfigGetCommand extension
FT.CONFIG GET option
ftConfigSet(String option, String value, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtConfigSetCommand extension
FT.CONFIG SET option value
ftCreate(String index, {List options = const [], required List schema}) → Future: Available on SearchCommands, provided by the FtCreateCommand extension
FT.CREATE index ON HASH|JSON [PREFIX count prefix prefix ...] LANGUAGE default_lang ... schema
ftCursorDel(String index, int cursorId, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtCursorDelCommand extension
FT.CURSOR DEL index cursor_id
ftCursorRead(String index, int cursorId, {int? count, bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtCursorReadCommand extension
FT.CURSOR READ index cursor_id COUNT read_size
ftDictAdd(String dict, List<String> terms, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtDictAddCommand extension
FT.DICTADD dict term term ...
ftDictDel(String dict, List<String> terms, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtDictDelCommand extension
FT.DICTDEL dict term term ...
ftDictDump(String dict, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtDictDumpCommand extension
FT.DICTDUMP dict
ftDropIndex(String index, {bool dd = false}) → Future: Available on SearchCommands, provided by the FtDropIndexCommand extension
FT.DROPINDEX index [DD]
ftExplain(String index, String query, {int? dialect, bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtExplainCommand extension
FT.EXPLAIN index query DIALECT dialect
ftExplainCli(String index, String query, {int? dialect, bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtExplainCliCommand extension
FT.EXPLAINCLI index query DIALECT dialect
ftHybrid(String index, List args, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtHybridCommand extension
FT.HYBRID ...
ftInfo(String index) → Future<Map<String, dynamic>>: Available on SearchCommands, provided by the FtInfoCommand extension
FT.INFO index
ftList() → Future<List<String>>: Available on SearchCommands, provided by the FtListCommand extension
FT._LIST
ftProfile(String index, {required String type, required String query, bool limited = false, bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtProfileCommand extension
FT.PROFILE index SEARCH|AGGREGATE [LIMITED] QUERY query
ftSearch(String index, String query, {List options = const []}) → Future: Available on SearchCommands, provided by the FtSearchCommand extension
FT.SEARCH index query options ... FT.SEARCH index query [NOCONTENT] [VERBATIM] [NOSTOPWORDS] WITHSCORES WITHPAYLOADS SORBY ... LIMIT ...
ftSpellCheck(String index, String query, {List options = const [], bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtSpellCheckCommand extension
FT.SPELLCHECK index query DISTANCE dist TERMS ...
ftSynDump(String index, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtSynDumpCommand extension
FT.SYNDUMP index
ftSynUpdate(String index, String groupId, List<String> terms, {bool skipInitialScan = false, bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtSynUpdateCommand extension
FT.SYNUPDATE index synonym_group_id [SKIPINITIALSCAN] term term ...
ftTagVals(String index, String fieldName, {bool forceRun = false}) → Future: Available on SearchCommands, provided by the FtTagValsCommand extension
FT.TAGVALS index field_name
geoAdd(String key, List<GeoLocation> items, {bool nx = false, bool xx = false, bool ch = false}) → Future<int>: Available on GeospatialIndicesCommands, provided by the GeoAddCommand extension
GEOADD key NX | XX [CH] longitude latitude member longitude latitude member ...
geoDist(String key, String member1, String member2, [String unit = 'm']) → Future<double?>: Available on GeospatialIndicesCommands, provided by the GeoDistCommand extension
GEODIST key member1 member2 m|km|ft|mi
geoHash(String key, List<String> members) → Future<List<String?>>: Available on GeospatialIndicesCommands, provided by the GeoHashCommand extension
GEOHASH key member member ...
geoPos(String key, List<String> members) → Future<List<List<double>?>>: Available on GeospatialIndicesCommands, provided by the GeoPosCommand extension
GEOPOS key member member ...
geoRadius(String key, double longitude, double latitude, double radius, String unit, {GeoRadiusOptions? options, String? store, String? storeDist}) → Future: Available on GeospatialIndicesCommands, provided by the GeoRadiusCommand extension
GEORADIUS key longitude latitude radius m|km|ft|mi WITHCOORD WITHDIST WITHHASH [COUNT count ANY] ASC|DESC STORE key STOREDIST key
geoRadiusByMember(String key, String member, double radius, String unit, {GeoRadiusOptions? options, String? store, String? storeDist}) → Future: Available on GeospatialIndicesCommands, provided by the GeoRadiusByMemberCommand extension
GEORADIUSBYMEMBER key member radius m|km|ft|mi WITHCOORD WITHDIST WITHHASH [COUNT count ANY] ASC|DESC STORE key STOREDIST key
geoRadiusByMemberRo(String key, String member, double radius, String unit, {GeoRadiusOptions? options}) → Future: Available on GeospatialIndicesCommands, provided by the GeoRadiusByMemberRoCommand extension
GEORADIUSBYMEMBER_RO key member radius m|km|ft|mi WITHCOORD WITHDIST WITHHASH [COUNT count ANY] ASC|DESC
geoRadiusRo(String key, double longitude, double latitude, double radius, String unit, {GeoRadiusOptions? options}) → Future: Available on GeospatialIndicesCommands, provided by the GeoRadiusRoCommand extension
GEORADIUS_RO key longitude latitude radius m|km|ft|mi WITHCOORD WITHDIST WITHHASH [COUNT count ANY] ASC|DESC
geoSearch(String key, {String? fromMember, List<double>? fromLonLat, List? byRadius, List? byBox, GeoRadiusOptions? options}) → Future: Available on GeospatialIndicesCommands, provided by the GeoSearchCommand extension
GEOSEARCH key FROMMEMBER member FROMLONLAT longitude latitude BYRADIUS radius m|km|ft|mi BYBOX width height m|km|ft|mi ASC|DESC [COUNT count ANY] [WITHCOORD] [WITHDIST] [WITHHASH]
geoSearchStore(String destination, String source, {String? fromMember, List<double>? fromLonLat, List? byRadius, List? byBox, String? sort, int? count, bool any = false, bool storeDist = false}) → Future<int>: Available on GeospatialIndicesCommands, provided by the GeoSearchStoreCommand extension
GEOSEARCHSTORE destination source FROMMEMBER member FROMLONLAT longitude latitude BYRADIUS radius m|km|ft|mi BYBOX width height m|km|ft|mi ASC|DESC [COUNT count ANY] [STOREDIST]
get(String key) → Future<String?>: Gets the value of key.
override
get(String key) → Future<String?>: Available on StringCommands, provided by the GetCommand extension
GET key
getBit(String key, int offset) → Future<int>: Available on BitmapCommands, provided by the GetBitCommand extension
GETBIT key offset
getDel(String key) → Future<String?>: Available on StringCommands, provided by the GetDelCommand extension
GETDEL key
getEx(String key, {int? ex, int? px, int? exAt, int? pxAt, bool persist = false}) → Future<String?>: Available on StringCommands, provided by the GetExCommand extension
GETEX key EX seconds | PX milliseconds | EXAT timestamp | PXAT timestamp | PERSIST
getModuleList() → Future<List<Map<String, dynamic>>>: Returns a list of loaded modules and their details.
inherited
getOrFetchMetadata() → Future<ServerMetadata>: Returns the cached metadata if available. If not, triggers fetchServerMetadata to load it on-demand.
inherited
getRange(String key, int start, int end) → Future<String>: Available on StringCommands, provided by the GetRangeCommand extension
GETRANGE key start end
getServerName() → Future<String?>
getServerVersion() → Future<String?>
getSet(String key, String value) → Future<String?>: Available on StringCommands, provided by the GetSetCommand extension
GETSET key value
getTransactionQueueInternal() → List<List<String>>: inherited
hDel(String key, List<String> fields) → Future<int>: Available on HashCommands, provided by the HDelCommand extension
HDEL key field field ...
hello(int protover, {String? authUsername, String? authPassword, String? clientName, bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the HelloCommand extension
HELLO protover AUTH username password SETNAME clientname Switches the protocol to the specified version (e.g., RESP2 or RESP3).
hExists(String key, String field) → Future<bool>: Available on HashCommands, provided by the HExistsCommand extension
HEXISTS key field
hExpire(String key, int seconds, {required List<String> fields, bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<List<int>>: Available on HashCommands, provided by the HExpireCommand extension
HEXPIRE key seconds NX | XX | GT | LT FIELDS numfields field field ...
hExpireAt(String key, int timestamp, {required List<String> fields, bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<List<int>>: Available on HashCommands, provided by the HExpireAtCommand extension
HEXPIREAT key timestamp NX | XX | GT | LT FIELDS numfields field field ...
hExpireTime(String key, List<String> fields) → Future<List<int>>: Available on HashCommands, provided by the HExpireTimeCommand extension
HEXPIRETIME key FIELDS numfields field field ...
hGet(String key, String field) → Future: Available on HashCommands, provided by the HGetCommand extension
HGET key field
hGet(String key, String field) → Future: Gets the value of field in the hash stored at key.
override
hget(String key, String field) → Future: override
hGetAll(String key) → Future<Map<String, String>>: Gets all fields and values of the hash stored at key.
override
hGetAll(String key) → Future<Map<String, String>>: Available on HashCommands, provided by the HGetAllCommand extension
HGETALL key
hgetall(String key) → Future<Map<String, String>>: override
hGetDel(String key, List<String> fields) → Future<List<String?>>: Available on HashCommands, provided by the HGetDelCommand extension
HGETDEL key FIELDS numfields field field ...
hGetEx(String key, List<String> fields, {int? ex, int? px, int? exAt, int? pxAt, bool persist = false}) → Future<List<String?>>: Available on HashCommands, provided by the HGetExCommand extension
HGETEX key EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | PERSIST FIELDS numfields field field ...
hIncrBy(String key, String field, int increment) → Future<int>: Available on HashCommands, provided by the HIncrByCommand extension
HINCRBY key field increment
hIncrByFloat(String key, String field, double increment) → Future<double>: Available on HashCommands, provided by the HIncrByFloatCommand extension
HINCRBYFLOAT key field increment
hKeys(String key) → Future<List<String>>: Available on HashCommands, provided by the HKeysCommand extension
HKEYS key
hLen(String key) → Future<int>: Available on HashCommands, provided by the HLenCommand extension
HLEN key
hMGet(String key, List<String> fields) → Future<List<String?>>: Available on HashCommands, provided by the HMGetCommand extension
HMGET key field field ...
hMSet(String key, Map<String, dynamic> data) → Future<int>: Available on HashCommands, provided by the HMSetCommand extension
HMSET key field value field value ...
hPersist(String key, List<String> fields) → Future<List<int>>: Available on HashCommands, provided by the HPersistCommand extension
HPERSIST key FIELDS numfields field field ...
hPExpire(String key, int milliseconds, {required List<String> fields, bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<List<int>>: Available on HashCommands, provided by the HPExpireCommand extension
HPEXPIRE key milliseconds NX | XX | GT | LT FIELDS numfields field field ...
hPExpireAt(String key, int millisecondsTimestamp, {required List<String> fields, bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<List<int>>: Available on HashCommands, provided by the HPExpireAtCommand extension
HPEXPIREAT key milliseconds-timestamp NX | XX | GT | LT FIELDS numfields field field ...
hPExpireTime(String key, List<String> fields) → Future<List<int>>: Available on HashCommands, provided by the HPExpireTimeCommand extension
HPEXPIRETIME key FIELDS numfields field field ...
hPTtl(String key, List<String> fields) → Future<List<int>>: Available on HashCommands, provided by the HPTtlCommand extension
HPTTL key FIELDS numfields field field ...
hRandField(String key, {int? count, bool withValues = false}) → Future: Available on HashCommands, provided by the HRandFieldCommand extension
HRANDFIELD key [count WITHVALUES]
hScan(String key, String cursor, {String? match, int? count}) → Future<List>: Available on HashCommands, provided by the HScanCommand extension
HSCAN key cursor MATCH pattern COUNT count
hSet(String key, Map<String, dynamic> data) → Future<int>: Sets field in the hash stored at key to value.
override
hSet(String key, Map<String, dynamic> data) → Future<int>: Available on HashCommands, provided by the HSetCommand extension
HSET key field value field value ...
hset(String key, String field, String value) → Future<int>: Sets multiple field-value pairs in the hash stored at key. Returns the number of fields that were added. Usage:
override
hSetEx(String key, int seconds, String field, String value) → Future<bool>: Available on HashCommands, provided by the HSetExCommand extension
HSETEX key seconds field value
hSetNx(String key, String field, String value) → Future<bool>: Available on HashCommands, provided by the HSetNxCommand extension
HSETNX key field value
hStrLen(String key, String field) → Future<int>: Available on HashCommands, provided by the HStrLenCommand extension
HSTRLEN key field
hTtl(String key, List<String> fields) → Future<List<int>>: Available on HashCommands, provided by the HTtlCommand extension
HTTL key FIELDS numfields field field ...
hVals(String key) → Future<List<String>>: Available on HashCommands, provided by the HValsCommand extension
HVALS key
incr(String key) → Future<int>: Available on StringCommands, provided by the IncrCommand extension
INCR key
incr(String key) → Future<int>: Increments the number stored at key by one.
override
incrBy(String key, int increment) → Future<int>: Available on StringCommands, provided by the IncrByCommand extension
INCRBY key increment
incrBy(String key, int amount) → Future<int>: Increments the number stored at key by amount.
override
incrByFloat(String key, double increment) → Future<double>: Available on StringCommands, provided by the IncrByFloatCommand extension
INCRBYFLOAT key increment
info({List<String>? section}) → Future<String>: Available on ServerCommands, provided by the InfoCommand extension
INFO [section section ...]
info({List<String>? section}) → Future<String>: inherited
infoServerMetadata() → Future<ServerMetadata>: Available on ServerCommands, provided by the InfoServerMetadataCommand extension
Executes 'INFO SERVER' and parses the result into ServerMetadata.
isDragonfly136OrLater() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
Check if Dragonfly version is at least 1.36.0
isDragonflyAtLeast(String dfVersion) → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
Check if Dragonfly version is at least a mapped version
isJsonModuleLoaded() → Future<bool>: Checks if the JSON module is loaded on the server.
inherited
isRedis70OrLater() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
Returns true if the server is Redis and version is 7.0.0 or later.
isRedis80OrLater() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
isRedis82OrLater() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
isRedisServer() → Future<bool>: Helper to check server type based on metadata.
isValkey70OrLater() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
Returns true if the server is Valkey and version is 7.0.0 or later.
isValkey70To80() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
Returns true if the server is Valkey and version is between 7.0.0 (inclusive) and 8.0.0 (exclusive).
isValkey80OrLater() → Future<bool>: Available on Commands, provided by the ServerVersionCheck extension
Returns true if the server is Valkey and version is 8.0.0 or later.
isValkeyServer() → Future<bool>: Checks if the connected server is Valkey.
jsonArrAppend({required String key, String path = r'$', required List values}) → Future: Available on JsonCommands, provided by the JsonArrAppendCommand extension
JSON.ARRAPPEND key path value value ...
jsonArrAppendEnhanced({required String key, required List<String> paths, required dynamic value}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonArrAppendEnhancedCommand extension
JSON.ARRAPPEND (Enhanced)
jsonArrIndex({required String key, required String path, required dynamic value, int? start, int? stop}) → Future: Available on JsonCommands, provided by the JsonArrIndexCommand extension
JSON.ARRINDEX key path value [start stop]
jsonArrIndexEnhanced({required String key, required List<String> paths, required dynamic value, int? start, int? stop}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonArrIndexEnhancedCommand extension
JSON.ARRINDEX (Enhanced)
jsonArrInsert({required String key, required String path, required int index, required List values}) → Future: Available on JsonCommands, provided by the JsonArrInsertCommand extension
JSON.ARRINSERT key path index value value ...
jsonArrInsertEnhanced({required String key, required List<String> paths, required int index, required List values}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonArrInsertEnhancedCommand extension
JSON.ARRINSERT (Enhanced)
jsonArrLen({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonArrLenCommand extension
JSON.ARRLEN key path
jsonArrLenEnhanced({required String key, required List<String> paths}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonArrLenEnhancedCommand extension
JSON.ARRLEN (Enhanced)
jsonArrPop({required String key, String path = r'$', int? index}) → Future: Available on JsonCommands, provided by the JsonArrPopCommand extension
JSON.ARRPOP key [path index]
jsonArrPopEnhanced({required String key, required List<String> paths, int? index}) → Future<List?>: Available on JsonCommands, provided by the JsonArrPopEnhancedCommand extension
JSON.ARRPOP (Enhanced)
jsonArrTrim({required String key, required String path, required int start, required int stop}) → Future: Available on JsonCommands, provided by the JsonArrTrimCommand extension
JSON.ARRTRIM key path start stop
jsonArrTrimEnhanced({required String key, required List<String> paths, required int start, required int stop}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonArrTrimEnhancedCommand extension
JSON.ARRTRIM (Enhanced)
jsonClear({required String key, String path = r'$'}) → Future<int>: Available on JsonCommands, provided by the JsonClearCommand extension
JSON.CLEAR key path
jsonDebug({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonDebugCommand extension
JSON.DEBUG MEMORY key path
jsonDebugDepth({required String key, bool forceRun = false}) → Future<int>: Available on JsonCommands, provided by the JsonDebugDepthCommand extension
JSON.DEBUG DEPTH key
jsonDebugFields({required String key, String? path, bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugFieldsCommand extension
JSON.DEBUG FIELDS <key> path
jsonDebugHelp() → Future<List<String>>: Available on JsonCommands, provided by the JsonDebugHelpCommand extension
JSON.DEBUG HELP
jsonDebugKeyTableCheck({bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugKeyTableCheckCommand extension
JSON.DEBUG KEYTABLE-CHECK
jsonDebugKeyTableCorrupt(String name, {bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugKeyTableCorruptCommand extension
JSON.DEBUG KEYTABLE-CORRUPT <name>
jsonDebugKeyTableDistribution(int topN, {bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugKeyTableDistributionCommand extension
JSON.DEBUG KEYTABLE-DISTRIBUTION <topN>
jsonDebugMaxDepthKey({bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugMaxDepthKeyCommand extension
JSON.DEBUG MAX-DEPTH-KEY
jsonDebugMaxSizeKey({bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugMaxSizeKeyCommand extension
JSON.DEBUG MAX-SIZE-KEY
jsonDebugMemory({required String key, String? path}) → Future: Available on JsonCommands, provided by the JsonDebugMemoryCommand extension
JSON.DEBUG MEMORY <key> path
jsonDebugTestSharedApi(String key, String path, {bool forceRun = false}) → Future: Available on JsonCommands, provided by the JsonDebugTestSharedApiCommand extension
JSON.DEBUG TEST-SHARED-API key path
jsonDel({required String key, String path = r'$'}) → Future<int?>: Available on JsonCommands, provided by the JsonDelCommand extension
JSON.DEL key path
jsonForget({required String key, String path = r'$'}) → Future<int>: Available on JsonCommands, provided by the JsonForgetCommand extension
JSON.FORGET key path
jsonGet({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonGetCommand extension
JSON.GET key path ...
jsonMerge({required String key, required String path, required dynamic data, bool forceRun = false}) → Future<void>: Available on JsonCommands, provided by the JsonMergeCommand extension
JSON.MERGE key path value
jsonMergeForce({required String key, required String path, required dynamic data, bool forceRun = false}) → Future<void>: Available on JsonCommands, provided by the JsonMergeForceCommand extension
jsonMGet({required List<String> keys, required String path}) → Future<List>: Available on JsonCommands, provided by the JsonMGetCommand extension
JSON.MGET key key ... path
jsonMSet({required List<JsonMSetEntry> entries}) → Future<void>: Available on JsonCommands, provided by the JsonMSetCommand extension
JSON.MSET key path value key path value ...
jsonNumIncrBy({required String key, required String path, required num value}) → Future: Available on JsonCommands, provided by the JsonNumIncrByCommand extension
JSON.NUMINCRBY key path value
jsonNumMultBy({required String key, required String path, required num value}) → Future: Available on JsonCommands, provided by the JsonNumMultByCommand extension
JSON.NUMMULTBY key path value
jsonObjKeys({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonObjKeysCommand extension
JSON.OBJKEYS key path
jsonObjKeysEnhanced({required String key, required List<String> paths}) → Future<List<List?>?>: Available on JsonCommands, provided by the JsonObjKeysEnhancedCommand extension
JSON.OBJKEYS (Enhanced)
jsonObjLen({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonObjLenCommand extension
JSON.OBJLEN key path
jsonResp({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonRespCommand extension
JSON.RESP key path
jsonSet({required String key, required String path, required dynamic data, bool nx = false, bool xx = false}) → Future<void>: Available on JsonCommands, provided by the JsonSetCommand extension
JSON.SET key path value NX | XX
jsonStrAppend({required String key, String path = r'$', required String value}) → Future: Available on JsonCommands, provided by the JsonStrAppendCommand extension
JSON.STRAPPEND key path value
jsonStrAppendEnhanced({required String key, required List<String> paths, required String value}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonStrAppendEnhancedCommand extension
JSON.STRAPPEND (Enhanced)
jsonStrLen({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonStrLenCommand extension
JSON.STRLEN key path
jsonStrLenEnhanced({required String key, required List<String> paths}) → Future<List<int?>?>: Available on JsonCommands, provided by the JsonStrLenEnhancedCommand extension
JSON.STRLEN (Enhanced)
jsonToggle({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonToggleCommand extension
JSON.TOGGLE key path
jsonType({required String key, String path = r'$'}) → Future: Available on JsonCommands, provided by the JsonTypeCommand extension
JSON.TYPE key path
keys(String pattern) → Future<List<String>>: Available on GenericCommands, provided by the KeysCommand extension
KEYS pattern
lcs(String key1, String key2, {bool len = false, bool idx = false, int? minMatchLen, bool withMatchLen = false}) → Future: Available on StringCommands, provided by the LcsCommand extension
LCS key1 key2 LEN IDX MINMATCHLEN len `WITHMATCHLEN`
lIndex(String key, int index) → Future<String?>: Available on ListCommands, provided by the LIndexCommand extension
LINDEX key index
lInsert(String key, String position, String pivot, String element) → Future<int>: Available on ListCommands, provided by the LInsertCommand extension
LINSERT key <BEFORE | AFTER> pivot element
lLen(String key) → Future<int>: Available on ListCommands, provided by the LLenCommand extension
LLEN key
lMove(String source, String destination, String whereFrom, String whereTo) → Future<String?>: Available on ListCommands, provided by the LMoveCommand extension
LMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT>
lMPop(List<String> keys, String direction, {int? count}) → Future: Available on ListCommands, provided by the LMPopCommand extension
LMPOP numkeys key key ... <LEFT | RIGHT> COUNT count
lPop(String key, {int? count}) → Future: Available on ListCommands, provided by the LPopCommand extension
LPOP key count
lpop(String key) → Future<String?>: Removes and returns the first element of the list stored at key.
override
lPos(String key, String element, {int? rank, int? count, int? maxLen}) → Future: Available on ListCommands, provided by the LPosCommand extension
LPOS key element RANK rank COUNT num-matches MAXLEN len
lPush(String key, List<String> elements) → Future<int>: Available on ListCommands, provided by the LPushCommand extension
LPUSH key element element ...
lpush(String key, String value) → Future<int>: Prepends value to the list stored at key.
override
lPushX(String key, List<String> elements) → Future<int>: Available on ListCommands, provided by the LPushXCommand extension
LPUSHX key element element ...
lRange(String key, int start, int stop) → Future<List<String>>: Available on ListCommands, provided by the LRangeCommand extension
LRANGE key start stop
lrange(String key, int start, int stop) → Future<List<String?>>: Returns the specified elements of the list stored at key.
override
lRem(String key, int count, String element) → Future<int>: Available on ListCommands, provided by the LRemCommand extension
LREM key count element
lSet(String key, int index, String element) → Future<String>: Available on ListCommands, provided by the LSetCommand extension
LSET key index element
lTrim(String key, int start, int stop) → Future<String>: Available on ListCommands, provided by the LTrimCommand extension
LTRIM key start stop
mGet(List<String> keys) → Future<List<String?>>: Available on StringCommands, provided by the MGetCommand extension
MGET key key ...
mget(List<String> keys) → Future<List<String?>>: Gets the values of all specified keys.
override
migrate(String host, int port, String key, int destinationDb, int timeout, {bool copy = false, bool replace = false, String? authPassword, String? auth2Username, List<String>? keys}) → Future<String>: Available on GenericCommands, provided by the MigrateCommand extension
MIGRATE host port key|"" destination-db timeout [COPY] [REPLACE] AUTH password AUTH2 username password [KEYS key key ...]
move(String key, int db) → Future<bool>: Available on GenericCommands, provided by the MoveCommand extension
MOVE key db
mSet(Map<String, String> data) → Future<String>: Available on StringCommands, provided by the MSetCommand extension
MSET key value key value ...
mSetEx(Map<String, String> data, {bool nx = false, bool xx = false, int? ex, int? px, int? exAt, int? pxAt, bool keepTtl = false, bool forceRun = false}) → Future<int>: Available on StringCommands, provided by the MSetExCommand extension
MSETEX numkeys key value key value ... NX | XX EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | KEEPTTL
mSetNx(Map<String, String> data) → Future<int>: Available on StringCommands, provided by the MSetNxCommand extension
MSETNX key value key value ...
multi() → Future<String>: Marks the start of a transaction block.
override
multi() → Future<String>: Available on TransactionsCommands, provided by the MultiCommand extension
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
objectEncoding(String key) → Future<String?>: Available on GenericCommands, provided by the ObjectEncodingCommand extension
OBJECT ENCODING key
objectFreq(String key) → Future<int?>: Available on GenericCommands, provided by the ObjectFreqCommand extension
OBJECT FREQ key
objectHelp() → Future<List<String>>: Available on GenericCommands, provided by the ObjectHelpCommand extension
OBJECT HELP
objectIdleTime(String key) → Future<int?>: Available on GenericCommands, provided by the ObjectIdleTimeCommand extension
OBJECT IDLETIME key
objectRefCount(String key) → Future<int?>: Available on GenericCommands, provided by the ObjectRefCountCommand extension
OBJECT REFCOUNT key
packVector(List<num> vector) → Uint8List: Converts a List<num> to a Float32 Little Endian Byte Array (Blob).
inherited
persist(String key) → Future<bool>: Available on GenericCommands, provided by the PersistCommand extension
PERSIST key
pExpire(String key, int milliseconds, {bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<bool>: Available on GenericCommands, provided by the PExpireCommand extension
PEXPIRE key milliseconds NX|XX|GT|LT
pExpireAt(String key, int millisecondsTimestamp, {bool nx = false, bool xx = false, bool gt = false, bool lt = false}) → Future<bool>: Available on GenericCommands, provided by the PExpireAtCommand extension
PEXPIREAT key milliseconds-timestamp NX|XX|GT|LT
pExpireTime(String key) → Future<int>: Available on GenericCommands, provided by the PExpireTimeCommand extension
PEXPIRETIME key
pfAdd(String key, List<String> elements) → Future<int>: Available on HyperLogLogCommands, provided by the PfAddCommand extension
PFADD key element element ...
pfCount(List<String> keys) → Future<int>: Available on HyperLogLogCommands, provided by the PfCountCommand extension
PFCOUNT key key ...
pfDebug(String subcommand, String key) → Future: Available on HyperLogLogCommands, provided by the PfDebugCommand extension
PFDEBUG <subcommand> <key>
pfMerge(String destKey, List<String> sourceKeys) → Future<String>: Available on HyperLogLogCommands, provided by the PfMergeCommand extension
PFMERGE destkey sourcekey sourcekey ...
pfSelfTest() → Future<String>: Available on HyperLogLogCommands, provided by the PfSelfTestCommand extension
PFSELFTEST
ping([String? message]) → Future<String>: PINGs the server.
override
printDebugWarning() → void: inherited
pSetEx(String key, int milliseconds, String value) → Future<String>: Available on StringCommands, provided by the PSetExCommand extension
PSETEX key milliseconds value
psubscribe(List<String> patterns) → Subscription: Subscribes the client to the given patterns (e.g., "log:*").
override
pTtl(String key) → Future<int>: Available on GenericCommands, provided by the PTtlCommand extension
PTTL key
publish(String channel, String message) → Future<int>: Posts a message to the given channel.
override
pubsubChannels([String? pattern]) → Future<List<String?>>: Lists the currently active channels.
override
pubsubNumPat() → Future<int>: Returns the number of subscriptions to patterns.
override
pubsubNumSub(List<String> channels) → Future<Map<String, int>>: Returns the number of subscribers for the specified channels.
override
punsubscribe([List<String> patterns = const []]) → Future<void>: Unsubscribes the client from the given patterns, or all patterns if none are given.
override
queueCommandInternal(List<String> command) → void: inherited
quit({bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the QuitCommand extension
QUIT Closes the connection.
randomKey() → Future<String?>: Available on GenericCommands, provided by the RandomKeyCommand extension
RANDOMKEY
rename(String key, String newKey) → Future<String>: Available on GenericCommands, provided by the RenameCommand extension
RENAME key newkey
renameNx(String key, String newKey) → Future<bool>: Available on GenericCommands, provided by the RenameNxCommand extension
RENAMENX key newkey
reset({bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the ResetCommand extension
RESET Resets the connection state.
restore(String key, int ttl, List<int> serializedValue, {bool replace = false, bool absttl = false, int? idleTime, int? freq}) → Future<String>: Available on GenericCommands, provided by the RestoreCommand extension
RESTORE key ttl serialized-value REPLACE ABSTTL IDLETIME seconds FREQ frequency
rPop(String key, {int? count}) → Future: Available on ListCommands, provided by the RPopCommand extension
RPOP key count
rpop(String key) → Future<String?>: Removes and returns the last element of the list stored at key.
override
rPopLPush(String source, String destination) → Future<String?>: Available on ListCommands, provided by the RPopLPushCommand extension
RPOPLPUSH source destination
rPush(String key, List<String> elements) → Future<int>: Available on ListCommands, provided by the RPushCommand extension
RPUSH key element element ...
rpush(String key, String value) → Future<int>: Appends value to the list stored at key.
override
rPushX(String key, List<String> elements) → Future<int>: Available on ListCommands, provided by the RPushXCommand extension
RPUSHX key element element ...
sAdd(String key, List<String> members) → Future<int>: Available on SetCommands, provided by the SAddCommand extension
SADD key member member ...
sadd(String key, String member) → Future<int>: Adds member to the set stored at key.
override
scan(String cursor, {String? match, int? count, String? type}) → Future<List>: Available on GenericCommands, provided by the ScanCommand extension
SCAN cursor MATCH pattern COUNT count TYPE type
scanCli({required String cursor, String match = '*', int count = 100}) → Future<ScanResult>: Available on GenericCommands, provided by the ScanCliCommand extension
from @Keyscope
sCard(String key) → Future<int>: Available on SetCommands, provided by the SCardCommand extension
SCARD key
sDiff(String key, [List<String> otherKeys = const []]) → Future<List<String>>: Available on SetCommands, provided by the SDiffCommand extension
SDIFF key key ...
sDiffStore(String destination, String key, [List<String> otherKeys = const []]) → Future<int>: Available on SetCommands, provided by the SDiffStoreCommand extension
SDIFFSTORE destination key key ...
select(int index, {bool forceRun = false}) → Future: Available on ConnectionCommands, provided by the SelectCommand extension
SELECT index Changes the logical database for the current connection.
send(List<String> command) → Future: Provides a shorter name for execute(). Internally calls execute().
override
set(String key, String value, {bool nx = false, bool xx = false, bool get = false, int? ex, int? px, int? exAt, int? pxAt, bool keepTtl = false}) → Future<String?>: Sets key to value.
override
set(String key, String value, {bool nx = false, bool xx = false, bool get = false, int? ex, int? px, int? exAt, int? pxAt, bool keepTtl = false}) → Future<String?>: Available on StringCommands, provided by the SetCommand extension
SET key value NX | XX GET EX seconds | PX milliseconds | EXAT timestamp | PXAT timestamp | KEEPTTL
setBit(String key, int offset, int value) → Future<int>: Available on BitmapCommands, provided by the SetBitCommand extension
SETBIT key offset value
setEx(String key, int seconds, String value) → Future<String>: Available on StringCommands, provided by the SetExCommand extension
SETEX key seconds value
setNx(String key, String value) → Future<int>: Available on StringCommands, provided by the SetNxCommand extension
SETNX key value
setRange(String key, int offset, String value) → Future<int>: Available on StringCommands, provided by the SetRangeCommand extension
SETRANGE key offset value
setTransactionStateInternal(bool isStarted) → void: inherited
sInter(List<String> keys) → Future<List<String>>: Available on SetCommands, provided by the SInterCommand extension
SINTER key key ...
sInterCard(List<String> keys, {int? limit}) → Future<int>: Available on SetCommands, provided by the SInterCardCommand extension
SINTERCARD numkeys key key ... LIMIT limit
sInterStore(String destination, List<String> keys) → Future<int>: Available on SetCommands, provided by the SInterStoreCommand extension
SINTERSTORE destination key key ...
sIsMember(String key, String member) → Future<bool>: Available on SetCommands, provided by the SIsMemberCommand extension
SISMEMBER key member
sMembers(String key) → Future<List<String>>: Available on SetCommands, provided by the SMembersCommand extension
SMEMBERS key
smembers(String key) → Future<List<String?>>: Returns all members of the set stored at key.
override
sMIsMember(String key, List<String> members) → Future<List<int>>: Available on SetCommands, provided by the SMIsMemberCommand extension
SMISMEMBER key member member ...
sMove(String source, String destination, String member) → Future<bool>: Available on SetCommands, provided by the SMoveCommand extension
SMOVE source destination member
sort(String key, {String? by, int? limitOffset, int? limitCount, List<String>? getPatterns, bool asc = false, bool desc = false, bool alpha = false, String? store}) → Future: Available on GenericCommands, provided by the SortCommand extension
SORT key BY pattern LIMIT offset count [GET pattern GET pattern ...] ASC|DESC ALPHA STORE destination
sortRo(String key, {String? by, int? limitOffset, int? limitCount, List<String>? getPatterns, bool asc = false, bool desc = false, bool alpha = false}) → Future<List<String>>: Available on GenericCommands, provided by the SortRoCommand extension
SORT_RO key BY pattern LIMIT offset count [GET pattern GET pattern ...] ASC|DESC [ALPHA]
sPop(String key, [int? count]) → Future: Available on SetCommands, provided by the SPopCommand extension
SPOP key count
spublish(String channel, String message) → Future<int>: Posts a message to the given channel using Sharded Pub/Sub. Returns the number of clients that received the message. Note: In Cluster mode, this command is routed to the specific node that owns the slot for channel.
override
sRandMember(String key, [int? count]) → Future: Available on SetCommands, provided by the SRandMemberCommand extension
SRANDMEMBER key count
sRem(String key, List<String> members) → Future<int>: Available on SetCommands, provided by the SRemCommand extension
SREM key member member ...
srem(String key, String member) → Future<int>: Removes member from the set stored at key.
override
sScan(String key, int cursor, {String? match, int? count}) → Future<List>: Available on SetCommands, provided by the SScanCommand extension
SSCAN key cursor MATCH pattern COUNT count
ssubscribe(List<String> channels) → Subscription: Subscribes the client to the specified channels using Sharded Pub/Sub.
override
strLen(String key) → Future<int>: Available on StringCommands, provided by the StrLenCommand extension
STRLEN key
subscribe(List<String> channels) → Subscription: Subscribes the client to the specified channels.
override
subStr(String key, int start, int end) → Future<String>: Available on StringCommands, provided by the SubStrCommand extension
SUBSTR key start end
sUnion(List<String> keys) → Future<List<String>>: Available on SetCommands, provided by the SUnionCommand extension
SUNION key key ...
sUnionStore(String destination, List<String> keys) → Future<int>: Available on SetCommands, provided by the SUnionStoreCommand extension
SUNIONSTORE destination key key ...
sunsubscribe([List<String> channels = const []]) → Future<void>: Unsubscribes from the given channels using Sharded Pub/Sub.
override
tDigestAdd(String key, List<double> values, {bool forceRun = false}) → Future: Available on TDigestSketchCommands, provided by the TDigestAddCommand extension
TDIGEST.ADD key value value ... Adds one or more observations to a t-digest sketch.
tDigestByRank(String key, List<int> ranks, {bool forceRun = false}) → Future<List<double>>: Available on TDigestSketchCommands, provided by the TDigestByRankCommand extension
TDIGEST.BYRANK key rank rank ... Returns the value(s) associated with the specified rank(s).
tDigestByRevRank(String key, List<int> revRanks, {bool forceRun = false}) → Future<List<double>>: Available on TDigestSketchCommands, provided by the TDigestByRevRankCommand extension
TDIGEST.BYREVRANK key rev_rank rev_rank ... Returns the value(s) associated with the specified reverse rank(s).
tDigestCdf(String key, List<double> values, {bool forceRun = false}) → Future<List<double>>: Available on TDigestSketchCommands, provided by the TDigestCdfCommand extension
TDIGEST.CDF key value value ... Returns the fraction of all points added which are <= value.
tDigestCreate(String key, {int? compression, bool forceRun = false}) → Future: Available on TDigestSketchCommands, provided by the TDigestCreateCommand extension
TDIGEST.CREATE key COMPRESSION compression Allocates memory and initializes a new t-digest.
tDigestInfo(String key, {bool forceRun = false}) → Future: Available on TDigestSketchCommands, provided by the TDigestInfoCommand extension
TDIGEST.INFO key Returns information and statistics about a t-digest sketch.
tDigestMax(String key, {bool forceRun = false}) → Future<double>: Available on TDigestSketchCommands, provided by the TDigestMaxCommand extension
TDIGEST.MAX key Returns the maximum observation value from a t-digest sketch.
tDigestMerge(String destinationKey, List<String> sourceKeys, {int? compression, bool override = false, bool forceRun = false}) → Future: Available on TDigestSketchCommands, provided by the TDigestMergeCommand extension
TDIGEST.MERGE destination_key numKeys source_key source_key ... COMPRESSION compression [OVERRIDE] Merges multiple t-digest sketches into a single sketch.
tDigestMin(String key, {bool forceRun = false}) → Future<double>: Available on TDigestSketchCommands, provided by the TDigestMinCommand extension
TDIGEST.MIN key Returns the minimum observation value from a t-digest sketch.
tDigestQuantile(String key, List<double> quantiles, {bool forceRun = false}) → Future<List<double>>: Available on TDigestSketchCommands, provided by the TDigestQuantileCommand extension
TDIGEST.QUANTILE key quantile quantile ... Returns estimates of one or more cutoffs such that a specified fraction of the observations added to this t-digest would be less than or equal to each of the specified cutoffs.
tDigestRank(String key, List<double> values, {bool forceRun = false}) → Future<List<int>>: Available on TDigestSketchCommands, provided by the TDigestRankCommand extension
TDIGEST.RANK key value value ... Returns the number of observations less than or equal to the specified value(s).
tDigestReset(String key, {bool forceRun = false}) → Future: Available on TDigestSketchCommands, provided by the TDigestResetCommand extension
TDIGEST.RESET key Resets a t-digest sketch: empty the sketch and re-initialize it.
tDigestRevRank(String key, List<double> values, {bool forceRun = false}) → Future<List<int>>: Available on TDigestSketchCommands, provided by the TDigestRevRankCommand extension
TDIGEST.REVRANK key value value ... Returns the number of observations greater than or equal to the specified value(s).
tDigestTrimmedMean(String key, double lowCutQuantile, double highCutQuantile, {bool forceRun = false}) → Future<double>: Available on TDigestSketchCommands, provided by the TDigestTrimmedMeanCommand extension
TDIGEST.TRIMMED_MEAN key low_cut_quantile high_cut_quantile Returns the mean of all values in the sketch, excluding values outside the specified cutoffs.
topkAdd(String key, List<String> items, {bool forceRun = false}) → Future<List<String?>>: Available on TopKSketchCommands, provided by the TopKAddCommand extension
TOPK.ADD key item item ... Adds one or more items to the TopK data structure. Returns a list of elements dropped from the TopK list. Null indicates no drop.
topkCount(String key, List<String> items, {bool forceRun = false}) → Future<List<int>>: Available on TopKSketchCommands, provided by the TopKCountCommand extension
TOPK.COUNT key item item ... Returns the approximate count for one or more items.
topkIncrBy(String key, Map<String, int> increments, {bool forceRun = false}) → Future<List<String?>>: Available on TopKSketchCommands, provided by the TopKIncrByCommand extension
TOPK.INCRBY key item increment item increment ... Increases the score of an item. Returns a list of elements dropped from the TopK list. Null indicates no drop.
topkInfo(String key, {bool forceRun = false}) → Future: Available on TopKSketchCommands, provided by the TopKInfoCommand extension
TOPK.INFO key Returns statistics about a TopK key.
topkList(String key, {bool withCount = false, bool forceRun = false}) → Future<List>: Available on TopKSketchCommands, provided by the TopKListCommand extension
TOPK.LIST key [WITHCOUNT] Returns the full list of items in the TopK list. If withCount is true, the result will interleave items and their counts.
topkQuery(String key, List<String> items, {bool forceRun = false}) → Future<List<bool>>: Available on TopKSketchCommands, provided by the TopKQueryCommand extension
TOPK.QUERY key item item ... Checks whether one or more items are in the TopK list. Returns a list of booleans indicating membership.
topkReserve(String key, int topk, {int? width, int? depth, double? decay, bool forceRun = false}) → Future: Available on TopKSketchCommands, provided by the TopKReserveCommand extension
TOPK.RESERVE key topk width depth decay Initializes a TopK with specified parameters.
toString() → String: A string representation of this object.
inherited
touch(List<String> keys) → Future<int>: Available on GenericCommands, provided by the TouchCommand extension
TOUCH key key ...
tsAdd(String key, Object timestamp, num value, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsAddCommand extension
TS.ADD key timestamp value RETENTION retentionPeriod ENCODING uncompressed|compressed CHUNK_SIZE size ON_DUPLICATE policy LABELS field value..
tsAdd2(String key, Object timestamp, num value, {int? retention, String? encoding, int? chunkSize, String? onDuplicate, Map<String, String>? labels, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsAddCommand extension
TS.ADD key timestamp value RETENTION retentionPeriod ENCODING uncompressed|compressed CHUNK_SIZE size ON_DUPLICATE policy LABELS field value..
tsAlter(String key, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsAlterCommand extension
TS.ALTER key RETENTION retentionPeriod CHUNK_SIZE size DUPLICATE_POLICY policy LABELS field value..
tsAlter2(String key, {int? retention, int? chunkSize, String? duplicatePolicy, Map<String, String>? labels, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsAlterCommand extension
TS.ALTER key RETENTION retentionPeriod CHUNK_SIZE size DUPLICATE_POLICY policy LABELS field value..
tsCreate(String key, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsCreateCommand extension
TS.CREATE key RETENTION retentionPeriod ENCODING encoding CHUNK_SIZE size DUPLICATE_POLICY policy LABELS field value..
tsCreate2(String key, {int? retention, String? encoding, int? chunkSize, String? duplicatePolicy, Map<String, String>? labels, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsCreateCommand extension
TS.CREATE key RETENTION retentionPeriod ENCODING uncompressed|compressed CHUNK_SIZE size DUPLICATE_POLICY policy LABELS field value..
tsCreateRule(String sourceKey, String destKey, String aggregator, int bucketDuration, {int? alignTimestamp, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsCreateRuleCommand extension
TS.CREATERULE sourceKey destKey AGGREGATION aggregator bucketDuration alignTimestamp
tsDecrBy(String key, num value, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsDecrByCommand extension
TS.DECRBY key value TIMESTAMP timestamp RETENTION retentionPeriod UNCOMPRESSED CHUNK_SIZE size LABELS field value..
tsDecrBy2(String key, num value, {Object? timestamp, int? retention, bool uncompressed = false, int? chunkSize, Map<String, String>? labels, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsDecrByCommand extension
TS.DECRBY key value TIMESTAMP timestamp RETENTION retentionPeriod UNCOMPRESSED CHUNK_SIZE size LABELS field value..
tsDel(String key, int fromTimestamp, int toTimestamp, {bool forceRun = false}) → Future<int>: Available on TimeSeriesCommands, provided by the TsDelCommand extension
TS.DEL key fromTimestamp toTimestamp
tsDeleteRule(String sourceKey, String destKey, {bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsDeleteRuleCommand extension
TS.DELETERULE sourceKey destKey
tsGet(String key, {bool latest = false, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsGetCommand extension
TS.GET key [LATEST]
tsIncrBy(String key, num value, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsIncrByCommand extension
TS.INCRBY key value TIMESTAMP timestamp RETENTION retentionPeriod UNCOMPRESSED CHUNK_SIZE size LABELS field value..
tsIncrBy2(String key, num value, {Object? timestamp, int? retention, bool uncompressed = false, int? chunkSize, Map<String, String>? labels, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsIncrByCommand extension
TS.INCRBY key value TIMESTAMP timestamp RETENTION retentionPeriod UNCOMPRESSED CHUNK_SIZE size LABELS field value..
tsInfo(String key, {bool debug = false, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsInfoCommand extension
TS.INFO key [DEBUG]
tsMAdd(List<List> samples, {bool forceRun = false}) → Future<List>: Available on TimeSeriesCommands, provided by the TsMAddCommand extension
TS.MADD key timestamp value key timestamp value ...
tsMGet(List<String> filters, {bool latest = false, List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsMGetCommand extension
TS.MGET LATEST WITHLABELS | SELECTED_LABELS label... FILTER filter...
tsMGet2(List<String> filters, {bool latest = false, bool withLabels = false, List<String>? selectedLabels, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsMGetCommand extension
TS.MGET LATEST WITHLABELS | SELECTED_LABELS label... FILTER filter...
tsMRange(Object fromTimestamp, Object toTimestamp, List<String> filters, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsMRangeCommand extension
TS.MRANGE fromTimestamp toTimestamp LATEST FILTER_BY_TS ... FILTER_BY_VALUE ... WITHLABELS COUNT count ALIGN align AGGREGATION aggregator bucketDuration BUCKETTIMESTAMP ... [EMPTY] FILTER filter...
tsMRange2({Object? fromTimestamp, Object? toTimestamp, List<String> filters = const [], bool latest = false, List<int>? filterByTs, num? filterByValueMin, num? filterByValueMax, bool withLabels = false, List<String>? selectedLabels, int? count, Object? align, String? aggregator, int? bucketDuration, List? bucketTimestamp, bool empty = false, String? groupByLabel, String? reduceReducer, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsMRangeCommand extension
TS.MRANGE fromTimestamp toTimestamp LATEST FILTER_BY_TS ... FILTER_BY_VALUE ... WITHLABELS | SELECTED_LABELS label... COUNT count ALIGN align AGGREGATION aggregator bucketDuration BUCKETTIMESTAMP ... EMPTY GROUPBY label REDUCE reducer FILTER filter...
tsMRevRange(Object fromTimestamp, Object toTimestamp, List<String> filters, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsMRevRangeCommand extension
TS.MREVRANGE fromTimestamp toTimestamp LATEST FILTER_BY_TS ... FILTER_BY_VALUE ... WITHLABELS COUNT count ALIGN align AGGREGATION aggregator bucketDuration BUCKETTIMESTAMP ... [EMPTY] FILTER filter...
tsMRevRange2({Object? fromTimestamp, Object? toTimestamp, List<String> filters = const [], bool latest = false, List<int>? filterByTs, num? filterByValueMin, num? filterByValueMax, bool withLabels = false, List<String>? selectedLabels, int? count, Object? align, String? aggregator, int? bucketDuration, List? bucketTimestamp, bool empty = false, String? groupByLabel, String? reduceReducer, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsMRevRangeCommand extension
TS.MREVRANGE fromTimestamp toTimestamp ...
tsQueryIndex(List<String> filters, {bool forceRun = false}) → Future<List<String>>: Available on TimeSeriesCommands, provided by the TsQueryIndexCommand extension
TS.QUERYINDEX filter...
tsRange(String key, Object fromTimestamp, Object toTimestamp, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsRangeCommand extension
TS.RANGE key fromTimestamp toTimestamp LATEST FILTER_BY_TS ... FILTER_BY_VALUE ... COUNT count ALIGN align AGGREGATION aggregator bucketDuration BUCKETTIMESTAMP ... [EMPTY]
tsRange2(String key, Object fromTimestamp, Object toTimestamp, {bool latest = false, List<int>? filterByTs, num? filterByValueMin, num? filterByValueMax, int? count, Object? align, String? aggregator, int? bucketDuration, List? bucketTimestamp, bool empty = false, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsRangeCommand extension
TS.RANGE key fromTimestamp toTimestamp LATEST FILTER_BY_TS ... FILTER_BY_VALUE ... COUNT count ALIGN align AGGREGATION aggregator bucketDuration BUCKETTIMESTAMP ... [EMPTY]
tsRevRange(String key, Object fromTimestamp, Object toTimestamp, {List options = const [], bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsRevRangeCommand extension
TS.REVRANGE key fromTimestamp toTimestamp LATEST FILTER_BY_TS ... FILTER_BY_VALUE ... COUNT count ALIGN align AGGREGATION aggregator bucketDuration BUCKETTIMESTAMP ... [EMPTY]
tsRevRange2(String key, Object fromTimestamp, Object toTimestamp, {bool latest = false, List<int>? filterByTs, num? filterByValueMin, num? filterByValueMax, int? count, Object? align, String? aggregator, int? bucketDuration, List? bucketTimestamp, bool empty = false, bool forceRun = false}) → Future: Available on TimeSeriesCommands, provided by the TsRevRangeCommand extension
TS.REVRANGE key fromTimestamp toTimestamp [LATEST] ... Note: fromTimestamp is still Min, toTimestamp is still Max.
ttl(String key) → Future<int>: Gets the remaining time to live of a key in seconds.
override
ttl(String key) → Future<int>: Available on GenericCommands, provided by the TtlCommand extension
TTL key
type(String key) → Future<String>: Available on GenericCommands, provided by the TypeCommand extension
TYPE key
unlink(List<String> keys) → Future<int>: Available on GenericCommands, provided by the UnlinkCommand extension
UNLINK key key ...
unpackVector(List<int> bytes) → List<double>: Converts a Byte Array (or List<int>) back to List<double>.
inherited
unsubscribe([List<String> channels = const []]) → Future<void>: Unsubscribes the client from the given channels, or all channels if none are given.
override
unwatch() → Future<String>: Available on TransactionsCommands, provided by the UnwatchCommand extension
UNWATCH
vAdd(String key, List<num> vector, String element, {int? reduce, bool cas = false, bool noQuant = false, bool q8 = false, bool bin = false, int? ef, String? setAttr, int? m, bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VAddCommand extension
VADD key REDUCE dim (FP32 | VALUES num) vector element [CAS] NOQUANT | Q8 | BIN EF ef SETATTR attributes M numlinks
vCard(String key, {bool forceRun = false}) → Future<int>: Available on VectorSetCommands, provided by the VCardCommand extension
VCARD key
vDim(String key, {bool forceRun = false}) → Future<int>: Available on VectorSetCommands, provided by the VDimCommand extension
VDIM key
vEmb(String key, String id, {bool forceRun = false}) → Future<List<double>>: Available on VectorSetCommands, provided by the VEmbCommand extension
VEMB key id
vGetAttr(String key, String element, {bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VGetAttrCommand extension
VGETATTR key element
vInfo(String key, {bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VInfoCommand extension
VINFO key
vIsMember(String key, String id, {bool forceRun = false}) → Future<bool>: Available on VectorSetCommands, provided by the VIsMemberCommand extension
VISMEMBER key id
vLinks(String key, String id, {bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VLinksCommand extension
VLINKS key id
vRandMember(String key, {int? count, bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VRandMemberCommand extension
VRANDMEMBER key count
vRange(String key, String start, String end, {int? count, bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VRangeCommand extension
VRANGE key start end count
vRem(String key, String id, {bool forceRun = false}) → Future<int>: Available on VectorSetCommands, provided by the VRemCommand extension
VREM key id
vSetAttr(String key, String id, Map<String, dynamic> attributes, {bool forceRun = false}) → Future: Available on VectorSetCommands, provided by the VSetAttrCommand extension
VSETATTR key id attributes
vSim(String key, {String? queryElement, List<num>? queryVector, bool withScores = false, bool withAttribs = false, int? count, double? epsilon, int? ef, String? filter, int? filterEf, bool truth = false, bool noThread = false, bool forceRun = false}) → Future<List>: Available on VectorSetCommands, provided by the VSimCommand extension
VSIM key (ELE | VALUES num) (element | vector) [WITHSCORES] WITHATTRIBS COUNT num EPSILON delta EF ef FILTER expression FILTER-EF max-effort [TRUTH] [NOTHREAD]
wait(int numReplicas, int timeout) → Future<int>: Available on GenericCommands, provided by the WaitCommand extension
WAIT numreplicas timeout
waitAof(int numLocal, int numReplicas, int timeout) → Future<List<int>>: Available on GenericCommands, provided by the WaitAofCommand extension
WAITAOF numLocal numReplicas timeout
watch(List<String> keys) → Future<String>: Available on TransactionsCommands, provided by the WatchCommand extension
WATCH key key ...
xAck(String key, String group, List<String> ids) → Future<int>: Available on StreamCommands, provided by the XAckCommand extension
XACK key group id id ...
xAdd(String key, Map<String, String> fields, {String id = '*', int? maxLen, bool approximate = false, bool noMkStream = false}) → Future<String>: Available on StreamCommands, provided by the XAddCommand extension
XADD key NOMKSTREAM [MAXLEN|MINID =|~ threshold LIMIT count] ID field value field value ...
xAutoClaim(String key, String group, String consumer, int minIdleTime, String start, {int? count, bool justId = false}) → Future<List>: Available on StreamCommands, provided by the XAutoClaimCommand extension
XAUTOCLAIM key group consumer min-idle-time start COUNT count [JUSTID]
xClaim(String key, String group, String consumer, int minIdleTime, List<String> ids, {int? idle, int? time, int? retryCount, bool force = false, bool justId = false}) → Future<List<StreamEntry>>: Available on StreamCommands, provided by the XClaimCommand extension
XCLAIM key group consumer min-idle-time id id ... IDLE ms TIME ms-unix-time RETRYCOUNT count [FORCE] [JUSTID]
xDel(String key, List<String> ids) → Future<int>: Available on StreamCommands, provided by the XDelCommand extension
XDEL key id id ...
xGroup(List<String> args) → Future: Available on StreamCommands, provided by the XGroupCommand extension
General XGROUP command entry. Use specific extensions like xGroupCreate, xGroupDestroy etc.
xGroupCreate(String key, String group, String id, {bool mkStream = false}) → Future<String>: Available on StreamCommands, provided by the XGroupCreateCommand extension
XGROUP CREATE key groupname id|$ MKSTREAM ENTRIESREAD entries_read
xGroupCreateConsumer(String key, String group, String consumer) → Future<int>: Available on StreamCommands, provided by the XGroupCreateConsumerCommand extension
XGROUP CREATECONSUMER key group consumer
xGroupDelConsumer(String key, String group, String consumer) → Future<int>: Available on StreamCommands, provided by the XGroupDelConsumerCommand extension
XGROUP DELCONSUMER key group consumer
xGroupDestroy(String key, String group) → Future<int>: Available on StreamCommands, provided by the XGroupDestroyCommand extension
XGROUP DESTROY key group
xGroupHelp() → Future<List<String>>: Available on StreamCommands, provided by the XGroupHelpCommand extension
XGROUP HELP
xGroupSetId(String key, String group, String id) → Future<String>: Available on StreamCommands, provided by the XGroupSetIdCommand extension
XGROUP SETID key group id
xInfo(List<String> args) → Future: Available on StreamCommands, provided by the XInfoCommand extension
General XINFO command entry. Use specific extensions like xInfoStream, xInfoGroups etc.
xInfoConsumers(String key, String group) → Future<List>: Available on StreamCommands, provided by the XInfoConsumersCommand extension
XINFO CONSUMERS key group
xInfoGroups(String key) → Future<List>: Available on StreamCommands, provided by the XInfoGroupsCommand extension
XINFO GROUPS key
xInfoHelp() → Future<List<String>>: Available on StreamCommands, provided by the XInfoHelpCommand extension
XINFO HELP
xInfoStream(String key, {bool full = false, int? count}) → Future: Available on StreamCommands, provided by the XInfoStreamCommand extension
XINFO STREAM key [FULL COUNT count]
xLen(String key) → Future<int>: Available on StreamCommands, provided by the XLenCommand extension
XLEN key
xPending(String key, String group, {int? idle, String? start, String? end, int? count, String? consumer}) → Future: Available on StreamCommands, provided by the XPendingCommand extension
XPENDING key group [IDLE min-idle-time start end count consumer]
xRange(String key, {String start = '-', String end = '+', int? count}) → Future<List<StreamEntry>>: Available on StreamCommands, provided by the XRangeCommand extension
XRANGE key start end COUNT count
xRead(List<String> keys, List<String> ids, {int? count, int? block}) → Future<Map<String, List<StreamEntry>>>: Available on StreamCommands, provided by the XReadCommand extension
XREAD COUNT count BLOCK milliseconds STREAMS key key ... id id ...
xReadGroup(String group, String consumer, List<String> keys, List<String> ids, {int? count, int? block, bool noAck = false}) → Future<Map<String, List<StreamEntry>>>: Available on StreamCommands, provided by the XReadGroupCommand extension
XREADGROUP GROUP group consumer COUNT count BLOCK milliseconds [NOACK] STREAMS key key ... id id ...
xRevRange(String key, {String end = '+', String start = '-', int? count}) → Future<List<StreamEntry>>: Available on StreamCommands, provided by the XRevRangeCommand extension
XREVRANGE key end start COUNT count
xSetId(String key, String lastId, {int? entriesAdded}) → Future<String>: Available on StreamCommands, provided by the XSetIdCommand extension
XSETID key last-id ENTRIESADDED entries-added
xTrim(String key, {int? maxLen, String? minId, bool approximate = false, int? limit}) → Future<int>: Available on StreamCommands, provided by the XTrimCommand extension
XTRIM key MAXLEN|MINID =|~ threshold LIMIT count
zAdd(String key, Map<String, num> items, {bool nx = false, bool xx = false, bool gt = false, bool lt = false, bool ch = false, bool incr = false}) → Future: Available on SortedSetCommands, provided by the ZAddCommand extension
ZADD key NX | XX GT | LT [CH] [INCR] score member score member ...
zadd(String key, double score, String member) → Future<int>: Adds member with the specified score to the sorted set stored at key.
override
zCard(String key) → Future<int>: Available on SortedSetCommands, provided by the ZCardCommand extension
ZCARD key
zCount(String key, Object min, Object max) → Future<int>: Available on SortedSetCommands, provided by the ZCountCommand extension
ZCOUNT key min max
zDiff(List<String> keys, {bool withScores = false}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZDiffCommand extension
ZDIFF numkeys key key ... [WITHSCORES]
zDiffStore(String destination, List<String> keys) → Future<int>: Available on SortedSetCommands, provided by the ZDiffStoreCommand extension
ZDIFFSTORE destination numkeys key key ...
zIncrBy(String key, num increment, String member) → Future<double>: Available on SortedSetCommands, provided by the ZIncrByCommand extension
ZINCRBY key increment member
zInter(List<String> keys, {List<num>? weights, String? aggregate, bool withScores = false}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZInterCommand extension
ZINTER numkeys key key ... [WEIGHTS weight weight ...] AGGREGATE <SUM | MIN | MAX> [WITHSCORES]
zInterCard(List<String> keys, {int? limit}) → Future<int>: Available on SortedSetCommands, provided by the ZInterCardCommand extension
ZINTERCARD numkeys key key ... LIMIT limit
zInterStore(String destination, List<String> keys, {List<num>? weights, String? aggregate}) → Future<int>: Available on SortedSetCommands, provided by the ZInterStoreCommand extension
ZINTERSTORE destination numkeys key key ... [WEIGHTS weight weight ...] AGGREGATE <SUM | MIN | MAX>
zLexCount(String key, String min, String max) → Future<int>: Available on SortedSetCommands, provided by the ZLexCountCommand extension
ZLEXCOUNT key min max
zMPop(List<String> keys, String modifier, {int? count}) → Future: Available on SortedSetCommands, provided by the ZMPopCommand extension
ZMPOP numkeys key key ... <MIN | MAX> COUNT count
zMScore(String key, List<String> members) → Future<List<double?>>: Available on SortedSetCommands, provided by the ZMScoreCommand extension
ZMSCORE key member member ...
zPopMax(String key, [int? count]) → Future<List<String>>: Available on SortedSetCommands, provided by the ZPopMaxCommand extension
ZPOPMAX key count
zPopMin(String key, [int? count]) → Future<List<String>>: Available on SortedSetCommands, provided by the ZPopMinCommand extension
ZPOPMIN key count
zRandMember(String key, {int? count, bool withScores = false}) → Future: Available on SortedSetCommands, provided by the ZRandMemberCommand extension
ZRANDMEMBER key [count WITHSCORES]
zRange(String key, Object start, Object stop, {bool byScore = false, bool byLex = false, bool rev = false, int? offset, int? count, bool withScores = false}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZRangeCommand extension
ZRANGE key start stop BYSCORE | BYLEX REV LIMIT offset count [WITHSCORES]
zrange(String key, int start, int stop) → Future<List<String?>>: Returns the specified range of members in the sorted set stored at key, ordered from lowest to highest score.
override
zRangeByLex(String key, String min, String max, {int? offset, int? count}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZRangeByLexCommand extension
ZRANGEBYLEX key min max LIMIT offset count
zRangeByScore(String key, Object min, Object max, {bool withScores = false, int? offset, int? count}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZRangeByScoreCommand extension
ZRANGEBYSCORE key min max WITHSCORES LIMIT offset count
zRangeStore(String dst, String src, Object min, Object max, {bool byScore = false, bool byLex = false, bool rev = false, int? offset, int? count}) → Future<int>: Available on SortedSetCommands, provided by the ZRangeStoreCommand extension
ZRANGESTORE dst src min max BYSCORE | BYLEX REV LIMIT offset count
zRank(String key, String member, {bool withScore = false}) → Future: Available on SortedSetCommands, provided by the ZRankCommand extension
ZRANK key member [WITHSCORE]
zRem(String key, List<String> members) → Future<int>: Available on SortedSetCommands, provided by the ZRemCommand extension
ZREM key member member ...
zrem(String key, String member) → Future<int>: Removes member from the sorted set stored at key.
override
zRemRangeByLex(String key, String min, String max) → Future<int>: Available on SortedSetCommands, provided by the ZRemRangeByLexCommand extension
ZREMRANGEBYLEX key min max
zRemRangeByRank(String key, int start, int stop) → Future<int>: Available on SortedSetCommands, provided by the ZRemRangeByRankCommand extension
ZREMRANGEBYRANK key start stop
zRemRangeByScore(String key, Object min, Object max) → Future<int>: Available on SortedSetCommands, provided by the ZRemRangeByScoreCommand extension
ZREMRANGEBYSCORE key min max
zRevRange(String key, int start, int stop, {bool withScores = false}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZRevRangeCommand extension
ZREVRANGE key start stop [WITHSCORES]
zRevRangeByLex(String key, String max, String min, {int? offset, int? count}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZRevRangeByLexCommand extension
ZREVRANGEBYLEX key max min LIMIT offset count
zRevRangeByScore(String key, Object max, Object min, {bool withScores = false, int? offset, int? count}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZRevRangeByScoreCommand extension
ZREVRANGEBYSCORE key max min WITHSCORES LIMIT offset count
zRevRank(String key, String member, {bool withScore = false}) → Future: Available on SortedSetCommands, provided by the ZRevRankCommand extension
ZREVRANK key member [WITHSCORE]
zScan(String key, int cursor, {String? match, int? count}) → Future<List>: Available on SortedSetCommands, provided by the ZScanCommand extension
ZSCAN key cursor MATCH pattern COUNT count
zScore(String key, String member) → Future<double?>: Available on SortedSetCommands, provided by the ZScoreCommand extension
ZSCORE key member
zUnion(List<String> keys, {List<num>? weights, String? aggregate, bool withScores = false}) → Future<List<String>>: Available on SortedSetCommands, provided by the ZUnionCommand extension
ZUNION numkeys key key ... [WEIGHTS weight weight ...] AGGREGATE <SUM | MIN | MAX> [WITHSCORES]
zUnionStore(String destination, List<String> keys, {List<num>? weights, String? aggregate}) → Future<int>: Available on SortedSetCommands, provided by the ZUnionStoreCommand extension
ZUNIONSTORE destination numkeys key key ... [WEIGHTS weight weight ...] AGGREGATE <SUM | MIN | MAX>

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

setLogLevel(KeyscopeLogLevel level) → void: Sets the logging level for all KeyscopeClient instances.

KeyscopeClient class

Constructors

Properties

Methods

Operators

Static Methods

keyscope_client library