google-cloud-bigtable 0.6.1 → 1.0.1

data/lib/google/cloud/bigtable/row_filter/simple_filter.rb

@@ -19,6 +19,7 @@ module Google
   module Cloud
     module Bigtable
       module RowFilter
+        ##
         #
         # # SimpleFilter
         #
@@ -30,6 +31,7 @@ module Google
             @grpc = Google::Bigtable::V2::RowFilter.new
           end
 
+          ##
           # Outputs all cells directly to the output of the read rather than to any parent filter.
           #
           # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
@@ -39,6 +41,7 @@ module Google
             self
           end
 
+          ##
           # Matches all cells, regardless of input. Functionally equivalent to
           # leaving `filter` unset, but included for completeness.
           #
@@ -49,6 +52,7 @@ module Google
             self
           end
 
+          ##
           # Does not match any cells, regardless of input. Useful for temporarily
           # disabling just part of a filter.
           #
@@ -59,6 +63,7 @@ module Google
             self
           end
 
+          ##
           # Replaces each cell's value with an empty string.
           #
           # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
@@ -68,6 +73,7 @@ module Google
             self
           end
 
+          ##
           # Matches only cells from rows whose keys satisfy the given RE2 regex. In
           # other words, passes through the entire row when the key matches, and
           # otherwise produces an empty row.
@@ -87,6 +93,7 @@ module Google
             self
           end
 
+          ##
           # Matches all cells from a row with probability p, and matches no cells
           # from the row with probability 1-p.
           #
@@ -95,15 +102,13 @@ module Google
           #
           def sample probability
             if probability >= 1 || probability <= 0
-              raise(
-                RowFilterError,
-                "Probability must be greather then 0 and less then 1.0"
-              )
+              raise RowFilterError, "Probability must be greater than 0 and less than 1.0."
             end
             @grpc.row_sample_filter = probability
             self
           end
 
+          ##
           # Matches only cells from columns whose families satisfy the given RE2
           # regex. For technical reasons, the regex must not contain the `:`
           # character, even if it is not being used as a literal.
@@ -119,6 +124,7 @@ module Google
             self
           end
 
+          ##
           # Matches only cells from columns whose qualifiers satisfy the given RE2
           # regex.
           # Note that, since column qualifiers can contain arbitrary bytes, the `\C`
@@ -134,6 +140,7 @@ module Google
             self
           end
 
+          ##
           # Matches only cells with values that satisfy the given regular expression.
           # Note that, since cell values can contain arbitrary bytes, the `\C` escape
           # sequence must be used if a true wildcard is desired. The `.` character
@@ -148,6 +155,7 @@ module Google
             self
           end
 
+          ##
           # Applies the given label to all cells in the output row. This allows
           # the client to determine which results were produced from which part of
           # the filter.
@@ -157,7 +165,7 @@ module Google
           #
           # Due to a technical limitation, it is not possible to apply
           # multiple labels to a cell. As a result, a chain may have no more than
-          # one sub-filter whithatch contains an `apply_label_transformer`. It is okay for
+          # one sub-filter that contains an `apply_label_transformer`. It is okay for
           # an interleave to contain multiple `apply_label_transformers`, as they
           # will be applied to separate copies of the input.
           #
@@ -169,6 +177,7 @@ module Google
             self
           end
 
+          ##
           # Skips the first N cells of each row, matching all subsequent cells.
           # If duplicate cells are present, as is possible when using an interleave,
           # each copy of the cell is counted separately.
@@ -181,6 +190,7 @@ module Google
             self
           end
 
+          ##
           # Matches only the first N cells of each row.
           # If duplicate cells are present, as is possible when using an Interleave,
           # each copy of the cell is counted separately.
@@ -193,6 +203,7 @@ module Google
             self
           end
 
+          ##
           # Matches only the most recent N cells within each column. For example,
           # if N=2, this filter would match column `foo:bar` at timestamps 10 and 9,
           # skip all earlier cells in `foo:bar`, and then begin matching again in
@@ -208,7 +219,8 @@ module Google
             self
           end
 
-          # Creates a timestamp-range filter instance.
+          ##
+          # Creates a timestamp-range filter.
           #
           # Matches only cells with timestamps within the given range.
           # Specifies a contiguous range of timestamps.
@@ -225,32 +237,35 @@ module Google
             self
           end
 
+          ##
           # Matches only cells with values that fall within the given range.
           #
           # See {Google::Cloud::Bigtable::ValueRange#from} and { Google::Cloud::Bigtable::ValueRange#to} for range
           # option inclusive/exclusive options
           #
           # * The value at which to start the range. If neither field is set, interpreted as an empty string, inclusive.
-          # * The value at which to end the range. If neither field is set, interpreted as an infinite string, exclusive.
+          # * The value at which to end the range. If neither field is set, interpreted as an infinite string,
+          #   exclusive.
           #
           # @param range [Google::Cloud::Bigtable::ValueRange]
           # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
           #
           def value_range range
