google-cloud-bigtable 0.6.2 → 0.7.0

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

@@ -16,6 +16,7 @@
 module Google
   module Cloud
     module Bigtable
+      ##
       # # Policy
       #
       # Represents a Cloud IAM Policy for Bigtable instance resources.
@@ -63,6 +64,7 @@ module Google
           @roles = roles
         end
 
+        ##
         # Convenience method for adding a member to a binding on this policy.
         # See [Understanding
         # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
@@ -88,6 +90,7 @@ module Google
           role(role_name) << member
         end
 
+        ##
         # Convenience method for removing a member from a binding on this
         # policy. See [Understanding
         # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
@@ -101,7 +104,7 @@ module Google
         #   `"user:owner@example.com"`.
         #
         # @example
-        #   require "google/cloud/Bigtable"
+        #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #   instance = bigtable.instance "my-instance"
@@ -113,6 +116,7 @@ module Google
           role(role_name).delete member
         end
 
+        ##
         # Convenience method returning the array of members bound to a role in
         # this policy. Returns an empty array if no value is present for the role in
         # {#roles}. See [Understanding
@@ -124,7 +128,7 @@ module Google
         # @return [Array<String>] The members strings, or an empty array.
         #
         # @example
-        #   require "google/cloud/Bigtable"
+        #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #   instance = bigtable.instance "my-instance"
@@ -142,11 +146,11 @@ module Google
           bindings = roles.keys.map do |role_name|
             next if roles[role_name].empty?
             Google::Iam::V1::Binding.new(
-              role: role_name,
+              role:    role_name,
               members: roles[role_name]
             )
           end
-          Google::Iam::V1::Policy.new(etag: etag, bindings: bindings)
+          Google::Iam::V1::Policy.new etag: etag, bindings: bindings
         end
 
         # @private
@@ -155,7 +159,7 @@ module Google
           roles = grpc.bindings.each_with_object({}) do |binding, memo|
             memo[binding.role] = binding.members.to_a
           end
-          new(grpc.etag, roles)
+          new grpc.etag, roles
         end
       end
     end

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

@@ -26,6 +26,7 @@ require "google/cloud/bigtable/table"
 module Google
   module Cloud
     module Bigtable
+      ##
       # # Project
       #
       # Projects are top-level containers in Google Cloud Platform. They store
@@ -42,7 +43,7 @@ module Google
       # {Google::Cloud#bigtable}.
       #
       # @example Obtaining an instance and the clusters from a project.
-      #   require "google/cloud"
+      #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
@@ -62,12 +63,13 @@ module Google
           @service = service
         end
 
+        ##
         # The identifier for the Cloud Bigtable project.
         #
         # @return [String] Project ID.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new(
         #     project_id: "my-project",
@@ -75,12 +77,13 @@ module Google
         #   )
         #
         #   bigtable.project_id #=> "my-project"
-
+        #
         def project_id
           ensure_service!
           service.project_id
         end
 
+        ##
         # Retrieves the list of Bigtable instances for the project.
         #
         # @param token [String] The `token` value returned by the last call to
@@ -98,13 +101,14 @@ module Google
         #   instances.all do |instance|
         #     puts instance.instance_id
         #   end
-
+        #
         def instances token: nil
           ensure_service!
-          grpc = service.list_instances(token: token)
-          Instance::List.from_grpc(grpc, service)
+          grpc = service.list_instances token: token
+          Instance::List.from_grpc grpc, service
         end
 
+        ##
         # Get an existing Bigtable instance.
         #
         # @param instance_id [String] Existing instance id.
@@ -120,15 +124,16 @@ module Google
         #   if instance
         #     puts instance.instance_id
         #   end
-
+        #
         def instance instance_id
           ensure_service!
-          grpc = service.get_instance(instance_id)
-          Instance.from_grpc(grpc, service)
+          grpc = service.get_instance instance_id
+          Instance.from_grpc grpc, service
         rescue Google::Cloud::NotFoundError
           nil
         end
 
+        ##
         # Create a Bigtable instance.
         #
         # @see https://cloud.google.com/compute/docs/regions-zones Cluster zone locations
@@ -186,7 +191,7 @@ module Google
         #   job.done? #=> false
         #
         #   # Reload job until completion.
-        #   job.wait_until_done
+        #   job.wait_until_done!
         #   job.done? #=> true
         #
         #   if job.error?
@@ -211,7 +216,7 @@ module Google
         #   job.done? #=> false
         #
         #   # To block until the operation completes.
-        #   job.wait_until_done
+        #   job.wait_until_done!
         #   job.done? #=> true
         #
         #   if job.error?
@@ -219,38 +224,24 @@ module Google
         #   else
         #     instance = job.instance
         #   end
-
-        def create_instance \
-            instance_id,
-            display_name: nil,
-            type: nil,
-            labels: nil,
-            clusters: nil
+        #
+        def create_instance instance_id, display_name: nil, type: nil, labels: nil, clusters: nil
           labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
 
