Skip to content

Commit 182a04f

Browse files
ofekshenawandyakov
andauthored
update HExpire command documentation (#3355)
* update HExpire command documentation * Apply suggestions from code review Format the links in the documentation. Add missing documentation. --------- Co-authored-by: Nedyalko Dyakov <[email protected]>
1 parent 030c184 commit 182a04f

File tree

1 file changed

+47
-7
lines changed

1 file changed

+47
-7
lines changed

hash_commands.go

+47-7
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,10 @@ type HExpireArgs struct {
224224

225225
// HExpire - Sets the expiration time for specified fields in a hash in seconds.
226226
// The command constructs an argument list starting with "HEXPIRE", followed by the key, duration, any conditional flags, and the specified fields.
227-
// For more information - https://redis.io/commands/hexpire/
227+
// Available since Redis 7.4 CE.
228+
// For more information refer to [HEXPIRE Documentation].
229+
//
230+
// [HEXPIRE Documentation]: https://redis.io/commands/hexpire/
228231
func (c cmdable) HExpire(ctx context.Context, key string, expiration time.Duration, fields ...string) *IntSliceCmd {
229232
args := []interface{}{"HEXPIRE", key, formatSec(ctx, expiration), "FIELDS", len(fields)}
230233

@@ -239,7 +242,10 @@ func (c cmdable) HExpire(ctx context.Context, key string, expiration time.Durati
239242
// HExpireWithArgs - Sets the expiration time for specified fields in a hash in seconds.
240243
// It requires a key, an expiration duration, a struct with boolean flags for conditional expiration settings (NX, XX, GT, LT), and a list of fields.
241244
// The command constructs an argument list starting with "HEXPIRE", followed by the key, duration, any conditional flags, and the specified fields.
242-
// For more information - https://redis.io/commands/hexpire/
245+
// Available since Redis 7.4 CE.
246+
// For more information refer to [HEXPIRE Documentation].
247+
//
248+
// [HEXPIRE Documentation]: https://redis.io/commands/hexpire/
243249
func (c cmdable) HExpireWithArgs(ctx context.Context, key string, expiration time.Duration, expirationArgs HExpireArgs, fields ...string) *IntSliceCmd {
244250
args := []interface{}{"HEXPIRE", key, formatSec(ctx, expiration)}
245251

@@ -268,7 +274,10 @@ func (c cmdable) HExpireWithArgs(ctx context.Context, key string, expiration tim
268274
// HPExpire - Sets the expiration time for specified fields in a hash in milliseconds.
269275
// Similar to HExpire, it accepts a key, an expiration duration in milliseconds, a struct with expiration condition flags, and a list of fields.
270276
// The command modifies the standard time.Duration to milliseconds for the Redis command.
271-
// For more information - https://redis.io/commands/hpexpire/
277+
// Available since Redis 7.4 CE.
278+
// For more information refer to [HPEXPIRE Documentation].
279+
//
280+
// [HPEXPIRE Documentation]: https://redis.io/commands/hpexpire/
272281
func (c cmdable) HPExpire(ctx context.Context, key string, expiration time.Duration, fields ...string) *IntSliceCmd {
273282
args := []interface{}{"HPEXPIRE", key, formatMs(ctx, expiration), "FIELDS", len(fields)}
274283

@@ -280,6 +289,13 @@ func (c cmdable) HPExpire(ctx context.Context, key string, expiration time.Durat
280289
return cmd
281290
}
282291

292+
// HPExpireWithArgs - Sets the expiration time for specified fields in a hash in milliseconds.
293+
// It requires a key, an expiration duration, a struct with boolean flags for conditional expiration settings (NX, XX, GT, LT), and a list of fields.
294+
// The command constructs an argument list starting with "HPEXPIRE", followed by the key, duration, any conditional flags, and the specified fields.
295+
// Available since Redis 7.4 CE.
296+
// For more information refer to [HPEXPIRE Documentation].
297+
//
298+
// [HPEXPIRE Documentation]: https://redis.io/commands/hpexpire/
283299
func (c cmdable) HPExpireWithArgs(ctx context.Context, key string, expiration time.Duration, expirationArgs HExpireArgs, fields ...string) *IntSliceCmd {
284300
args := []interface{}{"HPEXPIRE", key, formatMs(ctx, expiration)}
285301

@@ -308,7 +324,10 @@ func (c cmdable) HPExpireWithArgs(ctx context.Context, key string, expiration ti
308324
// HExpireAt - Sets the expiration time for specified fields in a hash to a UNIX timestamp in seconds.
309325
// Takes a key, a UNIX timestamp, a struct of conditional flags, and a list of fields.
310326
// The command sets absolute expiration times based on the UNIX timestamp provided.
311-
// For more information - https://redis.io/commands/hexpireat/
327+
// Available since Redis 7.4 CE.
328+
// For more information refer to [HExpireAt Documentation].
329+
//
330+
// [HExpireAt Documentation]: https://redis.io/commands/hexpireat/
312331
func (c cmdable) HExpireAt(ctx context.Context, key string, tm time.Time, fields ...string) *IntSliceCmd {
313332

314333
args := []interface{}{"HEXPIREAT", key, tm.Unix(), "FIELDS", len(fields)}
@@ -348,7 +367,10 @@ func (c cmdable) HExpireAtWithArgs(ctx context.Context, key string, tm time.Time
348367

349368
// HPExpireAt - Sets the expiration time for specified fields in a hash to a UNIX timestamp in milliseconds.
350369
// Similar to HExpireAt but for timestamps in milliseconds. It accepts the same parameters and adjusts the UNIX time to milliseconds.
351-
// For more information - https://redis.io/commands/hpexpireat/
370+
// Available since Redis 7.4 CE.
371+
// For more information refer to [HExpireAt Documentation].
372+
//
373+
// [HExpireAt Documentation]: https://redis.io/commands/hexpireat/
352374
func (c cmdable) HPExpireAt(ctx context.Context, key string, tm time.Time, fields ...string) *IntSliceCmd {
353375
args := []interface{}{"HPEXPIREAT", key, tm.UnixNano() / int64(time.Millisecond), "FIELDS", len(fields)}
354376

@@ -388,7 +410,10 @@ func (c cmdable) HPExpireAtWithArgs(ctx context.Context, key string, tm time.Tim
388410
// HPersist - Removes the expiration time from specified fields in a hash.
389411
// Accepts a key and the fields themselves.
390412
// This command ensures that each field specified will have its expiration removed if present.
391-
// For more information - https://redis.io/commands/hpersist/
413+
// Available since Redis 7.4 CE.
414+
// For more information refer to [HPersist Documentation].
415+
//
416+
// [HPersist Documentation]: https://redis.io/commands/hpersist/
392417
func (c cmdable) HPersist(ctx context.Context, key string, fields ...string) *IntSliceCmd {
393418
args := []interface{}{"HPERSIST", key, "FIELDS", len(fields)}
394419

@@ -403,6 +428,10 @@ func (c cmdable) HPersist(ctx context.Context, key string, fields ...string) *In
403428
// HExpireTime - Retrieves the expiration time for specified fields in a hash as a UNIX timestamp in seconds.
404429
// Requires a key and the fields themselves to fetch their expiration timestamps.
405430
// This command returns the expiration times for each field or error/status codes for each field as specified.
431+
// Available since Redis 7.4 CE.
432+
// For more information refer to [HExpireTime Documentation].
433+
//
434+
// [HExpireTime Documentation]: https://redis.io/commands/hexpiretime/
406435
// For more information - https://redis.io/commands/hexpiretime/
407436
func (c cmdable) HExpireTime(ctx context.Context, key string, fields ...string) *IntSliceCmd {
408437
args := []interface{}{"HEXPIRETIME", key, "FIELDS", len(fields)}
@@ -418,6 +447,10 @@ func (c cmdable) HExpireTime(ctx context.Context, key string, fields ...string)
418447
// HPExpireTime - Retrieves the expiration time for specified fields in a hash as a UNIX timestamp in milliseconds.
419448
// Similar to HExpireTime, adjusted for timestamps in milliseconds. It requires the same parameters.
420449
// Provides the expiration timestamp for each field in milliseconds.
450+
// Available since Redis 7.4 CE.
451+
// For more information refer to [HExpireTime Documentation].
452+
//
453+
// [HExpireTime Documentation]: https://redis.io/commands/hexpiretime/
421454
// For more information - https://redis.io/commands/hexpiretime/
422455
func (c cmdable) HPExpireTime(ctx context.Context, key string, fields ...string) *IntSliceCmd {
423456
args := []interface{}{"HPEXPIRETIME", key, "FIELDS", len(fields)}
@@ -433,7 +466,10 @@ func (c cmdable) HPExpireTime(ctx context.Context, key string, fields ...string)
433466
// HTTL - Retrieves the remaining time to live for specified fields in a hash in seconds.
434467
// Requires a key and the fields themselves. It returns the TTL for each specified field.
435468
// This command fetches the TTL in seconds for each field or returns error/status codes as appropriate.
436-
// For more information - https://redis.io/commands/httl/
469+
// Available since Redis 7.4 CE.
470+
// For more information refer to [HTTL Documentation].
471+
//
472+
// [HTTL Documentation]: https://redis.io/commands/httl/
437473
func (c cmdable) HTTL(ctx context.Context, key string, fields ...string) *IntSliceCmd {
438474
args := []interface{}{"HTTL", key, "FIELDS", len(fields)}
439475

@@ -448,6 +484,10 @@ func (c cmdable) HTTL(ctx context.Context, key string, fields ...string) *IntSli
448484
// HPTTL - Retrieves the remaining time to live for specified fields in a hash in milliseconds.
449485
// Similar to HTTL, but returns the TTL in milliseconds. It requires a key and the specified fields.
450486
// This command provides the TTL in milliseconds for each field or returns error/status codes as needed.
487+
// Available since Redis 7.4 CE.
488+
// For more information refer to [HPTTL Documentation].
489+
//
490+
// [HPTTL Documentation]: https://redis.io/commands/hpttl/
451491
// For more information - https://redis.io/commands/hpttl/
452492
func (c cmdable) HPTTL(ctx context.Context, key string, fields ...string) *IntSliceCmd {
453493
args := []interface{}{"HPTTL", key, "FIELDS", len(fields)}

0 commit comments

Comments
 (0)