google-cloud-bigtable 2.6.1 → 2.6.5

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

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

@@ -46,7 +46,7 @@ module Google
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
-      #   instance = bigtable.instance("my-instance")
+      #   instance = bigtable.instance "my-instance"
       #   clusters = bigtable.clusters # All clusters in the project
       #
       class Project
@@ -117,7 +117,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   if instance
         #     puts instance.instance_id
@@ -181,9 +181,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
@@ -206,9 +206,9 @@ module Google
         #   job = bigtable.create_instance(
         #     "my-instance",
         #     display_name: "Instance for user data",
-        #     labels: { "env" => "dev"}
+        #     labels: { "env" => "dev" }
         #   ) do |clusters|
-        #     clusters.add("test-cluster", "us-east1-b", nodes: 3, storage_type: :SSD)
+        #     clusters.add "test-cluster", "us-east1-b", nodes: 3, storage_type: :SSD
         #   end
         #
         #   job.done? #=> false
@@ -314,14 +314,14 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
         # @example Retrieve a table with a schema-only view.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true)
+        #   table = bigtable.table "my-instance", "my-table", perform_lookup: true
         #   if table
         #     puts table.name
         #     puts table.column_families
@@ -332,7 +332,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.table("my-instance", "my-table", view: :FULL, perform_lookup: true)
+        #   table = bigtable.table "my-instance", "my-table", view: :FULL, perform_lookup: true
         #   if table
         #     puts table.name
         #     puts table.column_families
@@ -402,7 +402,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   table = bigtable.create_table("my-instance", "my-table")
+        #   table = bigtable.create_table "my-instance", "my-table"
         #   puts table.name
         #
         # @example Create a table with initial splits and column families.
@@ -411,15 +411,15 @@ module Google
         #   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 |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 = 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)
         #     )
-        #     cfm.add('cf3', gc_rule: gc_rule)
+        #     cfm.add "cf3", gc_rule: gc_rule
         #   end
         #
         #   puts table
@@ -450,7 +450,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   bigtable.delete_table("my-instance", "my-table")
+        #   bigtable.delete_table "my-instance", "my-table"
         #
         def delete_table instance_id, table_id
           service.delete_table instance_id, table_id

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

@@ -50,7 +50,7 @@ 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"
         #
         #   table.sample_row_keys.each do |sample_row_key|
         #     p sample_row_key.key # user00116
@@ -90,7 +90,7 @@ 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"
         #
         #   table.read_rows(limit: 10).each do |row|
         #     puts row
@@ -100,7 +100,7 @@ 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"
         #
         #   table.read_rows(keys: ["user-1", "user-2"]).each do |row|
         #     puts row
@@ -110,9 +110,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"
         #
-        #   range = table.new_row_range.between("user-1", "user-100")
+        #   range = table.new_row_range.between "user-1", "user-100"
         #
         #   table.read_rows(ranges: range).each do |row|
         #     puts row
@@ -122,11 +122,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"
         #
-        #   filter = table.filter.key("user-*")
+        #   filter = table.filter.key "user-*"
         #   # OR
-        #   # filter = Google::Cloud::Bigtable::RowFilter.key("user-*")
+        #   # filter = Google::Cloud::Bigtable::RowFilter.key "user-*"
         #
         #   table.read_rows(filter: filter).each do |row|
         #     puts row
@@ -136,11 +136,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"
         #
-        #   filter = table.filter.key("user-*")
+        #   filter = table.filter.key "user-*"
         #   # OR
-        #   # filter = Google::Cloud::Bigtable::RowFilter.key("user-*")
+        #   # filter = Google::Cloud::Bigtable::RowFilter.key "user-*"
         #
         #   table.read_rows(filter: filter, limit: 10).each do |row|
         #     puts row
@@ -176,19 +176,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"
         #
-        #   row = table.read_row("user-1")
+        #   row = table.read_row "user-1"
         #
         # @example Read row with filter.
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   table = bigtable.table("my-instance", "my-table")
+        #   table = bigtable.table "my-instance", "my-table"
         #
-        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row(3)
+        #   filter = Google::Cloud::Bigtable::RowFilter.cells_per_row 3
         #
-        #   row = table.read_row("user-1", filter: filter)
+        #   row = table.read_row "user-1", filter: filter
         #
         def read_row key, filter: nil
           read_rows(keys: [key], filter: filter).first
@@ -203,11 +203,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"
         #
         #   range = table.new_value_range
-        #   range.from("abc")
-        #   range.to("xyz")
+        #   range.from "abc"
+        #   range.to "xyz"
         #
         #   # OR
         #   range = table.new_value_range.from("abc").to("xyz")
@@ -216,7 +216,7 @@ 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"
         #
         #   range = table.new_value_range.from("abc", inclusive: false).to("xyz")
         #
@@ -234,11 +234,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"
         #
-        #   range = table.new_column_range("test-family")
-        #   range.from("abc")
-        #   range.to("xyz")
+        #   range = table.new_column_range "test-family"
+        #   range.from "abc"
+        #   range.to "xyz"
         #
         #   # OR
         #   range = table.new_column_range("test-family").from("key-1").to("key-5")
@@ -247,7 +247,7 @@ 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"
         #
         #   range = table.new_column_range("test-family").from("key-1", inclusive: false).to("key-5")
         #
@@ -264,11 +264,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"
         #
         #   range = table.new_row_range
-        #   range.from("abc")
-        #   range.to("xyz")
+        #   range.from "abc"
+        #   range.to "xyz"
         #
         #   # OR
         #   range = table.new_row_range.from("key-1").to("key-5")
@@ -277,7 +277,7 @@ 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"
         #
         #   range = table.new_row_range.from("key-1", inclusive: false).to("key-5")
         #
@@ -294,9 +294,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"
         #
-        #   filter = table.filter.key("user-*")
+        #   filter = table.filter.key "user-*"
         #
         def filter
           Google::Cloud::Bigtable::RowFilter

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

@@ -38,10 +38,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
       #   )
       #
@@ -57,7 +57,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
       #
@@ -85,7 +85,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
       #
@@ -116,10 +116,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
       #   )
       #