riak-client 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f90dfc4b139c8163f6ece74ae945836171b027ce
-  data.tar.gz: b50c5fca9297a65ed3a3317029cdbc0b04634225
+  metadata.gz: 8eb1ae6b34bdb0bc9e7ace398e001f570dfe0782
+  data.tar.gz: f4b53df09ae0c37710f74bc6fa4bb2bc2e47e82e
 SHA512:
-  metadata.gz: 327cac82dd8a9e4ba701c250d7306f9bd57bb56dd5588a6fc67bceb8dc5a2355c1d601e627d439000c94852d25215d11abe5845ee1231a9a98070b02befc7612
-  data.tar.gz: af4e75b2f268d4d21654e19579f64c47cc368b19596359f4fca528af21a5a66aca94824e073c63e41794940bc99168b200abd506b822df77d63de75ab34c17a5
+  metadata.gz: 9bb8412b0efd79d81d486a87302c0985e59420d7d1a2d1cd9119f60afef9dbffbed2fc19a003c4e31917080c14816830545d3bcebab200d23b0f6ab0e8c3374f
+  data.tar.gz: 3ffebec87cfddc2ddd8422785f49e9814452ed94720c27d8666ff815e224f072c046302741c34d2b77aa4026f872a1e928cd25f7a4b93a901367518ad83a3b13

data/.rspec

@@ -1 +1,2 @@
 --color
+-fd

data/RELEASE_NOTES.md

@@ -1,5 +1,21 @@
 # Riak Ruby Client Release Notes
 
+## 2.3.0 Release - 2015-12-15
+
+Version 2.3.0 is a feature release, introducing support for the Riak TS time
+series database.
+
+New features:
+
+* Riak TS support, for queries, reads, writes, and deletes. Key list support
+is also provided.
+* Network error logging, thanks to Sebastian Röbke.
+
+Bug fixes:
+
+* The `last_modified` field on `RContent` and `RObject` objects now has
+microsecond precision, thanks to Sebastian Röbke.
+
 ## 2.2.2 Release - 2015-11-24
 
 Version 2.2.2 is a bugfix release.

data/Rakefile

@@ -90,7 +90,7 @@ task :pb_defs => 'beefcake:pb_defs'
 namespace :beefcake do
   task :pb_defs => 'lib/riak/client/beefcake/messages.rb'
 
-  PROTO_FILES = %w{riak_kv riak_search riak_yokozuna riak_dt}
+  PROTO_FILES = %w{riak_kv riak_search riak_yokozuna riak_dt riak_ts}
   PROTO_TMP = PROTO_FILES.map{|f| "tmp/#{f}.pb.rb"}
 
   task :clean do
@@ -113,7 +113,8 @@ namespace :beefcake do
 
   directory 'tmp/riak_pb' => 'tmp' do
     cd 'tmp' do
-      sh "git clone -b develop https://github.com/basho/riak_pb.git"
+      # NB: change this once TS is published
+      sh "git clone -b end-to-end/timeseries https://github.com/basho/riak_pb.git"
     end
   end
 end

data/lib/riak/client/beefcake/message_codes.rb

@@ -68,6 +68,18 @@ module Riak
         :DtUpdateReq => 82,
         :DtUpdateResp => 83,
 
+        # riak time series
+        :TsQueryReq => 90,
+        :TsQueryResp => 91,
+        :TsPutReq => 92,
+        :TsPutResp => 93,
+        :TsDelReq => 94,
+        :TsDelResp => 95,
+        :TsGetReq => 96,
+        :TsGetResp => 97,
+        :TsListKeysReq => 98,
+        :TsListKeysResp => 99,
+
         # internal
         :AuthReq => 253,
         :AuthResp => 254,

data/lib/riak/client/beefcake/messages.rb

@@ -4,7 +4,7 @@ module Riak
   class Client
     # @private
     class BeefcakeProtobuffsBackend
-## Generated from riak.proto for
+## Generated from riak.proto
 require "beefcake"
 
 
@@ -67,6 +67,14 @@ class RpbAuthReq
   include Beefcake::Message
 end
 
+class RpbToggleEncodingReq
+  include Beefcake::Message
+end
+
+class RpbToggleEncodingResp
+  include Beefcake::Message
+end
+
 class RpbErrorResp
   required :errmsg, :bytes, 1
   required :errcode, :uint32, 2
@@ -156,7 +164,15 @@ class RpbAuthReq
   required :user, :bytes, 1
   required :password, :bytes, 2
 end