-          instance_attrs = {
-            display_name: display_name,
-            type: type,
-            labels: labels
-          }.delete_if { |_, v| v.nil? }
-          instance = Google::Bigtable::Admin::V2::Instance.new(instance_attrs)
+          instance_attrs = { display_name: display_name, type: type, labels: labels }.delete_if { |_, v| v.nil? }
+          instance = Google::Bigtable::Admin::V2::Instance.new instance_attrs
           clusters ||= Instance::ClusterMap.new
           yield clusters if block_given?
 
           clusters.each_value do |cluster|
-            unless cluster.location == "".freeze
-              cluster.location = service.location_path(cluster.location)
-            end
+            cluster.location = service.location_path cluster.location unless cluster.location == ""
           end
 
-          grpc = service.create_instance(
-            instance_id,
-            instance,
-            clusters.to_h
-          )
-          Instance::Job.from_grpc(grpc, service)
+          grpc = service.create_instance instance_id, instance, clusters.to_h
+          Instance::Job.from_grpc grpc, service
         end
 
+        ##
         # List all clusters in project.
         #
         # @param token [String] The `token` value returned by the last call to
@@ -267,13 +258,14 @@ module Google
         #     puts cluster.cluster_id
         #     puts cluster.ready?
         #   end
-
+        #
         def clusters token: nil
           ensure_service!
-          grpc = service.list_clusters("-", token: token)
-          Cluster::List.from_grpc(grpc, service, instance_id: "-")
+          grpc = service.list_clusters "-", token: token
+          Cluster::List.from_grpc grpc, service, instance_id: "-"
         end
 
+        ##
         # List all tables for given instance.
         #
         # @param instance_id [String] Existing instance Id.
@@ -289,16 +281,16 @@ module Google
         #     puts table.name
         #     puts table.column_families
         #   end
-
+        #
         def tables instance_id
           ensure_service!
-          grpc = service.list_tables(instance_id)
-          Table::List.from_grpc(grpc, service)
+          grpc = service.list_tables instance_id
+          Table::List.from_grpc grpc, service
         end
 
+        ##
         # Get table information.
         #
-        #
         # @param instance_id [String] Existing instance Id.
         # @param table_id [String] Existing table Id.
         # @param view [Symbol] Optional. Table view type. Default `:SCHEMA_VIEW`
@@ -325,8 +317,8 @@ module Google
         #
         #   table = bigtable.table("my-instance", "my-table", perform_lookup: true, view: :SCHEMA_VIEW)
         #   if table
-        #     p table.name
-        #     p table.column_families
+        #     puts table.name
+        #     puts table.column_families
         #   end
         #
         # @example Get table object without calling get table admin api.
@@ -344,8 +336,8 @@ module Google
         #   table = bigtable.table("my-instance", "my-table", view: :FULL, perform_lookup: true)
         #   if table
         #     puts table.name
-        #     p table.column_families
-        #     p table.cluster_states
+        #     puts table.column_families
+        #     puts table.cluster_states
         #   end
         #
         # @example Mutate rows
@@ -374,23 +366,15 @@ module Google
         #   table.read_rows(limit: 5).each do |row|
         #     p row
         #   end
-
-        def table \
-            instance_id,
-            table_id,
-            view: nil,
-            perform_lookup: nil,
-            app_profile_id: nil
+        #
+        def table instance_id, table_id, view: nil, perform_lookup: nil, app_profile_id: nil
           ensure_service!
 
           table = if perform_lookup
-                    grpc = service.get_table(instance_id, table_id, view: view)
-                    Table.from_grpc(grpc, service, view: view)
+                    grpc = service.get_table instance_id, table_id, view: view
+                    Table.from_grpc grpc, service, view: view
                   else
-                    Table.from_path(
-                      service.table_path(instance_id, table_id),
-                      service
-                    )
+                    Table.from_path service.table_path(instance_id, table_id), service
                   end
 
           table.app_profile_id = app_profile_id
@@ -399,6 +383,7 @@ module Google
           nil
         end
 
+        ##
         # Creates a new table in the specified instance.
         # The table can be created with a full set of initial column families,
         # specified in the request.
@@ -408,9 +393,9 @@ module Google
         # @param table_id [String]
         #   The ID by which the new table should be referred to within the
         #   instance, e.g., `foobar`.
-        # @param column_families [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
-        #   (See {Google::Cloud::Bigtable::Table::ColumnFamilyMap})
-        #   If unspecified, you may use a code block to add column families.
+        # @param column_families [Google::Cloud::Bigtable::ColumnFamilyMap]
+        #   An object containing the column families for the table, mapped by
+        #   column family name.
         # @param granularity [Symbol]
         #   The granularity at which timestamps are stored in this table.
         #   Timestamps not matching the granularity will be rejected.
