Module: Valkey::Commands::StringCommands

Included in:
Valkey::Commands
Defined in:
lib/valkey/commands/string_commands.rb

Overview

This module contains commands on the String data type.

See Also:

Instance Method Summary collapse

Instance Method Details

#append(key, value) ⇒ Integer

Append a value to a key.

Parameters:

  • key (String)
  • value (String) —

    value to append

Returns:

  • (Integer) —

    length of the string after appending



260
261
262
 
# File 'lib/valkey/commands/string_commands.rb', line 260

def append(key, value)
  send_command(RequestType::APPEND, [key, value])
end

#decr(key) ⇒ Integer

Decrement the integer value of a key by one.

Examples:

valkey.decr("value")
  # => 4

Parameters:

  • key (String)

Returns:

  • (Integer) —

    value after decrementing it



18
19
20
 
# File 'lib/valkey/commands/string_commands.rb', line 18

def decr(key)
  send_command(RequestType::DECR, [key])
end

#decrby(key, decrement) ⇒ Integer

Decrement the integer value of a key by the given number.

Examples:

valkey.decrby("value", 5)
  # => 0

Parameters:

  • key (String)
  • decrement (Integer)

Returns:

  • (Integer) —

    value after decrementing it



31
32
33
 
# File 'lib/valkey/commands/string_commands.rb', line 31

def decrby(key, decrement)
  send_command(RequestType::DECR_BY, [key, decrement])
end

#get(key) ⇒ String

Get the value of a key.

Parameters:

  • key (String)

Returns:

  • (String) 


195
196
197
 
# File 'lib/valkey/commands/string_commands.rb', line 195

def get(key)
  send_command(RequestType::GET, [key])
end

#getdel(key) ⇒ String

Get the value of key and delete the key. This command is similar to GET, except for the fact that it also deletes the key on success.

Parameters:

  • key (String)

Returns:

  • (String) —

    the old value stored in the key, or ‘nil` if the key did not exist



280
281
282
 
# File 'lib/valkey/commands/string_commands.rb', line 280

def getdel(key)
  send_command(RequestType::GET_DEL, [key])
end

#getex(key, ex: nil, px: nil, exat: nil, pxat: nil, persist: false) ⇒ String

Get the value of key and optionally set its expiration. GETEX is similar to GET, but is a write command with additional options. When no options are provided, GETEX behaves like GET.

Parameters:

  • key (String)
  • options (Hash) —

    • ‘:ex => Integer`: Set the specified expire time, in seconds.

    • ‘:px => Integer`: Set the specified expire time, in milliseconds.

    • ‘:exat => true`: Set the specified Unix time at which the key will

      expire, in seconds.

    • ‘:pxat => true`: Set the specified Unix time at which the key will

      expire, in milliseconds.

    • ‘:persist => true`: Remove the time to live associated with the key.

Returns:

  • (String) —

    The value of key, or nil when key does not exist.



298
299
300
301
302
303
304
305
306
307
 
# File 'lib/valkey/commands/string_commands.rb', line 298

def getex(key, ex: nil, px: nil, exat: nil, pxat: nil, persist: false)
  args = [key]
  args << "EX" << ex if ex
  args << "PX" << px if px
  args << "EXAT" << exat if exat
  args << "PXAT" << pxat if pxat
  args << "PERSIST" if persist

  send_command(RequestType::GET_EX, args)
end

#getrange(key, start, stop) ⇒ Integer

Get a substring of the string stored at a key.

Parameters:

  • key (String)
  • start (Integer) —

    zero-based start offset

  • stop (Integer) —

    zero-based end offset. Use -1 for representing the end of the string

Returns:

  • (Integer) —

    ‘0` or `1`



251
252
253
 
# File 'lib/valkey/commands/string_commands.rb', line 251

def getrange(key, start, stop)
  send_command(RequestType::GET_RANGE, [key, start, stop])
end

#getset(key, value) ⇒ String

Set the string value of a key and return its old value.

Parameters:

  • key (String)
  • value (String) —

    value to replace the current value with

Returns:

  • (String) —

    the old value stored in the key, or ‘nil` if the key did not exist



270
271
272
 
# File 'lib/valkey/commands/string_commands.rb', line 270

def getset(key, value)
  send_command(RequestType::GET_SET, [key, value])
end

#incr(key) ⇒ Integer

Increment the integer value of a key by one.

Examples:

valkey.incr("value")
  # => 6

Parameters:

  • key (String)

