Class: Riak::Client

Inherits:
Object show all
Includes:
Instrumentable, Util::Escape, Util::Translation
Defined in:
lib/riak/client.rb,
lib/riak/client/node.rb,
lib/riak/client/search.rb,
lib/riak/client/yokozuna.rb,
lib/riak/client/decaying.rb,
lib/riak/client/beefcake/socket.rb,
lib/riak/client/instrumentation.rb,
lib/riak/client/feature_detection.rb,
lib/riak/client/beefcake/messages.rb,
lib/riak/client/beefcake/protocol.rb,
lib/riak/client/protobuffs_backend.rb,
lib/riak/client/beefcake/crdt_loader.rb,
lib/riak/client/beefcake/message_codes.rb,
lib/riak/client/beefcake/crdt_operator.rb,
lib/riak/client/beefcake/object_methods.rb,
lib/riak/client/beefcake/message_overlay.rb,
lib/riak/client/beefcake_protobuffs_backend.rb

Overview

A client connection to Riak.

Defined Under Namespace

Modules: BeefcakeMessageCodes, FeatureDetection Classes: BeefcakeProtobuffsBackend, Decaying, Node, ProtobuffsBackend

Constant Summary

MAX_CLIENT_ID =

When using integer client IDs, the exclusive upper-bound of valid values.

4294967296
HOST_REGEX =

Regexp for validating hostnames, lifted from uri.rb in Ruby 1.8.6

/^(?:(?:(?:[a-zA-Z\d](?:[-a-zA-Z\d]*[a-zA-Z\d])?)\.)*(?:[a-zA-Z](?:[-a-zA-Z\d]*[a-zA-Z\d])?)\.?|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|\[(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:(?:[a-fA-F\d]{1,4}:)*[a-fA-F\d]{1,4})?::(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))?)\])$/n
VALID_OPTIONS =

Valid constructor options.

[:nodes, :client_id, :protobuffs_backend, :authentication] | Node::VALID_OPTIONS
NETWORK_ERRORS =

Network errors.

[
  EOFError,
  Errno::ECONNABORTED,
  Errno::ECONNREFUSED,
  Errno::ECONNRESET,
  Errno::ENETDOWN,
  Errno::ENETRESET,
  Errno::ENETUNREACH,
  SocketError,
  SystemCallError,
  Riak::ProtobuffsFailedHeader,
]
Pool =
::Innertube::Pool

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util::Escape

#escape, #maybe_escape, #maybe_unescape, #unescape

Methods included from Util::Translation

#i18n_scope, #t

Constructor Details

#initialize(options = {}) ⇒ Client

Creates a client connection to Riak

Parameters:

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

    configuration options for the client

Options Hash (options):

  • :nodes (Array)

    A list of nodes this client connects to. Each element of the list is a hash which is passed to Node.new, e.g. `'127.0.0.1', pb_port: 1234, …`. If no nodes are given, a single node is constructed from the remaining options given to Client.new.

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

    The host or IP address for the Riak endpoint

  • :pb_port (Fixnum) — default: 8087

    The port of the Riak Protocol Buffers endpoint

  • :client_id (Fixnum, String) — default: rand(MAX_CLIENT_ID)

    The internal client ID used by Riak to route responses

  • :protobuffs_backend (String, Symbol) — default: :Beefcake

    which Protocol Buffers backend to use

Raises:

  • (ArgumentError)

    raised if any invalid options are given



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
# File 'lib/riak/client.rb', line 88

def initialize(options = {})
  if options.include? :port
    warn(t('deprecated.port', :backtrace => caller[0..2].join("\n    ")))
  end

  unless (evil = options.keys - VALID_OPTIONS).empty?
    raise ArgumentError, "#{evil.inspect} are not valid options for Client.new"
  end

  @nodes = (options[:nodes] || []).map do |n|
    Client::Node.new self, n
  end
  if @nodes.empty? or options[:host] or options[:pb_port]
    @nodes |= [Client::Node.new(self, options)]
  end

  @protobuffs_pool = Pool.new(
                              method(:new_protobuffs_backend),
                              lambda { |b| b.teardown }
                              )


  self.protobuffs_backend = options[:protobuffs_backend] || :Beefcake
  self.client_id          = options[:client_id]          if options[:client_id]
  self.multiget_threads   = options[:multiget_threads]
  @authentication         = options[:authentication] && options[:authentication].symbolize_keys
end

Instance Attribute Details

#authenticationHash (readonly)

Returns The authentication information this client will use.

Returns:

  • (Hash)

    The authentication information this client will use.



