google-cloud-bigtable 0.1.3 → 0.2.0

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

@@ -64,7 +64,7 @@ module Google
         # The gRPC Service object.
         attr_accessor :service
 
-        # @return [String] App profile id for request routing.
+        # @return [String] App profile ID for request routing.
         attr_accessor :app_profile_id
 
         # @private
@@ -110,7 +110,7 @@ module Google
         #
         # @param view [Symbol] Table view type.
         #   Default view type is `:SCHEMA_VIEW`
-        #   Valid view types are.
+        #   Valid view types are:
         #
         #   * `:NAME_ONLY` - Only populates `name`
         #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema
@@ -140,7 +140,7 @@ module Google
         end
 
         # The column families configured for this table, mapped by column family ID.
-        # Available column families data only in table view types: `SCHEMA_VIEW`, `FULL`
+        # Column-families data only available in table view types `SCHEMA_VIEW`, `FULL`.
         #
         #
         # @return [Array<Google::Bigtable::ColumnFamily>]
@@ -170,7 +170,7 @@ module Google
           @grpc.granularity
         end
 
-        # The table keeps data versioned at a granularity of 1ms.
+        # The table keeps data versioned at a granularity of 1 ms.
         #
         # @return [Boolean]
         #
@@ -196,7 +196,7 @@ module Google
           true
         end
 
-        # Check table existence.
+        # Checks to see if the table exists.
         #
         # @return [Boolean]
         #
@@ -213,7 +213,7 @@ module Google
         #     p "Table does not exist"
         #   end
         #
-        # @example Using bigtable instance
+        # @example Using Cloud Bigtable instance
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -292,7 +292,7 @@ module Google
           )
         end
 
-        # Apply multitple column modifications
+        # Applies multitple column modifications.
         # Performs a series of column family modifications on the specified table.
         # Either all or none of the modifications will occur before this method
         # returns, but data requests received prior to that point may see a table
@@ -358,9 +358,9 @@ module Google
         #
         # @param service [Google::Cloud::Bigtable::Service]
         # @param instance_id [String]
-        #   The unique Id of the instance in which table is exists.
+        #   The unique ID of the instance the table is in.
         # @param table_id [String]
-        #   The unique Id of the table whose families should be modified.
+        #   The unique ID of the table whose families should be modified.
         # @param modifications [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification> | Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification]
         #   Modifications to be atomically applied to the specified table's families.
         #   Entries are applied in order, meaning that earlier modifications can be
@@ -419,7 +419,7 @@ module Google
           from_grpc(grpc, service)
         end
 
-        # Generates a consistency token for a Table, which can be used in
+        # Generates a consistency token for a table. The token can be used in
         # CheckConsistency to check whether mutations to the table that finished
         # before this call started have been replicated. The tokens will be available
         # for 90 days.
@@ -442,9 +442,9 @@ module Google
           response.consistency_token
         end
 
-        # Checks replication consistency based on a consistency token, that is, if
-        # replication has caught up based on the conditions specified in the token
-        # and the check request.
+        # Checks replication consistency based on a consistency token. Replication is
+        # 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.
         #
@@ -470,7 +470,7 @@ module Google
 
         # Wait for replication to check replication consistency.
         # Checks replication consistency by generating a consistency token and
-        # calling the `check_consistency` api call 5 times (by default).
+        # making the `check_consistency` API call 5 times (by default).
         # 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`.
@@ -518,7 +518,7 @@ module Google
         end
 
         # @private
-        # Get Data client instance
+        # Gets the data client instance.
         #
         # @return [Google::Cloud::Bigtable::V2::BigtableClient]
         #
@@ -526,10 +526,10 @@ module Google
           service.client
         end
 
-        # Delete all rows
+        # Deletes all rows.
         #
         # @param timeout [Integer] Call timeout in seconds
-        #   Use in case of : Insufficient deadline for DropRowRange then
+        #   Use in case of insufficient deadline for DropRowRange, then
         #   try again with a longer request deadline.
         # @return [Boolean]
         #
@@ -549,9 +549,9 @@ module Google
           drop_row_range(delete_all_data: true, timeout: timeout)
         end
 
-        # Delete rows using row key prefix.
+        # Deletes rows using row key prefix.
         #
-        # @param prefix [String] Row key prefix. i.e "user"
+        # @param prefix [String] Row key prefix (for example, "user")
         # @param timeout [Integer] Call timeout in seconds
         # @return [Boolean]
         # @example
@@ -570,9 +570,9 @@ module Google
           drop_row_range(row_key_prefix: prefix, timeout: timeout)
         end
 
-        # Drop row range by row key prefix or delete all.
+        # Drops row range by row key prefix or deletes all.
         #
-        # @param row_key_prefix [String] Row key prefix. i.e "user"
+        # @param row_key_prefix [String] Row key prefix (for example, "user")
         # @param delete_all_data [Boolean]
         # @return [Boolean]
         #
