google-cloud-bigtable 0.8.0 → 1.0.0

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

@@ -35,11 +35,11 @@ module Google
           attr_accessor :token
 
           ##
-          # Locations from which Instance information could not be retrieved,
+          # Locations from which instance information could not be retrieved,
           # due to an outage or some other transient condition.
-          # Instances whose Clusters are all in one of the failed locations
-          # may be missing from `instances`, and Instances with at least one
-          # Cluster in a failed location may only have partial information returned.
+          # Instances whose clusters are all in one of the failed locations
+          # may be missing from `instances`, and instances with at least one
+          # cluster in a failed location may only have partial information returned.
           attr_accessor :failed_locations
 
           # @private

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

@@ -37,7 +37,7 @@ module Google
         attr_accessor :service
 
         ##
-        # Get result object of the operation.
+        # Gets the result object of the operation.
         #
         # @return [Object, nil]
         #   `nil` if the operation is not complete.

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

@@ -42,7 +42,7 @@ module Google
       #     timestamp_to: timestamp_micros
       #   ).delete_from_family("cf3").delete_from_row
       #
-      # @example Using table
+      # @example Create using a table.
       #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
@@ -74,9 +74,9 @@ module Google
         end
 
         ##
-        # Add SetCell mutation to list of mutations.
+        # Adds a SetCell to the list of mutations.
         #
-        # A mutation that sets the value of the specified cell.
+        # A SetCell is a mutation that sets the value of the specified cell.
         #
         # @param family [String] Table column family name.
         #   The name of the family into which new data should be written.
@@ -101,7 +101,7 @@ module Google
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   entry.set_cell("cf1", "field01", "XYZ")
         #
-        # @example With timestamp
+        # @example With timestamp.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   entry.set_cell(
         #     "cf-1",
@@ -128,10 +128,11 @@ module Google
         end
 
         ##
-        # Add DeleteFromColumn entry to list of mutations.
+        # Adds a DeleteFromColumn to the list of mutations.
         #
-        # A mutation that deletes cells from the specified column, optionally
-        # restricting the deletions to a given timestamp range.
+        # A DeleteFromColumn is a mutation that deletes cells from the
+        # specified column, optionally restricting the deletions to a given
+        # timestamp range.
         #
         # @param family [String] Table column family name.
         #   The name of the column family from which cells should be deleted.
@@ -153,11 +154,11 @@ module Google
         #   (millisecond granularity). For example: `1564257960168000`.
         # @return [MutationEntry] `self` object of entry for chaining.
         #
-        # @example Without timestamp range
+        # @example Without timestamp range.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   entry.delete_cells("cf-1", "field-1")
         #
-        # @example With timestamp range
+        # @example With timestamp range.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
         #   entry.delete_cells(
@@ -166,7 +167,7 @@ module Google
         #     timestamp_from: timestamp_micros - 5000000,
         #     timestamp_to: timestamp_micros
         #   )
-        # @example With timestamp range with lower boundary only
+        # @example With timestamp range with lower boundary only.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
         #   entry.delete_cells(
@@ -188,9 +189,9 @@ module Google
         end
 
         ##
-        # Add DeleteFromFamily to list of mutations.
+        # Adds a DeleteFromFamily to the list of mutations.
         #
-        # A mutation that deletes all cells from the specified column family.
+        # A DeleteFromFamily is a mutation that deletes all cells from the specified column family.
         #
         # @param family [String] Table column family name.
         #   The name of the column family from which cells should be deleted.
@@ -207,9 +208,9 @@ module Google
         end
 
         ##
-        # Add DeleteFromRow entry to list of mutations
+        # Adds a DeleteFromRow to the list of mutations.
         #
-        # A Mutation which deletes all cells from the containing row.
+        # A DeleteFromRow is a mutation which deletes all cells from the containing row.
         #
         # @return [MutationEntry] `self` object of entry for chaining.
         #
@@ -223,7 +224,7 @@ module Google
         end
 
         ##
-        # Mutation entry is retryable or not based on set_cell value.
+        # If the mutation entry is retryable or not based on set_cell value.
         #
         # @return [Boolean]
         #
@@ -232,7 +233,7 @@ module Google
         end
 
         ##
-        # Number of mutations
+        # The number of mutations.
         #
         # @return [Integer]
         #

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

@@ -36,13 +36,11 @@ module Google
       #
       module MutationOperations
         ##
-        # Mutate row.
-        #
         # Mutates a row atomically. Cells in the row are left
-        # unchanged unless explicitly changed by +mutation+.
+        # unchanged unless explicitly changed by the mutations.
         # Changes to be atomically applied to the specified row. Entries are applied
         # in order, meaning that earlier mutations can be masked by later mutations.
