google-cloud-bigtable 2.6.0 → 2.10.1

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

@@ -44,9 +44,9 @@ module Google
       #     "my-instance",
       #     display_name: "Instance for user data",
       #     type: :DEVELOPMENT,
-      #     labels: { "env" => "dev"}
+      #     labels: { "env" => "dev" }
       #   ) do |clusters|
-      #     clusters.add("test-cluster", "us-east1-b") # nodes not allowed
+      #     clusters.add "test-cluster", "us-east1-b" # nodes not allowed
       #   end
       #
       #   job.done? #=> false
@@ -203,7 +203,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   instance.development? # true
         #   instance.type = :PRODUCTION
@@ -245,7 +245,7 @@ module Google
           labels ||= {}
           @grpc.labels = Google::Protobuf::Map.new(
             :string, :string,
-            Hash[labels.map { |k, v| [String(k), String(v)] }]
+            labels.to_h { |k, v| [String(k), String(v)] }
           )
         end
 
@@ -267,7 +267,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #   instance.display_name = "My app dev instance"  # Set display name
         #   instance.labels = { env: "dev", data: "users" }
         #   job = instance.save
@@ -314,7 +314,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #   instance.delete
         #
         def delete
@@ -340,7 +340,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   instance.clusters.all do |cluster|
         #     puts cluster.cluster_id
@@ -366,9 +366,9 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
-        #   cluster = instance.cluster("my-instance-cluster")
+        #   cluster = instance.cluster "my-cluster"
         #   puts cluster.cluster_id
         #
         def cluster cluster_id
@@ -403,7 +403,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #   job = instance.create_cluster(
         #     "my-new-cluster",
         #     "us-east-1b",
@@ -429,7 +429,7 @@ module Google
             serve_nodes:          nodes,
             default_storage_type: storage_type,
             location:             location
-          }.delete_if { |_, v| v.nil? }
+          }.compact
 
           cluster = Google::Cloud::Bigtable::Admin::V2::Cluster.new attrs
           grpc = service.create_cluster instance_id, cluster_id, cluster
@@ -450,7 +450,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   # Default name-only view
         #   instance.tables.all do |table|
@@ -490,14 +490,14 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
-        #   table = instance.table("my-table", perform_lookup: true)
+        #   table = instance.table "my-table", perform_lookup: true
         #   puts table.name
         #   puts table.column_families
         #
         #   # Name-only view
-        #   table = instance.table("my-table", view: :NAME_ONLY, perform_lookup: true)
+        #   table = instance.table "my-table", view: :NAME_ONLY, perform_lookup: true
         #   puts table.name
         #
         # @example  Mutate rows.
@@ -505,31 +505,28 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   entry = table.new_mutation_entry("user-1")
+        #   entry = table.new_mutation_entry "user-1"
         #   entry.set_cell(
         #     "cf1",
         #     "field1",
         #     "XYZ",
-        #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
-        #   ).delete_cells("cf2", "field02")
+        #     timestamp: (Time.now.to_f * 1_000_000).round(-3) # microseconds
+        #   ).delete_cells "cf2", "field02"
         #
-        #   table.mutate_row(entry)
+        #   table.mutate_row entry
         #
         def table table_id, view: nil, perform_lookup: nil, app_profile_id: nil
           ensure_service!
 
           view ||= :SCHEMA_VIEW
-          table = if perform_lookup
-                    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
-                  end
-
-          table.app_profile_id = app_profile_id
-          table
+          if perform_lookup
+            grpc = service.get_table instance_id, table_id, view: view
+            Table.from_grpc grpc, service, view: view, app_profile_id: app_profile_id
+          else
+            Table.from_path service.table_path(instance_id, table_id), service, app_profile_id: app_profile_id
+          end
         rescue Google::Cloud::NotFoundError
           nil
         end
@@ -581,9 +578,9 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
-        #   table = instance.create_table("my-table")
+        #   table = instance.create_table "my-table"
         #   puts table.name
         #
         # @example Create a table with initial splits and column families.
