google-cloud-bigtable 0.1.3 → 0.2.0

data/lib/google/cloud/bigtable/app_profile/list.rb

@@ -19,7 +19,7 @@ module Google
   module Cloud
     module Bigtable
       class AppProfile
-        # AppProfile::List is a special case Array with additional
+        # AppProfile::List is a special-case array with additional
         # values.
         class List < DelegateClass(::Array)
           # @private
@@ -27,11 +27,11 @@ module Google
           attr_accessor :service
 
           # @private
-          # The gRPC page enumbrable object.
+          # The gRPC page enumerable object.
           attr_accessor :grpc
 
           # @private
-          # Create a new AppProfile::List with an array of Snapshot instances.
+          # Creates a new AppProfile::List with an array of snapshot instances.
           def initialize arr = []
             super(arr)
           end
@@ -55,7 +55,7 @@ module Google
             grpc.next_page?
           end
 
-          # Retrieve the next page of app_profiles.
+          # Retrieves the next page of app_profiles.
           #
           # @return [AppProfile::List] The list of instances.
           #
@@ -82,11 +82,11 @@ module Google
           # {#next?} returns `false`. Calls the given block once for each
           # result, which is passed as the argument to the block.
           #
-          # An Enumerator is returned if no block is given.
+          # An enumerator is returned if no block is given.
           #
           # This method will make repeated API calls until all remaining results
-          # are retrieved. (Unlike `#each`, for example, which merely iterates
-          # over the results returned by a single API call.) Use with caution.
+          # are retrieved (unlike `#each`, for example, which merely iterates
+          # over the results returned by a single API call). Use with caution.
           #
           # @yield [app_profile] The block for accessing each instance.
           # @yieldparam [AppProfile] instance The instance object.
@@ -148,9 +148,9 @@ module Google
 
           # @private
           #
-          # Raise an error if active grpc call is not available.
+          # Raises an error if an active gRPC call is not available.
           def ensure_grpc!
-            raise "Must have active grpc call" unless grpc
+            raise "Must have active gRPC call" unless grpc
           end
         end
       end

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

@@ -21,7 +21,7 @@ module Google
       # @private
       # # RowsMutator
       #
-      # Read chunk and merge based on states and build rows and cells
+      # Read a chunk of data and merge it based on states and build rows and cells
       #
       class ChunkProcessor
         # Row states
@@ -56,7 +56,7 @@ module Google
           if chunk.commit_row
             raise_if(
               chunk.value_size > 0,
-              "A row cant not have value_size and commit_row"
+              "Commit rows cannot have a non-zero value_size."
             )
           end
 
@@ -89,9 +89,9 @@ module Google
         # Validate chunk has new row state
         #
         # @raise [Google::Cloud::Bigtable::InvalidRowStateError]
-        #   If row has already set key, chunk has emoty row key, chunk state is
-        #   reset, new row key same as last read key, family name or column
-        #   qualifier is empty
+        #   If row already has a set key, chunk has an empty row key, chunk
+        #   state is reset, new row key is the same as the last-read key,
+        #   or if family name or column qualifier are empty
         #
         def validate_new_row
           raise_if(row.key, "A new row cannot have existing state")
@@ -124,7 +124,7 @@ module Google
           validate_reset_row
         end
 
-        # Process new row by setting valus from current chunk.
+        # Process new row by setting values from current chunk.
         #
         # @return [Google::Cloud::Bigtable::Row]
         #

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

@@ -110,7 +110,7 @@ module Google
         # The cluster is currently being resized, and may revert to its previous
         # node count if the process encounters an error.
         # A cluster is still capable of serving requests while being resized,
-        # but may exhibit performance as if its number of allocated nodes is
+        # but may perform as if its number of allocated nodes is
         # between the starting and requested states.
         #
         # @return [Boolean]
@@ -152,7 +152,7 @@ module Google
         end
 
         # Cluster location.
-        # i.e "us-east-1b"
+        # For example, "us-east1-b"
         #
         # @return [String]
         def location
@@ -169,7 +169,7 @@ module Google
 
         # Update cluster.
         #
-        # Updatable fields are no of nodes.
+        # `serve_nodes` is the only updatable field
         #
         # @return [Google::Cloud::Bigtable::Cluster::Job]
         #   The job representing the long-running, asynchronous processing of
