Module: Riak

Extended by:
Util::Translation
Defined in:
lib/riak.rb,
lib/riak/crdt.rb,
lib/riak/json.rb,
lib/riak/link.rb,
lib/riak/multi.rb,
lib/riak/stamp.rb,
lib/riak/bucket.rb,
lib/riak/client.rb,
lib/riak/search.rb,
lib/riak/counter.rb,
lib/riak/robject.rb,
lib/riak/version.rb,
lib/riak/conflict.rb,
lib/riak/crdt/map.rb,
lib/riak/crdt/set.rb,
lib/riak/multiget.rb,
lib/riak/rcontent.rb,
lib/riak/crdt/base.rb,
lib/riak/tombstone.rb,
lib/riak/util/gzip.rb,
lib/riak/walk_spec.rb,
lib/riak/map_reduce.rb,
lib/riak/multiexist.rb,
lib/riak/bucket_type.rb,
lib/riak/client/node.rb,
lib/riak/errors/base.rb,
lib/riak/serializers.rb,
lib/riak/time_series.rb,
lib/riak/util/escape.rb,
lib/riak/util/string.rb,
lib/riak/crdt/counter.rb,
lib/riak/list_buckets.rb,
lib/riak/client/search.rb,
lib/riak/preflist_item.rb,
lib/riak/crdt/batch_map.rb,
lib/riak/crdt/inner_map.rb,
lib/riak/crdt/inner_set.rb,
lib/riak/crdt/operation.rb,
lib/riak/client/decaying.rb,
lib/riak/client/yokozuna.rb,
lib/riak/crdt/inner_flag.rb,
lib/riak/secondary_index.rb,
lib/riak/index_collection.rb,
lib/riak/map_reduce/phase.rb,
lib/riak/map_reduce_error.rb,
lib/riak/util/translation.rb,
lib/riak/bucket_properties.rb,
lib/riak/errors/crdt_error.rb,
lib/riak/crdt/batch_counter.rb,
lib/riak/crdt/hyper_log_log.rb,
lib/riak/crdt/inner_counter.rb,
lib/riak/errors/time_series.rb,
lib/riak/map_reduce/results.rb,
lib/riak/bucket_typed/bucket.rb,
lib/riak/crdt/inner_register.rb,
lib/riak/errors/search_error.rb,
lib/riak/crdt/typed_collection.rb,
lib/riak/errors/failed_request.rb,
lib/riak/client/beefcake/socket.rb,
lib/riak/errors/backend_creation.rb,
lib/riak/errors/connection_error.rb,
lib/riak/errors/protobuffs_error.rb,
lib/riak/client/beefcake/messages.rb,
lib/riak/client/beefcake/protocol.rb,
lib/riak/client/feature_detection.rb,
lib/riak/client/protobuffs_backend.rb,
lib/riak/map_reduce/filter_builder.rb,
lib/riak/client/beefcake/crdt_loader.rb,
lib/riak/client/beefcake/crdt_operator.rb,
lib/riak/client/beefcake/message_codes.rb,
lib/riak/client/beefcake/object_methods.rb,
lib/riak/client/beefcake/message_overlay.rb,
lib/riak/client/beefcake_protobuffs_backend.rb

Overview

The Riak module contains all aspects of the client interface to Riak.

Defined Under Namespace

Modules: BucketTyped, Crdt, JSON, PreflistItem, Search, Serializers, TimeSeries, Util Classes: BackendCreationError, BackwardsClockError, Bucket, BucketProperties, BucketType, Client, Conflict, ConnectionError, Counter, CrdtError, Error, FailedRequest, IndexCollection, Link, ListBuckets, MapReduce, MapReduceError, Multi, Multiexist, Multiget, NullLogger, ProtobuffsError, ProtobuffsErrorResponse, ProtobuffsFailedHeader, ProtobuffsFailedRequest, ProtobuffsUnexpectedResponse, RContent, RObject, SearchError, SecondaryIndex, Stamp, TimeSeriesError, TlsError, Tombstone, UserConfigurationError, WalkSpec

Constant Summary collapse

VERSION = 
"2.6.0"

Class Attribute Summary collapse

Method Summary

Methods included from Util::Translation

i18n_scope, t

Class Attribute Details

.disable_list_keys_warnings ⇒ Object

Only change this if you really know what you’re doing. Better to err on the side of caution and assume you don’t.



32
33
34
 
# File 'lib/riak.rb', line 32

def disable_list_keys_warnings
  @disable_list_keys_warnings
end

.escaper ⇒ Object

See Also:

  • #escaper=


7
8
9
 
# File 'lib/riak/util/escape.rb', line 7

def escaper
  @escaper
end

.json_options ⇒ Object

Options that will be passed to the JSON parser and encoder. Defaults to ‘=> 20`



13
14
15
 
# File 'lib/riak/json.rb', line 13

def json_options
  @json_options
end

.logger ⇒ Object

Set a custom logger object (e.g. Riak.logger = Rails.logger)



35
36
37
 
# File 'lib/riak.rb', line 35

def logger
  @logger
end

.url_decoding ⇒ true, false

In Riak 1.0+, buckets and keys are decoded internally before being stored. This increases compatibility with the Protocol Buffers transport and reduces inconsistency of link-walking vs. regular operations. If the node you are connecting to has set ‘on`, set this to true. Default is false.

Returns:

  • (true, false) —

    Whether Riak decodes URL-encoded paths and headers



30
31
32
 
# File 'lib/riak/util/escape.rb', line 30

def url_decoding
  @url_decoding
end