Module: Redis::Commands::Keys

Included in:
Redis::Commands
Defined in:
sig/redis.rbs

Instance Method Summary collapse

Instance Method Details

#_scan {|arg0| ... } ⇒ Object

Parameters:

  • command (Object)
  • cursor (Object)
  • args (Object)
  • match: (Object, nil)
  • count: (Object, nil)
  • type: (Object, nil)

Yields:

Yield Parameters:

  • arg0

Yield Returns:

  • (Object)

Returns:

  • (Object) 


380
 
# File 'sig/redis.rbs', line 380

def _scan: (untyped command, untyped cursor, untyped args, ?match: untyped?, ?count: untyped?, ?type: untyped?) { (?) -> untyped } -> untyped

#copy ⇒ Boolean

Parameters:

  • source (String)
  • destination (String)
  • db: (Integer, nil)
  • replace: (Boolean)

Returns:

  • (Boolean) 


364
 
# File 'sig/redis.rbs', line 364

def copy: (String source, String destination, ?db: Integer?, ?replace: bool) -> bool

#del ⇒ 0, untyped

Parameters:

  • keys (String, Array[String])

Returns:

  • (0, untyped) 


352
 
# File 'sig/redis.rbs', line 352

def del: (*(String | Array[String]) keys) -> (0 | untyped)

#dump ⇒ String?

Parameters:

  • key (String)

Returns:

  • (String, nil) 


346
 
# File 'sig/redis.rbs', line 346

def dump: (String key) -> String?

#exists ⇒ Integer

Parameters:

  • keys (String, Array[String])

Returns:

  • (Integer) 


356
 
# File 'sig/redis.rbs', line 356

def exists: (*(String | Array[String]) keys) -> Integer

#exists? ⇒ Boolean

Parameters:

  • keys (String, Array[String])

Returns:

  • (Boolean) 


358
 
# File 'sig/redis.rbs', line 358

def exists?: (*(String | Array[String]) keys) -> bool

#expire ⇒ Boolean

Parameters:

  • key (String)
  • seconds (Integer)
  • nx: (Object, nil)
  • xx: (Object, nil)
  • gt: (Object, nil)
  • lt: (Object, nil)

Returns:

  • (Boolean) 


330
 
# File 'sig/redis.rbs', line 330

def expire: (String key, Integer seconds, ?nx: untyped?, ?xx: untyped?, ?gt: untyped?, ?lt: untyped?) -> bool

#expireat ⇒ Boolean

Parameters:

  • key (String)
  • unix_time (Integer)
  • nx: (Object, nil)
  • xx: (Object, nil)
  • gt: (Object, nil)
  • lt: (Object, nil)

Returns:

  • (Boolean) 


332
 
# File 'sig/redis.rbs', line 332

def expireat: (String key, Integer unix_time, ?nx: untyped?, ?xx: untyped?, ?gt: untyped?, ?lt: untyped?) -> bool

#expiretime ⇒ Integer

Parameters:

  • key (String)

Returns:

  • (Integer) 


334
 
# File 'sig/redis.rbs', line 334

def expiretime: (String key) -> Integer

#keys ⇒ Array[String]

Parameters:

  • pattern (::String)

Returns:

  • (Array[String]) 


360
 
# File 'sig/redis.rbs', line 360

def keys: (?::String pattern) -> Array[String]

#migrate ⇒ String

Parameters:

  • key (String, Array[String])
  • options (Hash[untyped, untyped])

Returns:

  • (String) 


350
 
# File 'sig/redis.rbs', line 350

def migrate: ((String | Array[String]) key, Hash[untyped, untyped] options) -> String

#move ⇒ Boolean

Parameters:

  • key (String)
  • db (Integer)

Returns:

  • (Boolean) 


362
 
# File 'sig/redis.rbs', line 362

def move: (String key, Integer db) -> bool

#object ⇒ Object

Parameters:

  • args (Object)

Returns:

  • (Object) 


366
 
# File 'sig/redis.rbs', line 366

def object: (*untyped args) -> untyped

#persist ⇒ Boolean

Parameters:

  • key (String)

Returns:

  • (Boolean) 


328
 
# File 'sig/redis.rbs', line 328