@@ -209,7 +209,7 @@ module Google
         end
         alias update save
 
-        # Reload cluster information.
+        # Reloads cluster information.
         #
         # @return [Google::Cloud::Bigtable::Cluster]
 
@@ -218,7 +218,7 @@ module Google
           self
         end
 
-        # Permanently deletes the cluster
+        # Permanently deletes the cluster.
         #
         # @return [Boolean] Returns `true` if the cluster was deleted.
         #

data/lib/google/cloud/bigtable/cluster/job.rb

@@ -55,7 +55,7 @@ module Google
         #   end
         #
         class Job < LongrunningJob
-          # Get the cluster object from job results
+          # Gets the cluster object from job results
           #
           # @return [Google::Cloud::Bigtable::Cluster, nil] The cluster instance, or
           #   `nil` if the operation is not complete.

data/lib/google/cloud/bigtable/cluster/list.rb

@@ -29,16 +29,16 @@ module Google
           attr_accessor :service
 
           # @private
-          # Instance id
+          # Instance ID
           attr_accessor :instance_id
 
           # If not empty, indicates that there are more records that match
           # the request and this value should be passed to continue.
           attr_accessor :token
 
-          # Locations from which Cluster information could not be retrieved,
+          # Locations from which cluster information could not be retrieved,
           # due to an outage or some other transient condition.
-          # Clusters from these locations may be missing from `clusters`,
+          # Clusters from these locations may be missing from `clusters`
           # or may only have partial information returned.
           attr_accessor :failed_locations
 
@@ -98,11 +98,11 @@ module Google
           # {#next?} returns `false`. Calls the given block once for each
           # result, which is passed as the argument to the block.
           #
-          # An Enumerator is returned if no block is given.
+          # An enumerator is returned if no block is given.
           #
           # This method will make repeated API calls until all remaining results
-          # are retrieved. (Unlike `#each`, for example, which merely iterates
-          # over the results returned by a single API call.) Use with caution.
+          # are retrieved (unlike `#each`, for example, which merely iterates
+          # over the results returned by a single API call). Use with caution.
           #
           # @yield [cluster] The block for accessing each cluster.
           # @yieldparam [Cluster] cluster The cluster object.

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

@@ -22,7 +22,7 @@ module Google
     module Bigtable
       # # ColumnFamily
       #
-      # A set of columns within a table which share a common configuration.
+      # A set of columns within a table that share a common configuration.
       #
       # @example
       #   require "google/cloud/bigtable"
@@ -47,7 +47,7 @@ module Google
       #
       class ColumnFamily
         # @private
-        # The gRPC Service object.
+        # The gRPC Service object
         attr_accessor :service
 
         # @private
@@ -72,7 +72,7 @@ module Google
           @name = name
         end
 
-        # Set GC rule
+        # Set Column Family garbage collection rules
         #
         # @param rule [Google::Cloud::Bigtable::GcRule]
         #
@@ -80,7 +80,7 @@ module Google
           @grpc.gc_rule = rule.to_grpc
         end
 
-        # Get GC rule
+        # Get garbage collection rule
         #
         # @return [Google::Cloud::Bigtable::GcRule]
         #
@@ -88,7 +88,7 @@ module Google
           GcRule.from_grpc(@grpc.gc_rule) if @grpc.gc_rule
         end
 
-        # Create column family.
+        # Create column family
         #
         # @return [Google::Cloud::Bigtable::ColumnFamily]
         #
@@ -108,7 +108,7 @@ module Google
           modify_column_family(self.class.create_modification(name, gc_rule))
         end
 
-        # Update column family.
+        # Update column family
         #
         # @return [Google::Cloud::Bigtable::ColumnFamily]
         #
@@ -129,9 +129,9 @@ module Google
         end
         alias update save
 
-        # Permanently delete column family from table.
+        # Permanently delete column family from table
         #
-        # @return [Boolean] Whether the column family was deleted.
+        # @return [Boolean] Returns true if the column family was deleted.
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -198,7 +198,7 @@ module Google
 
         # @private
         #
-        # Creates a new ColumnFamily instance from a
+        # Create a new ColumnFamily instance from a
         # Google::Bigtable::Admin::V2::ColumnFamily.
         #
         # @param grpc [Google::Bigtable::Admin::V2::ColumnFamily]