-            unless range.instance_of?(Google::Cloud::Bigtable::ValueRange)
+            unless range.instance_of? Google::Cloud::Bigtable::ValueRange
               raise RowFilterError, "Range type mustbe ValueRange"
             end
             @grpc.value_range_filter = range.to_grpc
             self
           end
 
+          ##
           # Matches only cells from columns within the given range.
           #
           # @param range [Google::Cloud::Bigtable::ColumnRange]
           # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
           #
           def column_range range
-            unless range.instance_of?(Google::Cloud::Bigtable::ColumnRange)
+            unless range.instance_of? Google::Cloud::Bigtable::ColumnRange
               raise RowFilterError, "Range type mustbe ColumnRange"
             end
             @grpc.column_range_filter = range.to_grpc

data/lib/google/cloud/bigtable/row_range.rb

@@ -16,6 +16,7 @@
 module Google
   module Cloud
     module Bigtable
+      ##
       # # RowRange
       #
       # Specifies a contiguous range of rows.
@@ -59,6 +60,7 @@ module Google
           @grpc = Google::Bigtable::V2::RowRange.new
         end
 
+        ##
         # Sets a row range with a lower bound.
         #
         # @param key [String] Row key. Required.
@@ -91,6 +93,7 @@ module Google
           self
         end
 
+        ##
         # Sets a row range with an upper bound.
         #
         # @param key [String] Row key. Required.
@@ -123,6 +126,7 @@ module Google
           self
         end
 
+        ##
         # Sets a row range with inclusive upper and lower bounds.
         #
         # @param from_key [String] Inclusive from row key. Required.
@@ -142,6 +146,7 @@ module Google
           from(from_key).to(to_key, inclusive: true)
         end
 
+        ##
         # Sets a row range with an inclusive lower bound and an exclusive upper bound.
         #
         # @param from_key [String] Inclusive from row key.

data/lib/google/cloud/bigtable/rows_mutator.rb

@@ -31,8 +31,8 @@ module Google
         # Retryable status codes
         RETRYABLE_CODES = {
           Google::Rpc::Code::DEADLINE_EXCEEDED => true,
-          Google::Rpc::Code::ABORTED => true,
-          Google::Rpc::Code::UNAVAILABLE => true
+          Google::Rpc::Code::ABORTED           => true,
+          Google::Rpc::Code::UNAVAILABLE       => true
         }.freeze
 
         # @private
@@ -50,26 +50,25 @@ module Google
           @entries = entries
         end
 
+        ##
         # Applies mutations.
         #
         # @return [Array<Google::Bigtable::V2::MutateRowsResponse::Entry>]
         #
         def apply_mutations
           @req_entries = @entries.map(&:to_grpc)
-          statuses = mutate_rows(@req_entries)
+          statuses = mutate_rows @req_entries
 
           # Collects retryable mutations indices.
-          indices = statuses.each_with_object([]) do |e, r|
-            if @entries[e.index].retryable? && RETRYABLE_CODES[e.status.code]
-              r << e.index
-            end
+          indices = statuses.each_with_object [] do |e, r|
+            r << e.index if @entries[e.index].retryable? && RETRYABLE_CODES[e.status.code]
           end
 
           return statuses if indices.empty?
 
           (RETRY_LIMIT - 1).times do
             break if indices.empty?
-            indices = retry_entries(statuses, indices)
+            indices = retry_entries statuses, indices
           end
 
           statuses
@@ -77,26 +76,20 @@ module Google
 
         private
 
+        ##
         # Mutates rows.
         #
         # @param entries [Array<Google::Cloud::Bigtable::MutationEntry>]
         # @return [Array<Google::Bigtable::V2::MutateRowsResponse::Entry>]
         #
         def mutate_rows entries
-          response = @table.client.mutate_rows(
-            @table.path,
-            entries,
-            app_profile_id: @table.app_profile_id
-          )
-          response.each_with_object([]) do |res, statuses|
-            statuses.concat(res.entries)
+          response = @table.service.mutate_rows @table.path, entries, app_profile_id: @table.app_profile_id
+          response.each_with_object [] do |res, statuses|
+            statuses.concat res.entries
           end
-        rescue Google::Gax::GaxError => e
-          raise Google::Cloud::Error.from_error(e.cause)
-        rescue GRPC::BadStatus => e
-          raise Google::Cloud::Error.from_error(e)
         end
 
+        ##
         # Collects failed entries, retries mutation, and updates status.
         #
         # @param statuses [Array<Google::Bigtable::V2::MutateRowsResponse::Entry>]
@@ -107,9 +100,9 @@ module Google
         #
         def retry_entries statuses, indices
           entries = indices.map { |i| @req_entries[i] }
-          retry_statuses = mutate_rows(entries)
+          retry_statuses = mutate_rows entries
 
