ValkeyCommandsBase class abstract

The abstract base class for all common Valkey data commands.

Both the standalone client (ValkeyClientBase) and the cluster client (ValkeyClusterClientBase) implement this interface.

Implementers

Constructors

ValkeyCommandsBase()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

decr(String key) → Future<int>
Decrements the number stored at key by one.
decrBy(String key, int amount) → Future<int>
Decrements the number stored at key by amount.
del(String key) → Future<int>
Deletes the specified key.
echo(String message) → Future<String>
Echoes the given message back from the server.
exists(String key) → Future<int>
Checks if key exists.
expire(String key, int seconds) → Future<int>
Sets a timeout on key in seconds.
get(String key) → Future<String?>
Gets the value of key.
hget(String key, String field) → Future<String?>
Gets the value of field in the hash stored at key.
hgetall(String key) → Future<Map<String, String>>
Gets all fields and values of the hash stored at key.
hset(String key, String field, String value) → Future<int>
Sets field in the hash stored at key to value.
incr(String key) → Future<int>
Increments the number stored at key by one.
incrBy(String key, int amount) → Future<int>
Increments the number stored at key by amount.
lpop(String key) → Future<String?>
Removes and returns the first element of the list stored at key.
lpush(String key, String value) → Future<int>
Prepends value to the list stored at key.
lrange(String key, int start, int stop) → Future<List<String?>>
Returns the specified elements of the list stored at key.
mget(List<String> keys) → Future<List<String?>>
Gets the values of all specified keys.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rpop(String key) → Future<String?>
Removes and returns the last element of the list stored at key.
rpush(String key, String value) → Future<int>
Appends value to the list stored at key.
sadd(String key, String member) → Future<int>
Adds member to the set stored at key.
set(String key, String value) → Future<String>
Sets key to value.
smembers(String key) → Future<List<String?>>
Returns all members of the set stored at key.
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.
srem(String key, String member) → Future<int>
Removes member from the set stored at key.
ssubscribe(List<String> channels) → Subscription
Subscribes the client to the specified channels using Sharded Pub/Sub.
sunsubscribe([List<String> channels = const []]) → Future<void>
Unsubscribes from the given channels using Sharded Pub/Sub.
toString() → String
A string representation of this object.
inherited
ttl(String key) → Future<int>
Gets the remaining time to live of a key in seconds.
zadd(String key, double score, String member) → Future<int>
Adds member with the specified score to the sorted set stored at key.
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.
zrem(String key, String member) → Future<int>
Removes member from the sorted set stored at key.

Operators

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