def persist: (String key) -> bool

#pexpire ⇒ Boolean

Parameters:

  • key (String)
  • milliseconds (Integer)
  • nx: (Object, nil)
  • xx: (Object, nil)
  • gt: (Object, nil)
  • lt: (Object, nil)

Returns:

  • (Boolean) 


338
 
# File 'sig/redis.rbs', line 338

def pexpire: (String key, Integer milliseconds, ?nx: untyped?, ?xx: untyped?, ?gt: untyped?, ?lt: untyped?) -> bool

#pexpireat ⇒ Boolean

Parameters:

  • key (String)
  • ms_unix_time (Integer)
  • nx: (Object, nil)
  • xx: (Object, nil)
  • gt: (Object, nil)
  • lt: (Object, nil)

Returns:

  • (Boolean) 


340
 
# File 'sig/redis.rbs', line 340

def pexpireat: (String key, Integer ms_unix_time, ?nx: untyped?, ?xx: untyped?, ?gt: untyped?, ?lt: untyped?) -> bool

#pexpiretime ⇒ Integer

Parameters:

  • key (String)

Returns:

  • (Integer) 


342
 
# File 'sig/redis.rbs', line 342

def pexpiretime: (String key) -> Integer

#pttl ⇒ Integer

Parameters:

  • key (String)

Returns:

  • (Integer) 


344
 
# File 'sig/redis.rbs', line 344

def pttl: (String key) -> Integer

#randomkey ⇒ String?

Returns:

  • (String, nil) 


368
 
# File 'sig/redis.rbs', line 368

def randomkey: () -> String?

#rename ⇒ String

Parameters:

  • old_name (String)
  • new_name (String)

Returns:

  • (String) 


370
 
# File 'sig/redis.rbs', line 370

def rename: (String old_name, String new_name) -> String

#renamenx ⇒ Boolean

Parameters:

  • old_name (String)
  • new_name (String)

Returns:

  • (Boolean) 


372
 
# File 'sig/redis.rbs', line 372

def renamenx: (String old_name, String new_name) -> bool

#restore ⇒ String

Parameters:

  • key (String)
  • ttl (String)
  • serialized_value (String)
  • replace: (Object, nil)

Returns:

  • (String) 


348
 
# File 'sig/redis.rbs', line 348

def restore: (String key, String ttl, String serialized_value, ?replace: untyped?) -> String

#scan ⇒ String, Array[String]

Parameters:

  • cursor (String, Integer)
  • options (Hash[untyped, untyped])

Returns:

  • (String, Array[String]) 


324
 
# File 'sig/redis.rbs', line 324

def scan: ((String | Integer) cursor, **Hash[untyped, untyped] options) -> (String | Array[String])

#scan_each ⇒ void

This method returns an undefined value.

Parameters:

  • options (Hash[untyped, untyped]) 


326
 
# File 'sig/redis.rbs', line 326

def scan_each: (**Hash[untyped, untyped] options) ?{ (?) -> untyped } -> Enumerator[untyped, untyped]

#sort ⇒ Array[String], ...

Parameters:

  • key (String)
  • by: (Object, nil)
  • limit: (Object, nil)
  • get: (Object, nil)
  • order: (Object, nil)
  • store: (Object, nil)

Returns:

  • (Array[String], Array[Array[String]], Integer) 


374
 
# File 'sig/redis.rbs', line 374

def sort: (String key, ?by: untyped?, ?limit: untyped?, ?get: untyped?, ?order: untyped?, ?store: untyped?) -> (Array[String] | Array[Array[String]] | Integer)

#ttl ⇒ Integer

Parameters:

  • key (String)

Returns:

  • (Integer) 


336
 
# File 'sig/redis.rbs', line 336

def ttl: (String key) -> Integer

#type ⇒ String

Parameters:

  • key (String)

Returns:

  • (String) 


376
 
# File 'sig/redis.rbs', line 376

def type: (String key) -> String

#unlink ⇒ Integer

Parameters:

  • keys (String, Array[String])

Returns:

  • (Integer) 


354
 
# File 'sig/redis.rbs', line 354

def unlink: (*(String | Array[String]) keys) -> Integer