-## Generated from riak_kv.proto for
+
+class RpbToggleEncodingReq
+  required :use_native, :bool, 1
+end
+
+class RpbToggleEncodingResp
+  required :use_native, :bool, 1
+end
+## Generated from riak_kv.proto
 require "beefcake"
 
 
@@ -225,6 +241,10 @@ class RpbIndexResp
   include Beefcake::Message
 end
 
+class RpbIndexBodyResp
+  include Beefcake::Message
+end
+
 class RpbCSBucketReq
   include Beefcake::Message
 end
@@ -273,6 +293,18 @@ class RpbBucketKeyPreflistItem
   include Beefcake::Message
 end
 
+class RpbCoverageReq
+  include Beefcake::Message
+end
+
+class RpbCoverageResp
+  include Beefcake::Message
+end
+
+class RpbCoverageEntry
+  include Beefcake::Message
+end
+
 class RpbGetClientIdResp
   required :client_id, :bytes, 1
 end
@@ -392,6 +424,8 @@ class RpbIndexReq
   optional :type, :bytes, 12
   optional :term_regex, :bytes, 13
   optional :pagination_sort, :bool, 14
+  optional :cover_context, :bytes, 15
+  optional :return_body, :bool, 16
 end
 
 class RpbIndexResp
@@ -401,6 +435,12 @@ class RpbIndexResp
   optional :done, :bool, 4
 end
 
+class RpbIndexBodyResp
+  repeated :objects, RpbIndexObject, 1
+  optional :continuation, :bytes, 2
+  optional :done, :bool, 3
+end
+
 class RpbCSBucketReq
   required :bucket, :bytes, 1
   required :start_key, :bytes, 2
@@ -411,6 +451,7 @@ class RpbCSBucketReq
   optional :max_results, :uint32, 7
   optional :timeout, :uint32, 8
   optional :type, :bytes, 9
+  optional :cover_context, :bytes, 10
 end
 
 class RpbCSBucketResp
@@ -486,7 +527,26 @@ class RpbBucketKeyPreflistItem
   required :node, :bytes, 2
   required :primary, :bool, 3
 end
-## Generated from riak_search.proto for
+
+class RpbCoverageReq
+  optional :type, :bytes, 1
+  required :bucket, :bytes, 2
+  optional :min_partitions, :uint32, 3
+  optional :replace_cover, :bytes, 4
+  repeated :unavailable_cover, :bytes, 5
+end
+
+class RpbCoverageResp
+  repeated :entries, RpbCoverageEntry, 1
+end
+
+class RpbCoverageEntry
+  required :ip, :bytes, 1
+  required :port, :uint32, 2
+  optional :keyspace_desc, :bytes, 3
+  required :cover_context, :bytes, 4
+end
+## Generated from riak_search.proto
 require "beefcake"
 
 
@@ -524,7 +584,7 @@ class RpbSearchQueryResp
   optional :max_score, :float, 2
   optional :num_found, :uint32, 3
 end
-## Generated from riak_yokozuna.proto for
+## Generated from riak_yokozuna.proto
 require "beefcake"
 
 
@@ -603,7 +663,7 @@ end
 class RpbYokozunaSchemaGetResp
   required :schema, RpbYokozunaSchema, 1
 end
-## Generated from riak_dt.proto for
+## Generated from riak_dt.proto
 require "beefcake"
 
 
@@ -766,6 +826,146 @@ class DtUpdateResp
   repeated :set_value, :bytes, 4
   repeated :map_value, MapEntry, 5
 end
