diff --git a/src/StackExchange.Redis/Interfaces/IDatabase.cs b/src/StackExchange.Redis/Interfaces/IDatabase.cs index e5c120eb9..7cf2248fd 100644 --- a/src/StackExchange.Redis/Interfaces/IDatabase.cs +++ b/src/StackExchange.Redis/Interfaces/IDatabase.cs @@ -331,7 +331,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// The key of the hash. /// The field in the hash to get. /// The flags to use for this operation. - /// The value associated with field, or nil when field is not present in the hash or key does not exist. + /// The value associated with field, or when field is not present in the hash or key does not exist. /// RedisValue HashGet(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None); @@ -341,13 +341,14 @@ public interface IDatabase : IRedis, IDatabaseAsync /// The key of the hash. /// The field in the hash to get. /// The flags to use for this operation. - /// The value associated with field, or nil when field is not present in the hash or key does not exist. + /// The value associated with field, or when field is not present in the hash or key does not exist. /// Lease? HashGetLease(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None); /// /// Returns the values associated with the specified fields in the hash stored at key. - /// 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. + /// For every field that does not exist in the hash, a value is returned. + /// Because non-existing keys are treated as empty hashes, running HMGET against a non-existing key will return a list of values. /// /// The key of the hash. /// The fields in the hash to get. @@ -802,7 +803,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// Return a random key from the currently selected database. /// /// The flags to use for this operation. - /// The random key, or nil when the database is empty. + /// The random key, or when the database is empty. /// RedisKey KeyRandom(CommandFlags flags = CommandFlags.None); @@ -847,7 +848,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// /// The key to check. /// The flags to use for this operation. - /// TTL, or nil when key does not exist or does not have a timeout. + /// TTL, or when key does not exist or does not have a timeout. /// TimeSpan? KeyTimeToLive(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -888,7 +889,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// The key of the list. /// The index position to get the value at. /// The flags to use for this operation. - /// The requested element, or nil when index is out of range. + /// The requested element, or when index is out of range. /// RedisValue ListGetByIndex(RedisKey key, long index, CommandFlags flags = CommandFlags.None); @@ -921,7 +922,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// /// The key of the list. /// The flags to use for this operation. - /// The value of the first element, or nil when key does not exist. + /// The value of the first element, or when key does not exist. /// RedisValue ListLeftPop(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -932,7 +933,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// The key of the list. /// The number of elements to remove /// The flags to use for this operation. - /// Array of values that were popped, or nil if the key doesn't exist. + /// Array of values that were popped, or if the key doesn't exist. /// RedisValue[] ListLeftPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None); @@ -1075,7 +1076,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// /// The key of the list. /// The flags to use for this operation. - /// The element being popped. + /// The element being popped, or when key does not exist.. /// RedisValue ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -1086,7 +1087,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// The key of the list. /// The number of elements to pop /// The flags to use for this operation. - /// Array of values that were popped, or nil if the key doesn't exist. + /// Array of values that were popped, or if the key doesn't exist. /// RedisValue[] ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None); @@ -1494,7 +1495,7 @@ public interface IDatabase : IRedis, IDatabaseAsync /// /// The key of the set. /// The flags to use for this operation. - /// The removed element, or nil when key does not exist. + /// The removed element, or when key does not exist. /// RedisValue SetPop(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -2122,7 +2123,7 @@ IEnumerable SortedSetScan(RedisKey key, /// /// 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. + /// If member does not exist in the sorted set, or key does not exist, is returned. /// /// The key of the sorted set. /// The member to get a score for. @@ -2151,7 +2152,7 @@ IEnumerable SortedSetScan(RedisKey key, /// The key of the sorted set. /// The order to sort by (defaults to ascending). /// The flags to use for this operation. - /// The removed element, or nil when key does not exist. + /// The removed element, or when key does not exist. /// /// , /// @@ -2674,32 +2675,32 @@ IEnumerable SortedSetScan(RedisKey key, double StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None); /// - /// Get the value of key. If the key does not exist the special value nil is returned. + /// Get the value of key. If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// RedisValue StringGet(RedisKey key, CommandFlags flags = CommandFlags.None); /// /// 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. + /// For every key that does not hold a string value or does not exist, the special value is returned. /// /// The keys of the strings. /// The flags to use for this operation. - /// The values of the strings with nil for keys do not exist. + /// The values of the strings with for keys do not exist. /// RedisValue[] StringGet(RedisKey[] keys, CommandFlags flags = CommandFlags.None); /// - /// Get the value of key. If the key does not exist the special value nil is returned. + /// Get the value of key. If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// Lease? StringGetLease(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -2733,7 +2734,7 @@ IEnumerable SortedSetScan(RedisKey key, /// The key of the string. /// The value to replace the existing value with. /// The flags to use for this operation. - /// The old value stored at key, or nil when key did not exist. + /// The old value stored at key, or when key did not exist. /// RedisValue StringGetSet(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None); @@ -2744,7 +2745,7 @@ IEnumerable SortedSetScan(RedisKey key, /// The key of the string. /// The expiry to set. will remove expiry. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// RedisValue StringGetSetExpiry(RedisKey key, TimeSpan? expiry, CommandFlags flags = CommandFlags.None); @@ -2755,29 +2756,29 @@ IEnumerable SortedSetScan(RedisKey key, /// The key of the string. /// The exact date and time to expire at. will remove expiry. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// RedisValue StringGetSetExpiry(RedisKey key, DateTime expiry, CommandFlags flags = CommandFlags.None); /// /// Get the value of key and delete the key. - /// If the key does not exist the special value nil is returned. + /// If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// RedisValue StringGetDelete(RedisKey key, CommandFlags flags = CommandFlags.None); /// /// Get the value of key. - /// If the key does not exist the special value nil is returned. + /// If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key and its expiry, or nil when key does not exist. + /// The value of key and its expiry, or when key does not exist. /// RedisValueWithExpiry StringGetWithExpiry(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -2901,7 +2902,7 @@ IEnumerable SortedSetScan(RedisKey key, /// The expiry to set. /// Which condition to set the value under (defaults to ). /// The flags to use for this operation. - /// The previous value stored at , or nil when key did not exist. + /// The previous value stored at , or when key did not exist. /// /// This method uses the SET command with the GET option introduced in Redis 6.2.0 instead of the deprecated GETSET command. /// @@ -2917,7 +2918,7 @@ IEnumerable SortedSetScan(RedisKey key, /// Whether to maintain the existing key's TTL (KEEPTTL flag). /// Which condition to set the value under (defaults to ). /// The flags to use for this operation. - /// The previous value stored at , or nil when key did not exist. + /// The previous value stored at , or when key did not exist. /// This method uses the SET command with the GET option introduced in Redis 6.2.0 instead of the deprecated GETSET command. /// RedisValue StringSetAndGet(RedisKey key, RedisValue value, TimeSpan? expiry = null, bool keepTtl = false, When when = When.Always, CommandFlags flags = CommandFlags.None); diff --git a/src/StackExchange.Redis/Interfaces/IDatabaseAsync.cs b/src/StackExchange.Redis/Interfaces/IDatabaseAsync.cs index 4a9cd400d..a19525925 100644 --- a/src/StackExchange.Redis/Interfaces/IDatabaseAsync.cs +++ b/src/StackExchange.Redis/Interfaces/IDatabaseAsync.cs @@ -318,7 +318,7 @@ public interface IDatabaseAsync : IRedisAsync /// The key of the hash. /// The field in the hash to get. /// The flags to use for this operation. - /// The value associated with field, or nil when field is not present in the hash or key does not exist. + /// The value associated with field, or when field is not present in the hash or key does not exist. /// Task HashGetAsync(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None); @@ -328,13 +328,14 @@ public interface IDatabaseAsync : IRedisAsync /// The key of the hash. /// The field in the hash to get. /// The flags to use for this operation. - /// The value associated with field, or nil when field is not present in the hash or key does not exist. + /// The value associated with field, or when field is not present in the hash or key does not exist. /// Task?> HashGetLeaseAsync(RedisKey key, RedisValue hashField, CommandFlags flags = CommandFlags.None); /// /// Returns the values associated with the specified fields in the hash stored at key. - /// 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. + /// For every field that does not exist in the hash, a 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 values. /// /// The key of the hash. /// The fields in the hash to get. @@ -778,7 +779,7 @@ public interface IDatabaseAsync : IRedisAsync /// Return a random key from the currently selected database. /// /// The flags to use for this operation. - /// The random key, or nil when the database is empty. + /// The random key, or when the database is empty. /// Task KeyRandomAsync(CommandFlags flags = CommandFlags.None); @@ -823,7 +824,7 @@ public interface IDatabaseAsync : IRedisAsync /// /// The key to check. /// The flags to use for this operation. - /// TTL, or nil when key does not exist or does not have a timeout. + /// TTL, or when key does not exist or does not have a timeout. /// Task KeyTimeToLiveAsync(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -864,7 +865,7 @@ public interface IDatabaseAsync : IRedisAsync /// The key of the list. /// The index position to get the value at. /// The flags to use for this operation. - /// The requested element, or nil when index is out of range. + /// The requested element, or when index is out of range. /// Task ListGetByIndexAsync(RedisKey key, long index, CommandFlags flags = CommandFlags.None); @@ -897,7 +898,7 @@ public interface IDatabaseAsync : IRedisAsync /// /// The key of the list. /// The flags to use for this operation. - /// The value of the first element, or nil when key does not exist. + /// The value of the first element, or when key does not exist. /// Task ListLeftPopAsync(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -908,7 +909,7 @@ public interface IDatabaseAsync : IRedisAsync /// The key of the list. /// The number of elements to remove /// The flags to use for this operation. - /// Array of values that were popped, or nil if the key doesn't exist. + /// Array of values that were popped, or if the key doesn't exist. /// Task ListLeftPopAsync(RedisKey key, long count, CommandFlags flags = CommandFlags.None); @@ -1051,7 +1052,7 @@ public interface IDatabaseAsync : IRedisAsync /// /// The key of the list. /// The flags to use for this operation. - /// The element being popped. + /// The element being popped, or when key does not exist.. /// Task ListRightPopAsync(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -1062,7 +1063,7 @@ public interface IDatabaseAsync : IRedisAsync /// The key of the list. /// The number of elements to pop /// The flags to use for this operation. - /// Array of values that were popped, or nil if the key doesn't exist. + /// Array of values that were popped, or if the key doesn't exist. /// Task ListRightPopAsync(RedisKey key, long count, CommandFlags flags = CommandFlags.None); @@ -1470,7 +1471,7 @@ public interface IDatabaseAsync : IRedisAsync /// /// The key of the set. /// The flags to use for this operation. - /// The removed element, or nil when key does not exist. + /// The removed element, or when key does not exist. /// Task SetPopAsync(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -2075,7 +2076,7 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// /// 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. + /// If member does not exist in the sorted set, or key does not exist, is returned. /// /// The key of the sorted set. /// The member to get a score for. @@ -2127,7 +2128,7 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// The key of the sorted set. /// The order to sort by (defaults to ascending). /// The flags to use for this operation. - /// The removed element, or nil when key does not exist. + /// The removed element, or when key does not exist. /// /// , /// @@ -2627,32 +2628,32 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, Task StringDecrementAsync(RedisKey key, double value, CommandFlags flags = CommandFlags.None); /// - /// Get the value of key. If the key does not exist the special value nil is returned. + /// Get the value of key. If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// Task StringGetAsync(RedisKey key, CommandFlags flags = CommandFlags.None); /// /// 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. + /// For every key that does not hold a string value or does not exist, the special value is returned. /// /// The keys of the strings. /// The flags to use for this operation. - /// The values of the strings with nil for keys do not exist. + /// The values of the strings with for keys do not exist. /// Task StringGetAsync(RedisKey[] keys, CommandFlags flags = CommandFlags.None); /// - /// Get the value of key. If the key does not exist the special value nil is returned. + /// Get the value of key. If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// Task?> StringGetLeaseAsync(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -2686,7 +2687,7 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// The key of the string. /// The value to replace the existing value with. /// The flags to use for this operation. - /// The old value stored at key, or nil when key did not exist. + /// The old value stored at key, or when key did not exist. /// Task StringGetSetAsync(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None); @@ -2697,7 +2698,7 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// The key of the string. /// The expiry to set. will remove expiry. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// Task StringGetSetExpiryAsync(RedisKey key, TimeSpan? expiry, CommandFlags flags = CommandFlags.None); @@ -2708,29 +2709,29 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// The key of the string. /// The exact date and time to expire at. will remove expiry. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// Task StringGetSetExpiryAsync(RedisKey key, DateTime expiry, CommandFlags flags = CommandFlags.None); /// /// Get the value of key and delete the key. - /// If the key does not exist the special value nil is returned. + /// If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key, or nil when key does not exist. + /// The value of key, or when key does not exist. /// Task StringGetDeleteAsync(RedisKey key, CommandFlags flags = CommandFlags.None); /// /// Get the value of key. - /// If the key does not exist the special value nil is returned. + /// If the key does not exist the special value is returned. /// An error is returned if the value stored at key is not a string, because GET only handles string values. /// /// The key of the string. /// The flags to use for this operation. - /// The value of key and its expiry, or nil when key does not exist. + /// The value of key and its expiry, or when key does not exist. /// Task StringGetWithExpiryAsync(RedisKey key, CommandFlags flags = CommandFlags.None); @@ -2854,7 +2855,7 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// The expiry to set. /// Which condition to set the value under (defaults to ). /// The flags to use for this operation. - /// The previous value stored at , or nil when key did not exist. + /// The previous value stored at , or when key did not exist. /// /// This method uses the SET command with the GET option introduced in Redis 6.2.0 instead of the deprecated GETSET command. /// @@ -2870,7 +2871,7 @@ IAsyncEnumerable SortedSetScanAsync(RedisKey key, /// Whether to maintain the existing key's TTL (KEEPTTL flag). /// Which condition to set the value under (defaults to ). /// The flags to use for this operation. - /// The previous value stored at , or nil when key did not exist. + /// The previous value stored at , or when key did not exist. /// This method uses the SET command with the GET option introduced in Redis 6.2.0 instead of the deprecated GETSET command. /// Task StringSetAndGetAsync(RedisKey key, RedisValue value, TimeSpan? expiry = null, bool keepTtl = false, When when = When.Always, CommandFlags flags = CommandFlags.None);