google-cloud-bigtable 0.8.0 → 1.0.0

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

@@ -53,7 +53,7 @@ module Google
           end
 
           ##
-          # Set a true filter on predicate-filter match.
+          # Sets a true filter on predicate-filter match.
           #
           # The filter to apply to the input row if `predicate_filter` returns any
           # results. If not provided, no results will be returned in the true case.
@@ -62,6 +62,7 @@ module Google
           # @return [Google::Cloud::Bigtable::RowFilter::ConditionFilter]
           #
           # @example
+          #   require "google/cloud/bigtable"
           #   predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")
           #
           #   label = Google::Cloud::Bigtable::RowFilter.label("user")
@@ -85,6 +86,8 @@ module Google
           # @return [Google::Cloud::Bigtable::RowFilter::ConditionFilter]
           #
           # @example
+          #   require "google/cloud/bigtable"
+          #
           #   predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")
           #
           #   label = Google::Cloud::Bigtable::RowFilter.label("user")

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

@@ -52,6 +52,7 @@ module Google
         # All interleaved filters are executed atomically.
         #
         # @example Create an interleave filter with a simple filter.
+        #   require "google/cloud/bigtable"
         #
         #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
         #
@@ -63,14 +64,15 @@ module Google
         #   interleave.key("user-*").sink
         #
         # @example Create a complex interleave filter.
+        #   require "google/cloud/bigtable"
         #
-        #  interleave = Google::Cloud::Bigtable::RowFilter.interleave
+        #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
         #
-        #  chain_1 = Google::Cloud::Bigtable::RowFilter.chain
-        #  chain_1.label("users").qualifier("name").cells_per_row(5)
+        #   chain_1 = Google::Cloud::Bigtable::RowFilter.chain
+        #   chain_1.label("users").qualifier("name").cells_per_row(5)
         #
-        #  # Add to main chain filter
-        #  interleave.chain(chain_1).value("xyz*").key("user-*")
+        #   # Add to main chain filter
+        #   interleave.chain(chain_1).value("xyz*").key("user-*")
         #
         class InterleaveFilter
           # @private
@@ -80,7 +82,7 @@ module Google
           end
 
           ##
-          # Adds a chain filter instance.
+          # Adds a chain filter.
           #
           # A Chain RowFilter that sends rows through several RowFilters in sequence.
           #
@@ -95,6 +97,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example Create a chain filter and add an interleave filter.
+          #   require "google/cloud/bigtable"
           #
           #   chain = Google::Cloud::Bigtable::RowFilter.chain
           #
@@ -145,6 +148,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example Add an interleave filter to a chain filter.
+          #   require "google/cloud/bigtable"
           #
           #   interleave = Google::Cloud::Bigtable::RowFilter.interleave
           #
@@ -159,7 +163,7 @@ module Google
           end
 
           ##
-          # Adds a condition filter instance.
+          # Adds a condition filter.
           #
           # A RowFilter that evaluates one of two possible RowFilters, depending on
           # whether or not a predicate RowFilter outputs any cells from the input row.
@@ -176,6 +180,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")
           #
@@ -193,7 +198,7 @@ module Google
           end
 
           ##
-          # Adds a pass filter instance.
+          # Adds a pass filter.
           #
           # Matches all cells, regardless of input. Functionally equivalent to
           # leaving `filter` unset, but included for completeness.
@@ -202,6 +207,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.pass
           #
@@ -210,7 +216,7 @@ module Google
           end
 
           ##
-          # Adds a block-all filter instance.
+          # Adds a block-all filter.
           #
           # Does not match any cells, regardless of input. Useful for temporarily
           # disabling just part of a filter.
@@ -219,6 +225,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.block
           #
@@ -227,7 +234,7 @@ module Google
           end
 
           ##
-          # Adds a sink filter instance.
+          # Adds a sink filter.
           #
           # Outputs all cells directly to the output of the read rather than to any parent filter.
           #
@@ -235,6 +242,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.sink
           #
@@ -243,7 +251,7 @@ module Google
           end
 
           ##
-          # Adds a strip-value filter instance.
+          # Adds a strip-value filter.
           #
           # Replaces each cell's value with an empty string.
           #