+## Generated from riak_ts.proto
+require "beefcake"
+
+
+module TsColumnType
+  VARCHAR = 0
+  SINT64 = 1
+  DOUBLE = 2
+  TIMESTAMP = 3
+  BOOLEAN = 4
+end
+
+class TsQueryReq
+  include Beefcake::Message
+end
+
+class TsQueryResp
+  include Beefcake::Message
+end
+
+class TsGetReq
+  include Beefcake::Message
+end
+
+class TsGetResp
+  include Beefcake::Message
+end
+
+class TsPutReq
+  include Beefcake::Message
+end
+
+class TsPutResp
+  include Beefcake::Message
+end
+
+class TsDelReq
+  include Beefcake::Message
+end
+
+class TsDelResp
+  include Beefcake::Message
+end
+
+class TsInterpolation
+  include Beefcake::Message
+end
+
+class TsColumnDescription
+  include Beefcake::Message
+end
+
+class TsRow
+  include Beefcake::Message
+end
+
+class TsCell
+  include Beefcake::Message
+end
+
+class TsListKeysReq
+  include Beefcake::Message
+end
+
+class TsListKeysResp
+  include Beefcake::Message
+end
+
+class TsQueryReq
+  optional :query, TsInterpolation, 1
+  optional :stream, :bool, 2, :default => false
+end
+
+class TsQueryResp
+  repeated :columns, TsColumnDescription, 1
+  repeated :rows, TsRow, 2
+  optional :done, :bool, 3, :default => true
+end
+
+class TsGetReq
+  required :table, :bytes, 1
+  repeated :key, TsCell, 2
+  optional :timeout, :uint32, 3
+end
+
+class TsGetResp
+  repeated :columns, TsColumnDescription, 1
+  repeated :rows, TsRow, 2
+end
+
+class TsPutReq
+  required :table, :bytes, 1
+  repeated :columns, TsColumnDescription, 2
+  repeated :rows, TsRow, 3
+end
+
+class TsPutResp
+end
+
+class TsDelReq
+  required :table, :bytes, 1
+  repeated :key, TsCell, 2
+  optional :vclock, :bytes, 3
+  optional :timeout, :uint32, 4
+end
+
+class TsDelResp
+end
+
+class TsInterpolation
+  required :base, :bytes, 1
+  repeated :interpolations, RpbPair, 2
+end
+
+class TsColumnDescription
+  required :name, :bytes, 1
+  required :type, TsColumnType, 2
+end
+
+class TsRow
+  repeated :cells, TsCell, 1
+end
+
+class TsCell
+  optional :varchar_value, :bytes, 1
+  optional :sint64_value, :sint64, 2
+  optional :timestamp_value, :sint64, 3
+  optional :boolean_value, :bool, 4
+  optional :double_value, :double, 5
+end
+
+class TsListKeysReq
+  required :table, :bytes, 1
+  optional :timeout, :uint32, 2
+end
+
+class TsListKeysResp
+  repeated :keys, TsRow, 1
+  optional :done, :bool, 2
+end
 
     end
   end

data/lib/riak/client/beefcake/object_methods.rb

@@ -49,8 +49,7 @@ module Riak
             pbuf.indexes.each {|pair| decode_index(pair, rcontent.indexes) }
           end
           if pbuf.last_mod.present?
-            rcontent.last_modified = Time.at(pbuf.last_mod)
-            rcontent.last_modified += pbuf.last_mod_usecs / 1000000 if pbuf.last_mod_usecs.present?
+            rcontent.last_modified = Time.at(pbuf.last_mod, pbuf.last_mod_usecs || 0)
           end
           rcontent
         end

data/lib/riak/client/beefcake/operator.rb

@@ -0,0 +1,9 @@
+class Riak::Client::BeefcakeProtobuffsBackend
+  class Operator
+    attr_reader :backend
+
+    def initialize(backend)
+      @backend = backend
+    end
+  end
+end

data/lib/riak/client/beefcake/time_series_delete_operator.rb

@@ -0,0 +1,24 @@
+require_relative './ts_cell_codec'
+require_relative './operator'
+
+class Riak::Client::BeefcakeProtobuffsBackend
+  def time_series_delete_operator
+    TimeSeriesDeleteOperator.new(self)
+  end
+
+  class TimeSeriesDeleteOperator < Operator
+    def delete(table_name, key_components, options = {})
+      codec = TsCellCodec.new
+
+      request_options = options.merge(table: table_name,
+                                      key: codec.cells_for(key_components))
+
+      request = TsDelReq.new request_options
+
+      backend.protocol do |p|
+        p.write :TsDelReq, request
+        p.expect :TsDelResp, TsDelResp, empty_body_acceptable: true
+      end
+    end
+  end
+end

data/lib/riak/client/beefcake/time_series_get_operator.rb

@@ -0,0 +1,35 @@
+require_relative './ts_cell_codec'
+require_relative './operator'
+
+class Riak::Client::BeefcakeProtobuffsBackend
+  def time_series_get_operator
+    TimeSeriesGetOperator.new(self)
+  end
+
+  class TimeSeriesGetOperator < Operator
+    def get(table_name, key_components, options = {})
+      codec = TsCellCodec.new
+
+      request_options = options.merge(table: table_name,
+                                      key: codec.cells_for(key_components))
+
+      request = TsGetReq.new request_options
+
+      result = begin
+        backend.protocol do |p|
+          p.write :TsGetReq, request
+          result = p.expect :TsGetResp, TsGetResp, empty_body_acceptable: true
+        end
+      rescue Riak::ProtobuffsErrorResponse => e
+        raise unless e.code == 10
+        return nil
+      end
+
+      return nil if result == :empty
+
+      Riak::TimeSeries::Collection.new(result.rows.map do |row|
+        Riak::TimeSeries::Row.new codec.scalars_for row.cells
+      end.to_a)
+    end
+  end
+end

