Skip to content

S
StackExchange.Redis
Commit 59ece8d6 authored by Nick Craver's avatar Nick Craver
Browse files
Options

Cleanup: IDatabase* alignment 

This will make maintenace and compares easy for adding sync/async operations. Next up: docs completion and syncing over.
parent c9ee9ab9
Hide whitespace changes
Inline Side-by-side
Showing with 260 additions and 248 deletions
StackExchange.Redis/StackExchange/Redis/Interfaces/IDatabase.cs
View file @ 59ece8d6
......@@ -18,111 +18,113 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Allows creation of a group of operations that will be sent to the server as a single unit,
/// but which may or may not be processed on the server contiguously.
/// </summary>
/// <param name="asyncState">The async object state to be passed into the created <see cref="IBatch"/>.</param>
[IgnoreNamePrefix]
IBatch CreateBatch(object asyncState = null);
/// <summary>
/// Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance by default, and is guaranteed to exist in the target instance.
/// </summary>
/// <remarks>http://redis.io/commands/MIGRATE</remarks>
void KeyMigrate(RedisKey key, EndPoint toServer, int toDatabase = 0, int timeoutMilliseconds = 0, MigrateOptions migrateOptions = MigrateOptions.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Allows creation of a group of operations that will be sent to the server as a single unit,
/// and processed on the server as a single unit.
/// </summary>
/// <param name="asyncState">The async object state to be passed into the created <see cref="ITransaction"/>.</param>
[IgnoreNamePrefix]
ITransaction CreateTransaction(object asyncState = null);
/// <summary>
/// Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance by default, and is guaranteed to exist in the target instance.
/// </summary>
/// <remarks>https://redis.io/commands/MIGRATE</remarks>
void KeyMigrate(RedisKey key, EndPoint toServer, int toDatabase = 0, int timeoutMilliseconds = 0, MigrateOptions migrateOptions = MigrateOptions.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the raw DEBUG OBJECT output for a key; this command is not fully documented and should be avoided unless you have good reason, and then avoided anyway.
/// </summary>
/// <remarks>http://redis.io/commands/debug-object</remarks>
/// <remarks>https://redis.io/commands/debug-object</remarks>
RedisValue DebugObject(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Add the specified member to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
/// </summary>
/// <returns>True if the specified member was not already present in the set, else False</returns>
/// <remarks>http://redis.io/commands/geoadd</remarks>
/// <remarks>https://redis.io/commands/geoadd</remarks>
bool GeoAdd(RedisKey key, double longitude, double latitude, RedisValue member, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Add the specified member to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
/// </summary>
/// <returns>True if the specified member was not already present in the set, else False</returns>
/// <remarks>http://redis.io/commands/geoadd</remarks>
/// <remarks>https://redis.io/commands/geoadd</remarks>
bool GeoAdd(RedisKey key, StackExchange.Redis.GeoEntry value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Add the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
/// </summary>
/// <returns>the number of elements that were added to the set, not including all the elements already present into the set.</returns>
/// <remarks>http://redis.io/commands/geoadd</remarks>
/// <remarks>https://redis.io/commands/geoadd</remarks>
long GeoAdd(RedisKey key, GeoEntry[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified member from the geo sorted set stored at key. Non existing members are ignored.
/// </summary>
/// <returns>True if the member existed in the sorted set and was removed; False otherwise.</returns>
/// <remarks>http://redis.io/commands/zrem</remarks>
/// <remarks>https://redis.io/commands/zrem</remarks>
bool GeoRemove(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return the distance between two members in the geospatial index represented by the sorted set.
/// </summary>
/// <returns>The command returns the distance as a double (represented as a string) in the specified unit, or NULL if one or both the elements are missing.</returns>
/// <remarks>http://redis.io/commands/geodist</remarks>
/// <remarks>https://redis.io/commands/geodist</remarks>
double? GeoDistance(RedisKey key, RedisValue member1, RedisValue member2, GeoUnit unit = GeoUnit.Meters, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).
/// </summary>
/// <returns>The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.</returns>
/// <remarks>http://redis.io/commands/geohash</remarks>
/// <remarks>https://redis.io/commands/geohash</remarks>
string[] GeoHash(RedisKey key, RedisValue[] members, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).
/// </summary>
/// <returns>The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.</returns>
/// <remarks>http://redis.io/commands/geohash</remarks>
/// <remarks>https://redis.io/commands/geohash</remarks>
string GeoHash(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.
/// </summary>
/// <returns>The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command.Non existing elements are reported as NULL elements of the array.</returns>
/// <remarks>http://redis.io/commands/geopos</remarks>
/// <remarks>https://redis.io/commands/geopos</remarks>
GeoPosition?[] GeoPosition(RedisKey key, RedisValue[] members, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.
/// </summary>
/// <returns>The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command.Non existing elements are reported as NULL elements of the array.</returns>
/// <remarks>http://redis.io/commands/geopos</remarks>
/// <remarks>https://redis.io/commands/geopos</remarks>
GeoPosition? GeoPosition(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).
/// </summary>
/// <returns>GeoRadiusResult[]</returns>
/// <remarks>http://redis.io/commands/georadius</remarks>
/// <remarks>https://redis.io/commands/georadius</remarks>
GeoRadiusResult[] GeoRadius(RedisKey key, RedisValue member, double radius, GeoUnit unit = GeoUnit.Meters, int count = -1, Order? order = null, GeoRadiusOptions options = GeoRadiusOptions.Default, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).
/// </summary>
/// <returns>GeoRadiusResult[]</returns>
/// <remarks>http://redis.io/commands/georadius</remarks>
/// <remarks>https://redis.io/commands/georadius</remarks>
GeoRadiusResult[] GeoRadius(RedisKey key, double longitude, double latitude, double radius, GeoUnit unit = GeoUnit.Meters, int count = -1, Order? order = null, GeoRadiusOptions options = GeoRadiusOptions.Default, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Decrements the number stored at field in the hash stored at key by decrement. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
/// </summary>
/// <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
/// <returns>the value at field after the decrement operation.</returns>
/// <remarks>http://redis.io/commands/hincrby</remarks>
/// <returns>The value at field after the decrement operation.</returns>
/// <remarks>https://redis.io/commands/hincrby</remarks>
long HashDecrement(RedisKey key, RedisValue hashField, long value = 1, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -130,20 +132,20 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// </summary>
/// <remarks>The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.</remarks>
/// <returns>the value at field after the decrement operation.</returns>
/// <remarks>http://redis.io/commands/hincrbyfloat</remarks>
/// <remarks>https://redis.io/commands/hincrbyfloat</remarks>
double HashDecrement(RedisKey key, RedisValue hashField, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified fields from the hash stored at key. Non-existing fields are ignored. Non-existing keys are treated as empty hashes and this command returns 0.
/// </summary>
/// <remarks>http://redis.io/commands/hdel</remarks>
/// <remarks>https://redis.io/commands/hdel</remarks>
/// <returns>The number of fields that were removed.</returns>
bool HashDelete(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified fields from the hash stored at key. Non-existing fields are ignored. Non-existing keys are treated as empty hashes and this command returns 0.
/// </summary>
/// <remarks>http://redis.io/commands/hdel</remarks>
/// <remarks>https://redis.io/commands/hdel</remarks>
/// <returns>The number of fields that were removed.</returns>
long HashDelete(RedisKey key, RedisValue[] hashFields, CommandFlags flags = CommandFlags.None);
......@@ -151,14 +153,14 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Returns if field is an existing field in the hash stored at key.
/// </summary>
/// <returns>1 if the hash contains field. 0 if the hash does not contain field, or key does not exist.</returns>
/// <remarks>http://redis.io/commands/hexists</remarks>
/// <remarks>https://redis.io/commands/hexists</remarks>
bool HashExists(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the value associated with field in the hash stored at key.
/// </summary>
/// <returns>the value associated with field, or nil when field is not present in the hash or key does not exist.</returns>
/// <remarks>http://redis.io/commands/hget</remarks>
/// <remarks>https://redis.io/commands/hget</remarks>
RedisValue HashGet(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -166,14 +168,14 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// For every field that does not exist in the hash, a nil value is returned.Because a non-existing keys are treated as empty hashes, running HMGET against a non-existing key will return a list of nil values.
/// </summary>
/// <returns>list of values associated with the given fields, in the same order as they are requested.</returns>
/// <remarks>http://redis.io/commands/hmget</remarks>
/// <remarks>https://redis.io/commands/hmget</remarks>
RedisValue[] HashGet(RedisKey key, RedisValue[] hashFields, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns all fields and values of the hash stored at key.
/// </summary>
/// <returns>list of fields and their values stored in the hash, or an empty list when key does not exist.</returns>
/// <remarks>http://redis.io/commands/hgetall</remarks>
/// <remarks>https://redis.io/commands/hgetall</remarks>
HashEntry[] HashGetAll(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -181,7 +183,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// </summary>
/// <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
/// <returns>the value at field after the increment operation.</returns>
/// <remarks>http://redis.io/commands/hincrby</remarks>
/// <remarks>https://redis.io/commands/hincrby</remarks>
long HashIncrement(RedisKey key, RedisValue hashField, long value = 1, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -189,96 +191,96 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// </summary>
/// <remarks>The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.</remarks>
/// <returns>the value at field after the increment operation.</returns>
/// <remarks>http://redis.io/commands/hincrbyfloat</remarks>
/// <remarks>https://redis.io/commands/hincrbyfloat</remarks>
double HashIncrement(RedisKey key, RedisValue hashField, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns all field names in the hash stored at key.
/// </summary>
/// <returns>list of fields in the hash, or an empty list when key does not exist.</returns>
/// <remarks>http://redis.io/commands/hkeys</remarks>
/// <remarks>https://redis.io/commands/hkeys</remarks>
RedisValue[] HashKeys(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the number of fields contained in the hash stored at key.
/// </summary>
/// <returns>number of fields in the hash, or 0 when key does not exist.</returns>
/// <remarks>http://redis.io/commands/hlen</remarks>
/// <remarks>https://redis.io/commands/hlen</remarks>
long HashLength(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// The HSCAN command is used to incrementally iterate over a hash
/// </summary>
/// <returns>yields all elements of the hash.</returns>
/// <remarks>http://redis.io/commands/hscan</remarks>
/// <remarks>https://redis.io/commands/hscan</remarks>
IEnumerable<HashEntry> HashScan(RedisKey key, RedisValue pattern, int pageSize, CommandFlags flags);
/// <summary>
/// The HSCAN command is used to incrementally iterate over a hash; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
/// </summary>
/// <returns>yields all elements of the hash.</returns>
/// <remarks>http://redis.io/commands/hscan</remarks>
/// <remarks>https://redis.io/commands/hscan</remarks>
IEnumerable<HashEntry> HashScan(RedisKey key, RedisValue pattern = default(RedisValue), int pageSize = RedisBase.CursorUtils.DefaultPageSize, long cursor = RedisBase.CursorUtils.Origin, int pageOffset = 0, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sets the specified fields to their respective values in the hash stored at key. This command overwrites any existing fields in the hash. If key does not exist, a new key holding a hash is created.
/// </summary>
/// <remarks>http://redis.io/commands/hmset</remarks>
/// <remarks>https://redis.io/commands/hmset</remarks>
void HashSet(RedisKey key, HashEntry[] hashFields, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.
/// </summary>
/// <returns>1 if field is a new field in the hash and value was set. 0 if field already exists in the hash and the value was updated.</returns>
/// <remarks>http://redis.io/commands/hset</remarks>
/// <remarks>http://redis.io/commands/hsetnx</remarks>
/// <remarks>https://redis.io/commands/hset</remarks>
/// <remarks>https://redis.io/commands/hsetnx</remarks>
bool HashSet(RedisKey key, RedisValue hashField, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns all values in the hash stored at key.
/// </summary>
/// <returns>list of values in the hash, or an empty list when key does not exist.</returns>
/// <remarks>http://redis.io/commands/hvals</remarks>
/// <remarks>https://redis.io/commands/hvals</remarks>
RedisValue[] HashValues(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Adds the element to the HyperLogLog data structure stored at the variable name specified as first argument.
/// </summary>
/// <returns>true if at least 1 HyperLogLog internal register was altered. false otherwise.</returns>
/// <remarks>http://redis.io/commands/pfadd</remarks>
/// <remarks>https://redis.io/commands/pfadd</remarks>
bool HyperLogLogAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Adds all the element arguments to the HyperLogLog data structure stored at the variable name specified as first argument.
/// </summary>
/// <returns>true if at least 1 HyperLogLog internal register was altered. false otherwise.</returns>
/// <remarks>http://redis.io/commands/pfadd</remarks>
/// <remarks>https://redis.io/commands/pfadd</remarks>
bool HyperLogLogAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the approximated cardinality computed by the HyperLogLog data structure stored at the specified variable, or 0 if the variable does not exist.
/// </summary>
/// <returns>The approximated number of unique elements observed via HyperLogLogAdd.</returns>
/// <remarks>http://redis.io/commands/pfcount</remarks>
/// <remarks>https://redis.io/commands/pfcount</remarks>
long HyperLogLogLength(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the approximated cardinality of the union of the HyperLogLogs passed, by internally merging the HyperLogLogs stored at the provided keys into a temporary hyperLogLog, or 0 if the variable does not exist.
/// </summary>
/// <returns>The approximated number of unique elements observed via HyperLogLogAdd.</returns>
/// <remarks>http://redis.io/commands/pfcount</remarks>
/// <remarks>https://redis.io/commands/pfcount</remarks>
long HyperLogLogLength(RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
/// </summary>
/// <remarks>http://redis.io/commands/pfmerge</remarks>
/// <remarks>https://redis.io/commands/pfmerge</remarks>
void HyperLogLogMerge(RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of the observed Sets of the source HyperLogLog structures.
/// </summary>
/// <remarks>http://redis.io/commands/pfmerge</remarks>
/// <remarks>https://redis.io/commands/pfmerge</remarks>
void HyperLogLogMerge(RedisKey destination, RedisKey[] sourceKeys, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -291,28 +293,28 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Removes the specified key. A key is ignored if it does not exist.
/// </summary>
/// <returns>True if the key was removed.</returns>
/// <remarks>http://redis.io/commands/del</remarks>
/// <remarks>https://redis.io/commands/del</remarks>
bool KeyDelete(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified keys. A key is ignored if it does not exist.
/// </summary>
/// <returns>The number of keys that were removed.</returns>
/// <remarks>http://redis.io/commands/del</remarks>
/// <remarks>https://redis.io/commands/del</remarks>
long KeyDelete(RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Serialize the value stored at key in a Redis-specific format and return it to the user. The returned value can be synthesized back into a Redis key using the RESTORE command.
/// </summary>
/// <returns>the serialized value.</returns>
/// <remarks>http://redis.io/commands/dump</remarks>
/// <remarks>https://redis.io/commands/dump</remarks>
byte[] KeyDump(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns if key exists.
/// </summary>
/// <returns>1 if the key exists. 0 if the key does not exist.</returns>
/// <remarks>http://redis.io/commands/exists</remarks>
/// <remarks>https://redis.io/commands/exists</remarks>
bool KeyExists(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -321,9 +323,9 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// <remarks>If key is updated before the timeout has expired, then the timeout is removed as if the PERSIST command was invoked on key.
/// For Redis versions &lt; 2.1.3, existing timeouts cannot be overwritten. So, if key already has an associated timeout, it will do nothing and return 0. Since Redis 2.1.3, you can update the timeout of a key. It is also possible to remove the timeout using the PERSIST command. See the page on key expiry for more information.</remarks>
/// <returns>1 if the timeout was set. 0 if key does not exist or the timeout could not be set.</returns>
/// <remarks>http://redis.io/commands/expire</remarks>
/// <remarks>http://redis.io/commands/pexpire</remarks>
/// <remarks>http://redis.io/commands/persist</remarks>
/// <remarks>https://redis.io/commands/expire</remarks>
/// <remarks>https://redis.io/commands/pexpire</remarks>
/// <remarks>https://redis.io/commands/persist</remarks>
bool KeyExpire(RedisKey key, TimeSpan? expiry, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -332,63 +334,63 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// <remarks>If key is updated before the timeout has expired, then the timeout is removed as if the PERSIST command was invoked on key.
/// For Redis versions &lt; 2.1.3, existing timeouts cannot be overwritten. So, if key already has an associated timeout, it will do nothing and return 0. Since Redis 2.1.3, you can update the timeout of a key. It is also possible to remove the timeout using the PERSIST command. See the page on key expiry for more information.</remarks>
/// <returns>1 if the timeout was set. 0 if key does not exist or the timeout could not be set.</returns>
/// <remarks>http://redis.io/commands/expireat</remarks>
/// <remarks>http://redis.io/commands/pexpireat</remarks>
/// <remarks>http://redis.io/commands/persist</remarks>
/// <remarks>https://redis.io/commands/expireat</remarks>
/// <remarks>https://redis.io/commands/pexpireat</remarks>
/// <remarks>https://redis.io/commands/persist</remarks>
bool KeyExpire(RedisKey key, DateTime? expiry, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Move key from the currently selected database (see SELECT) to the specified destination database. When key already exists in the destination database, or it does not exist in the source database, it does nothing. It is possible to use MOVE as a locking primitive because of this.
/// </summary>
/// <returns>1 if key was moved; 0 if key was not moved.</returns>
/// <remarks>http://redis.io/commands/move</remarks>
/// <remarks>https://redis.io/commands/move</remarks>
bool KeyMove(RedisKey key, int database, CommandFlags flags = CommandFlags.None);
/// <summary>Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).</summary>
/// <returns>1 if the timeout was removed. 0 if key does not exist or does not have an associated timeout.</returns>
/// <remarks>http://redis.io/commands/persist</remarks>
/// <remarks>https://redis.io/commands/persist</remarks>
bool KeyPersist(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return a random key from the currently selected database.
/// </summary>
/// <returns>the random key, or nil when the database is empty.</returns>
/// <remarks>http://redis.io/commands/randomkey</remarks>
/// <remarks>https://redis.io/commands/randomkey</remarks>
RedisKey KeyRandom(CommandFlags flags = CommandFlags.None);
/// <summary>
/// Renames key to newkey. It returns an error when the source and destination names are the same, or when key does not exist.
/// </summary>
/// <returns>http://redis.io/commands/rename</returns>
/// <remarks>http://redis.io/commands/renamenx</remarks>
/// <returns>https://redis.io/commands/rename</returns>
/// <remarks>https://redis.io/commands/renamenx</remarks>
bool KeyRename(RedisKey key, RedisKey newKey, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Create a key associated with a value that is obtained by deserializing the provided serialized value (obtained via DUMP).
/// If ttl is 0 the key is created without any expire, otherwise the specified expire time(in milliseconds) is set.
/// </summary>
/// <remarks>http://redis.io/commands/restore</remarks>
/// <remarks>https://redis.io/commands/restore</remarks>
void KeyRestore(RedisKey key, byte[] value, TimeSpan? expiry = null, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the remaining time to live of a key that has a timeout. This introspection capability allows a Redis client to check how many seconds a given key will continue to be part of the dataset.
/// </summary>
/// <returns>TTL, or nil when key does not exist or does not have a timeout.</returns>
/// <remarks>http://redis.io/commands/ttl</remarks>
/// <remarks>https://redis.io/commands/ttl</remarks>
TimeSpan? KeyTimeToLive(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the string representation of the type of the value stored at key. The different types that can be returned are: string, list, set, zset and hash.
/// </summary>
/// <returns>type of key, or none when key does not exist.</returns>
/// <remarks>http://redis.io/commands/type</remarks>
/// <remarks>https://redis.io/commands/type</remarks>
RedisType KeyType(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the element at index index in the list stored at key. The index is zero-based, so 0 means the first element, 1 the second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element, -2 means the penultimate and so forth.
/// </summary>
/// <returns>the requested element, or nil when index is out of range.</returns>
/// <remarks>http://redis.io/commands/lindex</remarks>
/// <remarks>https://redis.io/commands/lindex</remarks>
RedisValue ListGetByIndex(RedisKey key, long index, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -396,7 +398,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// When key does not exist, it is considered an empty list and no operation is performed.
/// </summary>
/// <returns>the length of the list after the insert operation, or -1 when the value pivot was not found.</returns>
/// <remarks>http://redis.io/commands/linsert</remarks>
/// <remarks>https://redis.io/commands/linsert</remarks>
long ListInsertAfter(RedisKey key, RedisValue pivot, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -404,22 +406,22 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// When key does not exist, it is considered an empty list and no operation is performed.
/// </summary>
/// <returns>the length of the list after the insert operation, or -1 when the value pivot was not found.</returns>
/// <remarks>http://redis.io/commands/linsert</remarks>
/// <remarks>https://redis.io/commands/linsert</remarks>
long ListInsertBefore(RedisKey key, RedisValue pivot, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes and returns the first element of the list stored at key.
/// </summary>
/// <returns>the value of the first element, or nil when key does not exist.</returns>
/// <remarks>http://redis.io/commands/lpop</remarks>
/// <remarks>https://redis.io/commands/lpop</remarks>
RedisValue ListLeftPop(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Insert the specified value at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations.
/// </summary>
/// <returns>the length of the list after the push operations.</returns>
/// <remarks>http://redis.io/commands/lpush</remarks>
/// <remarks>http://redis.io/commands/lpushx</remarks>
/// <remarks>https://redis.io/commands/lpush</remarks>
/// <remarks>https://redis.io/commands/lpushx</remarks>
long ListLeftPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -427,14 +429,14 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
/// </summary>
/// <returns>the length of the list after the push operations.</returns>
/// <remarks>http://redis.io/commands/lpush</remarks>
/// <remarks>https://redis.io/commands/lpush</remarks>
long ListLeftPush(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the length of the list stored at key. If key does not exist, it is interpreted as an empty list and 0 is returned.
/// </summary>
/// <returns>the length of the list at key.</returns>
/// <remarks>http://redis.io/commands/llen</remarks>
/// <remarks>https://redis.io/commands/llen</remarks>
long ListLength(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -443,7 +445,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Note that if you have a list of numbers from 0 to 100, LRANGE list 0 10 will return 11 elements, that is, the rightmost item is included.
/// </summary>
/// <returns>list of elements in the specified range.</returns>
/// <remarks>http://redis.io/commands/lrange</remarks>
/// <remarks>https://redis.io/commands/lrange</remarks>
RedisValue[] ListRange(RedisKey key, long start = 0, long stop = -1, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -453,28 +455,28 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// count = 0: Remove all elements equal to value.
/// </summary>
/// <returns>the number of removed elements.</returns>
/// <remarks>http://redis.io/commands/lrem</remarks>
/// <remarks>https://redis.io/commands/lrem</remarks>
long ListRemove(RedisKey key, RedisValue value, long count = 0, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes and returns the last element of the list stored at key.
/// </summary>
/// <remarks>http://redis.io/commands/rpop</remarks>
/// <remarks>https://redis.io/commands/rpop</remarks>
RedisValue ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
/// </summary>
/// <returns>the element being popped and pushed.</returns>
/// <remarks>http://redis.io/commands/rpoplpush</remarks>
/// <remarks>https://redis.io/commands/rpoplpush</remarks>
RedisValue ListRightPopLeftPush(RedisKey source, RedisKey destination, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Insert the specified value at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.
/// </summary>
/// <returns>the length of the list after the push operation.</returns>
/// <remarks>http://redis.io/commands/rpush</remarks>
/// <remarks>http://redis.io/commands/rpushx</remarks>
/// <remarks>https://redis.io/commands/rpush</remarks>
/// <remarks>https://redis.io/commands/rpushx</remarks>
long ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -482,13 +484,13 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
/// </summary>
/// <returns>the length of the list after the push operation.</returns>
/// <remarks>http://redis.io/commands/rpush</remarks>
/// <remarks>https://redis.io/commands/rpush</remarks>
long ListRightPush(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sets the list element at index to value. For more information on the index argument, see ListGetByIndex. An error is returned for out of range indexes.
/// </summary>
/// <remarks>http://redis.io/commands/lset</remarks>
/// <remarks>https://redis.io/commands/lset</remarks>
void ListSetByIndex(RedisKey key, long index, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -496,7 +498,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// For example: LTRIM foobar 0 2 will modify the list stored at foobar so that only the first three elements of the list will remain.
/// start and end can also be negative numbers indicating offsets from the end of the list, where -1 is the last element of the list, -2 the penultimate element and so on.
/// </summary>
/// <remarks>http://redis.io/commands/ltrim</remarks>
/// <remarks>https://redis.io/commands/ltrim</remarks>
void ListTrim(RedisKey key, long start, long stop, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -523,7 +525,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Posts a message to the given channel.
/// </summary>
/// <returns>the number of clients that received the message.</returns>
/// <remarks>http://redis.io/commands/publish</remarks>
/// <remarks>https://redis.io/commands/publish</remarks>
long Publish(RedisChannel channel, RedisValue message, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -545,14 +547,14 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// <summary>
/// Execute a Lua script against the server
/// </summary>
/// <remarks>http://redis.io/commands/eval, http://redis.io/commands/evalsha</remarks>
/// <remarks>https://redis.io/commands/eval, https://redis.io/commands/evalsha</remarks>
/// <returns>A dynamic representation of the script's result</returns>
RedisResult ScriptEvaluate(string script, RedisKey[] keys = null, RedisValue[] values = null, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Execute a Lua script against the server using just the SHA1 hash
/// </summary>
/// <remarks>http://redis.io/commands/evalsha</remarks>
/// <remarks>https://redis.io/commands/evalsha</remarks>
/// <returns>A dynamic representation of the script's result</returns>
RedisResult ScriptEvaluate(byte[] hash, RedisKey[] keys = null, RedisValue[] values = null, CommandFlags flags = CommandFlags.None);
......@@ -573,71 +575,71 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Add the specified member to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
/// </summary>
/// <returns>True if the specified member was not already present in the set, else False</returns>
/// <remarks>http://redis.io/commands/sadd</remarks>
/// <remarks>https://redis.io/commands/sadd</remarks>
bool SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Add the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
/// </summary>
/// <returns>the number of elements that were added to the set, not including all the elements already present into the set.</returns>
/// <remarks>http://redis.io/commands/sadd</remarks>
/// <remarks>https://redis.io/commands/sadd</remarks>
long SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the members of the set resulting from the specified operation against the given sets.
/// </summary>
/// <returns>list with members of the resulting set.</returns>
/// <remarks>http://redis.io/commands/sunion</remarks>
/// <remarks>http://redis.io/commands/sinter</remarks>
/// <remarks>http://redis.io/commands/sdiff</remarks>
/// <remarks>https://redis.io/commands/sunion</remarks>
/// <remarks>https://redis.io/commands/sinter</remarks>
/// <remarks>https://redis.io/commands/sdiff</remarks>
RedisValue[] SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the members of the set resulting from the specified operation against the given sets.
/// </summary>
/// <returns>list with members of the resulting set.</returns>
/// <remarks>http://redis.io/commands/sunion</remarks>
/// <remarks>http://redis.io/commands/sinter</remarks>
/// <remarks>http://redis.io/commands/sdiff</remarks>
/// <remarks>https://redis.io/commands/sunion</remarks>
/// <remarks>https://redis.io/commands/sinter</remarks>
/// <remarks>https://redis.io/commands/sdiff</remarks>
RedisValue[] SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
/// </summary>
/// <returns>the number of elements in the resulting set.</returns>
/// <remarks>http://redis.io/commands/sunionstore</remarks>
/// <remarks>http://redis.io/commands/sinterstore</remarks>
/// <remarks>http://redis.io/commands/sdiffstore</remarks>
/// <remarks>https://redis.io/commands/sunionstore</remarks>
/// <remarks>https://redis.io/commands/sinterstore</remarks>
/// <remarks>https://redis.io/commands/sdiffstore</remarks>
long SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None);
/// <summary>
/// This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
/// </summary>
/// <returns>the number of elements in the resulting set.</returns>
/// <remarks>http://redis.io/commands/sunionstore</remarks>
/// <remarks>http://redis.io/commands/sinterstore</remarks>
/// <remarks>http://redis.io/commands/sdiffstore</remarks>
/// <remarks>https://redis.io/commands/sunionstore</remarks>
/// <remarks>https://redis.io/commands/sinterstore</remarks>
/// <remarks>https://redis.io/commands/sdiffstore</remarks>
long SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns if member is a member of the set stored at key.
/// </summary>
/// <returns>1 if the element is a member of the set. 0 if the element is not a member of the set, or if key does not exist.</returns>
/// <remarks>http://redis.io/commands/sismember</remarks>
/// <remarks>https://redis.io/commands/sismember</remarks>
bool SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the set cardinality (number of elements) of the set stored at key.
/// </summary>
/// <returns>the cardinality (number of elements) of the set, or 0 if key does not exist.</returns>
/// <remarks>http://redis.io/commands/scard</remarks>
/// <remarks>https://redis.io/commands/scard</remarks>
long SetLength(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns all the members of the set value stored at key.
/// </summary>
/// <returns>all elements of the set.</returns>
/// <remarks>http://redis.io/commands/smembers</remarks>
/// <remarks>https://redis.io/commands/smembers</remarks>
RedisValue[] SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -645,21 +647,21 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// When the specified element already exists in the destination set, it is only removed from the source set.
/// </summary>
/// <returns>1 if the element is moved. 0 if the element is not a member of source and no operation was performed.</returns>
/// <remarks>http://redis.io/commands/smove</remarks>
/// <remarks>https://redis.io/commands/smove</remarks>
bool SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes and returns a random element from the set value stored at key.
/// </summary>
/// <returns>the removed element, or nil when key does not exist.</returns>
/// <remarks>http://redis.io/commands/spop</remarks>
/// <remarks>https://redis.io/commands/spop</remarks>
RedisValue SetPop(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Return a random element from the set value stored at key.
/// </summary>
/// <returns>the randomly selected element, or nil when key does not exist</returns>
/// <remarks>http://redis.io/commands/srandmember</remarks>
/// <remarks>https://redis.io/commands/srandmember</remarks>
RedisValue SetRandomMember(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -667,45 +669,45 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// In this case the numer of returned elements is the absolute value of the specified count.
/// </summary>
/// <returns>an array of elements, or an empty array when key does not exist</returns>
/// <remarks>http://redis.io/commands/srandmember</remarks>
/// <remarks>https://redis.io/commands/srandmember</remarks>
RedisValue[] SetRandomMembers(RedisKey key, long count, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Remove the specified member from the set stored at key. Specified members that are not a member of this set are ignored.
/// </summary>
/// <returns>True if the specified member was already present in the set, else False</returns>
/// <remarks>http://redis.io/commands/srem</remarks>
/// <remarks>https://redis.io/commands/srem</remarks>
bool SetRemove(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Remove the specified members from the set stored at key. Specified members that are not a member of this set are ignored.
/// </summary>
/// <returns>the number of members that were removed from the set, not including non existing members.</returns>
/// <remarks>http://redis.io/commands/srem</remarks>
/// <remarks>https://redis.io/commands/srem</remarks>
long SetRemove(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// The SSCAN command is used to incrementally iterate over set
/// </summary>
/// <returns>yields all elements of the set.</returns>
/// <remarks>http://redis.io/commands/sscan</remarks>
/// <remarks>https://redis.io/commands/sscan</remarks>
IEnumerable<RedisValue> SetScan(RedisKey key, RedisValue pattern, int pageSize, CommandFlags flags);
/// <summary>
/// The SSCAN command is used to incrementally iterate over set; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
/// </summary>
/// <returns>yields all elements of the set.</returns>
/// <remarks>http://redis.io/commands/sscan</remarks>
/// <remarks>https://redis.io/commands/sscan</remarks>
IEnumerable<RedisValue> SetScan(RedisKey key, RedisValue pattern = default(RedisValue), int pageSize = RedisBase.CursorUtils.DefaultPageSize, long cursor = RedisBase.CursorUtils.Origin, int pageOffset = 0, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
/// used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
/// be performed instead by specifying the <c>get</c> parameter (note that <c>#</c> specifies the element itself, when used in <c>get</c>).
/// Referring to the <a href="http://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
/// Referring to the <a href="https://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
/// can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
/// </summary>
/// <remarks>http://redis.io/commands/sort</remarks>
/// <remarks>https://redis.io/commands/sort</remarks>
/// <returns>Returns the sorted elements, or the external values if <c>get</c> is specified</returns>
[IgnoreNamePrefix]
RedisValue[] Sort(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default(RedisValue), RedisValue[] get = null, CommandFlags flags = CommandFlags.None);
......@@ -714,10 +716,10 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
/// used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
/// be performed instead by specifying the <c>get</c> parameter (note that <c>#</c> specifies the element itself, when used in <c>get</c>).
/// Referring to the <a href="http://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
/// Referring to the <a href="https://redis.io/commands/sort">redis SORT documentation </a> for examples is recommended. When used in hashes, <c>by</c> and <c>get</c>
/// can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
/// </summary>
/// <remarks>http://redis.io/commands/sort</remarks>
/// <remarks>https://redis.io/commands/sort</remarks>
/// <returns>Returns the number of elements stored in the new list</returns>
[IgnoreNamePrefix]
long SortAndStore(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default(RedisValue), RedisValue[] get = null, CommandFlags flags = CommandFlags.None);
......@@ -726,36 +728,36 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Adds the specified member with the specified score to the sorted set stored at key. If the specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
/// </summary>
/// <returns>True if the value was added, False if it already existed (the score is still updated)</returns>
/// <remarks>http://redis.io/commands/zadd</remarks>
/// <remarks>https://redis.io/commands/zadd</remarks>
bool SortedSetAdd(RedisKey key, RedisValue member, double score, CommandFlags flags);
/// <summary>
/// Adds the specified member with the specified score to the sorted set stored at key. If the specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
/// </summary>
/// <returns>True if the value was added, False if it already existed (the score is still updated)</returns>
/// <remarks>http://redis.io/commands/zadd</remarks>
/// <remarks>https://redis.io/commands/zadd</remarks>
bool SortedSetAdd(RedisKey key, RedisValue member, double score, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Adds all the specified members with the specified scores to the sorted set stored at key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
/// </summary>
/// <returns>The number of elements added to the sorted sets, not including elements already existing for which the score was updated.</returns>
/// <remarks>http://redis.io/commands/zadd</remarks>
/// <remarks>https://redis.io/commands/zadd</remarks>
long SortedSetAdd(RedisKey key, SortedSetEntry[] values, CommandFlags flags);
/// <summary>
/// Adds all the specified members with the specified scores to the sorted set stored at key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
/// </summary>
/// <returns>The number of elements added to the sorted sets, not including elements already existing for which the score was updated.</returns>
/// <remarks>http://redis.io/commands/zadd</remarks>
/// <remarks>https://redis.io/commands/zadd</remarks>
long SortedSetAdd(RedisKey key, SortedSetEntry[] values, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Computes a set operation over two sorted sets, and stores the result in destination, optionally performing
/// a specific aggregation (defaults to sum)
/// </summary>
/// <remarks>http://redis.io/commands/zunionstore</remarks>
/// <remarks>http://redis.io/commands/zinterstore</remarks>
/// <remarks>https://redis.io/commands/zunionstore</remarks>
/// <remarks>https://redis.io/commands/zinterstore</remarks>
/// <returns>the number of elements in the resulting sorted set at destination</returns>
long SortedSetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, Aggregate aggregate = Aggregate.Sum, CommandFlags flags = CommandFlags.None);
......@@ -763,8 +765,8 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Computes a set operation over multiple sorted sets (optionally using per-set weights), and stores the result in destination, optionally performing
/// a specific aggregation (defaults to sum)
/// </summary>
/// <remarks>http://redis.io/commands/zunionstore</remarks>
/// <remarks>http://redis.io/commands/zinterstore</remarks>
/// <remarks>https://redis.io/commands/zunionstore</remarks>
/// <remarks>https://redis.io/commands/zinterstore</remarks>
/// <returns>the number of elements in the resulting sorted set at destination</returns>
long SortedSetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, double[] weights = null, Aggregate aggregate = Aggregate.Sum, CommandFlags flags = CommandFlags.None);
......@@ -772,21 +774,21 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Decrements the score of member in the sorted set stored at key by decrement. If member does not exist in the sorted set, it is added with -decrement as its score (as if its previous score was 0.0).
/// </summary>
/// <returns>the new score of member</returns>
/// <remarks>http://redis.io/commands/zincrby</remarks>
/// <remarks>https://redis.io/commands/zincrby</remarks>
double SortedSetDecrement(RedisKey key, RedisValue member, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Increments the score of member in the sorted set stored at key by increment. If member does not exist in the sorted set, it is added with increment as its score (as if its previous score was 0.0).
/// </summary>
/// <returns>the new score of member</returns>
/// <remarks>http://redis.io/commands/zincrby</remarks>
/// <remarks>https://redis.io/commands/zincrby</remarks>
double SortedSetIncrement(RedisKey key, RedisValue member, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the sorted set cardinality (number of elements) of the sorted set stored at key.
/// </summary>
/// <returns>the cardinality (number of elements) of the sorted set, or 0 if key does not exist.</returns>
/// <remarks>http://redis.io/commands/zcard</remarks>
/// <remarks>https://redis.io/commands/zcard</remarks>
long SortedSetLength(RedisKey key, double min = double.NegativeInfinity, double max = double.PositiveInfinity, Exclude exclude = Exclude.None, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -801,8 +803,8 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Both start and stop are zero-based indexes, where 0 is the first element, 1 is the next element and so on. They can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set, -2 the penultimate element and so on.
/// </summary>
/// <returns>list of elements in the specified range</returns>
/// <remarks>http://redis.io/commands/zrange</remarks>
/// <remarks>http://redis.io/commands/zrevrange</remarks>
/// <remarks>https://redis.io/commands/zrange</remarks>
/// <remarks>https://redis.io/commands/zrevrange</remarks>
RedisValue[] SortedSetRangeByRank(RedisKey key, long start = 0, long stop = -1, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -810,8 +812,8 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Both start and stop are zero-based indexes, where 0 is the first element, 1 is the next element and so on. They can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set, -2 the penultimate element and so on.
/// </summary>
/// <returns>list of elements in the specified range</returns>
/// <remarks>http://redis.io/commands/zrange</remarks>
/// <remarks>http://redis.io/commands/zrevrange</remarks>
/// <remarks>https://redis.io/commands/zrange</remarks>
/// <remarks>https://redis.io/commands/zrevrange</remarks>
SortedSetEntry[] SortedSetRangeByRankWithScores(RedisKey key, long start = 0, long stop = -1, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -819,8 +821,8 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Start and stop are used to specify the min and max range for score values. Similar to other range methods the values are inclusive.
/// </summary>
/// <returns>list of elements in the specified score range</returns>
/// <remarks>http://redis.io/commands/zrangebyscore</remarks>
/// <remarks>http://redis.io/commands/zrevrangebyscore</remarks>
/// <remarks>https://redis.io/commands/zrangebyscore</remarks>
/// <remarks>https://redis.io/commands/zrevrangebyscore</remarks>
RedisValue[] SortedSetRangeByScore(RedisKey key,
double start = double.NegativeInfinity, double stop = double.PositiveInfinity,
Exclude exclude = Exclude.None, Order order = Order.Ascending, long skip = 0, long take = -1,
......@@ -831,8 +833,8 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Start and stop are used to specify the min and max range for score values. Similar to other range methods the values are inclusive.
/// </summary>
/// <returns>list of elements in the specified score range</returns>
/// <remarks>http://redis.io/commands/zrangebyscore</remarks>
/// <remarks>http://redis.io/commands/zrevrangebyscore</remarks>
/// <remarks>https://redis.io/commands/zrangebyscore</remarks>
/// <remarks>https://redis.io/commands/zrevrangebyscore</remarks>
SortedSetEntry[] SortedSetRangeByScoreWithScores(RedisKey key,
double start = double.NegativeInfinity, double stop = double.PositiveInfinity,
Exclude exclude = Exclude.None, Order order = Order.Ascending, long skip = 0, long take = -1,
......@@ -841,7 +843,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// <summary>
/// When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.
/// </summary>
/// <remarks>http://redis.io/commands/zrangebylex</remarks>
/// <remarks>https://redis.io/commands/zrangebylex</remarks>
/// <returns>list of elements in the specified score range.</returns>
RedisValue[] SortedSetRangeByValue(RedisKey key, RedisValue min = default(RedisValue), RedisValue max = default(RedisValue),
Exclude exclude = Exclude.None, long skip = 0, long take = -1,
......@@ -851,62 +853,64 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Returns the rank of member in the sorted set stored at key, by default with the scores ordered from low to high. The rank (or index) is 0-based, which means that the member with the lowest score has rank 0.
/// </summary>
/// <returns>If member exists in the sorted set, the rank of member; If member does not exist in the sorted set or key does not exist, null</returns>
/// <remarks>http://redis.io/commands/zrank</remarks>
/// <remarks>http://redis.io/commands/zrevrank</remarks>
/// <remarks>https://redis.io/commands/zrank</remarks>
/// <remarks>https://redis.io/commands/zrevrank</remarks>
long? SortedSetRank(RedisKey key, RedisValue member, Order order = Order.Ascending, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified member from the sorted set stored at key. Non existing members are ignored.
/// </summary>
/// <returns>True if the member existed in the sorted set and was removed; False otherwise.</returns>
/// <remarks>http://redis.io/commands/zrem</remarks>
/// <remarks>https://redis.io/commands/zrem</remarks>
bool SortedSetRemove(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified members from the sorted set stored at key. Non existing members are ignored.
/// </summary>
/// <returns>The number of members removed from the sorted set, not including non existing members.</returns>
/// <remarks>http://redis.io/commands/zrem</remarks>
/// <remarks>https://redis.io/commands/zrem</remarks>
long SortedSetRemove(RedisKey key, RedisValue[] members, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second highest score and so forth.
/// </summary>
/// <returns> the number of elements removed.</returns>
/// <remarks>http://redis.io/commands/zremrangebyrank</remarks>
/// <remarks>https://redis.io/commands/zremrangebyrank</remarks>
long SortedSetRemoveRangeByRank(RedisKey key, long start, long stop, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes all elements in the sorted set stored at key with a score between min and max (inclusive by default).
/// </summary>
/// <returns> the number of elements removed.</returns>
/// <remarks>http://redis.io/commands/zremrangebyscore</remarks>
/// <remarks>https://redis.io/commands/zremrangebyscore</remarks>
long SortedSetRemoveRangeByScore(RedisKey key, double start, double stop, Exclude exclude = Exclude.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command removes all elements in the sorted set stored at key between the lexicographical range specified by min and max.
/// </summary>
/// <remarks>http://redis.io/commands/zremrangebylex</remarks>
/// <remarks>https://redis.io/commands/zremrangebylex</remarks>
/// <returns>the number of elements removed.</returns>
long SortedSetRemoveRangeByValue(RedisKey key, RedisValue min, RedisValue max, Exclude exclude = Exclude.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// The ZSCAN command is used to incrementally iterate over a sorted set
/// </summary>
/// <returns>yields all elements of the sorted set.</returns>
/// <remarks>http://redis.io/commands/zscan</remarks>
/// <remarks>https://redis.io/commands/zscan</remarks>
IEnumerable<SortedSetEntry> SortedSetScan(RedisKey key, RedisValue pattern, int pageSize, CommandFlags flags);
/// <summary>
/// The ZSCAN command is used to incrementally iterate over a sorted set; note: to resume an iteration via <i>cursor</i>, cast the original enumerable or enumerator to <i>IScanningCursor</i>.
/// </summary>
/// <returns>yields all elements of the sorted set.</returns>
/// <remarks>http://redis.io/commands/zscan</remarks>
/// <remarks>https://redis.io/commands/zscan</remarks>
IEnumerable<SortedSetEntry> SortedSetScan(RedisKey key, RedisValue pattern = default(RedisValue), int pageSize = RedisBase.CursorUtils.DefaultPageSize, long cursor = RedisBase.CursorUtils.Origin, int pageOffset = 0, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the score of member in the sorted set at key; If member does not exist in the sorted set, or key does not exist, nil is returned.
/// </summary>
/// <returns>the score of member</returns>
/// <remarks>http://redis.io/commands/zscore</remarks>
/// <remarks>https://redis.io/commands/zscore</remarks>
double? SortedSetScore(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -914,7 +918,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// so APPEND will be similar to SET in this special case.
/// </summary>
/// <returns>the length of the string after the append operation.</returns>
/// <remarks>http://redis.io/commands/append</remarks>
/// <remarks>https://redis.io/commands/append</remarks>
long StringAppend(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -923,7 +927,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Like for the GETRANGE command start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate, and so forth.
/// </summary>
/// <returns>The number of bits set to 1</returns>
/// <remarks>http://redis.io/commands/bitcount</remarks>
/// <remarks>https://redis.io/commands/bitcount</remarks>
long StringBitCount(RedisKey key, long start = 0, long end = -1, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -933,7 +937,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// The result of the operation is always stored at destkey.
/// </summary>
/// <returns>The size of the string stored in the destination key, that is equal to the size of the longest input string.</returns>
/// <remarks>http://redis.io/commands/bitop</remarks>
/// <remarks>https://redis.io/commands/bitop</remarks>
long StringBitOperation(Bitwise operation, RedisKey destination, RedisKey first, RedisKey second = default(RedisKey), CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -942,7 +946,7 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// The result of the operation is always stored at destkey.
/// </summary>
/// <returns>The size of the string stored in the destination key, that is equal to the size of the longest input string.</returns>
/// <remarks>http://redis.io/commands/bitop</remarks>
/// <remarks>https://redis.io/commands/bitop</remarks>
long StringBitOperation(Bitwise operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -952,35 +956,35 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// </summary>
/// <returns>The command returns the position of the first bit set to 1 or 0 according to the request.
/// If we look for set bits(the bit argument is 1) and the string is empty or composed of just zero bytes, -1 is returned.</returns>
/// <remarks>http://redis.io/commands/bitpos</remarks>
/// <remarks>https://redis.io/commands/bitpos</remarks>
long StringBitPosition(RedisKey key, bool bit, long start = 0, long end = -1, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Decrements the number stored at key by decrement. If the key does not exist, it is set to 0 before performing the operation.
/// An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
/// </summary>
/// <returns> the value of key after the decrement</returns>
/// <remarks>http://redis.io/commands/decrby</remarks>
/// <remarks>http://redis.io/commands/decr</remarks>
/// <returns>The value of key after the decrement.</returns>
/// <remarks>https://redis.io/commands/decrby</remarks>
/// <remarks>https://redis.io/commands/decr</remarks>
long StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Decrements the string representing a floating point number stored at key by the specified decrement. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
/// </summary>
/// <returns>the value of key after the decrement</returns>
/// <remarks>http://redis.io/commands/incrbyfloat</remarks>
/// <returns>The value of key after the decrement.</returns>
/// <remarks>https://redis.io/commands/incrbyfloat</remarks>
double StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.
/// </summary>
/// <returns>the value of key, or nil when key does not exist.</returns>
/// <remarks>http://redis.io/commands/get</remarks>
/// <remarks>https://redis.io/commands/get</remarks>
RedisValue StringGet(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the values of all specified keys. For every key that does not hold a string value or does not exist, the special value nil is returned.
/// </summary>
/// <remarks>http://redis.io/commands/mget</remarks>
/// <remarks>https://redis.io/commands/mget</remarks>
RedisValue[] StringGet(RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -988,20 +992,20 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// When offset is beyond the string length, the string is assumed to be a contiguous space with 0 bits.
/// </summary>
/// <returns>the bit value stored at offset.</returns>
/// <remarks>http://redis.io/commands/getbit</remarks>
/// <remarks>https://redis.io/commands/getbit</remarks>
bool StringGetBit(RedisKey key, long offset, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive). Negative offsets can be used in order to provide an offset starting from the end of the string. So -1 means the last character, -2 the penultimate and so forth.
/// </summary>
/// <returns>the substring of the string value stored at key</returns>
/// <remarks>http://redis.io/commands/getrange</remarks>
/// <remarks>https://redis.io/commands/getrange</remarks>
RedisValue StringGetRange(RedisKey key, long start, long end, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Atomically sets key to value and returns the old value stored at key.
/// </summary>
/// <remarks>http://redis.io/commands/getset</remarks>
/// <remarks>https://redis.io/commands/getset</remarks>
/// <returns> the old value stored at key, or nil when key did not exist.</returns>
RedisValue StringGetSet(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None);
......@@ -1009,42 +1013,42 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.
/// </summary>
/// <returns>the value of key, or nil when key does not exist.</returns>
/// <remarks>http://redis.io/commands/get</remarks>
/// <remarks>https://redis.io/commands/get</remarks>
RedisValueWithExpiry StringGetWithExpiry(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
/// </summary>
/// <returns> the value of key after the increment</returns>
/// <remarks>http://redis.io/commands/incrby</remarks>
/// <remarks>http://redis.io/commands/incr</remarks>
/// <returns>The value of key after the increment.</returns>
/// <remarks>https://redis.io/commands/incrby</remarks>
/// <remarks>https://redis.io/commands/incr</remarks>
long StringIncrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Increments the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
/// </summary>
/// <returns>the value of key after the increment</returns>
/// <remarks>http://redis.io/commands/incrbyfloat</remarks>
/// <returns>The value of key after the increment.</returns>
/// <remarks>https://redis.io/commands/incrbyfloat</remarks>
double StringIncrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the length of the string value stored at key.
/// </summary>
/// <returns>the length of the string at key, or 0 when key does not exist.</returns>
/// <remarks>http://redis.io/commands/strlen</remarks>
/// <remarks>https://redis.io/commands/strlen</remarks>
long StringLength(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Set key to hold the string value. If key already holds a value, it is overwritten, regardless of its type.
/// </summary>
/// <remarks>http://redis.io/commands/set</remarks>
/// <remarks>https://redis.io/commands/set</remarks>
bool StringSet(RedisKey key, RedisValue value, TimeSpan? expiry = null, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sets the given keys to their respective values. If "not exists" is specified, this will not perform any operation at all even if just a single key already exists.
/// </summary>
/// <returns>True if the keys were set, else False</returns>
/// <remarks>http://redis.io/commands/mset</remarks>
/// <remarks>http://redis.io/commands/msetnx</remarks>
/// <remarks>https://redis.io/commands/mset</remarks>
/// <remarks>https://redis.io/commands/msetnx</remarks>
bool StringSet(KeyValuePair<RedisKey, RedisValue>[] values, When when = When.Always, CommandFlags flags = CommandFlags.None);
/// <summary>
......@@ -1052,13 +1056,13 @@ public interface IDatabase : IRedis, IDatabaseAsync
/// The bit is either set or cleared depending on value, which can be either 0 or 1. When key does not exist, a new string value is created.The string is grown to make sure it can hold a bit at offset.
/// </summary>
/// <returns>the original bit value stored at offset.</returns>
/// <remarks>http://redis.io/commands/setbit</remarks>
/// <remarks>https://redis.io/commands/setbit</remarks>
bool StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value. If the offset is larger than the current length of the string at key, the string is padded with zero-bytes to make offset fit. Non-existing keys are considered as empty strings, so this command will make sure it holds a string large enough to be able to set value at offset.
/// </summary>
/// <returns>the length of the string after it was modified by the command.</returns>
/// <remarks>http://redis.io/commands/setrange</remarks>
/// <remarks>https://redis.io/commands/setrange</remarks>
RedisValue StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None);
}
}
StackExchange.Redis/StackExchange/Redis/Interfaces/IDatabaseAsync.cs
View file @ 59ece8d6
......@@ -10,6 +10,19 @@ namespace StackExchange.Redis
/// </summary>
public interface IDatabaseAsync : IRedisAsync
{
/// <summary>
/// Indicates whether the instance can communicate with the server (resolved
/// using the supplied key and optional flags)
/// </summary>
[IgnoreNamePrefix(true)]
bool IsConnected(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance by default, and is guaranteed to exist in the target instance.
/// </summary>
/// <remarks>https://redis.io/commands/MIGRATE</remarks>
Task KeyMigrateAsync(RedisKey key, EndPoint toServer, int toDatabase = 0, int timeoutMilliseconds = 0, MigrateOptions migrateOptions = MigrateOptions.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the raw DEBUG OBJECT output for a key; this command is not fully documented and should be avoided unless you have good reason, and then avoided anyway.
/// </summary>
......@@ -94,10 +107,10 @@ public interface IDatabaseAsync : IRedisAsync
Task<GeoRadiusResult[]> GeoRadiusAsync(RedisKey key, double longitude, double latitude, double radius, GeoUnit unit = GeoUnit.Meters, int count = -1, Order? order = null, GeoRadiusOptions options = GeoRadiusOptions.Default, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
/// Decrements the number stored at field in the hash stored at key by decrement. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
/// </summary>
/// <remarks>The range of values supported by HINCRBY is limited to 64 bit signed integers.</remarks>
/// <returns>the value at field after the increment operation.</returns>
/// <returns>The value at field after the decrement operation.</returns>
/// <remarks>https://redis.io/commands/hincrby</remarks>
Task<long> HashDecrementAsync(RedisKey key, RedisValue hashField, long value = 1, CommandFlags flags = CommandFlags.None);
......@@ -130,13 +143,6 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/hexists</remarks>
Task<bool> HashExistsAsync(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns all fields and values of the hash stored at key.
/// </summary>
/// <returns>list of fields and their values stored in the hash, or an empty list when key does not exist.</returns>
/// <remarks>https://redis.io/commands/hgetall</remarks>
Task<HashEntry[]> HashGetAllAsync(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the value associated with field in the hash stored at key.
/// </summary>
......@@ -152,6 +158,13 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/hmget</remarks>
Task<RedisValue[]> HashGetAsync(RedisKey key, RedisValue[] hashFields, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns all fields and values of the hash stored at key.
/// </summary>
/// <returns>list of fields and their values stored in the hash, or an empty list when key does not exist.</returns>
/// <remarks>https://redis.io/commands/hgetall</remarks>
Task<HashEntry[]> HashGetAllAsync(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist or holds a string that cannot be interpreted as integer, the value is set to 0 before the operation is performed.
/// </summary>
......@@ -249,13 +262,6 @@ public interface IDatabaseAsync : IRedisAsync
[IgnoreNamePrefix]
Task<EndPoint> IdentifyEndpointAsync(RedisKey key = default(RedisKey), CommandFlags flags = CommandFlags.None);
/// <summary>
/// Indicates whether the instance can communicate with the server (resolved
/// using the supplied key and optional flags)
/// </summary>
[IgnoreNamePrefix(true)]
bool IsConnected(RedisKey key, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Removes the specified key. A key is ignored if it does not exist.
/// </summary>
......@@ -306,12 +312,6 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/persist</remarks>
Task<bool> KeyExpireAsync(RedisKey key, DateTime? expiry, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance by default, and is guaranteed to exist in the target instance.
/// </summary>
/// <remarks>https://redis.io/commands/MIGRATE</remarks>
Task KeyMigrateAsync(RedisKey key, EndPoint toServer, int toDatabase = 0, int timeoutMilliseconds = 0, MigrateOptions migrateOptions = MigrateOptions.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Move key from the currently selected database (see SELECT) to the specified destination database. When key already exists in the destination database, or it does not exist in the source database, it does nothing. It is possible to use MOVE as a locking primitive because of this.
/// </summary>
......@@ -501,13 +501,6 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/publish</remarks>
Task<long> PublishAsync(RedisChannel channel, RedisValue message, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Execute a Lua script against the server
/// </summary>
/// <remarks>https://redis.io/commands/eval, https://redis.io/commands/evalsha</remarks>
/// <returns>A dynamic representation of the script's result</returns>
Task<RedisResult> ScriptEvaluateAsync(string script, RedisKey[] keys = null, RedisValue[] values = null, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Execute an arbitrary command against the server; this is primarily intended for
/// executing modules, but may also be used to provide access to new features that lack
......@@ -524,6 +517,13 @@ public interface IDatabaseAsync : IRedisAsync
/// <returns>A dynamic representation of the command's result</returns>
Task<RedisResult> ExecuteAsync(string command, ICollection<object> args, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Execute a Lua script against the server
/// </summary>
/// <remarks>https://redis.io/commands/eval, https://redis.io/commands/evalsha</remarks>
/// <returns>A dynamic representation of the script's result</returns>
Task<RedisResult> ScriptEvaluateAsync(string script, RedisKey[] keys = null, RedisValue[] values = null, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Execute a Lua script against the server using just the SHA1 hash
/// </summary>
......@@ -558,24 +558,6 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/sadd</remarks>
Task<long> SetAddAsync(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
/// </summary>
/// <returns>the number of elements in the resulting set.</returns>
/// <remarks>https://redis.io/commands/sunionstore</remarks>
/// <remarks>https://redis.io/commands/sinterstore</remarks>
/// <remarks>https://redis.io/commands/sdiffstore</remarks>
Task<long> SetCombineAndStoreAsync(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None);
/// <summary>
/// This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
/// </summary>
/// <returns>the number of elements in the resulting set.</returns>
/// <remarks>https://redis.io/commands/sunionstore</remarks>
/// <remarks>https://redis.io/commands/sinterstore</remarks>
/// <remarks>https://redis.io/commands/sdiffstore</remarks>
Task<long> SetCombineAndStoreAsync(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the members of the set resulting from the specified operation against the given sets.
/// </summary>
......@@ -594,6 +576,24 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/sdiff</remarks>
Task<RedisValue[]> SetCombineAsync(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
/// </summary>
/// <returns>the number of elements in the resulting set.</returns>
/// <remarks>https://redis.io/commands/sunionstore</remarks>
/// <remarks>https://redis.io/commands/sinterstore</remarks>
/// <remarks>https://redis.io/commands/sdiffstore</remarks>
Task<long> SetCombineAndStoreAsync(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None);
/// <summary>
/// This command is equal to SetCombine, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
/// </summary>
/// <returns>the number of elements in the resulting set.</returns>
/// <remarks>https://redis.io/commands/sunionstore</remarks>
/// <remarks>https://redis.io/commands/sinterstore</remarks>
/// <remarks>https://redis.io/commands/sdiffstore</remarks>
Task<long> SetCombineAndStoreAsync(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns if member is a member of the set stored at key.
/// </summary>
......@@ -659,6 +659,7 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/srem</remarks>
Task<long> SetRemoveAsync(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
/// used to perform external key-lookups using the <c>by</c> parameter. By default, the elements themselves are returned, but external key-lookups (one or many) can
......@@ -667,9 +668,9 @@ public interface IDatabaseAsync : IRedisAsync
/// can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
/// </summary>
/// <remarks>https://redis.io/commands/sort</remarks>
/// <returns>Returns the number of elements stored in the new list</returns>
/// <returns>Returns the sorted elements, or the external values if <c>get</c> is specified</returns>
[IgnoreNamePrefix]
Task<long> SortAndStoreAsync(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default(RedisValue), RedisValue[] get = null, CommandFlags flags = CommandFlags.None);
Task<RedisValue[]> SortAsync(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default(RedisValue), RedisValue[] get = null, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Sorts a list, set or sorted set (numerically or alphabetically, ascending by default); By default, the elements themselves are compared, but the values can also be
......@@ -679,9 +680,9 @@ public interface IDatabaseAsync : IRedisAsync
/// can be used to specify fields using <c>-&gt;</c> notation (again, refer to redis documentation).
/// </summary>
/// <remarks>https://redis.io/commands/sort</remarks>
/// <returns>Returns the sorted elements, or the external values if <c>get</c> is specified</returns>
/// <returns>Returns the number of elements stored in the new list</returns>
[IgnoreNamePrefix]
Task<RedisValue[]> SortAsync(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default(RedisValue), RedisValue[] get = null, CommandFlags flags = CommandFlags.None);
Task<long> SortAndStoreAsync(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default(RedisValue), RedisValue[] get = null, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Adds the specified member with the specified score to the sorted set stored at key. If the specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
......@@ -850,6 +851,7 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/zremrangebylex</remarks>
/// <returns>the number of elements removed.</returns>
Task<long> SortedSetRemoveRangeByValueAsync(RedisKey key, RedisValue min, RedisValue max, Exclude exclude = Exclude.None, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the score of member in the sorted set at key; If member does not exist in the sorted set, or key does not exist, nil is returned.
/// </summary>
......@@ -895,7 +897,7 @@ public interface IDatabaseAsync : IRedisAsync
/// <summary>
/// Return the position of the first bit set to 1 or 0 in a string.
/// The position is returned thinking at the string as an array of bits from left to right where the first byte most significant bit is at position 0, the second byte most significant big is at position 8 and so forth.
/// The position is returned thinking at the string as an array of bits from left to right where the first byte most significant bit is at position 0, the second byte most significant bit is at position 8 and so forth.
/// An start and end may be specified; these are in bytes, not bits; start and end can contain negative values in order to index bytes starting from the end of the string, where -1 is the last byte, -2 is the penultimate, and so forth.
/// </summary>
/// <returns>The command returns the position of the first bit set to 1 or 0 according to the request.
......@@ -904,17 +906,18 @@ public interface IDatabaseAsync : IRedisAsync
Task<long> StringBitPositionAsync(RedisKey key, bool bit, long start = 0, long end = -1, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Decrements the number stored at key by decrement. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
/// Decrements the number stored at key by decrement. If the key does not exist, it is set to 0 before performing the operation.
/// An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
/// </summary>
/// <returns> the value of key after the increment</returns>
/// <returns>The value of key after the decrement.</returns>
/// <remarks>https://redis.io/commands/decrby</remarks>
/// <remarks>https://redis.io/commands/decr</remarks>
Task<long> StringDecrementAsync(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Decrements the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
/// Decrements the string representing a floating point number stored at key by the specified decrement. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
/// </summary>
/// <returns>the value of key after the increment</returns>
/// <returns>The value of key after the decrement.</returns>
/// <remarks>https://redis.io/commands/incrbyfloat</remarks>
Task<double> StringDecrementAsync(RedisKey key, double value, CommandFlags flags = CommandFlags.None);
......@@ -962,17 +965,18 @@ public interface IDatabaseAsync : IRedisAsync
/// <summary>
/// Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that is not representable as integer. This operation is limited to 64 bit signed integers.
/// </summary>
/// <returns>the value of key after the increment</returns>
/// <returns>The value of key after the increment.</returns>
/// <remarks>https://redis.io/commands/incrby</remarks>
/// <remarks>https://redis.io/commands/incr</remarks>
Task<long> StringIncrementAsync(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Increment the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
/// Increments the string representing a floating point number stored at key by the specified increment. If the key does not exist, it is set to 0 before performing the operation. The precision of the output is fixed at 17 digits after the decimal point regardless of the actual internal precision of the computation.
/// </summary>
/// <returns>the value of key after the increment</returns>
/// <returns>The value of key after the increment.</returns>
/// <remarks>https://redis.io/commands/incrbyfloat</remarks>
Task<double> StringIncrementAsync(RedisKey key, double value, CommandFlags flags = CommandFlags.None);
/// <summary>
/// Returns the length of the string value stored at key.
/// </summary>
......@@ -1007,26 +1011,4 @@ public interface IDatabaseAsync : IRedisAsync
/// <remarks>https://redis.io/commands/setrange</remarks>
Task<RedisValue> StringSetRangeAsync(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None);
}
/// <summary>
/// Describes a value/expiry pair
/// </summary>
public struct RedisValueWithExpiry
{
internal RedisValueWithExpiry(RedisValue value, TimeSpan? expiry)
{
Value = value;
Expiry = expiry;
}
/// <summary>
/// The expiry of this record
/// </summary>
public TimeSpan? Expiry { get; }
/// <summary>
/// The value of this record
/// </summary>
public RedisValue Value { get; }
}
}
StackExchange.Redis/StackExchange/Redis/RedisValueWithExpiry.cs 0 → 100644
View file @ 59ece8d6
using System;
namespace StackExchange.Redis
{
/// <summary>
/// Describes a value/expiry pair
/// </summary>
public struct RedisValueWithExpiry
{
internal RedisValueWithExpiry(RedisValue value, TimeSpan? expiry)
{
Value = value;
Expiry = expiry;
}
/// <summary>
/// The expiry of this record
/// </summary>
public TimeSpan? Expiry { get; }
/// <summary>
/// The value of this record
/// </summary>
public RedisValue Value { get; }
}
}
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment