Class: ValkeyObjects::HashKey

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/valkey/objects.rb

Overview

Hash wrapper

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, valkey) ⇒ HashKey

Returns a new instance of HashKey.



397
398
399
400
 
# File 'lib/valkey/objects.rb', line 397

def initialize(key, valkey)
  @key = key
  @valkey = valkey
end

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.



395
396
397
 
# File 'lib/valkey/objects.rb', line 395

def key
  @key
end

#valkey ⇒ Object (readonly)

Returns the value of attribute valkey.



395
396
397
 
# File 'lib/valkey/objects.rb', line 395

def valkey
  @valkey
end

Instance Method Details

#[](field) ⇒ Object 



402
403
404
 
# File 'lib/valkey/objects.rb', line 402

def [](field)
  valkey.hget(key, field)
end

#[]=(field, value) ⇒ Object 



406
407
408
 
# File 'lib/valkey/objects.rb', line 406

def []=(field, value)
  valkey.hset(key, field, value)
end

#all ⇒ Object Also known as: to_h 



431
432
433
 
# File 'lib/valkey/objects.rb', line 431

def all
  valkey.hgetall(key)
end

#clear ⇒ Object 



461
462
463
 
# File 'lib/valkey/objects.rb', line 461

def clear
  valkey.del(key)
end

#delete(field) ⇒ Object 



414
415
416
 
# File 'lib/valkey/objects.rb', line 414

def delete(field)
  valkey.hdel(key, field)
end

#each(&block) ⇒ Object 



457
458
459
 
# File 'lib/valkey/objects.rb', line 457

def each(&block)
  all.each(&block)
end

#expire(seconds) ⇒ Object 



441
442
443
 
# File 'lib/valkey/objects.rb', line 441

def expire(seconds)
  valkey.expire(key, seconds)
end

#expireat(unix_timestamp) ⇒ Object 



445
446
447
 
# File 'lib/valkey/objects.rb', line 445

def expireat(unix_timestamp)
  valkey.expireat(key, unix_timestamp)
end

#fetch(field, default = nil) ⇒ Object 



410
411
412
 
# File 'lib/valkey/objects.rb', line 410

def fetch(field, default = nil)
  valkey.hget(key, field) || default
end

#key?(field) ⇒ Boolean Also known as: has_key?

Returns:

  • (Boolean) 


418
419
420
 
# File 'lib/valkey/objects.rb', line 418

def key?(field)
  valkey.hexists(key, field)
end

#keys ⇒ Object 



423
424
425
 
# File 'lib/valkey/objects.rb', line 423

def keys
  valkey.hkeys(key)
end

#persist ⇒ Object 



453
454
455
 
# File 'lib/valkey/objects.rb', line 453

def persist
  valkey.persist(key)
end

#size ⇒ Object Also known as: length 



436
437
438
 
# File 'lib/valkey/objects.rb', line 436

def size
  valkey.hlen(key)
end

#ttl ⇒ Object 



449
450
451
 
# File 'lib/valkey/objects.rb', line 449

def ttl
  valkey.ttl(key)
end

#values ⇒ Object 



427
428
429
 
# File 'lib/valkey/objects.rb', line 427

def values
  valkey.hvals(key)
end