Class: Moneta::Adapters::HBase

Inherits:
Moneta::Adapter show all
Defined in:
lib/moneta/adapters/hbase.rb

Overview

HBase thrift backend

Instance Attribute Summary

Attributes inherited from Moneta::Adapter

#backend

Instance Method Summary collapse

Methods inherited from Moneta::Adapter

backend, backend_block, backend_required?

Methods included from Config

#config, included

Methods included from Defaults

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

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ HBase

Returns a new instance of HBase.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

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

    Server host name

  • :port (Integer) — default: 9090 —

    Server port

  • :table (String) — default: 'moneta' —

    Table name

  • :column_family (String) — default: 'moneta' —

    Column family

  • :column (String) — default: 'value' —

    Column

  • :backend (::HBaseRb::Client) —

    Use existing backend instance



26
27
28
29
30
31
 
# File 'lib/moneta/adapters/hbase.rb', line 26

def initialize(options = {})
  super
  @column = [config.column_family, config.column].join(':')
  backend.create_table(config.table, config.column_family) unless backend.has_table?(config.table)
  @table = backend.get_table(config.table)
end

Instance Method Details

#clear(options = {}) ⇒ void

This method returns an undefined value.

Clear all keys in this store

Parameters:

  • options (Hash) (defaults to: {}) 


67
68
69
70
71
72
 
# File 'lib/moneta/adapters/hbase.rb', line 67

def clear(options = {})
  @table.create_scanner do |row|
    @table.delete_row(row.row)
  end
  self
end

#close ⇒ Object

Explicitly close the store

Returns:

  • nil



75
76
77
78
 
# File 'lib/moneta/adapters/hbase.rb', line 75

def close
  backend.close
  nil
end

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

Delete the key from the store and return the current value

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

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

Returns:

  • (Object) —

    current value



59
60
61
62
63
64
 
# File 'lib/moneta/adapters/hbase.rb', line 59

def delete(key, options = {})
  if value = load(key, options)
    @table.delete_row(key)
    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.

Parameters:

  • key (Object)
  • amount (Integer) (defaults to: 1)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    value from store



51
52
53
54
55
56
 
# File 'lib/moneta/adapters/hbase.rb', line 51

def increment(key, amount = 1, options = {})
  result = @table.atomic_increment(key, @column, amount)
  # HACK: Throw error if applied to invalid value
  Integer(load(key)) if result == 0
  result
end

#key?(key, options = {}) ⇒ Boolean

Exists the value with key

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Update expiration time (See Expires)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/moneta/adapters/hbase.rb', line 34

def key?(key, options = {})
  @table.get(key, @column).first != nil
end

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

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

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

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

Returns:

  • (Object) —

    value



39
40
41
42
 
# File 'lib/moneta/adapters/hbase.rb', line 39

def load(key, options = {})
  cell = @table.get(key, @column).first
  cell && unpack(cell.value)
end

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

Store value with key

Parameters:

  • key (Object)
  • value (Object)
  • options (Hash) (defaults to: {})

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

Returns:

  • value



45
46
47
48
 
# File 'lib/moneta/adapters/hbase.rb', line 45

def store(key, value, options = {})
  @table.mutate_row(key, @column => pack(value))
  value
end