@@ -591,18 +588,18 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   initial_splits = ["user-00001", "user-100000", "others"]
-        #   table = instance.create_table("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))
+        #   table = instance.create_table "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_age(1800),
         #       Google::Cloud::Bigtable::GcRule.max_versions(3)
         #     )
-        #     cfm.add('cf3', gc_rule: gc_rule)
+        #     cfm.add "cf3", gc_rule: gc_rule
         #   end
         #
         #   puts table
@@ -660,10 +657,10 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
-        #     "my-instance-cluster-1",
+        #     "my-cluster",
         #     allow_transactional_writes: true
         #   )
         #
@@ -679,7 +676,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #
@@ -695,7 +692,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #
@@ -721,7 +718,7 @@ module Google
             single_cluster_routing:        single_cluster_routing,
             description:                   description,
             etag:                          etag
-          }.delete_if { |_, v| v.nil? }
+          }.compact
 
           grpc = service.create_app_profile(
             instance_id,
@@ -746,9 +743,9 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
-        #   app_profile = instance.app_profile("my-app-profile")
+        #   app_profile = instance.app_profile "my-app-profile"
         #
         #   if app_profile
         #     puts app_profile.name
@@ -776,7 +773,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   instance.app_profiles.all do |app_profile|
         #     puts app_profile.name
@@ -808,17 +805,17 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #   policy = instance.policy
         #
         # @example Update the policy by passing a block.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   instance.policy do |p|
-        #     p.add("roles/owner", "user:owner@example.com")
+        #     p.add "roles/owner", "user:owner@example.com"
         #   end # 2 API calls
         #
         def policy
@@ -849,11 +846,11 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   policy = instance.policy
-        #   policy.add("roles/owner", "user:owner@example.com")
-        #   updated_policy = instance.update_policy(policy)
+        #   policy.add "roles/owner", "user:owner@example.com"
+        #   updated_policy = instance.update_policy policy
         #
         #   puts updated_policy.roles
         #
@@ -892,7 +889,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   permissions = instance.test_iam_permissions(
         #     "bigtable.instances.get",

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

@@ -33,14 +33,14 @@ module Google
       #     See {Google::Cloud::Bigtable::Table#check_and_mutate_row}
       #
       # @example
-      #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-      #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
+      #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
+      #   timestamp_micros = (Time.now.to_f * 1_000_000).round(-3)
       #   entry.set_cell(
       #     "cf1", "fiel01", "XYZ", timestamp: timestamp_micros
       #   ).delete_cells(
       #     "cf2",
       #     "field02",
-      #     timestamp_from: timestamp_micros - 5000000,
+      #     timestamp_from: timestamp_micros - 5_000_000,
       #     timestamp_to: timestamp_micros
       #   ).delete_from_family("cf3").delete_from_row
       #
@@ -48,10 +48,10 @@ module Google
       #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
-      #   table = bigtable.table("my-instance", "my-table")
+      #   table = bigtable.table "my-instance", "my-table"
       #
-      #   entry = table.new_mutation_entry("user-1")
-      #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
+      #   entry = table.new_mutation_entry "user-1"
+      #   timestamp_micros = (Time.now.to_f * 1_000_000).round(-3)
       #   entry.set_cell(
       #     "cf1", "fiel01", "XYZ", timestamp: timestamp_micros
       #   )
@@ -101,16 +101,16 @@ module Google
         # @return [MutationEntry]  `self` object of entry for chaining.
         #
         # @example
-        #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-        #   entry.set_cell("cf1", "field01", "XYZ")
+        #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
+        #   entry.set_cell "cf1", "field01", "XYZ"
         #
         # @example With timestamp.
-        #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
+        #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
         #   entry.set_cell(
         #     "cf1",
         #     "field1",
         #     "XYZ",
-        #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
+        #     timestamp: (Time.now.to_f * 1_000_000).round(-3) # microseconds
         #   )
         #
         def set_cell family, qualifier, value, timestamp: nil
@@ -158,25 +158,25 @@ module Google
         # @return [MutationEntry] `self` object of entry for chaining.
         #
         # @example Without timestamp range.
-        #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-        #   entry.delete_cells("cf1", "field1")
+        #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
+        #   entry.delete_cells "cf1", "field1"
         #
         # @example With timestamp range.
-        #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-        #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
+        #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
+        #   timestamp_micros = (Time.now.to_f * 1_000_000).round(-3)
         #   entry.delete_cells(
         #     "cf1",
         #     "field1",
-        #     timestamp_from: timestamp_micros - 5000000,
+        #     timestamp_from: timestamp_micros - 5_000_000,
         #     timestamp_to: timestamp_micros
         #   )
         # @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 = Google::Cloud::Bigtable::MutationEntry.new "user-1"
+        #   timestamp_micros = (Time.now.to_f * 1_000_000).round(-3)
         #   entry.delete_cells(
         #     "cf1",
         #     "field1",
-        #     timestamp_from: timestamp_micros - 5000000
+        #     timestamp_from: timestamp_micros - 5_000_000
         #   )
         #
         def delete_cells family, qualifier, timestamp_from: nil, timestamp_to: nil
@@ -203,8 +203,8 @@ module Google
         # @return [MutationEntry] `self` object of entry for chaining.
         #
         # @example
-        #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-        #   entry.delete_from_family("cf1")
+        #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
+        #   entry.delete_from_family "cf1"
         #
         def delete_from_family family
           @mutations << Google::Cloud::Bigtable::V2::Mutation.new(delete_from_family: { family_name: family })
@@ -219,7 +219,7 @@ module Google
         # @return [MutationEntry] `self` object of entry for chaining.
         #
         # @example
-        #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
+        #   entry = Google::Cloud::Bigtable::MutationEntry.new "user-1"
         #   entry.delete_from_row
         #
         def delete_from_row

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

@@ -50,28 +50,28 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   entry = table.new_mutation_entry("user-1")
-        #   entry.set_cell("cf1", "field1", "XYZ")
-        #   table.mutate_row(entry)
+        #   entry = table.new_mutation_entry "user-1"
+        #   entry.set_cell "cf1", "field1", "XYZ"
+        #   table.mutate_row entry
         #
         # @example Multiple mutations on row.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   entry = table.new_mutation_entry("user-1")
+        #   entry = table.new_mutation_entry "user-1"
         #   entry.set_cell(
         #     "cf1",
         #     "field1",
         #     "XYZ",
-        #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
-        #   ).delete_cells("cf2", "field02")
+        #     timestamp: (Time.now.to_f * 1_000_000).round(-3) # microseconds
+        #   ).delete_cells "cf2", "field02"
         #
-        #   table.mutate_row(entry)
+        #   table.mutate_row entry
         #
         def mutate_row entry
           service.mutate_row path, entry.row_key, entry.mutations, app_profile_id: @app_profile_id
@@ -96,12 +96,12 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
         #   entries = []
         #   entries << table.new_mutation_entry("row-1").set_cell("cf1", "field1", "XYZ")
         #   entries << table.new_mutation_entry("row-2").set_cell("cf1", "field1", "ABC")
-        #   responses = table.mutate_rows(entries)
+        #   responses = table.mutate_rows entries
         #
         #   responses.each do |response|
         #     puts response.status.description
@@ -131,15 +131,15 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   rule_1 = table.new_read_modify_write_rule("cf", "field01")
-        #   rule_1.append("append-xyz")
+        #   rule_1 = table.new_read_modify_write_rule "cf", "field01"
+        #   rule_1.append "append-xyz"
         #
-        #   rule_2 = table.new_read_modify_write_rule("cf", "field01")
-        #   rule_2.increment(1)
+        #   rule_2 = table.new_read_modify_write_rule "cf", "field01"
+        #   rule_2.increment 1
         #
-        #   row = table.read_modify_write_row("user01", [rule_1, rule_2])
+        #   row = table.read_modify_write_row "user01", [rule_1, rule_2]
         #
         #   puts row.cells
         #
@@ -147,11 +147,11 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
         #   rule = table.new_read_modify_write_rule("cf", "field01").append("append-xyz")
         #
-        #   row = table.read_modify_write_row("user01", rule)
+        #   row = table.read_modify_write_row "user01", rule
         #
         #   puts row.cells
         #
@@ -214,19 +214,19 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   predicate_filter = Google::Cloud::Bigtable::RowFilter.key("user-10")
+        #   predicate_filter = Google::Cloud::Bigtable::RowFilter.key "user-10"
         #   on_match_mutations = Google::Cloud::Bigtable::MutationEntry.new
         #   on_match_mutations.set_cell(
         #     "cf1",
         #     "field1",
         #     "XYZ",
-        #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
-        #   ).delete_cells("cf2", "field02")
+        #     timestamp: (Time.now.to_f * 1_000_000).round(-3) # microseconds
+        #   ).delete_cells "cf2", "field02"
         #
         #   otherwise_mutations = Google::Cloud::Bigtable::MutationEntry.new
-        #   otherwise_mutations.delete_from_family("cf3")
+        #   otherwise_mutations.delete_from_family "cf3"
         #
         #   predicate_matched = table.check_and_mutate_row(
         #     "user01",
@@ -264,9 +264,9 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   entry = table.new_mutation_entry("row-key-1")
+        #   entry = table.new_mutation_entry "row-key-1"
         #
         #   # Without row key
         #   entry = table.new_mutation_entry
@@ -289,17 +289,17 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
-        #   rule = table.new_read_modify_write_rule("cf", "qualifier-1")
-        #   rule.append("append-xyz")
+        #   table = bigtable.table "my-instance", "my-table"
+        #   rule = table.new_read_modify_write_rule "cf", "qualifier-1"
+        #   rule.append "append-xyz"
         #
         # @example Create rule to increment qualifier value.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
-        #   rule = table.new_read_modify_write_rule("cf", "qualifier-1")
-        #   rule.increment(100)
+        #   table = bigtable.table "my-instance", "my-table"
+        #   rule = table.new_read_modify_write_rule "cf", "qualifier-1"
+        #   rule.increment 100
         #
         def new_read_modify_write_rule family, qualifier
           Google::Cloud::Bigtable::ReadModifyWriteRule.new family, qualifier
@@ -323,12 +323,12 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
         #   entries = []
         #   entries << table.new_mutation_entry("row-1").set_cell("cf1", "field1", "XYZ")
         #   entries << table.new_mutation_entry("row-2").set_cell("cf1", "field1", "ABC")
-        #   responses = table.mutate_rows(entries)
+        #   responses = table.mutate_rows entries
         #
         #   responses.each do |response|
         #     puts response.status.description

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

@@ -49,8 +49,8 @@ module Google
       #   instance = bigtable.instance "my-instance"
       #
       #   policy = instance.policy
-      #   policy.remove("roles/owner", "user:owner@example.com")
-      #   policy.add("roles/owner", "user:newowner@example.com")
+      #   policy.remove "roles/owner", "user:owner@example.com"
+      #   policy.add "roles/owner", "user:newowner@example.com"
       #   policy.roles["roles/viewer"] = ["allUsers"]
       #
       class Policy
@@ -85,7 +85,7 @@ module Google
         #   instance = bigtable.instance "my-instance"
         #
         #   policy = instance.policy
-        #   policy.add("roles/owner", "user:newowner@example.com")
+        #   policy.add "roles/owner", "user:newowner@example.com"
         #
         def add role_name, member
           role(role_name) << member
@@ -111,7 +111,7 @@ module Google
         #   instance = bigtable.instance "my-instance"
         #
         #   policy = instance.policy
-        #   policy.remove("roles/owner", "user:newowner@example.com")
+        #   policy.remove "roles/owner", "user:newowner@example.com"
         #
         def remove role_name, member
           role(role_name).delete member