Class: Familia::StringKey
- Includes:
- DataType::ScalarBase
- Defined in:
- lib/familia/data_type/types/stringkey.rb
Instance Attribute Summary collapse
-
#features_enabled ⇒ Object
included
from Features
readonly
Returns the value of attribute features_enabled.
- #logical_database(val = nil) ⇒ Object included from DataType::ClassMethods
-
#parent ⇒ Object
included
from DataType::ClassMethods
Returns the value of attribute parent.
-
#prefix ⇒ Object
included
from DataType::ClassMethods
Returns the value of attribute prefix.
-
#suffix ⇒ Object
included
from DataType::ClassMethods
Returns the value of attribute suffix.
-
#uri(val = nil) ⇒ Object
included
from DataType::ClassMethods
Returns the value of attribute uri.
Attributes included from Settings
#current_key_version, #default_expiration, #delim, #encryption_hkdf_salt, #encryption_hkdf_salt_history, #encryption_keys, #encryption_personalization, #encryption_personalization_history, #logical_database, #prefix, #raise_on_unsaved_parent_write, #schema_path, #schema_validator, #schemas, #strict_write_order, #suffix, #transaction_mode
Class Method Summary collapse
-
.bitop(operation, destkey, *keys, client: nil) ⇒ Integer
Perform bitwise operations between strings and store result.
-
.mget(*keys, client: nil) ⇒ Array
Get values for multiple keys.
-
.mset(hash, client: nil) ⇒ String
Set multiple keys atomically.
-
.msetnx(hash, client: nil) ⇒ Boolean
Set multiple keys only if none of them exist.
Instance Method Summary collapse
- #append(val) ⇒ Object (also: #<<)
-
#bitcount(start_pos = nil, end_pos = nil) ⇒ Integer
Count the number of set bits (population counting).
-
#bitfield(*args) ⇒ Array
Perform bitfield operations on this string.
-
#bitpos(bit, start_pos = nil, end_pos = nil) ⇒ Integer
Find the position of the first bit set to 0 or 1.
-
#char_count ⇒ Integer, Redis::Future
(also: #size, #length)
Returns the number of characters in the stored value.
- #decrement ⇒ Object (also: #decr)
- #decrementby(val) ⇒ Object (also: #decrby)
- #del ⇒ Object
-
#deserialize_value(val) ⇒ Object
StringKey returns raw values (not JSON parsed).
-
#empty? ⇒ Boolean, Redis::Future
Whether the value is missing or empty.
- #getbit(offset) ⇒ Object
-
#getdel ⇒ String?
Atomically get and delete the value.
-
#getex(ex: nil, px: nil, exat: nil, pxat: nil, persist: false) ⇒ String?
Get value and optionally set expiration atomically.
- #getrange(spoint, epoint) ⇒ Object
- #getset(val) ⇒ Object
-
#incrbyfloat(val) ⇒ Float
(also: #incrfloat)
Increment value by a float amount.
- #increment ⇒ Object (also: #incr)
- #incrementby(val) ⇒ Object (also: #incrby)
- #init ⇒ Object
-
#psetex(milliseconds, val) ⇒ String
Set value with expiration in milliseconds.
-
#serialize_value(val) ⇒ Object
StringKey uses raw string serialization (not JSON) because Redis string operations like INCR, DECR, APPEND operate on raw values.
- #setbit(offset, val) ⇒ Object
-
#setex(seconds, val) ⇒ String
Set value with expiration in seconds.
-
#setnx(val) ⇒ Boolean, Redis::Future
True if the key was set, false if it already existed.
- #setrange(offset, val) ⇒ Object
-
#to_i ⇒ Integer
A conversion method, refused inside a block like #to_s.
-
#to_s ⇒ String
Ruby calls to_s implicitly (string interpolation, Array#join, puts) and prints the object's default "#<...>" form when it returns anything but a String, so it cannot hand back a Redis::Future.
-
#value ⇒ String, ...
(also: #content, #get)
The stored value, or the default when one is configured and the key was missing.
- #value=(val) ⇒ Object (also: #replace, #set)
Methods included from DataType::ScalarBase
Methods included from Features::Autoloader
autoload_files, included, normalize_to_config_name
Methods included from DataType::Serialization
#deserialize_values, #deserialize_values_with_nil, #strip_legacy_json_encoding
Methods included from DataType::DatabaseCommands
#current_expiration, #delete!, #echo, #exists?, #expire, #expireat, #move, #persist, #rename, #renamenx, #type
Methods included from DataType::Connection
Methods included from Connection::Behavior
#connect, #create_dbclient, #multi, #normalize_uri, #pipeline, #pipelined, #transaction, #uri=, #url, #url=, #with_connection_scope
Methods included from Settings
#configure, #default_suffix, #dirty_write_warnings, #dirty_write_warnings=, #pipelined_mode, #pipelined_mode=
Methods included from Base
add_feature, #as_json, #expired?, #expires?, find_feature, #generate_id, #to_json, #ttl, #update_expiration, #uuid
Constructor Details
This class inherits a constructor from Familia::DataType
Instance Attribute Details
#features_enabled ⇒ Object (readonly) Originally defined in module Features
Returns the value of attribute features_enabled.
#logical_database(val = nil) ⇒ Object Originally defined in module DataType::ClassMethods
#parent ⇒ Object Originally defined in module DataType::ClassMethods
Returns the value of attribute parent.
#prefix ⇒ Object Originally defined in module DataType::ClassMethods
Returns the value of attribute prefix.
#suffix ⇒ Object Originally defined in module DataType::ClassMethods
Returns the value of attribute suffix.
#uri(val = nil) ⇒ Object Originally defined in module DataType::ClassMethods
Returns the value of attribute uri.
Class Method Details
.bitop(operation, destkey, *keys, client: nil) ⇒ Integer
This method is a raw Redis passthrough and does NOT apply Familia's serialization pipeline or expiration hooks. All key arguments are used as-is (no dbkey prefixing). The destination key will not have a TTL applied automatically.
Perform bitwise operations between strings and store result
337 338 339 340 |
# File 'lib/familia/data_type/types/stringkey.rb', line 337 def bitop(operation, destkey, *keys, client: nil) client ||= Familia.dbclient client.bitop(operation.to_s.upcase, destkey, *keys) end |
.mget(*keys, client: nil) ⇒ Array
This method is a raw Redis passthrough and does NOT apply Familia's
serialization pipeline. Keys are used as-is (no dbkey prefixing) and
returned values are raw Redis strings. If you need round-trip
compatibility with StringKey instances, read via the instance #value
getter or a Familia.dbclient.get(instance.dbkey) call.
Get values for multiple keys
284 285 286 287 |
# File 'lib/familia/data_type/types/stringkey.rb', line 284 def mget(*keys, client: nil) client ||= Familia.dbclient client.mget(*keys) end |
.mset(hash, client: nil) ⇒ String
This method is a raw Redis passthrough and does NOT apply Familia's
serialization pipeline or expiration hooks. Keys are used as-is (no
dbkey prefixing) and values are written as-is. For round-trip
compatibility with StringKey instances, write via the instance
#value= setter (which calls serialize_value and update_expiration).
Set multiple keys atomically. Keys and values are extracted from the hash for the Redis MSET command.
302 303 304 305 |
# File 'lib/familia/data_type/types/stringkey.rb', line 302 def mset(hash, client: nil) client ||= Familia.dbclient client.mset(*hash.flatten) end |
.msetnx(hash, client: nil) ⇒ Boolean
This method is a raw Redis passthrough and does NOT apply Familia's
serialization pipeline or expiration hooks. Keys are used as-is (no
dbkey prefixing) and values are written as-is. For round-trip
compatibility with StringKey instances, write via the instance
#value= setter (which calls serialize_value and update_expiration).
Set multiple keys only if none of them exist. Keys and values are extracted from the hash for the Redis MSETNX command.
320 321 322 323 |
# File 'lib/familia/data_type/types/stringkey.rb', line 320 def msetnx(hash, client: nil) client ||= Familia.dbclient client.msetnx(*hash.flatten) end |
Instance Method Details
#append(val) ⇒ Object Also known as: <<
141 142 143 144 145 |
# File 'lib/familia/data_type/types/stringkey.rb', line 141 def append(val) ret = dbclient.append dbkey, val update_expiration ret end |
#bitcount(start_pos = nil, end_pos = nil) ⇒ Integer
Count the number of set bits (population counting)
228 229 230 231 232 233 234 235 236 |
# File 'lib/familia/data_type/types/stringkey.rb', line 228 def bitcount(start_pos = nil, end_pos = nil) if start_pos && end_pos dbclient.bitcount(dbkey, start_pos, end_pos) elsif start_pos dbclient.bitcount(dbkey, start_pos) else dbclient.bitcount(dbkey) end end |
#bitfield(*args) ⇒ Array
Perform bitfield operations on this string
260 261 262 263 264 |
# File 'lib/familia/data_type/types/stringkey.rb', line 260 def bitfield(*args) ret = dbclient.bitfield(dbkey, *args) update_expiration ret end |
#bitpos(bit, start_pos = nil, end_pos = nil) ⇒ Integer
Find the position of the first bit set to 0 or 1
243 244 245 246 247 248 249 250 251 |
# File 'lib/familia/data_type/types/stringkey.rb', line 243 def bitpos(bit, start_pos = nil, end_pos = nil) if start_pos && end_pos dbclient.bitpos(dbkey, bit, start_pos, end_pos) elsif start_pos dbclient.bitpos(dbkey, bit, start_pos) else dbclient.bitpos(dbkey, bit) end end |
#char_count ⇒ Integer, Redis::Future Also known as: size, length
Returns the number of characters in the stored value.
Reads from #value rather than #to_s: #to_s follows Familia::Base's "never nil" contract and falls back to an inspect-style string (e.g. "#Familia::StringKey:0x...") when there's no value, which made #char_count/#size/#empty? report a nonsense non-zero count for a deleted/never-created key.
43 44 45 |
# File 'lib/familia/data_type/types/stringkey.rb', line 43 def char_count Familia.transform_reply(value) { |val| val.to_s.size } end |
#decrement ⇒ Object Also known as: decr
127 128 129 130 131 |
# File 'lib/familia/data_type/types/stringkey.rb', line 127 def decrement ret = dbclient.decr dbkey update_expiration ret end |
#decrementby(val) ⇒ Object Also known as: decrby
134 135 136 137 138 |
# File 'lib/familia/data_type/types/stringkey.rb', line 134 def decrementby(val) ret = dbclient.decrby dbkey, val.to_i update_expiration ret end |
#del ⇒ Object
266 267 268 269 |
# File 'lib/familia/data_type/types/stringkey.rb', line 266 def del ret = dbclient.del dbkey Familia.positive?(ret) end |
#deserialize_value(val) ⇒ Object
StringKey returns raw values (not JSON parsed)
27 28 29 30 31 |
# File 'lib/familia/data_type/types/stringkey.rb', line 27 def deserialize_value(val) return val if val.is_a?(Redis::Future) return @opts[:default] if val.nil? val end |
#empty? ⇒ Boolean, Redis::Future
Returns whether the value is missing or empty. Inside a transaction or pipeline, the GET Future.
51 52 53 |
# File 'lib/familia/data_type/types/stringkey.rb', line 51 def empty? Familia.transform_reply(char_count, &:zero?) end |
#getbit(offset) ⇒ Object
148 149 150 |
# File 'lib/familia/data_type/types/stringkey.rb', line 148 def getbit(offset) dbclient.getbit dbkey, offset end |
#getdel ⇒ String?
Atomically get and delete the value
176 177 178 |
# File 'lib/familia/data_type/types/stringkey.rb', line 176 def getdel dbclient.getdel(dbkey) end |
#getex(ex: nil, px: nil, exat: nil, pxat: nil, persist: false) ⇒ String?
Get value and optionally set expiration atomically
187 188 189 190 191 192 193 194 195 196 |
# File 'lib/familia/data_type/types/stringkey.rb', line 187 def getex(ex: nil, px: nil, exat: nil, pxat: nil, persist: false) = {} [:ex] = ex if ex [:px] = px if px [:exat] = exat if exat [:pxat] = pxat if pxat [:persist] = persist if persist dbclient.getex(dbkey, **) end |
#getrange(spoint, epoint) ⇒ Object
158 159 160 |
# File 'lib/familia/data_type/types/stringkey.rb', line 158 def getrange(spoint, epoint) dbclient.getrange dbkey, spoint, epoint end |
#getset(val) ⇒ Object
168 169 170 171 172 |
# File 'lib/familia/data_type/types/stringkey.rb', line 168 def getset(val) ret = dbclient.getset dbkey, val update_expiration ret end |
#incrbyfloat(val) ⇒ Float Also known as: incrfloat
Increment value by a float amount
201 202 203 204 205 |
# File 'lib/familia/data_type/types/stringkey.rb', line 201 def incrbyfloat(val) ret = dbclient.incrbyfloat(dbkey, val.to_f) update_expiration ret end |
#increment ⇒ Object Also known as: incr
113 114 115 116 117 |
# File 'lib/familia/data_type/types/stringkey.rb', line 113 def increment ret = dbclient.incr(dbkey) update_expiration ret end |
#incrementby(val) ⇒ Object Also known as: incrby
120 121 122 123 124 |
# File 'lib/familia/data_type/types/stringkey.rb', line 120 def incrementby(val) ret = dbclient.incrby(dbkey, val.to_i) update_expiration ret end |
#init ⇒ Object
9 |
# File 'lib/familia/data_type/types/stringkey.rb', line 9 def init; end |
#psetex(milliseconds, val) ⇒ String
Set value with expiration in milliseconds
220 221 222 |
# File 'lib/familia/data_type/types/stringkey.rb', line 220 def psetex(milliseconds, val) dbclient.psetex(dbkey, milliseconds.to_i, serialize_value(val)) end |
#serialize_value(val) ⇒ Object
StringKey uses raw string serialization (not JSON) because Redis string operations like INCR, DECR, APPEND operate on raw values. This overrides the base JSON serialization from DataType.
14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/familia/data_type/types/stringkey.rb', line 14 def serialize_value(val) Familia.trace :TOREDIS, nil, "#{val}<#{val.class}>" if Familia.debug? # Handle Familia object references - extract identifier if val.is_a?(Familia::Base) || (val.is_a?(Class) && val.ancestors.include?(Familia::Base)) return val.is_a?(Class) ? val.name : val.identifier end # StringKey uses raw string conversion for Redis compatibility val.to_s end |
#setbit(offset, val) ⇒ Object
152 153 154 155 156 |
# File 'lib/familia/data_type/types/stringkey.rb', line 152 def setbit(offset, val) ret = dbclient.setbit dbkey, offset, val update_expiration ret end |
#setex(seconds, val) ⇒ String
Set value with expiration in seconds
212 213 214 |
# File 'lib/familia/data_type/types/stringkey.rb', line 212 def setex(seconds, val) dbclient.setex(dbkey, seconds.to_i, serialize_value(val)) end |
#setnx(val) ⇒ Boolean, Redis::Future
Returns true if the key was set, false if it already existed. Inside a transaction or pipeline, the SETNX Future of that Boolean (the Future itself is always truthy).
107 108 109 110 111 |
# File 'lib/familia/data_type/types/stringkey.rb', line 107 def setnx(val) ret = dbclient.setnx(dbkey, serialize_value(val)) update_expiration ret end |
#setrange(offset, val) ⇒ Object
162 163 164 165 166 |
# File 'lib/familia/data_type/types/stringkey.rb', line 162 def setrange(offset, val) ret = dbclient.setrange dbkey, offset, val update_expiration ret end |
#to_i ⇒ Integer
A conversion method, refused inside a block like #to_s. Use #value to get the GET Future there.
86 87 88 89 90 |
# File 'lib/familia/data_type/types/stringkey.rb', line 86 def to_i Familia.assert_replies_available!('StringKey#to_i') value.to_i end |
#to_s ⇒ String
Ruby calls to_s implicitly (string interpolation, Array#join, puts) and prints the object's default "#<...>" form when it returns anything but a String, so it cannot hand back a Redis::Future. Use #value to get the GET Future inside a block.
74 75 76 77 78 79 |
# File 'lib/familia/data_type/types/stringkey.rb', line 74 def to_s Familia.assert_replies_available!('StringKey#to_s') val = value.to_s val.empty? ? super : val end |
#value ⇒ String, ... Also known as: content, get
Returns the stored value, or the default when one is configured and the key was missing. Inside a transaction or pipeline, the GET Future (resolves to the raw value).
58 59 60 61 62 |
# File 'lib/familia/data_type/types/stringkey.rb', line 58 def value echo :value, Familia.pretty_stack(limit: 1) if Familia.debug dbclient.setnx dbkey, @opts[:default] if @opts[:default] deserialize_value dbclient.get(dbkey) end |
#value=(val) ⇒ Object Also known as: replace, set
This method executes a Redis SET immediately, unlike scalar field setters which are deferred until save. If the parent object has unsaved scalar field changes, consider calling save first to avoid split-brain state.
95 96 97 98 99 100 |
# File 'lib/familia/data_type/types/stringkey.rb', line 95 def value=(val) warn_if_dirty! ret = dbclient.set(dbkey, serialize_value(val)) update_expiration ret end |