google-cloud-bigtable 0.7.0 → 1.1.0

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

@@ -36,7 +36,7 @@ module Google
       #
       class ReadModifyWriteRule
         # @private
-        # Create an instance of ReadModifyWriteRule
+        # Creates an instance of ReadModifyWriteRule
         #
         # @param family [String]
         #   The name of the family to which the read/modify/write should be applied.
@@ -50,7 +50,7 @@ module Google
         end
 
         ##
-        # Create an instance of an append-value rule.
+        # Creates an instance of an append-value rule.
         #
         # @param family [String]
         #   The name of the family to which the read/modify/write should be applied.
@@ -73,7 +73,7 @@ module Google
         end
 
         ##
-        # Create an instance of an increment-amount rule.
+        # Creates an instance of an increment-amount rule.
         #
         # @param family [String]
         #   The name of the family to which the read/modify/write should be applied.
@@ -86,7 +86,7 @@ module Google
         #   as a 64-bit big-endian signed integer), or the entire request will fail.
         # @return [Google::Cloud::Bigtable::ReadModifyWriteRule]
         #
-        # @example increment value rule
+        # @example
         #   rule = Google::Cloud::Bigtable::ReadModifyWriteRule.increment(
         #     "cf", "field01", 1
         #   )
@@ -98,7 +98,7 @@ module Google
         end
 
         ##
-        # Set append value.
+        # Sets the append value.
         #
         # @param value [String]
         # @return [Google::Cloud::Bigtable::ReadModifyWriteRule]
@@ -109,7 +109,7 @@ module Google
         end
 
         ##
-        # Set increment amount.
+        # Sets the increment amount.
         #
         # @param amount [Integer]
         # @return [Google::Cloud::Bigtable::ReadModifyWriteRule]

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

@@ -60,7 +60,7 @@ module Google
         def sample_row_keys
           return enum_for :sample_row_keys unless block_given?
 
-          response = client.sample_row_keys path, app_profile_id: @app_profile_id
+          response = service.sample_row_keys path, app_profile_id: @app_profile_id
           response.each do |grpc|
             yield SampleRowKey.from_grpc grpc
           end
@@ -86,7 +86,7 @@ module Google
         #   The default (zero) is to return all results.
         # @return [Array<Google::Cloud::Bigtable::Row> | :yields: row]
         #   Array of row or yield block for each processed row.
-        # @example Read with limit
+        # @example Read with limit.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -96,7 +96,7 @@ module Google
         #     puts row
         #   end
         #
-        # @example Read using row keys
+        # @example Read using row keys.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -106,7 +106,7 @@ module Google
         #     puts row
         #   end
         #
-        # @example Read using row ranges
+        # @example Read using row ranges.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -118,8 +118,7 @@ module Google
         #     puts row
         #   end
         #
-        # @example Read using filter
-        #
+        # @example Read using filter.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -133,8 +132,7 @@ module Google
         #     puts row
         #   end
         #
-        # @example Read using filter with limit
-        #
+        # @example Read using filter with limit.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -169,13 +167,12 @@ module Google
         ##
         # Reads a single row by row key.
         #
-        # @param key [String] Row key. Required
+        # @param key [String] Row key. Required.
         # @param filter [Google::Cloud::Bigtable::RowFilter]
         #   The filter to apply to the contents of the specified row. Optional.
         # @return [Google::Cloud::Bigtable::Row]
         #
-        # @example Read row
-        #
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -183,8 +180,7 @@ module Google
         #
         #   row = table.read_row("user-1")
         #
-        # @example Read row
-        #
+        # @example Read row with filter.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -216,7 +212,7 @@ module Google
         #   # OR
         #   range = table.new_value_range.from("abc").to("xyz")
         #
-        # @example With exclusive from range
+        # @example With exclusive from range.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -229,9 +225,9 @@ module Google
         end
 
         ##
-        # Get a new instance of ColumnRange.
+        # Gets a new instance of ColumnRange.
         #
-        # @param family [String] Column family name
+        # @param family [String] Column family name.
         # @return [Google::Cloud::Bigtable::ColumnRange]
         #
         # @example
@@ -247,7 +243,7 @@ module Google
         #   # OR
         #   range = table.new_column_range("test-family").from("key-1").to("key-5")
         #
-        # @example With exclusive from range
+        # @example With exclusive from range.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -260,7 +256,7 @@ module Google
         end
 
         ##