@@ -222,7 +222,7 @@ module Google
 
         # @private
         #
-        # Create column family modification gRPC instance.
+        # Create column family modification gRPC instance
         #
         # @param type [Symbol] Type of modification.
         #   Valid values are `:create`, `:update`, `drop`
@@ -250,7 +250,7 @@ module Google
 
         # @private
         #
-        # Create/Update/Delete column_family.
+        # Create/Update/Delete column_family
         #
         # @param modification [Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification]
         # @return [Google::Cloud::Bigtable::ColumnFamily]
@@ -269,7 +269,7 @@ module Google
         # @private
         #
         # Raise an error unless an active connection to the service is
-        # available.
+        # available
         #
         def ensure_service!
           raise "Must have active connection to service" unless service

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

@@ -36,7 +36,7 @@ module Google
       #   # Range that includes all qualifiers including "user-001" up until "user-010"
       #   table.new_column_range("cf").from("user-001").to("user-010")
       #
-      #   # Range that includes all qualifiers including "user-001" up incluing "user-005"
+      #   # Range that includes all qualifiers including "user-001" up to and including "user-005"
       #   table.new_column_range("cf").from("user-001").to("user-005", inclusive: true)
       #
       #   # Range that includes all qualifiers until end of the row key "user-001".
@@ -45,7 +45,7 @@ module Google
       #   # Range with unbounded start and the inclusive end "user-100"
       #   table.new_column_range("cf").to("user-100", inclusive: true)
       #
-      #   # Range that includes all qualifiers including "user-001" up to including "user-100"
+      #   # Range that includes all qualifiers including "user-001" up to and including "user-100"
       #   table.new_column_range("cf").between("user-001", "user-100")
       #
       class ColumnRange
@@ -77,7 +77,7 @@ module Google
         #
         # @param qualifier [String] Column qualifier name. Required
         # @param inclusive [String] Lower bound flag. Inclusive/Exclusive.
-        #   Default it is an inclusive lower bound.
+        #   Default is an inclusive lower bound.
         # @return [Google::Cloud::Bigtable::ColumnRange]
         #
         # @example Inclusive lower bound.
@@ -107,9 +107,9 @@ module Google
 
         # Set column range with the upper bound.
         #
-        # @param qualifier [String] Column qualifier name. Required
-        # @param inclusive [String] Upper bound flag. Inclusive/Exclusive..
-        #   Default it is an inclusive upper bound.
+        # @param qualifier [String] Column qualifier name. Required.
+        # @param inclusive [String] Upper bound flag. Inclusive/Exclusive.
+        #   Default is an inclusive upper bound.
         # @return [Google::Cloud::Bigtable::ColumnRange]
         #
         # @example Inclusive upper bound.
@@ -139,8 +139,8 @@ module Google
 
         # Set column range with the inclusive upper and lower bound.
         #
-        # @param from_qualifier [String] Inclusive from qualifier. Required
-        # @param to_qualifier [String] Inclusive to qualifier. Required
+        # @param from_qualifier [String] Inclusive from qualifier. Required.
+        # @param to_qualifier [String] Inclusive to qualifier. Required.
         # @return [Google::Cloud::Bigtable::ColumnRange]
         #
         # @example

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

@@ -21,7 +21,7 @@ module Google
       # # GcRule
       #
       # Rule for determining which cells to delete during garbage collection.
-      # Garbage collection executes opportunistically in the background, and
+      # Garbage collection (GC) executes opportunistically in the background,
       # so it's possible for reads to return a cell even if it matches the active
       # GC expression for its family.
       #
@@ -32,7 +32,7 @@ module Google
       #   * `union` - Delete cells that would be deleted by every nested rule.
       #       It can have mutiple chainable GC Rules.
       #   * `intersection` - Delete cells that would be deleted by any nested rule.
-      #       It can have mutiple chainable GC Rules.
+      #       It can have multiple chainable GC Rules.
       #
       # @example Create GC rule instance with max version.
       #

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

@@ -27,7 +27,7 @@ module Google
       # # Instance
       #
       # Represents a Bigtable instance. Instances are dedicated Bigtable
-      # serving and storage resources to be used by Bigtable tables.
+      # storage resources that Bigtable tables.
       #
       # See {Google::Cloud::Bigtable::Project#instances},
       # {Google::Cloud::Bigtable::Project#instance}, and
