module Redis::Commands::Strings
def append(key, value)
-
(Integer)
- length of the string after appending
Parameters:
-
value
(String
) -- value to append -
key
(String
) --
def append(key, value) send_command([:append, key, value]) end
def decr(key)
-
(Integer)
- value after decrementing it
Parameters:
-
key
(String
) --
def decr(key) send_command([:decr, key]) end
def decrby(key, decrement)
-
(Integer)
- value after decrementing it
Parameters:
-
decrement
(Integer
) -- -
key
(String
) --
def decrby(key, decrement) send_command([:decrby, key, decrement]) end
def get(key)
-
(String)
-
Parameters:
-
key
(String
) --
def get(key) send_command([:get, key]) end
def getdel(key)
-
(String)
- the old value stored in the key, or `nil` if the key
Parameters:
-
key
(String
) --
def getdel(key) send_command([:getdel, key]) end
def getex(key, ex: nil, px: nil, exat: nil, pxat: nil, persist: false)
-
(String)
- The value of key, or nil when key does not exist.
Parameters:
-
options
(Hash
) -- -
key
(String
) --
def getex(key, ex: nil, px: nil, exat: nil, pxat: nil, persist: false) args = [:getex, 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(args) end
def getrange(key, start, stop)
-
(Integer)
- `0` or `1`
Parameters:
-
stop
(Integer
) -- zero-based end offset. Use -1 for representing -
start
(Integer
) -- zero-based start offset -
key
(String
) --
def getrange(key, start, stop) send_command([:getrange, key, start, stop]) end
def getset(key, value)
-
(String)
- the old value stored in the key, or `nil` if the key
Parameters:
-
value
(String
) -- value to replace the current value with -
key
(String
) --
def getset(key, value) send_command([:getset, key, value.to_s]) end
def incr(key)
-
(Integer)
- value after incrementing it
Parameters:
-
key
(String
) --
def incr(key) send_command([:incr, key]) end
def incrby(key, increment)
-
(Integer)
- value after incrementing it
Parameters:
-
increment
(Integer
) -- -
key
(String
) --
def incrby(key, increment) send_command([:incrby, key, increment]) end
def incrbyfloat(key, increment)
-
(Float)
- value after incrementing it
Parameters:
-
increment
(Float
) -- -
key
(String
) --
def incrbyfloat(key, increment) send_command([:incrbyfloat, key, increment], &Floatify) end
def mapped_mget(*keys)
- See: #mget -
Returns:
-
(Hash)
- a hash mapping the specified keys to their values
Parameters:
-
keys
(Array
) -- array of keys
def mapped_mget(*keys) mget(*keys) do |reply| if reply.is_a?(Array) Hash[keys.zip(reply)] else reply end end end
def mapped_mset(hash)
- See: #mset -
Returns:
-
(String)
- `"OK"`
Parameters:
-
hash
(Hash
) -- keys mapping to values
def mapped_mset(hash) mset(hash.to_a.flatten) end
def mapped_msetnx(hash)
- See: #msetnx -
Returns:
-
(Boolean)
- whether or not all values were set
Parameters:
-
hash
(Hash
) -- keys mapping to values
def mapped_msetnx(hash) msetnx(hash.to_a.flatten) end
def mget(*keys, &blk)
- See: #mapped_mget -
Returns:
-
(Array
- an array of values for the specified keys)
Parameters:
-
keys
(Array
) --
def mget(*keys, &blk) send_command([:mget, *keys], &blk) end
def mset(*args)
- See: #mapped_mset -
Returns:
-
(String)
- `"OK"`
Parameters:
-
args
(Array
) -- array of keys and values
def mset(*args) send_command([:mset] + args) end
def msetnx(*args)
- See: #mapped_msetnx -
Returns:
-
(Boolean)
- whether or not all values were set
Parameters:
-
args
(Array
) -- array of keys and values
def msetnx(*args) send_command([:msetnx, *args], &Boolify) end
def psetex(key, ttl, value)
-
(String)
- `"OK"`
Parameters:
-
value
(String
) -- -
ttl
(Integer
) -- -
key
(String
) --
def psetex(key, ttl, value) send_command([:psetex, key, ttl, value.to_s]) end
def set(key, value, ex: nil, px: nil, exat: nil, pxat: nil, nx: nil, xx: nil, keepttl: nil, get: nil)
-
(String, Boolean)
- `"OK"` or true, false if `:nx => true` or `:xx => true`
Parameters:
-
options
(Hash
) -- -
value
(String
) -- -
key
(String
) --
def set(key, value, ex: nil, px: nil, exat: nil, pxat: nil, nx: nil, xx: nil, keepttl: nil, get: nil) args = [:set, key, value.to_s] 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 if nx || xx send_command(args, &BoolifySet) else send_command(args) end end
def setex(key, ttl, value)
-
(String)
- `"OK"`
Parameters:
-
value
(String
) -- -
ttl
(Integer
) -- -
key
(String
) --
def setex(key, ttl, value) send_command([:setex, key, ttl, value.to_s]) end
def setnx(key, value)
-
(Boolean)
- whether the key was set or not
Parameters:
-
value
(String
) -- -
key
(String
) --
def setnx(key, value) send_command([:setnx, key, value.to_s], &Boolify) end
def setrange(key, offset, value)
-
(Integer)
- length of the string after it was modified
Parameters:
-
value
(String
) -- -
offset
(Integer
) -- byte offset -
key
(String
) --
def setrange(key, offset, value) send_command([:setrange, key, offset, value.to_s]) end
def strlen(key)
-
(Integer)
- the length of the value stored in the key, or 0
Parameters:
-
key
(String
) --
def strlen(key) send_command([:strlen, key]) end