@@ -251,6 +259,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.strip_value
           #
@@ -277,6 +286,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.key("user-*")
           #
@@ -285,17 +295,18 @@ module Google
           end
 
           ##
-          # Adds a sample-probability filter instance.
+          # Adds a sample-probability filter.
           #
           # 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::InterleaveFilter]
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.sample(0.5)
           #
@@ -321,6 +332,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.family("cf-*")
           #
@@ -346,6 +358,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.qualifier("user-name*")
           #
@@ -370,6 +383,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value("abc*")
           #
@@ -385,7 +399,7 @@ module Google
           # the filter.
           #
           # Values must be at most 15 characters in length, and match the RE2
-          # pattern `[a-z0-9\\-]+`
+          # pattern `[a-z0-9\\-]+`.
           #
           # 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
@@ -398,6 +412,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.label("user-detail")
           #
@@ -417,6 +432,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row_offset(3)
           #
@@ -425,7 +441,7 @@ module Google
           end
 
           ##
-          # Adds a cells-per-row-limit filter instance.
+          # Adds a cells-per-row-limit filter.
           #
           # Matches only the first N cells of each row.
           # If duplicate cells are present, as is possible when using an interleave,
@@ -436,6 +452,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row(5)
           #
@@ -444,7 +461,7 @@ module Google
           end
 
           ##
-          # Adds a cells-per-column filter instance.
+          # Adds a cells-per-column filter.
           #
           # 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,
@@ -458,6 +475,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_column(5)
           #
@@ -466,7 +484,7 @@ module Google
           end
 
           ##
-          # Adds a timestamp-range filter instance.
+          # Adds a timestamp-range filter.
           #
           # Matches only cells with timestamps within the given range.
           # Specifies a contiguous range of timestamps.
@@ -479,6 +497,7 @@ module Google
           #   `self` instance of interleave filter.
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
           #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
           #   from = timestamp_micros - 300000000
@@ -491,7 +510,7 @@ module Google
           end
 
           ##
-          # Adds a value-range filter instance.
+          # Adds a value-range filter.
           #
           # Matches only cells with values that fall within the given range.
           #
@@ -506,7 +525,7 @@ module Google
           # @return [Google::Cloud::Bigtable::RowFilter::InterleaveFilter]
           #   `self` instance of interleave filter.
           #
-          # @example Start to end range
+          # @example Start to end range.
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
@@ -515,7 +534,7 @@ module Google
           #   range = table.new_value_range.from("value-001").to("value-005")
           #   filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range(range)
           #
-          # @example Start exlusive to infinite end range
+          # @example Start exlusive to infinite end range.
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
@@ -529,7 +548,7 @@ module Google
           end
 
           ##
-          # Adds a column-range filter instance.
+          # Adds a column-range filter.
           #
           # Matches only cells from columns within the given range.
           #
@@ -554,9 +573,10 @@ module Google
           # @return [Integer]
           #
           # @example
+          #   require "google/cloud/bigtable"
           #
-          #  filter = Google::Cloud::Bigtable::RowFilter.interleave.key("user-1*").label("user")
-          #  filter.length # 2
+          #   filter = Google::Cloud::Bigtable::RowFilter.interleave.key("user-1*").label("user")
+          #   filter.length # 2
           #
           def length
             @filters.length

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

@@ -102,7 +102,7 @@ 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
@@ -165,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.
           #
@@ -220,7 +220,7 @@ module Google
           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.

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
@@ -106,7 +106,7 @@ module Google
         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.

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

@@ -31,7 +31,7 @@ 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

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

@@ -70,7 +70,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the project.
+        # The unique identifier for the project to which the table belongs.
         #
         # @return [String]
         #
@@ -79,7 +79,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the instance.
+        # The unique identifier for the instance to which the table belongs.
         #
         # @return [String]
         #
@@ -108,16 +108,16 @@ module Google
         end
 
         ##
-        # Reload table information.
+        # Reloads table data.
         #
         # @param view [Symbol] Table view type.