-        # Must contain at least one mutation entry and at most 100,000.
+        # Must contain at least one mutation and at most 100,000.
         #
         # @param entry [Google::Cloud::Bigtable::MutationEntry]
         #   Mutation entry with row key and list of mutations.
@@ -82,7 +80,7 @@ module Google
 
         ##
         # Mutates multiple rows in a batch. Each individual row is mutated
-        # atomically as in MutateRow, but the entire batch is not executed
+        # atomically as in #{mutate_row}, but the entire batch is not executed
         # atomically.
         #
         # @param entries [Array<Google::Cloud::Bigtable::MutationEntry>]
@@ -210,7 +208,8 @@ module Google
         #   Must contain at least one entry if +true_mutations+ is empty and at most
         #   100,000 entries.
         # @return [Boolean]
-        #   Predicate match or not status
+        #   Predicate match or not status.
+        #
         # @example
         #   require "google/cloud/bigtable"
         #
@@ -255,9 +254,9 @@ module Google
         end
 
         ##
-        # Create an instance of mutation_entry
+        # Creates a mutation entry instance.
         #
-        # @param row_key [String] Row key. Optional
+        # @param row_key [String] Row key. Optional.
         #   The row key of the row to which the mutation should be applied.
         # @return [Google::Cloud::Bigtable::MutationEntry]
         #
@@ -277,13 +276,13 @@ module Google
         end
 
         ##
-        # Create an instance of ReadModifyWriteRule to append or increment the value
+        # Create a read/modify/write rule to append or increment the value
         # of the cell qualifier.
         #
         # @param family [String]
-        #   The name of the column family to which the read/modify/write should be applied.
+        #   The name of the column family to which the read/modify/write rule should be applied.
         # @param qualifier [String]
-        #   The qualifier of the column to which the read/modify/write should be applied.
+        #   The qualifier of the column to which the read/modify/write rule should be applied.
         # @return [Google::Cloud::Bigtable::ReadModifyWriteRule]
         #
         # @example Create rule to append to qualifier value.

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

@@ -33,14 +33,13 @@ module Google
       # information about billing and authorized users, and they contain
       # Cloud Bigtable data. Each project has a friendly name and a unique ID.
       #
-      # Google::Cloud::Bigtable::Project is the main object for interacting with
+      # `Google::Cloud::Bigtable::Project` is the main object for interacting with
       # Cloud Bigtable.
       #
       # {Google::Cloud::Bigtable::Cluster} and {Google::Cloud::Bigtable::Instance}
       # objects are created, accessed, and managed by Google::Cloud::Bigtable::Project.
       #
-      # To create an instance, use {Google::Cloud::Bigtable.new} or
-      # {Google::Cloud#bigtable}.
+      # To create a `Project` instance, use {Google::Cloud::Bigtable.new}.
       #
       # @example Obtaining an instance and the clusters from a project.
       #   require "google/cloud/bigtable"
@@ -58,7 +57,6 @@ module Google
         # @private
         # Creates a new Bigtable Project instance.
         # @param service [Google::Cloud::Bigtable::Service]
-
         def initialize service
           @service = service
         end
@@ -109,9 +107,9 @@ module Google
         end
 
         ##
-        # Get an existing Bigtable instance.
+        # Gets an existing Bigtable instance.
         #
-        # @param instance_id [String] Existing instance id.
+        # @param instance_id [String] Existing instance ID.
         # @return [Google::Cloud::Bigtable::Instance, nil]
         #
         # @example
@@ -134,7 +132,7 @@ module Google
         end
 
         ##
-        # Create a Bigtable instance.
+        # Creates a Bigtable instance.
         #
         # @see https://cloud.google.com/compute/docs/regions-zones Cluster zone locations
         #
@@ -145,9 +143,9 @@ module Google
         # @param display_name [String] The descriptive name for this instance as it
         #   appears in UIs. Must be unique per project and between 4 and 30
         #   characters.
-        # @param type [Symbol] The type of the instance.
-        #   Valid values are `:DEVELOPMENT` or `:PRODUCTION`.
-        #   Default `:PRODUCTION` instance will created if left blank.
+        # @param type [Symbol] The type of the instance. When creating a development instance,
+        #   `nodes` on the cluster must not be set.
+        #   Valid values are `:DEVELOPMENT` or `:PRODUCTION`. Default is `:PRODUCTION`.
         # @param labels [Hash{String=>String}] labels 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
@@ -174,7 +172,7 @@ module Google
         #   The job representing the long-running, asynchronous processing of
         #   an instance create operation.
         #