Returns:

  • (Integer) —

    value after incrementing it



43
44
45
 
# File 'lib/valkey/commands/string_commands.rb', line 43

def incr(key)
  send_command(RequestType::INCR, [key])
end

#incrby(key, increment) ⇒ Integer

Increment the integer value of a key by the given integer number.

Examples:

valkey.incrby("value", 5)
  # => 10

Parameters:

  • key (String)
  • increment (Integer)

Returns:

  • (Integer) —

    value after incrementing it



56
57
58
 
# File 'lib/valkey/commands/string_commands.rb', line 56

def incrby(key, increment)
  send_command(RequestType::INCR_BY, [key, increment])
end

#incrbyfloat(key, increment) ⇒ Float

Increment the numeric value of a key by the given float number.

Examples:

valkey.incrbyfloat("value", 1.23)
  # => 1.23

Parameters:

  • key (String)
  • increment (Float)

Returns:

  • (Float) —

    value after incrementing it



69
70
71
 
# File 'lib/valkey/commands/string_commands.rb', line 69

def incrbyfloat(key, increment)
  send_command(RequestType::INCR_BY_FLOAT, [key, increment])
end

#lcs(key1, key2, len: nil, idx: nil, min_match_len: nil, with_match_len: nil) ⇒ Object

This command implements longest common subsequence algorithm.

Parameters:

  • key1 (String)
  • key2 (String)
  • len (Integer) (defaults to: nil) —

    length of the longest common subsequence

  • idx (Boolean) (defaults to: nil)
  • min_match_len (Integer) (defaults to: nil) —

    minimum length of the match

  • with_match_len (Boolean) (defaults to: nil)

See Also:



328
329
330
331
332
333
334
335
336
 
# File 'lib/valkey/commands/string_commands.rb', line 328

def lcs(key1, key2, len: nil, idx: nil, min_match_len: nil, with_match_len: nil)
  args = [key1, key2]
  args << "LEN" << len if len
  args << "IDX" if idx
  args << "MINMATCHLEN" << min_match_len if min_match_len
  args << "WITHMATCHLEN" if with_match_len

  send_command(RequestType::LCS, args)
end

#mapped_mget(*keys) ⇒ Hash

Get the values of all the given keys.

Examples:

valkey.mapped_mget("key1", "key2")
  # => { "key1" => "v1", "key2" => "v2" }

Parameters:

  • keys (Array<String>) —

    array of keys

Returns:

  • (Hash) —

    a hash mapping the specified keys to their values

See Also:



224
225
226
227
228
229
230
231
232
 
# File 'lib/valkey/commands/string_commands.rb', line 224

def mapped_mget(*keys)
  mget(*keys) do |reply|
    if reply.is_a?(Array)
      Hash[keys.zip(reply)]
    else
      reply
    end
  end
end

#mapped_mset(hash) ⇒ String

Set one or more values.

Examples:

valkey.mapped_mset({ "f1" => "v1", "f2" => "v2" })
  # => "OK"

Parameters:

  • hash (Hash) —

    keys mapping to values

Returns:

  • (String) —

    ‘“OK”`

See Also:



159
160
161
 
# File 'lib/valkey/commands/string_commands.rb', line 159

def mapped_mset(hash)
  mset(*hash.flatten)
end

#mapped_msetnx(hash) ⇒ Boolean

Set one or more values, only if none of the keys exist.

Examples:

valkey.mapped_msetnx({ "key1" => "v1", "key2" => "v2" })
  # => true

Parameters:

  • hash (Hash) —

    keys mapping to values

Returns:

  • (Boolean) —

    whether or not all values were set

See Also:



187
188
189
 
# File 'lib/valkey/commands/string_commands.rb', line 187

def mapped_msetnx(hash)
  msetnx(*hash.flatten)
end

#mget(*keys, &blk) ⇒ Array<String>

Get the values of all the given keys.

Examples:

valkey.mget("key1", "key2")
  # => ["v1", "v2"]

Parameters:

  • keys (Array<String>)

Returns:

  • (Array<String>) —

    an array of values for the specified keys

See Also:



209
210
211
212
 
# File 'lib/valkey/commands/string_commands.rb', line 209

def mget(*keys, &blk)
  keys.flatten!(1)
  send_command(RequestType::MGET, keys, &blk)
end

#mset(*args) ⇒ String

Set one or more values.

Examples:

valkey.mset("key1", "v1", "key2", "v2")
  # => "OK"

Parameters:

  • args (Array<String>) —

    array of keys and values

Returns:

  • (String) —

    ‘“OK”`