-        #   Default view type is `:SCHEMA_VIEW`
+        #   Default view type is `:SCHEMA_VIEW`.
         #   Valid view types are:
         #
-        #   * `:NAME_ONLY` - Only populates `name`
-        #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema
+        #   * `:NAME_ONLY` - Only populates `name`.
+        #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema.
         #   * `:REPLICATION_VIEW` - Only populates `name` and fields related to the table's replication state.
-        #   * `:FULL` - Populates all fields
+        #   * `:FULL` - Populates all fields.
         #
         # @return [Google::Cloud::Bigtable::Table]
         #
@@ -132,7 +132,7 @@ module Google
         # If it could not be determined whether or not the table has data in a
         # particular cluster (for example, if its zone is unavailable), then
         # there will be an entry for the cluster with UNKNOWN `replication_status`.
-        # Views: `FULL`
+        # Views: `FULL`.
         #
         # @return [Array<Google::Cloud::Bigtable::Table::ClusterState>]
         #
@@ -221,7 +221,7 @@ module Google
         # The granularity (e.g. `MILLIS`, `MICROS`) at which timestamps are stored in
         # this table. Timestamps not matching the granularity will be rejected.
         # If unspecified at creation time, the value will be set to `MILLIS`.
-        # Views: `SCHEMA_VIEW`, `FULL`
+        # Views: `SCHEMA_VIEW`, `FULL`.
         #
         # @return [Symbol]
         #
@@ -334,7 +334,7 @@ module Google
         # before this call started have been replicated. The tokens will be available
         # for 90 days.
         #
-        # @return [String] Generated consistency token
+        # @return [String] The generated consistency token
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -357,7 +357,7 @@ module Google
         # considered consistent if replication has caught up based on the conditions
         # specified in the token and the check request.
         # @param token [String] Consistency token
-        # @return [Boolean] Replication is consistent or not.
+        # @return [Boolean] `true` if replication is consistent
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -383,7 +383,7 @@ module Google
         # Wait for replication to check replication consistency.
         # Checks replication consistency by generating a consistency token and
         # making the `check_consistency` API call 5 times (by default).
-        # If the response is consistent, returns true. Otherwise tries again
+        # If the response is consistent, returns `true`. Otherwise tries again
         # repeatedly until the timeout. If the check does not succeed by the
         # timeout, returns `false`.
         #
@@ -391,7 +391,7 @@ module Google
         #   Timeout in seconds. Defaults value is 600 seconds.
         # @param check_interval [Integer]
         #   Consistency check interval in seconds. Default is 5 seconds.
-        # @return [Boolean] Replication is consistent or not.
+        # @return [Boolean] `true` if replication is consistent
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -410,7 +410,7 @@ module Google
         #   end
         #
         def wait_for_replication timeout: 600, check_interval: 5
-          raise InvalidArgumentError, "'check_interval' can not be greather then timeout" if check_interval > timeout
+          raise InvalidArgumentError, "'check_interval' cannot be greater than timeout" if check_interval > timeout
           token = generate_consistency_token
           status = false
           start_at = Time.now
@@ -427,7 +427,7 @@ module Google
         ##
         # Deletes all rows.
         #
-        # @param timeout [Integer] Call timeout in seconds
+        # @param timeout [Integer] Call timeout in seconds.
         #   Use in case of insufficient deadline for DropRowRange, then
         #   try again with a longer request deadline.
         # @return [Boolean]
@@ -451,8 +451,8 @@ module Google
         ##
         # Deletes rows using row key prefix.
         #
-        # @param prefix [String] Row key prefix (for example, "user")
-        # @param timeout [Integer] Call timeout in seconds
+        # @param prefix [String] Row key prefix (for example, "user").
+        # @param timeout [Integer] Call timeout in seconds.
         # @return [Boolean]
         # @example
         #   require "google/cloud/bigtable"
@@ -473,7 +473,7 @@ module Google
         ##
         # Drops row range by row key prefix or deletes all.
         #
-        # @param row_key_prefix [String] Row key prefix (for example, "user")
+        # @param row_key_prefix [String] Row key prefix (for example, "user").
         # @param delete_all_data [Boolean]
         # @return [Boolean]
         #