@@ -434,15 +419,14 @@ module Google
         #     * 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 [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
-        #    Map of family name and column family object.
-        #   (See {Google::Cloud::Bigtable::Instance::ColumnFamilyMap})
-        #   (Read the GC Rules for column families at {Google::Cloud::Bigtable::GcRule})
+        # @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,
+        #   mapped by column family name.
         #
         # @return [Google::Cloud::Bigtable::Table]
         #
-        # @example Create a table without a column family
+        # @example Create a table without column families.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
@@ -450,44 +434,39 @@ module Google
         #   table = bigtable.create_table("my-instance", "my-table")
         #   puts table.name
         #
-        # @example Create table with column families and initial splits.
+        # @example Create a table with initial splits and column families.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
         #   initial_splits = ["user-00001", "user-100000", "others"]
-        #   table = bigtable.create_table("my-instance", "my-table", initial_splits: initial_splits) do |column_families|
-        #     column_families.add('cf1', Google::Cloud::Bigtable::GcRule.max_versions(5))
-        #     column_families.add('cf2', Google::Cloud::Bigtable::GcRule.max_age(600))
+        #   table = bigtable.create_table("my-instance", "my-table", initial_splits: initial_splits) do |cfm|
+        #     cfm.add('cf1', gc_rule: Google::Cloud::Bigtable::GcRule.max_versions(5))
+        #     cfm.add('cf2', gc_rule: Google::Cloud::Bigtable::GcRule.max_age(600))
         #
         #     gc_rule = Google::Cloud::Bigtable::GcRule.union(
         #       Google::Cloud::Bigtable::GcRule.max_age(1800),
         #       Google::Cloud::Bigtable::GcRule.max_versions(3)
         #     )
-        #     column_families.add('cf3', gc_rule)
+        #     cfm.add('cf3', gc_rule: gc_rule)
         #   end
         #
-        #   p table
-
-        def create_table \
-            instance_id,
-            table_id,
-            column_families: nil,
-            granularity: nil,
-            initial_splits: nil,
-            &block
+        #   puts table
+        #
+        def create_table instance_id, table_id, column_families: nil, granularity: nil, initial_splits: nil, &block
           ensure_service!
           Table.create(
             service,
             instance_id,
             table_id,
             column_families: column_families,
-            granularity: granularity,
-            initial_splits: initial_splits,
+            granularity:     granularity,
+            initial_splits:  initial_splits,
             &block
           )
         end
 
+        ##
         # Permanently deletes a specified table and all of its data.
         #
         # @param instance_id [String]
@@ -504,67 +483,10 @@ module Google
         #   bigtable.delete_table("my-instance", "my-table")
         #
         def delete_table instance_id, table_id
-          service.delete_table(instance_id, table_id)
+          service.delete_table instance_id, table_id
           true
         end
 
-        # 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
-        # where only some modifications have taken effect.
-        #
-        # @param instance_id [String]
-        #   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.
-        # @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
-        #   masked by later ones (in the case of repeated updates to the same family,
-        #   for example).
-        # @return [Google::Cloud::Bigtable::Table] Table with updated column families.
-        #
-        # @example
-        #   require "google/cloud/bigtable"
-        #
-        #   bigtable = Google::Cloud::Bigtable.new
-        #
-        #   modifications = []
-        #   modifications << Google::Cloud::Bigtable::ColumnFamily.create_modification(
-        #     "cf1", Google::Cloud::Bigtable::GcRule.max_age(600))
-        #   )
-        #
-        #   modifications << Google::Cloud::Bigtable::ColumnFamily.update_modification(
-        #     "cf2", Google::Cloud::Bigtable::GcRule.max_versions(5)
-        #   )
-        #
-        #   gc_rule_1 = Google::Cloud::Bigtable::GcRule.max_versions(3)
-        #   gc_rule_2 = Google::Cloud::Bigtable::GcRule.max_age(600)
-        #   modifications << Google::Cloud::Bigtable::ColumnFamily.update_modification(
-        #     "cf3", Google::Cloud::Bigtable::GcRule.union(gc_rule_1, gc_rule_2)
-        #   )
-        #
-        #   max_age_gc_rule = Google::Cloud::Bigtable::GcRule.max_age(300)
-        #   modifications << Google::Cloud::Bigtable::ColumnFamily.update_modification(
-        #     "cf4", Google::Cloud::Bigtable::GcRule.union(max_version_gc_rule)
-        #   )
-        #
-        #   modifications << Google::Cloud::Bigtable::ColumnFamily.drop_modification("cf5")
-        #
-        #   table = bigtable.modify_column_families("my-instance", "my-table", modifications)
-        #
-        #   p table.column_families
-
-        def modify_column_families instance_id, table_id, modifications
-          ensure_service!
-          Table.modify_column_families(
-            service,
-            instance_id,
-            table_id,
-            modifications
-          )
-        end
-
         protected
 
         # @private