-        # Get a new instance of RowRange.
+        # Gets a new instance of RowRange.
         #
         # @return [Google::Cloud::Bigtable::RowRange]
         #
@@ -277,7 +273,7 @@ module Google
         #   # OR
         #   range = table.new_row_range.from("key-1").to("key-5")
         #
-        # @example With exclusive from range
+        # @example With exclusive from range.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new

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

@@ -33,7 +33,7 @@ module Google
       #   availability. Value contains `cluster_id` and optional field
       #   `allow_transactional_writes`.
       #
-      # @example Create an app profile with a single cluster routing policy
+      # @example Create an app profile with a single cluster routing policy.
       #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
@@ -52,7 +52,7 @@ module Google
       #   )
       #   puts app_profile.routing_policy
       #
-      # @example Create an app profile with multi-cluster routing policy
+      # @example Create an app profile with multi-cluster routing policy.
       #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
@@ -139,6 +139,7 @@ module Google
       #     allowed by this app profile. It is unsafe to send these requests to
       #     the same table/row/column in multiple clusters.
       #     Default value is false.
+      #
       class SingleClusterRouting < RoutingPolicy
         attr_reader :cluster_id, :allow_transactional_writes
 

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

@@ -35,11 +35,11 @@ module Google
           ##
           # Creates a row cell instance.
           #
-          # @param family [String] Column family name
-          # @param qualifier [String] Column cell qualifier name
-          # @param timestamp [Integer] Timestamp in microseconds
-          # @param value [String] Cell value
-          # @param labels [Array<String>] List of label array
+          # @param family [String] Column family name.
+          # @param qualifier [String] Column cell qualifier name.
+          # @param timestamp [Integer] Timestamp in microseconds.
+          # @param value [String] Cell value.
+          # @param labels [Array<String>] List of label array.
           #
           def initialize family, qualifier, timestamp, value, labels = []
             @family = family
@@ -52,9 +52,9 @@ module Google
           ##
           # Converts timestamp to Time instance.
           #
-          # @param granularity [Symbol] Optional
-          #   Valid granularity types are `:micros`, `millis`
-          #   Default granularity is a millis.
+          # @param granularity [Symbol] Optional.
+          #   Valid granularity types are `:micros`, `:millis`.
+          #   Default is `:millis`.
           # @return [Time | nil]
           #
           def to_time granularity = nil
@@ -74,7 +74,7 @@ module Google
 
           # @private
           #
-          # Cell object comparator
+          # Cell object comparator.
           #
           # @return [Boolean]
           #
@@ -88,19 +88,19 @@ module Google
         end
 
         ##
-        # @return [String] Row key
+        # @return [String] Row key.
         #
         attr_accessor :key
 
         ##
-        # @return [Hash{String => Array<Google::Cloud::Bigtable::Row::Cell>}] Row cells
+        # @return [Hash{String => Array<Google::Cloud::Bigtable::Row::Cell>}] Row cells.
         #
         attr_accessor :cells
 
         ##
         # Creates a flat row object.
         #
-        # @param key [String] Row key name
+        # @param key [String] Row key name.
         #
         def initialize key = nil
           @key = key
@@ -108,7 +108,7 @@ module Google
         end
 
         ##
-        # List of column families names
+        # List of column families names.
         #
         # @return [Array<String>]
         #
@@ -118,7 +118,7 @@ module Google
 
         # @private
         #
-        # FlatRow object comparator
+        # FlatRow object comparator.
         #
         # @return [Boolean]
         #

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

@@ -121,6 +121,7 @@ module Google
       # while the other does not.
       #
       # @example
+      #   require "google/cloud/bigtable"
       #
       #   # Pass filter
       #   Google::Cloud::Bigtable::RowFilter.pass
@@ -151,7 +152,7 @@ module Google
         #
         # A chain RowFilter that sends rows through several RowFilters in sequence.
         #
-        # See {Google::Cloud::Bigtable::RowFilter::ChainFilter}
+        # See {Google::Cloud::Bigtable::RowFilter::ChainFilter}.
         #
         # The elements of "filters" are chained together to process the input row:
         # in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
@@ -160,6 +161,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::ChainFilter]
         #
         # @example Create chain filter with simple filter.
+        #   require "google/cloud/bigtable"
         #
         #   chain = Google::Cloud::Bigtable::RowFilter.chain
         #
@@ -171,6 +173,7 @@ module Google
         #   chain.key("user-*").strip_value
         #
         # @example Create complex chain filter.
