Class: Moneta::Adapters::TokyoTyrant

Inherits:
Object
  • Object
show all
Includes:
Defaults, HashAdapter
Defined in:
lib/moneta/adapters/tokyotyrant.rb

Overview

TokyoTyrant backend

Constant Summary collapse

ENOREC =

error code: no record found

7

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashAdapter

#clear, #key?

Methods included from Defaults

#[], #[]=, #decrement, #each_key, #features, #fetch, #fetch_values, included, #key?, #merge!, #slice, #supports?, #values_at

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ TokyoTyrant

Returns a new instance of TokyoTyrant

Options Hash (options):

  • :host (String) — default: '127.0.0.1'

    Server host name

  • :port (Integer) — default: 1978

    Server port

  • :backend (::TokyoTyrant::RDB)

    Use existing backend instance


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/moneta/adapters/tokyotyrant.rb', line 27

def initialize(options = {})
  options[:host] ||= '127.0.0.1'
  options[:port] ||= 1978
  if options[:backend]
    @backend = options[:backend]
  elsif defined?(::TokyoTyrant::RDB)
    # Use ruby client
    @backend = ::TokyoTyrant::RDB.new
    @backend.open(options[:host], options[:port]) or error
  else
    # Use native client
    @backend = ::TokyoTyrant::DB.new(options[:host], options[:port])
  end
  @native = @backend.class.name != 'TokyoTyrant::RDB'
  probe = '__tokyotyrant_endianness_probe'
  @backend.delete(probe)
  @backend.addint(probe, 1)
  @pack = @backend.delete(probe) == [1].pack('l>') ? 'l>' : 'l<'
end

Instance Attribute Details

#backendObject (readonly)


21
22
23
# File 'lib/moneta/adapters/tokyotyrant.rb', line 21

def backend
  @backend
end

Instance Method Details

#closeObject

Explicitly close the store


90
91
92
93
# File 'lib/moneta/adapters/tokyotyrant.rb', line 90

def close
  @backend.close
  nil
end

#create(key, value, options = {}) ⇒ Boolean

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically sets a key to value if it's not set.

Options Hash (options):

  • :expires (Integer)

    Update expiration time (See Expires)

  • :raw (Boolean)

    Raw access without value transformation (See Transformer)

  • :prefix (String)

    Prefix key (See Transformer)


76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/moneta/adapters/tokyotyrant.rb', line 76

def create(key, value, options = {})
  if @native
    begin
      # Native client throws an exception
      @backend.putkeep(key, pack(value))
    rescue TokyoTyrantError
      false
    end
  else
    @backend.putkeep(key, pack(value))
  end
end

#delete(key, options = {}) ⇒ Object

Delete the key from the store and return the current value

Options Hash (options):

  • :raw (Boolean)

    Raw access without value transformation (See Transformer)

  • :prefix (String)

    Prefix key (See Transformer)

  • Other (Object)

    options as defined by the adapters or middleware


62
63
64
65
66
67
68
# File 'lib/moneta/adapters/tokyotyrant.rb', line 62

def delete(key, options = {})
  value = load(key, options)
  if value
    @backend.delete(key) or error
    value
  end
end

#increment(key, amount = 1, options = {}) ⇒ Object

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically increment integer value with key

This method also accepts negative amounts.

Options Hash (options):

  • :prefix (String)

    Prefix key (See Transformer)

  • Other (Object)

    options as defined by the adapters or middleware


71
72
73
# File 'lib/moneta/adapters/tokyotyrant.rb', line 71

def increment(key, amount = 1, options = {})
  @backend.addint(key, amount) or error
end

#load(key, options = {}) ⇒ Object

Fetch value with key. Return nil if the key doesn't exist

Options Hash (options):

  • :expires (Integer)

    Update expiration time (See Expires)

  • :raw (Boolean)

    Raw access without value transformation (See Transformer)

  • :prefix (String)

    Prefix key (See Transformer)

  • :sync (Boolean)

    Synchronized load (Cache reloads from adapter, Daybreak syncs with file)

  • Other (Object)

    options as defined by the adapters or middleware


48
49
50
51
52
53
# File 'lib/moneta/adapters/tokyotyrant.rb', line 48

def load(key, options = {})
  value = @backend[key]
  # raise if there is an error and the error is not "no record"
  error if value.nil? && @backend.ecode != ENOREC
  value && unpack(value)
end

#store(key, value, options = {}) ⇒ Object

Store value with key

Options Hash (options):

  • :expires (Integer)

    Set expiration time (See Expires)

  • :raw (Boolean)

    Raw access without value transformation (See Transformer)

  • :prefix (String)

    Prefix key (See Transformer)

  • Other (Object)

    options as defined by the adapters or middleware


56
57
58
59
# File 'lib/moneta/adapters/tokyotyrant.rb', line 56

def store(key, value, options = {})
  @backend.put(key, pack(value)) or error
  value
end