data/lib/riak/client/beefcake/time_series_list_operator.rb

@@ -0,0 +1,42 @@
+require_relative './ts_cell_codec'
+require_relative './operator'
+
+class Riak::Client::BeefcakeProtobuffsBackend
+  def time_series_list_operator
+    TimeSeriesListOperator.new(self)
+  end
+
+  class TimeSeriesListOperator < Operator
+    def list(table_name, block, options = {  })
+      request = TsListKeysReq.new options.merge(table: table_name)
+
+      return streaming_list_keys(request, &block) unless block.nil?
+
+      Riak::TimeSeries::Collection.new.tap do |key_buffer|
+        streaming_list_keys(request) do |key_row|
+          key_buffer << key_row
+        end
+      end
+    end
+
+    private
+
+    def streaming_list_keys(request)
+      backend.protocol do |p|
+        p.write :TsListKeysReq, request
+
+        codec = TsCellCodec.new
+
+        while resp = p.expect(:TsListKeysResp, TsListKeysResp)
+          break if resp.done
+          resp.keys.each do |row|
+            key_fields = codec.scalars_for row.cells
+            yield key_fields
+          end
+        end
+      end
+
+      true
+    end
+  end
+end

data/lib/riak/client/beefcake/time_series_put_operator.rb

@@ -0,0 +1,32 @@
+require_relative './ts_cell_codec'
+require_relative './operator'
+
+class Riak::Client::BeefcakeProtobuffsBackend
+  def time_series_put_operator
+    TimeSeriesPutOperator.new(self)
+  end
+
+  class TimeSeriesPutOperator < Operator
+    def put(table_name, measurements)
+      rows = rows_for measurements
+
+      request = TsPutReq.new table: table_name, rows: rows
+
+      backend.protocol do |p|
+        p.write :TsPutReq, request
+        p.expect :TsPutResp, TsPutResp, empty_body_acceptable: true
+      end
+    end
+
+    private
+    def rows_for(measurements)
+      codec = TsCellCodec.new
+      measurements.map do |measurement|
+        # expect a measurement to be mappable
+        TsRow.new(cells: measurement.map do |measure|
+          codec.cell_for measure
+        end)
+      end
+    end
+  end
+end

data/lib/riak/client/beefcake/time_series_query_operator.rb

@@ -0,0 +1,42 @@
+require_relative './ts_cell_codec'
+require_relative './operator'
+
+class Riak::Client::BeefcakeProtobuffsBackend
+  def time_series_query_operator
+    TimeSeriesQueryOperator.new(self)
+  end
+
+  class TimeSeriesQueryOperator < Operator
+    def query(base, interpolations = {  })
+      interpolator = TsInterpolation.new base: base
+      interpolator.interpolations = pairs_for interpolations
+
+      request = TsQueryReq.new query: interpolator
+
+      result = backend.protocol do |p|
+        p.write :TsQueryReq, request
+        p.expect :TsQueryResp, TsQueryResp, empty_body_acceptable: true
+      end
+
+      return nil if :empty == result
+
+      codec = TsCellCodec.new
+
+      collection = Riak::TimeSeries::Collection.
+                   new(result.rows.map do |row|
+                         Riak::TimeSeries::Row.new codec.scalars_for row.cells
+                       end)
+
+      collection.columns = result.columns
+
+      collection
+    end
+
+    private
+    def pairs_for(interpolations)
+      interpolations.map do |key, value|
+        RpbPair.new key: key.to_s, value: value.to_s
+      end
+    end
+  end
+end

data/lib/riak/client/beefcake/ts_cell_codec.rb