-        # @example Create development instance.
+        # @example Create a development instance.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -185,7 +183,7 @@ module Google
         #     type: :DEVELOPMENT,
         #     labels: { "env" => "dev"}
         #   ) do |clusters|
-        #     clusters.add("test-cluster", "us-east1-b", nodes: 1)
+        #     clusters.add("test-cluster", "us-east1-b") # nodes not allowed
         #   end
         #
         #   job.done? #=> false
@@ -200,7 +198,7 @@ module Google
         #     instance = job.instance
         #   end
         #
-        # @example Create production instance.
+        # @example Create a production instance.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -242,7 +240,7 @@ module Google
         end
 
         ##
-        # List all clusters in project.
+        # Lists all clusters in the project.
         #
         # @param token [String] The `token` value returned by the last call to
         #   `clusters` indicates that this is a continuation of a call
@@ -266,13 +264,13 @@ module Google
         end
 
         ##
-        # List all tables for given instance.
+        # Lists all tables for the given instance.
         #
         # @param instance_id [String] Existing instance Id.
         # @return [Array<Google::Cloud::Bigtable::Table>]
         #   (See {Google::Cloud::Bigtable::Table::List})
         #
-        # @example Get tables
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -289,7 +287,8 @@ module Google
         end
 
         ##
-        # Get table information.
+        # Returns a table representation. If `perform_lookup` is `false` (the default), a sparse representation will be
+        # returned without performing an RPC and without verifying that the table resource exists.
         #
         # @param instance_id [String] Existing instance Id.
         # @param table_id [String] Existing table Id.
@@ -310,61 +309,34 @@ module Google
         #   "default" application profile will be used.
         # @return [Google::Cloud::Bigtable::Table, nil]
         #
-        # @example Get table with schema only view
-        #   require "google/cloud/bigtable"
-        #
-        #   bigtable = Google::Cloud::Bigtable.new
-        #
-        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true, view: :SCHEMA_VIEW)
-        #   if table
-        #     puts table.name
-        #     puts table.column_families
-        #   end
-        #
-        # @example Get table object without calling get table admin api.
+        # @example Get a sparse table representation without performing an RPC.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
         #   table = bigtable.table("my-instance", "my-table")
         #
-        # @example Get table with all fields, cluster states, and column families.
+        # @example Get a table with schema-only view.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table", view: :FULL, perform_lookup: true)
+        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true, view: :SCHEMA_VIEW)
         #   if table
         #     puts table.name
         #     puts table.column_families
-        #     puts table.cluster_states
         #   end
         #
-        # @example Mutate rows
+        # @example Get a table with all fields, cluster states, and column families.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
-        #
-        #   entry = table.new_mutation_entry("user-1")
-        #   entry.set_cell(
-        #     "cf-1",
-        #     "field-1",
-        #     "XYZ",
-        #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
-        #   ).delete_cells("cf2", "field02")
-        #
-        #   table.mutate_row(entry)
-        # @example Read rows using app profile routing
-        #   require "google/cloud/bigtable"
-        #
-        #   bigtable = Google::Cloud::Bigtable.new
-        #
-        #   table = bigtable.table("my-instance", "my-table", app_profile_id: "my-app-profile")
-        #
-        #   table.read_rows(limit: 5).each do |row|
-        #     p row
+        #   table = bigtable.table("my-instance", "my-table", view: :FULL, perform_lookup: true)
+        #   if table
+        #     puts table.name
+        #     puts table.column_families
+        #     puts table.cluster_states
         #   end
         #
         def table instance_id, table_id, view: nil, perform_lookup: nil, app_profile_id: nil
@@ -417,8 +389,6 @@ module Google
         #     * Tablet 3 : `[customer_1, customer_2) => {"customer_1"}`
         #     * Tablet 4 : `[customer_2, other)      => {"customer_2"}`
         #     * Tablet 5 : `[other, )                => {"other", "zz"}`
-        #   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 [Google::Cloud::Bigtable::ColumnFamilyMap] column_families
         #   A mutable object containing the column families for the table,
@@ -467,15 +437,14 @@ module Google
         end
 
         ##
-        # Permanently deletes a specified table and all of its data.
+        # Permanently deletes the specified table and all of its data.
         #
         # @param instance_id [String]
         #  The unique ID of the instance the table is in.
         # @param table_id [String]
-        #   The unique ID of the table to be deleted,
-        #   e.g., `foobar`
+        #   The unique ID of the table to be deleted.
         #
-        # @example Create table with column families and initial splits.
+        # @example
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new

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]