1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
|
require 'active_record'
module Moneta
module Adapters
# ActiveRecord as key/value stores
# @api public
class ActiveRecord < Adapter
autoload :V5Backend, 'moneta/adapters/activerecord/v5_backend'
autoload :Backend, 'moneta/adapters/activerecord/backend'
@table_create_lock = ::Mutex.new
class << self
attr_reader :table_create_lock
end
supports :create, :increment, :each_key
attr_reader :table
delegate :connection_pool, to: :@backend
delegate :with_connection, to: :connection_pool
config :key_column, default: :k
config :value_column, default: :v
backend do |table: :moneta, create_table: true, **options|
# Ensure the table name is a symbol.
table_name = table.to_sym
backend =
if ::ActiveRecord.version < ::Gem::Version.new('6.0.0')
::Moneta::Adapters::ActiveRecord::V5Backend.new(table: table_name, **options)
else
::Moneta::Adapters::ActiveRecord::Backend.new(table: table_name, **options)
end
case create_table
when Proc
backend.connection_pool.with_connection(&create_table)
when true
backend.connection_pool.with_connection do |conn|
default_create_table(conn, table_name)
end
end
backend
end
# @param [Hash] options
# @option options [Object] :backend A class object inheriting from ActiveRecord::Base to use as a table
# @option options [String,Symbol] :table (:moneta) Table name
# @option options [Hash/String/Symbol] :connection ActiveRecord connection configuration (`Hash` or `String`), or
# symbol giving the name of a Rails connection (e.g. :production)
# @option options [Proc, Boolean] :create_table Proc called with a connection if table
# needs to be created. Pass false to skip the create table check all together.
# @option options [Symbol] :key_column (:k) The name of the column to use for keys
# @option options [Symbol] :value_column (:v) The name of the column to use for values
def initialize(options = {})
super
@table = ::Arel::Table.new(backend.table_name)
end
# (see Proxy#key?)
def key?(key, options = {})
with_connection do |conn|
sel = arel_sel_key(key).project(::Arel.sql('1'))
result = conn.select_all(sel)
!result.empty?
end
end
# (see Proxy#each_key)
def each_key(&block)
with_connection do |conn|
return enum_for(:each_key) { conn.select_value(arel_sel.project(table[config.key_column].count)) } unless block_given?
conn.select_values(arel_sel.project(table[config.key_column])).each { |k| yield(k) }
end
self
end
# (see Proxy#load)
def load(key, options = {})
with_connection do |conn|
conn_sel_value(conn, key)
end
end
# (see Proxy#store)
def store(key, value, options = {})
with_connection do |conn|
encoded = encode(conn, value)
conn_ins(conn, key, encoded) unless conn_upd(conn, key, encoded) == 1
end
value
end
# (see Proxy#delete)
def delete(key, options = {})
with_connection do |conn|
conn.transaction do
sel = arel_sel_key(key).project(table[config.value_column]).lock
value = decode(conn, conn.select_value(sel))
del = arel_del.where(table[config.key_column].eq(key))
conn.delete(del)
value
end
end
end
# (see Proxy#increment)
def increment(key, amount = 1, options = {})
with_connection do |conn|
conn_ins(conn, key, amount.to_s)
amount
rescue ::ActiveRecord::RecordNotUnique
conn.transaction do
sel = arel_sel_key(key).project(table[config.value_column]).lock
value = decode(conn, conn.select_value(sel))
value = (value ? Integer(value) : 0) + amount
# Re-raise if the upate affects no rows (i.e. row deleted after attempted insert,
# before select for update)
raise unless conn_upd(conn, key, value.to_s) == 1
value
end
end
rescue ::ActiveRecord::RecordNotUnique, ::ActiveRecord::Deadlocked
# This handles the "no row updated" issue, above, as well as deadlocks
# which may occur on some adapters
tries ||= 0
(tries += 1) <= 3 ? retry : raise
end
# (see Proxy#create)
def create(key, value, options = {})
with_connection do |conn|
conn_ins(conn, key, value)
true
end
rescue ::ActiveRecord::RecordNotUnique
false
end
# (see Proxy#clear)
def clear(options = {})
with_connection do |conn|
conn.delete(arel_del)
end
self
end
# (see Proxy#close)
def close
@table = nil
@connection_pool = nil
end
# (see Proxy#slice)
def slice(*keys, lock: false, **options)
with_connection do |conn|
conn.create_table(:slice_keys, temporary: true) do |t|
t.string :key, null: false
end
begin
temp_table = ::Arel::Table.new(:slice_keys)
keys.each do |key|
conn.insert ::Arel::InsertManager.new
.into(temp_table)
.insert([[temp_table[:key], key]])
end
sel = arel_sel
.join(temp_table)
.on(table[config.key_column].eq(temp_table[:key]))
.project(table[config.key_column], table[config.value_column])
sel = sel.lock if lock
result = conn.select_all(sel)
k = config.key_column.to_s
v = config.value_column.to_s
result.map do |row|
[row[k], decode(conn, row[v])]
end
ensure
conn.drop_table(:slice_keys)
end
end
end
# (see Proxy#values_at)
def values_at(*keys, **options)
hash = Hash[slice(*keys, **options)]
keys.map { |key| hash[key] }
end
# (see Proxy#fetch_values)
def fetch_values(*keys, **options)
return values_at(*keys, **options) unless block_given?
hash = Hash[slice(*keys, **options)]
keys.map do |key|
if hash.key?(key)
hash[key]
else
yield key
end
end
end
# (see Proxy#merge!)
def merge!(pairs, options = {})
with_connection do |conn|
conn.transaction do
existing = Hash[slice(*pairs.map { |k, _| k }, lock: true, **options)]
update_pairs, insert_pairs = pairs.partition { |k, _| existing.key?(k) }
insert_pairs.each { |key, value| conn_ins(conn, key, encode(conn, value)) }
if block_given?
update_pairs.map! do |key, new_value|
[key, yield(key, existing[key], new_value)]
end
end
update_pairs.each { |key, value| conn_upd(conn, key, encode(conn, value)) }
end
end
self
end
private
def default_create_table(conn, table_name)
# From 6.1, we can use the `if_not_exists?` check
if ::ActiveRecord.version < ::Gem::Version.new('6.1.0')
return if conn.table_exists?(table_name)
# Prevent multiple connections from attempting to create the table simultaneously.
self.class.table_create_lock.synchronize do
conn.create_table(table_name, id: false) do |t|
# Do not use binary key (Issue #17)
t.string config.key_column, null: false
t.binary config.value_column
end
conn.add_index(table_name, config.key_column, unique: true)
end
else
conn.create_table(table_name, id: false, if_not_exists: true) do |t|
# Do not use binary key (Issue #17)
t.string config.key_column, null: false
t.binary config.value_column
end
conn.add_index(table_name, config.key_column, unique: true, if_not_exists: true)
end
end
def arel_del
::Arel::DeleteManager.new.from(table)
end
def arel_sel
::Arel::SelectManager.new.from(table)
end
def arel_upd
::Arel::UpdateManager.new.table(table)
end
def arel_sel_key(key)
arel_sel.where(table[config.key_column].eq(key))
end
def conn_ins(conn, key, value)
ins = ::Arel::InsertManager.new.into(table)
ins.insert([[table[config.key_column], key], [table[config.value_column], value]])
conn.insert ins
end
def conn_upd(conn, key, value)
conn.update arel_upd.where(table[config.key_column].eq(key)).set([[table[config.value_column], value]])
end
def conn_sel_value(conn, key)
decode(conn, conn.select_value(arel_sel_key(key).project(table[config.value_column])))
end
def encode(conn, value)
if value == nil
nil
elsif conn.respond_to?(:escape_bytea)
conn.escape_bytea(value)
elsif defined?(::ActiveRecord::ConnectionAdapters::SQLite3Adapter) &&
conn.is_a?(::ActiveRecord::ConnectionAdapters::SQLite3Adapter)
Arel::Nodes::SqlLiteral.new("X'#{value.unpack1('H*')}'")
else
value
end
end
def decode(conn, value)
if value == nil
nil
elsif defined?(::ActiveModel::Type::Binary::Data) &&
value.is_a?(::ActiveModel::Type::Binary::Data)
value.to_s
elsif conn.respond_to?(:unescape_bytea)
conn.unescape_bytea(value)
else
value
end
end
end
end
end
|