-          retry_statuses.each_with_object([]) do |e, next_indices|
+          retry_statuses.each_with_object [] do |e, next_indices|
             next_indices << indices[e.index] if RETRYABLE_CODES[e.status.code]
             statuses[indices[e.index]].status = e.status
           end

data/lib/google/cloud/bigtable/rows_reader.rb

@@ -23,7 +23,7 @@ module Google
       # @private
       # # RowsReader
       #
-      # Retyable read rows helper
+      # Retryable read rows helper
       #
       class RowsReader
         # @private
@@ -56,6 +56,7 @@ module Google
           @retry_count = 0
         end
 
+        ##
         # Read rows
         #
         # @param rows [Google::Bigtable::V2::RowSet]
@@ -72,22 +73,20 @@ module Google
         #   The default (zero) is to return all results.
         # @return [:yields: row]
         #   Array of row or yield block for each processed row.
-
-        def read \
-            rows: nil,
-            filter: nil,
-            rows_limit: nil
-          response = @table.client.read_rows(
-            @table.path,
-            rows: rows,
-            filter: filter,
-            rows_limit: rows_limit,
+        #
+        def read rows: nil, filter: nil, rows_limit: nil
+          response = @table.service.read_rows(
+            @table.instance_id,
+            @table.table_id,
+            rows:           rows,
+            filter:         filter,
+            rows_limit:     rows_limit,
             app_profile_id: @table.app_profile_id
           )
           response.each do |res|
             res.chunks.each do |chunk|
               @retry_count = 0
-              row = @chunk_processor.process(chunk)
+              row = @chunk_processor.process chunk
               next if row.nil?
               yield row
               @rows_count += 1
@@ -97,15 +96,17 @@ module Google
           @chunk_processor.validate_last_row_complete
         end
 
+        ##
         # Last read row key.
         #
         # @return [String]
-
+        #
         def last_key
           @chunk_processor.last_key
         end
 
-        # Calucates and returns the read rows limit and row set based on last read key.
+        ##
+        # Calculates and returns the read rows limit and row set based on last read key.
         #
         # @param rows_limit [Integer]
         #   The read will terminate after committing to N rows' worth of results.
@@ -116,7 +117,7 @@ module Google
         #   A hash of the same form as `Google::Bigtable::V2::RowSet`
         #   can also be provided.
         # @return [Integer, Google::Bigtable::V2::RowSet]
-
+        #
         def retry_options rows_limit, row_set
           return [rows_limit, row_set] unless last_key
 
@@ -129,14 +130,14 @@ module Google
             delete_indexes = []
 
             row_set.row_ranges.each_with_index do |range, i|
-              if end_key_read?(range)
+              if end_key_read? range
                 delete_indexes << i
-              elsif start_key_read?(range)
+              elsif start_key_read? range
                 range.start_key_open = last_key
               end
             end
 
-            delete_indexes.each { |i| row_set.row_ranges.delete_at(i) }
+            delete_indexes.each { |i| row_set.row_ranges.delete_at i }
           end
 
           if row_set.row_ranges.empty?
@@ -151,15 +152,18 @@ module Google
           [rows_limit, row_set]
         end
 
+        ##
         # Checks if a read operation is retryable.
         #
         # @return [Boolean]
+        #
         def retryable?
           @retry_count < RowsReader::RETRY_LIMIT
         end
 
         private
 
+        ##
         # Checks if the start key was already read for the range.
         #
         # @param range [Google::Bigtable::V2::RowRange]
@@ -175,6 +179,7 @@ module Google
           start_key.empty? || last_key >= start_key
         end
 
+        ##
         # Checks if the end key was already read for the range.
         #
         # @param range [Google::Bigtable::V2::RowRange]

data/lib/google/cloud/bigtable/sample_row_key.rb

@@ -18,6 +18,7 @@
 module Google
   module Cloud
     module Bigtable
+      ##
       # # SampleRowKey
       #
       # Sample row key with byte offset.
@@ -30,14 +31,14 @@ module Google
       #   Note: that row keys in this list may not have ever been written to or read
       #   from, and users should therefore not make any assumptions about the row key
       #   structure that are specific to their use case.
-
+      #
       # * offset_bytes : Approximate total storage space used by all rows in the table which precede
       #   `row_key`. Buffering the contents of all rows between two subsequent
       #   samples would require space roughly equal to the difference in their
       #   `offset_bytes` fields.
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
@@ -48,9 +49,11 @@ module Google
       #   end
       #
       class SampleRowKey
+        ##
         # @return [String] Sample row key.
         attr_reader :key
 
+        ##
         # @return [Integer] Row offset in bytes.
         attr_reader :offset
 
@@ -74,7 +77,7 @@ module Google
         # @return [Google::Cloud::Bigtable::SampleRowKey]
         #
         def self.from_grpc grpc
-          new(grpc.row_key, grpc.offset_bytes)
+          new grpc.row_key, grpc.offset_bytes
         end
       end
     end