74
75
76
# File 'lib/riak/client.rb', line 74

def authentication
  @authentication
end

#client_idString

Returns The internal client ID used by Riak to route responses

Returns:

  • (String)

    The internal client ID used by Riak to route responses



62
63
64
# File 'lib/riak/client.rb', line 62

def client_id
  @client_id
end

#multiget_threadsInteger

Returns The number of threads for multiget requests

Returns:

  • (Integer)

    The number of threads for multiget requests



71
72
73
# File 'lib/riak/client.rb', line 71

def multiget_threads
  @multiget_threads
end

#nodesArray

Returns The set of Nodes this client can communicate with.

Returns:

  • (Array)

    The set of Nodes this client can communicate with.



59
60
61
# File 'lib/riak/client.rb', line 59

def nodes
  @nodes
end

#protobuffs_backendSymbol

Returns The Protocol Buffers backend/client to use

Returns:

  • (Symbol)

    The Protocol Buffers backend/client to use



65
66
67
# File 'lib/riak/client.rb', line 65

def protobuffs_backend
  @protobuffs_backend
end

#protobuffs_poolClient::Pool (readonly)

Returns A pool of protobuffs connections

Returns:



68
69
70
# File 'lib/riak/client.rb', line 68

def protobuffs_pool
  @protobuffs_pool
end

Instance Method Details

#bucket(name, options = {}) ⇒ Bucket Also known as: []

Retrieves a bucket from Riak.

Parameters:

  • name (String)

    the bucket to retrieve

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

    options for retrieving the bucket

Options Hash (options):

  • :props (Boolean) — default: false

    whether to retreive the bucket properties

Returns:

  • (Bucket)

    the requested bucket

Raises:

  • (ArgumentError)


127
128
129
130
131
132
133
134
135
136
# File 'lib/riak/client.rb', line 127

def bucket(name, options = {})
  raise ArgumentError, t('zero_length_bucket') if name == ''
  unless (options.keys - [:props]).empty?
    raise ArgumentError, "invalid options"
  end
  @bucket_cache ||= {}
  (@bucket_cache[name] ||= Bucket.new(self, name)).tap do |b|
    b.props if options[:props]
  end
end

#bucket_type(name) ⇒ Object



139
140
141
# File 'lib/riak/client.rb', line 139

def bucket_type(name)
  BucketType.new self, name
end

#buckets(options = {}, &block) ⇒ Array<Bucket> Also known as: list_buckets

Note:

This is an expensive operation and should be used only in development.

Lists buckets which have keys stored in them.

Returns:



147
148
149
150
151
152
153
154
155
# File 'lib/riak/client.rb', line 147

def buckets(options = {}, &block)
  warn(t('list_buckets', :backtrace => caller.join("\n    "))) unless Riak.disable_list_keys_warnings

  return ListBuckets.new self, options, block if block_given?

  backend do |b|
    b.list_buckets(options).map {|name| Bucket.new(self, name) }
  end
end

#choose_node(nodes = self.nodes) ⇒ Object

Choose a node from a set.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/riak/client.rb', line 159

def choose_node(nodes = self.nodes)
  # Prefer nodes which have gone a reasonable time without errors.
  s = nodes.select do |node|
    node.error_rate.value < 0.1
  end

  if s.empty?
    # Fall back to minimally broken node.
    nodes.min_by do |node|
      node.error_rate.value
    end
  else
    s[rand(s.size)]
  end
end

#clear_bucket_props(bucket, options = { }) ⇒ Object

Clears the properties on a bucket. See Bucket#clear_props



396
397
398
399
400
# File 'lib/riak/client.rb', line 396

def clear_bucket_props(bucket, options = {  })
  backend do |b|
    b.reset_bucket_props(bucket, options)
  end
end

#create_search_index(name, schema = nil, n_val = nil, timeout = nil) ⇒ Object

Raises:

  • (ArgumentError)


3
4
5
6
7
8
9
# File 'lib/riak/client/yokozuna.rb', line 3

def create_search_index(name, schema = nil, n_val = nil, timeout = nil)
  raise ArgumentError, t("zero_length_index") if name.nil? || name.empty?
  backend do |b|
    b.create_search_index(name, schema, n_val, timeout)
  end
  true
end

#create_search_schema(name, content) ⇒ Object

Raises:

  • (ArgumentError)


36
37
38
39
40
41
42
43
# File 'lib/riak/client/yokozuna.rb', line 36

def create_search_schema(name, content)
  raise ArgumentError, t("zero_length_schema") if name.nil? || name.empty?
  raise ArgumentError, t("zero_length_content") if content.nil? || content.empty?
  backend do |b|
    b.create_search_schema(name, content)
  end
  true