@@ -89,7 +89,7 @@ module Google
         end
 
         # The descriptive name for this instance as it appears in UIs. Must be
-        # unique per project and between 4 and 30 characters in length.
+        # unique per project and between 4 and 30 characters long.
         #
         # @return [String]
 
@@ -126,7 +126,7 @@ module Google
         end
 
         # The instance has been successfully created and can serve requests
-        # to its tables
+        # to its tables.
         #
         # @return [Boolean]
 
@@ -134,7 +134,7 @@ module Google
           state == :READY
         end
 
-        # The instance is currently being created, and may be destroyed if the
+        # The instance is currently being created and may be destroyed if the
         # creation process encounters an error.
         #
         # @return [Boolean]
@@ -178,8 +178,8 @@ module Google
         # Set instance type.
         #
         # Valid values are `:DEVELOPMENT`, `:PRODUCTION`.
-        # If instance already created then After a development instance is
-        # created, it can be upgraded by updating the instance to type `PRODUCTION`.
+        # After a development instance is created, it can be upgraded
+        # by updating the instance to type `PRODUCTION`.
         # An instance created as a production instance cannot be changed to a
         # development instance.
         #
@@ -194,9 +194,9 @@ module Google
         # Cloud Labels are a flexible and lightweight mechanism for organizing
         # cloud resources into groups that reflect a customer's organizational
         # needs and deployment strategies. Cloud Labels can be used to filter
-        # collections of resources. They can be used to control how resource
-        # metrics are aggregated. And they can be used as arguments to policy
-        # management rules (e.g. route, firewall, load balancing, etc.).
+        # collections of resources, to control how resource
+        # metrics are aggregated, and as arguments to policy
+        # management rules (e.g., route, firewall, load balancing, etc.).
         #
         # * Label keys must be between 1 and 63 characters long and must conform
         #   to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
@@ -300,7 +300,7 @@ module Google
         #  cluster {Google::Cloud::Bigtable::Cluster#save}.
         #
         # @param token [String] The `token` value returned by the last call to
-        #   `clusters`; indicates that this is a continuation of a call,
+        #   `clusters`; indicates that this is a continuation of a call
         #   and that the system should return the next page of data.
         # @return [Array<Google::Cloud::Bigtable::Cluster>]
         #  See({Google::Cloud::Bigtable::Cluster::List})
@@ -356,11 +356,10 @@ module Google
         # @param location [String]
         #   The location where this cluster's nodes and storage reside. For best
         #   performance, clients should be located as close as possible to this
-        #   cluster. Currently only zones are supported.
-        #   i.e "us-east-1b"
+        #   cluster. Example: "us-east-1b"
         # @param nodes [Integer] The number of nodes allocated to this cluster.
         #   More nodes enable higher throughput and more consistent performance.
-        # @param storage_type [Symbol] Type of storage type.
+        # @param storage_type [Symbol] Storage type.
         #   The type of storage used by this cluster to serve its
         #   parent instance's tables.
         #   Valid types are:
@@ -421,7 +420,7 @@ module Google
         #
         #   instance = bigtable.instance("my-instance")
         #
-        #   # Default name only view
+        #   # Default name-only view
         #   instance.tables.all do |table|
         #     puts table.name
         #   end
@@ -448,13 +447,13 @@ module Google
         #   * `: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
-        # @param perform_lookup [Boolean] Create table object without verifying
+        # @param perform_lookup [Boolean] Creates table object without verifying
         #   that the table resource exists.
-        #   Calls made on this object will raise errors if the table.
+        #   Calls made on this object will raise errors if the table
         #   does not exist. Default value is `false`. Optional.
-        #   It helps to reduce admin apis calls.
+        #   Helps to reduce admin API calls.
         # @param app_profile_id [String] The unique identifier for the app profile. Optional.
-        #   It is used only in data operations.
+        #   Used only in data operations.
         #   This value specifies routing for replication. If not specified, the
         #   "default" application profile will be used.
         # @return [Google::Cloud::Bigtable::Table]
@@ -471,7 +470,7 @@ module Google
         #   puts table.name
         #   puts table.column_families
         #
-        #   # Name only view
+        #   # Name-only view
         #   table = instance.table("my-table", view: :NAME_ONLY, perform_lookup: true)
         #   puts table.name
         #