+        #   require "google/cloud/bigtable"
         #
         #   chain = Google::Cloud::Bigtable::RowFilter.chain
         #
@@ -219,6 +222,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::InterleaveFilter]
         #
         # @example Create an interleave filter with simple filter.
+        #   require "google/cloud/bigtable"
         #
         #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
         #
@@ -230,6 +234,7 @@ module Google
         #   interleave.key("user-*").sink
         #
         # @example Create complex interleave filter.
+        #   require "google/cloud/bigtable"
         #
         #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
         #
@@ -254,12 +259,13 @@ module Google
         # results. Additionally, condition filters have poor performance, especially
         # when filters are set for the false condition.
         #
-        # Cannot be used within the `predicate_filter`, `true_filter`, or `false_filter`
+        # Cannot be used within the `predicate_filter`, `true_filter`, or `false_filter`.
         #
         # @param predicate [SimpleFilter, ChainFilter, InterleaveFilter, ConditionFilter]
         # @return [Google::Cloud::Bigtable::RowFilter::ConditionFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")
         #   condition = Google::Cloud::Bigtable::RowFilter.condition(predicate)
@@ -283,6 +289,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.pass
         #
@@ -299,6 +306,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.block
         #
@@ -310,11 +318,12 @@ module Google
         # Creates a sink filter instance.
         #
         # Outputs all cells directly to the output of the read rather than to any
-        # parent filter
+        # parent filter.
         #
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.sink
         #
@@ -330,6 +339,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.strip_value
         #
@@ -348,13 +358,13 @@ module Google
         # will not match the new line character `\n`, which may be present in a
         # binary key.
         #
-        # For Regex syntax:
-        # @see https://github.com/google/re2/wiki/Syntax
+        # @see https://github.com/google/re2/wiki/Syntax Regex syntax
         #
         # @param regex [String] Regex to match row keys.
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.key("user-.*")
         #
@@ -368,11 +378,12 @@ module Google
         # Matches all cells from a row with probability p, and matches no cells
         # from the row with probability 1-p.
         #
-        # @param probability [Float] Probability value
-        #   Probability must be greather then 0 and less then 1.0
+        # @param probability [Float] Probability value.
+        #   Probability must be greater than 0 and less than 1.0.
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.sample(0.5)
         #
@@ -390,13 +401,13 @@ module Google
         # `\n`, it is sufficient to use `.` as a full wildcard when matching
         # column family names.
         #
-        # For Regex syntax:
-        # @see https://github.com/google/re2/wiki/Syntax
+        # @see https://github.com/google/re2/wiki/Syntax Regex syntax
         #
         # @param regex [String] Regex to match family name.
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.family("cf-.*")
         #
@@ -414,13 +425,13 @@ module Google
         # character will not match the new line character `\n`, which may be
         # present in a binary qualifier.
         #
-        # For Regex syntax:
-        # @see https://github.com/google/re2/wiki/Syntax
+        # @see https://github.com/google/re2/wiki/Syntax Regex syntax
         #
         # @param regex [String] Regex to match column qualifier name.
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.qualifier("user-name.*")
         #
@@ -437,13 +448,13 @@ module Google
         # will not match the new line character `\n`, which may be present in a
         # binary value.
         #
-        # For Regex syntax:
-        # @see https://github.com/google/re2/wiki/Syntax
+        # @see https://github.com/google/re2/wiki/Syntax Regex syntax
         #
         # @param regex [String] Regex to match cell value.
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.value("abc.*")
         #
@@ -472,6 +483,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.label("user-detail")
         #
@@ -490,6 +502,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row_offset(3)
         #
@@ -508,6 +521,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row(5)
         #
@@ -526,6 +540,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_column(5)
         #
@@ -544,6 +559,7 @@ module Google
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
         # @example
+        #   require "google/cloud/bigtable"
         #
         #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
         #   from = timestamp_micros - 300000000
@@ -577,7 +593,7 @@ module Google
         # @param range [Google::Cloud::Bigtable::ValueRange]
         # @return [Google::Cloud::Bigtable::RowFilter::SimpleFilter]
         #
-        # @example Start to end range
+        # @example Start to end range.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -586,7 +602,7 @@ module Google
         #   range = table.new_value_range.from("value-001", inclusive: false)
         #   filter = Google::Cloud::Bigtable::RowFilter.value_range(range)
         #
-        # @example Start exlusive to infinite end range
+        # @example Start exclusive to infinite end range.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new