end

#delete_object(bucket, key, options = {}) ⇒ Object

Delete an object. See Bucket#delete



224
225
226
227
228
# File 'lib/riak/client.rb', line 224

def delete_object(bucket, key, options = {})
  backend do |b|
    b.delete_object(bucket, key, options)
  end
end

#delete_search_index(name) ⇒ Object

Raises:

  • (ArgumentError)


28
29
30
31
32
33
34
# File 'lib/riak/client/yokozuna.rb', line 28

def delete_search_index(name)
  raise ArgumentError, t("zero_length_index") if name.nil? || name.empty?
  backend do |b|
    b.delete_search_index(name)
  end
  true
end

#get_bucket_props(bucket, options = { }) ⇒ Object

Bucket properties. See Bucket#props



231
232
233
234
235
# File 'lib/riak/client.rb', line 231

def get_bucket_props(bucket, options = {  })
  backend do |b|
    b.get_bucket_props bucket, options
  end
end

#get_index(bucket, index, query, options = {}) ⇒ Object

Queries a secondary index on a bucket. See Bucket#get_index



238
239
240
241
242
# File 'lib/riak/client.rb', line 238

def get_index(bucket, index, query, options = {})
  backend do |b|
    b.get_index bucket, index, query, options
  end
end

#get_many(pairs) ⇒ Object

Get multiple objects in parallel.



258
259
260
# File 'lib/riak/client.rb', line 258

def get_many(pairs)
  Multiget.get_all self, pairs
end

#get_object(bucket, key, options = {}) ⇒ Object

Get an object. See Bucket#get

Raises:

  • (ArgumentError)


263
264
265
266
267
268
# File 'lib/riak/client.rb', line 263

def get_object(bucket, key, options = {})
  raise ArgumentError, t("zero_length_key") if key == ''
  backend do |b|
    b.fetch_object(bucket, key, options)
  end
end

#get_preflist(bucket, key, type = nil, options = { }) ⇒ Array<PreflistItem>

Retrieves a preflist for the given bucket, key, and type; useful for figuring out where in the cluster an object is stored.

Parameters:

  • bucket (Bucket, String)

    the Bucket or name of the bucket

  • key (String)

    the key

  • type (BucketType, String) (defaults to: nil)

    the bucket type or name of the bucket type

Returns:



251
252
253
254
255
# File 'lib/riak/client.rb', line 251

def get_preflist(bucket, key, type = nil, options = {  })
  backend do |b|
    b.get_preflist bucket, key, type, options
  end
end

#get_search_index(name) ⇒ Object

Raises:

  • (ArgumentError)


11
12
13
14
15
16
17
18
# File 'lib/riak/client/yokozuna.rb', line 11

def get_search_index(name)
  raise ArgumentError, t("zero_length_index") if name.nil? || name.empty?
  resp = []
  backend do |b|
    resp = b.get_search_index(name)
  end
  resp.index && Array === resp.index ? resp.index.first : resp
end

#get_search_schema(name) ⇒ Object

Raises:

  • (ArgumentError)


45
46
47
48
49
50
# File 'lib/riak/client/yokozuna.rb', line 45

def get_search_schema(name)
  raise ArgumentError, t("zero_length_schema") if name.nil? || name.empty?
  backend do |b|
    return b.get_search_schema(name)
  end
end

#inspectString

Returns A representation suitable for IRB and debugging output.

Returns:

  • (String)

    A representation suitable for IRB and debugging output.



271
272
273
# File 'lib/riak/client.rb', line 271

def inspect
  "#<Riak::Client #{nodes.inspect}>"
end

#list_keys(bucket, options = {}, &block) ⇒ Object

Retrieves a list of keys in the given bucket. See Bucket#keys



276
277
278
279
280
281
282
283
284
285
286
# File 'lib/riak/client.rb', line 276

def list_keys(bucket, options = {}, &block)
  if block_given?
    backend do |b|
      b.list_keys bucket, options, &block
    end
  else
    backend do |b|
      b.list_keys bucket, options
    end
  end
end

#list_search_indexesObject



20
21
22
23
24
25
26
# File 'lib/riak/client/yokozuna.rb', line 20

def list_search_indexes()
  resp = []
  backend do |b|
    resp = b.get_search_index(nil)
  end
  resp.index ? resp.index : resp
end

#mapred(mr, &block) ⇒ Object

Executes a mapreduce request. See MapReduce#run



289
290
291
292
293
# File 'lib/riak/client.rb', line 289