@@ -633,7 +633,7 @@ module Google
         protected
 
         # @private
-        # Raise an error unless an active connection to the service is
+        # Raises an error unless an active connection to the service is
         # available.
         #
         def ensure_service!
@@ -648,7 +648,7 @@ module Google
 
         # @private
         #
-        # Check and reload table with expected view and set fields
+        # Checks and reloads table with expected view and sets fields.
         # @param view [Symbol] Expected view type.
         #
         def check_view_and_load view

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

@@ -19,12 +19,12 @@ module Google
   module Cloud
     module Bigtable
       class Table
-        # Table::ClusterState is a The state of a table's data in a particular cluster.
+        # Table::ClusterState is the state of a table's data in a particular cluster.
         class ClusterState
           attr_reader :cluster_name
 
           # @private
-          # Create a new Table::ClusterState
+          # Creates a new Table::ClusterState
           #
           def initialize grpc, cluster_name
             @grpc = grpc

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

@@ -19,9 +19,9 @@ module Google
   module Cloud
     module Bigtable
       class Table
-        # Table::ColumnFamilyMap is a Hash with column_family name and grpc object.
-        # It is used to create instance.
-        # @example Add column family with name and GC rule
+        # Table::ColumnFamilyMap is a hash accepting string `ColumnFamily` names as keys and `GcRule` objects as values.
+        # It is used to create an instance.
+        # @example Add column family with name and garbage collection rule
         #
         #  column_families = Google::Cloud::Bigtable::Instance::ColumnFamilyMap.new
         #
@@ -34,7 +34,7 @@ module Google
             super(value)
           end
 
-          # Add column family.
+          # Adds a column family.
           #
           # @param name [String] Column family name
           # @param gc_rule [Google::Bigtable::GcRule] GC Rule
@@ -53,7 +53,7 @@ module Google
             )
           end
 
-          # Remove column family from map.
+          # Removes a column family from the map.
           #
           # @param name [String] Column family name
           # @return [Google::Bigtable::Admin::V2::ColumnFamily]

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

@@ -19,7 +19,7 @@ module Google
   module Cloud
     module Bigtable
       class Table
-        # Table::List is a special case Array with additional
+        # Table::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 Table::List with an array of table instances.
+          # Creates a new Table::List with an array of table instances.
           def initialize arr = []
             super(arr)
           end
@@ -53,7 +53,7 @@ module Google
             grpc.next_page?
           end
 
-          # Retrieve the next page of tables.
+          # Retrieves the next page of tables.
           #
           # @return [Table::List] The list of table instances.
           #
@@ -78,11 +78,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 [table] The block for accessing each table instance.
           # @yieldparam [Table] instance The table instance object.
@@ -135,7 +135,7 @@ module Google
 
           # @private
           #
-          # Raise an error unless an active grpc call is available.
+          # Raises an error unless an active grpc call is available.
           #
           def ensure_grpc!
             raise "Must have grpc call" unless grpc

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

@@ -22,10 +22,10 @@ module Google
       #
       # Specifies a contiguous range of string values.
       #
-      # * from value bound : The value at which to from the range.
-      #   If neither field is set, interpreted as the empty string, inclusive.
+      # * from value bound : The value at which to begin the range.
+      #   If neither field is set, interpreted as an empty string, inclusive.
       # * End value bound: The value at which to end the range.
-      #   If neither field is set, interpreted as the infinite string value, exclusive.
+      #   If neither field is set, interpreted as an infinite string value, exclusive.
       #
       # @example
       #   require "google/cloud/bigtable"
@@ -56,12 +56,12 @@ module Google
       #
       class ValueRange
         # @private
-        # Create value range instance.
+        # Creates a value range instance.
         def initialize
           @grpc = Google::Bigtable::V2::ValueRange.new
         end
 
-        # Ser row range with the lower bound.
+        # Sets the row range with the lower bound.
         #
         # @param value [String] value. Required
         # @param inclusive [String] Inclusive/Exclusive lower bound.
@@ -93,7 +93,7 @@ module Google
           self
         end
 
-        # Set value range with upper bound.
+        # Sets the value range with upper bound.
         #
         # @param value [String] value. Required
         # @param inclusive [String] Inclusive/Exclusive upper bound.
@@ -125,7 +125,7 @@ module Google
           self
         end
 
-        # Set value range with the inclusive lower and upper bound.
+        # Sets the value range with the inclusive lower and upper bound.
         #
         # @param from_value [String] Inclusive from value. Required
         # @param to_value [String] Inclusive end value. Required

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigtable
-      VERSION = "0.1.3".freeze
+      VERSION = "0.2.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.59.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.59.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- EMULATOR.md
 - LICENSE
 - LOGGING.md
 - OVERVIEW.md