@@ -491,7 +490,6 @@ module Google
         #   ).delete_from_column("cf2", "field02")
         #
         #   table.mutate_row(entry)
-
         #
         def table table_id, view: nil, perform_lookup: nil, app_profile_id: nil
           ensure_service!
@@ -522,12 +520,12 @@ module Google
         #   instance, e.g., `foobar`
         # @param column_families [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
         #   (See {Google::Cloud::Bigtable::Table::ColumnFamilyMap})
-        #   If passed as an empty use code block to add column families.
+        #   If passed as an empty, use a code block to add column families.
         # @param granularity [Symbol]
         #   The granularity at which timestamps are stored in this table.
         #   Timestamps not matching the granularity will be rejected.
-        #   Valid values are `:MILLIS`.
-        #   If unspecified, the value will be set to `:MILLIS`
+        #   Valid value is `:MILLIS`.
+        #   If unspecified, the value will be set to `:MILLIS`.
         # @param initial_splits [Array<String>]
         #   The optional list of row keys that will be used to initially split the
         #   table into several tablets (tablets are similar to HBase regions).
@@ -544,13 +542,13 @@ module Google
         #     * Tablet 3 : `[customer_1, customer_2) => {"customer_1"}`
         #     * Tablet 4 : `[customer_2, other)      => {"customer_2"}`
         #     * Tablet 5 : `[other, )                => {"other", "zz"}`
-        #   A hash of the same form as `Google::Bigtable::Admin::V2::CreateTableRequest::Split`
+        #   A hash in the form of `Google::Bigtable::Admin::V2::CreateTableRequest::Split`
         #   can also be provided.
         # @yield [column_families] A block for adding column_families.
         # @yieldparam [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
         #   Cluster map of cluster name and cluster object.
         #   (See {Google::Cloud::Bigtable::Instance::ClusterMap})
-        #   GC Rules for column family see {Google::Cloud::Bigtable::GcRule})
+        #   See rules for column families at {Google::Cloud::Bigtable::GcRule})
         #
         # @return [Google::Cloud::Bigtable::Table]
         #
@@ -603,29 +601,29 @@ module Google
           )
         end
 
-        # Create app profile of instance with routing policy.
-        # Only one routing policy can applied to app profile. It can be
-        # multi cluster routing or single cluster routing
+        # Create app profile for an instance with a routing policy.
+        # Only one routing policy can applied to app profile. The policy can be
+        # multi-cluster routing or single cluster routing.
         #
         # @param name [String] Unique Id of the app profile
         # @param routing_policy [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting | Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
-        #   The routing policy for all read/write requests which use this app profile.
+        #   The routing policy for all read/write requests that use this app profile.
         #   A value must be explicitly set.
         #
         #   Routing Policies:
         #   * `multi_cluster_routing` - Read/write requests may be routed to any
-        #     cluster in the instance, and will fail over to another cluster in the event
+        #     cluster in the instance and will fail over to another cluster in the event
         #     of transient errors or delays. Choosing this option sacrifices
         #     read-your-writes consistency to improve availability.
         #   * `single_cluster_routing` - Unconditionally routes all read/write requests
-        #     to a specific cluster. This option preserves read-your-writes consistency,
+        #     to a specific cluster. This option preserves read-your-writes consistency
         #     but does not improve availability.
-        #     Value contain `cluster_id` and optional field `allow_transactional_writes`.
-        # @param description [String] Description of the use case for this AppProfile
+        #     Value contains `cluster_id` and optional field `allow_transactional_writes`.
+        # @param description [String] Description of the use case for this app profile
         # @param etag [String]
         #   Strongly validated etag for optimistic concurrency control. Preserve the
         #   value returned from `GetAppProfile` when calling `UpdateAppProfile` to
-        #   fail the request if there has been a modification in the mean time. The
+        #   fail the request if there has been a modification in the meantime. The
         #   `update_mask` of the request need not include `etag` for this protection
         #   to apply.
         #   See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
@@ -635,7 +633,7 @@ module Google
         #   Default value is `false`
         # @return [Google::Cloud::Bigtable::AppProfile]
         #
-        # @example Create app profile with single cluster routing policy
+        # @example Create an app profile with a single cluster routing policy
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -654,7 +652,7 @@ module Google
         #   )
         #   puts app_profile.name
         #
-        # @example Create 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