def mapred(mr, &block)
  backend do |b|
    b.mapred(mr, &block)
  end
end

#new_protobuffs_backendProtobuffsBackend

Creates a new protocol buffers backend.

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/riak/client.rb', line 298

def new_protobuffs_backend
  klass = self.class.const_get("#{@protobuffs_backend}ProtobuffsBackend")
  if klass.configured?
    node = choose_node(
      @nodes.select do |n|
        n.protobuffs?
      end
    )

    klass.new(self, node)
  else
    raise BackendCreationError.new @protobuffs_backend
  end
end

#nodeNode

Returns An arbitrary Node.

Returns:

  • (Node)

    An arbitrary Node.



314
315
316
# File 'lib/riak/client.rb', line 314

def node
  nodes[rand nodes.size]
end

#pingtrue, false

Pings the Riak cluster to check for liveness.

Returns:

  • (true, false)

    whether the Riak cluster is alive and reachable



320
321
322
323
324
# File 'lib/riak/client.rb', line 320

def ping
  backend do |b|
    b.ping
  end
end

#protobuffs(&block) ⇒ Object Also known as: backend

Yields a protocol buffers backend.



327
328
329
# File 'lib/riak/client.rb', line 327

def protobuffs(&block)
  recover_from @protobuffs_pool, &block
end

#recover_from(pool) ⇒ Object

Takes a pool. Acquires a backend from the pool and yields it with node-specific error recovery.



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/riak/client.rb', line 342

def recover_from(pool)
  skip_nodes = []
  take_opts = {}
  tries = 3

  begin
    # Only select nodes which we haven't used before.
    unless skip_nodes.empty?
      take_opts[:filter] = lambda do |backend|
        not skip_nodes.include? backend.node
      end
    end

    # Acquire a backend
    pool.take(take_opts) do |backend|
      begin
        yield backend
      rescue *NETWORK_ERRORS => e
        Riak.logger.warn("Riak client error: #{e.inspect} for #{backend.inspect}")

        # Network error.
        tries -= 1

        # Notify the node that a request against it failed.
        backend.node.error_rate << 1

        # Skip this node next time.
        skip_nodes << backend.node

        # And delete this connection.
        raise Pool::BadResource, e
      end
    end
  rescue Pool::BadResource => e
    retry if tries > 0
    raise e.message
  end
end

#reload_object(object, options = {}) ⇒ Object

Reloads the object from Riak.



382
383
384
385
386
# File 'lib/riak/client.rb', line 382

def reload_object(object, options = {})
  backend do |b|
    b.reload_object(object, options)
  end
end

#search(index, query, options = {}) ⇒ Hash #search(query, options = {}) ⇒ Hash Also known as: select

(Riak Search) Performs a search via the Solr interface.

Overloads:

  • #search(index, query, options = {}) ⇒ Hash

    Parameters:

    • index (String)

      the index to query on

    • query (String)

      a Lucene query string

  • #search(query, options = {}) ⇒ Hash

    Queries the default index

    Parameters:

    • query (String)

      a Lucene query string

Parameters:

  • options (Hash)

    extra options for the Solr query

Returns:

  • (Hash)

    the query result, containing the 'responseHeaders' and 'response' keys



18
19
20
21
22
23
24
# File 'lib/riak/client/search.rb', line 18

def search(*args)
  options = args.extract_options!
  index, query = args[-2], args[-1]  # Allows nil index, while keeping it as firstargument
  backend do |b|
    b.search(index, query, options)
  end
end

#security?Boolean

Is security enabled?

Returns:

  • (Boolean)

    whether or not a secure connection is being used



118
119
120
# File 'lib/riak/client.rb', line 118

def security?
  !!authentication
end

#set_bucket_props(bucket, properties, type = nil) ⇒ Object

Sets the properties on a bucket. See Bucket#props=



389
390
391
392
393
# File 'lib/riak/client.rb', line 389

def set_bucket_props(bucket, properties, type = nil)
  backend do |b|
    b.set_bucket_props(bucket, properties, type)
  end
end

#stampStamp

Exposes a Stamp object for use in generating unique identifiers.

Returns:

  • (Stamp)

    an ID generator

See Also:



406
407
408
# File 'lib/riak/client.rb', line 406

def stamp
  @stamp ||= Riak::Stamp.new(self)
end

#store_object(object, options = {}) ⇒ Object

Stores an object in Riak.



412
413
414
415
416
417
# File 'lib/riak/client.rb', line 412

def store_object(object, options = {})
  params = {:returnbody => true}.merge(options)
  backend do |b|
    b.store_object(object, params)
  end
end