@@ -0,0 +1,63 @@
+require 'bigdecimal'
+
+class Riak::Client::BeefcakeProtobuffsBackend
+  class TsCellCodec
+    def cells_for(measures)
+      measures.map{ |m| cell_for m }
+    end
+
+    def scalars_for(cells)
+      cells.map{ |c| scalar_for c }
+    end
+
+    def cell_for(measure)
+      TsCell.new case measure
+                 when String
+                   { varchar_value: measure }
+                 when Fixnum
+                   { sint64_value: measure }
+                 when Bignum
+                   { sint64_value: check_bignum_range(measure) }
+                 when Float
+                   { double_value: measure }
+                 when BigDecimal
+                   { double_value: measure.to_f }
+                 when Rational
+                   fail Riak::TimeSeriesError::SerializeRationalNumberError
+                 when Complex
+                   fail Riak::TimeSeriesError::SerializeComplexNumberError
+                 when Time
+                   seconds = measure.to_f
+                   milliseconds = seconds * 1000
+                   truncated_ms = milliseconds.to_i
+                   { timestamp_value: truncated_ms }
+                 when TrueClass, FalseClass
+                   { boolean_value: measure }
+                 when nil
+                   {  }
+                 end
+    end
+
+    def scalar_for(cell)
+      cell.varchar_value ||
+        cell.sint64_value ||
+        cell.double_value ||
+        timestamp(cell) ||
+        cell.boolean_value # boolean_value is last, so we can get either false, nil, or true
+    end
+
+    private
+    def check_bignum_range(bignum)
+      if (bignum > -0x8000000000000000) && (bignum < 0x7FFFFFFFFFFFFFFF)
+        return bignum
+      end
+
+      fail Riak::TimeSeriesError::SerializeBigIntegerError, bignum
+    end
+
+    def timestamp(cell)
+      return false unless cell.timestamp_value.is_a? Integer
+      Time.at(cell.timestamp_value.to_f / 1000)
+    end
+  end
+end

data/lib/riak/client/beefcake_protobuffs_backend.rb

@@ -16,6 +16,11 @@ module Riak
           require 'riak/client/beefcake/bucket_properties_operator'
           require 'riak/client/beefcake/crdt_operator'
           require 'riak/client/beefcake/crdt_loader'
+          require 'riak/client/beefcake/time_series_delete_operator'
+          require 'riak/client/beefcake/time_series_get_operator'
+          require 'riak/client/beefcake/time_series_list_operator'
+          require 'riak/client/beefcake/time_series_put_operator'
+          require 'riak/client/beefcake/time_series_query_operator'
           require 'riak/client/beefcake/protocol'
           require 'riak/client/beefcake/socket'
           true

data/lib/riak/client.rb

@@ -21,6 +21,7 @@ require 'riak/multiget'
 require 'riak/secondary_index'
 require 'riak/search'
 require 'riak/stamp'
+require 'riak/time_series'
 require 'riak/list_buckets'
 
 module Riak
@@ -356,6 +357,8 @@ module Riak
           begin
             yield backend
           rescue *NETWORK_ERRORS => e
+            Riak.logger.warn("Riak client error: #{e.inspect} for #{backend.inspect}")
+
             # Network error.
             tries -= 1
 

data/lib/riak/errors/time_series.rb

@@ -0,0 +1,23 @@
+require 'riak/errors/base'
+
+module Riak
+  class TimeSeriesError < Error
+    class SerializeComplexNumberError < TimeSeriesError
+      def initialize
+        super t('time_series.serialize_complex_number')
+      end
+    end
+
+    class SerializeRationalNumberError < TimeSeriesError
+      def initialize
+        super t('time_series.serialize_rational_number')
+      end
+    end
+
+    class SerializeBigIntegerError < TimeSeriesError
+      def initialize(bignum)
+        super t('time_series.serialize_big_integer', bignum: bignum)
+      end
+    end
+  end
+end

data/lib/riak/locale/en.yml

@@ -97,6 +97,11 @@ en:
     stored_function_invalid: "function must have :bucket and :key when a hash"
     streaming_bucket_list_without_block: "Streaming bucket list was requested but no block was given."
     string_type: "invalid_argument %{string} is not a String"
+    time_series:
+      list_keys: "Riak::TimeSeries::List is an expensive operation that should not be used in production.\n    %{backtrace}"
+      serialize_big_integer: "%{bignum} is out of range for sint64 field"
+      serialize_complex_number: "Cannot serialize Complex numbers"
+      serialize_rational_number: "Cannot serialize Rational numbers without losing precision"
     too_few_arguments: "too few arguments: %{params}"
     walk_spec_invalid_unless_link: "WalkSpec is only valid for a function when the type is :link"
     wrong_argument_count_walk_spec: "wrong number of arguments (one Hash or bucket,tag,keep required)"