See Also:



145
146
147
 
# File 'lib/valkey/commands/string_commands.rb', line 145

def mset(*args)
  send_command(RequestType::MSET, args)
end

#msetnx(*args) ⇒ Boolean

Set one or more values, only if none of the keys exist.

Examples:

valkey.msetnx("key1", "v1", "key2", "v2")
  # => true

Parameters:

  • args (Array<String>) —

    array of keys and values

Returns:

  • (Boolean) —

    whether or not all values were set

See Also:



173
174
175
 
# File 'lib/valkey/commands/string_commands.rb', line 173

def msetnx(*args)
  send_command(RequestType::MSET_NX, args)
end

#psetex(key, ttl, value) ⇒ String

Set the time to live in milliseconds of a key.

Parameters:

  • key (String)
  • ttl (Integer)
  • value (String)

Returns:

  • (String) —

    ‘“OK”`



122
123
124
 
# File 'lib/valkey/commands/string_commands.rb', line 122

def psetex(key, ttl, value)
  send_command(RequestType::PSET_EX, [key, Integer(ttl), value])
end

#set(key, value, ex: nil, px: nil, exat: nil, pxat: nil, nx: nil, xx: nil, keepttl: nil, get: nil) ⇒ String, Boolean

Set the string value of a key.

Parameters:

  • key (String)
  • value (String)
  • options (Hash) —

    • ‘:ex => Integer`: Set the specified expire time, in seconds.

    • ‘:px => Integer`: Set the specified expire time, in milliseconds.

    • ‘:exat => Integer` : Set the specified Unix time at which the key will expire, in seconds.

    • ‘:pxat => Integer` : Set the specified Unix time at which the key will expire, in milliseconds.

    • ‘:nx => true`: Only set the key if it does not already exist.

    • ‘:xx => true`: Only set the key if it already exist.

    • ‘:keepttl => true`: Retain the time to live associated with the key.

    • ‘:get => true`: Return the old string stored at key, or nil if key did not exist.

Returns:

  • (String, Boolean) —

    ‘“OK”` or true, false if `:nx => true` or `:xx => true`



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/valkey/commands/string_commands.rb', line 87

def set(key, value, ex: nil, px: nil, exat: nil, pxat: nil, nx: nil, xx: nil, keepttl: nil, get: nil)
  args = [key, value]
  args << "EX" << ex if ex
  args << "PX" << px if px
  args << "EXAT" << exat if exat
  args << "PXAT" << pxat if pxat
  args << "NX" if nx
  args << "XX" if xx
  args << "KEEPTTL" if keepttl
  args << "GET" if get

  send_command(RequestType::SET, args)
  # if nx || xx
  #   send_command(RequestType::SET, &Utils::BoolifySet))
  # else
  #   send_command(RequestType::SET, args)
  # end
end

#setex(key, ttl, value) ⇒ String

Set the time to live in seconds of a key.

Parameters:

  • key (String)
  • ttl (Integer)
  • value (String)

Returns:

  • (String) —

    ‘“OK”`



112
113
114
 
# File 'lib/valkey/commands/string_commands.rb', line 112

def setex(key, ttl, value)
  send_command(RequestType::SET_EX, [key, ttl, value])
end

#setnx(key, value) ⇒ Boolean

Set the value of a key, only if the key does not exist.

Parameters:

  • key (String)
  • value (String)

Returns:

  • (Boolean) —

    whether the key was set or not



131
132
133
 
# File 'lib/valkey/commands/string_commands.rb', line 131

def setnx(key, value)
  send_command(RequestType::SET_NX, [key, value])
end

#setrange(key, offset, value) ⇒ Integer

Overwrite part of a string at key starting at the specified offset.

Parameters:

  • key (String)
  • offset (Integer) —

    byte offset

  • value (String)

Returns:

  • (Integer) —

    length of the string after it was modified



240
241
242
 
# File 'lib/valkey/commands/string_commands.rb', line 240

def setrange(key, offset, value)
  send_command(RequestType::SET_RANGE, [key, offset, value])
end

#strlen(key) ⇒ Integer

Get the length of the value stored in a key.

Parameters:

  • key (String)

Returns:

  • (Integer) —

    the length of the value stored in the key, or 0 if the key does not exist



314
315
316
 
# File 'lib/valkey/commands/string_commands.rb', line 314

def strlen(key)
  send_command(RequestType::STRLEN, [key])
end