google-cloud-bigtable 2.7.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e534271f2a313216bfb3d54e7a5ac84dec994ee4f42da33a81a0ecd9ab1230
-  data.tar.gz: 6a4e80bf21ded6b239f26a59fbb51997a3f32130454787ff0c15136841ce8c45
+  metadata.gz: bf857acc4d00f606d2712fea755ba9f18d8c7d898599144029ff341081549f4c
+  data.tar.gz: aed266e0fabdd16d2ac25c21dde0501e4a0e4172a828f7cc5e468ec9b9caa190
 SHA512:
-  metadata.gz: 0cd1d97d9bb9663ccb56653cb6de6e60062ad9f9bb2ff8a3c010f12dab27d0ef93fb5ce38c3fefc1830df60857cb2fb26189c6bb6c15c21a53b5149b170f7040
-  data.tar.gz: d0407fd6d9f71869bc1e3a2897ab83d6de5b65c9c94a14332bb4d557de17c7c9e20cb2c74fd3e005fedb53917db02c098236d96e8aaf2213d101b2760bf0af4c
+  metadata.gz: 4f232903645d9d3e5614c862813005f2e35d998e369f6f1b0b949245e3f5a0a8fb5735d57ac3fb721c7b244d2d8e659ae94e7addef250b2fdd6cc01ad76fd6a5
+  data.tar.gz: 81cc42b99915c8fc15b42020a2582075bfaf5108420d9e3f8350dbece58da63a620316216fd1459ce34feb6b2d6c2341375b800a3c840ec2d7e1b647a09e1647

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 2.9.0 (2023-09-14)
+
+#### Features
+
+* Add support for channel pooling ([#22747](https://github.com/googleapis/google-cloud-ruby/issues/22747)) 
+
+### 2.8.0 (2023-08-17)
+
+#### Features
+
+* Added support for copybackup ([#19341](https://github.com/googleapis/google-cloud-ruby/issues/19341)) 
+
 ### 2.7.1 (2023-06-16)
 
 #### Documentation

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

@@ -109,6 +109,18 @@ module Google
           @grpc.name
         end
 
+        ##
+        # The name of the backup from which this backup is copied.
+        # Value will be empty if its not a copied backup and of the form -
+        # `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<source_backup>`
+        # if this is a copied backup.
+        #
+        # @return [String]
+        #
+        def source_backup
+          @grpc.source_backup
+        end
+
         ##
         # The table from which this backup was created.
         #
@@ -412,6 +424,61 @@ module Google
           Table::RestoreJob.from_grpc grpc, service
         end
 
+        ##
+        # Creates a copy of the backup at the desired location. Copy of the backup won't be created
+        # if the backup is already a copied one.
+        #
+        # @param dest_project_id [String] Existing project ID. Copy of the backup
+        #   will be created in this project. Required.
+        # @param dest_instance_id [Instance, String] Existing instance ID. Copy
+        #   of the backup will be created in this instance. Required.
+        # @param dest_cluster_id [String] Existing cluster ID. Copy of the backup
+        #   will be created in this cluster. Required.
+        # @param new_backup_id [String] The id of the copy of the backup to be created. This string must
+        #   be between 1 and 50 characters in length and match the regex
+        #   `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`. Required.
+        # @param expire_time [Time] The expiration time of the copy of the backup, with microseconds
+        #   granularity that must be at least 6 hours and at most 30 days from the time the request
+        #   is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup
+        #   and free the resources used by the backup. Required.
+        #
+        # @return [Google::Cloud::Bigtable::Backup::Job] The job representing the long-running, asynchronous
+        #   processing of a copy backup operation.
+        #
+        # @example Create a copy of the backup at a specific location
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
+        #
+        #   backup = cluster.backup "my-backup"
+        #
+        #   job = backup.copy dest_project_id:"my-project-2",
+        #                     dest_instance_id:"my-instance-2",
+        #                     dest_cluster_id:"my-cluster-2",
+        #                     new_backup_id:"my-backup-2",
+        #                     expire_time: Time.now + 60 * 60 * 7
+        #
+        #   job.wait_until_done!
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     backup = job.backup
+        #   end
+        #
+        def copy dest_project_id:, dest_instance_id:, dest_cluster_id:, new_backup_id:, expire_time:
+          grpc = service.copy_backup project_id: dest_project_id,
+                                     instance_id: dest_instance_id,
+                                     cluster_id: dest_cluster_id,
+                                     backup_id: new_backup_id,
+                                     source_backup: service.backup_path(instance_id, cluster_id, backup_id),
+                                     expire_time: expire_time
+          Backup::Job.from_grpc grpc, service
+        end
+
         ##
         # Updates the backup.
         #

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

@@ -17,6 +17,13 @@
 
 require "time"
 require "date"
+require "gapic/protobuf"
+require "gapic/call_options"
+require "gapic/headers"
+require "google/cloud/bigtable/version"
+require "google/cloud/bigtable/v2/version"
+require "google/bigtable/v2/bigtable_pb"
+require "google/cloud/bigtable/admin/v2"
 
 module Google
   module Cloud
@@ -89,6 +96,33 @@ module Google
           return [value].pack "q>" if value.is_a? Integer
           value
         end
+
+        def ping_and_warm_request table_path, app_profile_id, timeout
+          request = {
+            name: table_path.split("/").slice(0, 4).join("/"),
+            app_profile_id: app_profile_id
+          }
+          request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigtable::V2::PingAndWarmRequest
+
+          header_params = {}
+          if request.name && %r{^projects/[^/]+/instances/[^/]+/?$}.match?(request.name)
+            header_params["name"] = request.name
+          end
+          if request.app_profile_id && !request.app_profile_id.empty?
+            header_params["app_profile_id"] = request.app_profile_id
+          end
+          request_params_header = URI.encode_www_form header_params
+          metadata = {
+            "x-goog-request-params": request_params_header,
+            "x-goog-api-client":
+              ::Gapic::Headers.x_goog_api_client(lib_name: "gccl",
+                                                 lib_version: ::Google::Cloud::Bigtable::VERSION,
+                                                 gapic_version: ::Google::Cloud::Bigtable::V2::VERSION),
+            "google-cloud-resource-prefix": "projects/#{table_path.split('/')[1]}"
+          }
+          options = ::Gapic::CallOptions.new timeout: timeout, metadata: metadata
+          [request, options]
+        end
       end
     end
   end

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

@@ -521,15 +521,12 @@ module Google
           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

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

@@ -343,15 +343,12 @@ module Google
           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
@@ -457,6 +454,67 @@ module Google
           true
         end
 
+        ##
+        # Creates a copy of the backup at the desired location. Copy of the backup won't be created
+        # if the backup is already a copied one.
+        #
+        # @param dest_project_id [String] Existing project ID. Copy of the backup
+        #   will be created in this project. Required.
+        # @param dest_instance_id [Instance, String] Existing instance ID. Copy
+        #   of the backup will be created in this instance. Required.
+        # @param dest_cluster_id [String] Existing cluster ID. Copy of the backup
+        #   will be created in this cluster. Required.
+        # @param new_backup_id [String] The id of the copy of the backup to be created. This string must
+        #   be between 1 and 50 characters in length and match the regex
+        #   `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`. Required.
+        # @param source_instance_id [String] Existing instance ID. Backup will be copied from this instance. Required.
+        # @param source_cluster_id [String] Existing cluster ID. Backup will be copied from this cluster. Required.
+        # @param source_backup_id [Instance, String] Existing backup ID. This backup will be copied. Required.
+        # @param expire_time [Time] The expiration time of the copy of the backup, with microseconds
+        #   granularity that must be at least 6 hours and at most 30 days from the time the request
+        #   is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup
+        #   and free the resources used by the backup. Required.
+        #
+        # @return [Google::Cloud::Bigtable::Backup::Job] The job representing the long-running, asynchronous
+        #   processing of a copy backup operation.
+        #
+        # @example Create a copy of the specified backup at a specific location
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   job = bigtable.copy_backup dest_project_id:"my-project-2",
+        #                              dest_instance_id:"my-instance-2",
+        #                              dest_cluster_id:"my-cluster-2",
+        #                              new_backup_id:"my-backup-2",
+        #                              source_instance_id:"my-instance",
+        #                              source_cluster_id:"my-cluster",
+        #                              source_backup_id:"my-backup",
+        #                              expire_time: Time.now + 60 * 60 * 7
+        #
+        #   job.wait_until_done!
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     backup = job.backup
+        #   end
+        #
+        def copy_backup dest_project_id:, dest_instance_id:, dest_cluster_id:, new_backup_id:,
+                        source_instance_id:, source_cluster_id:, source_backup_id:, expire_time:
+          ensure_service!
+          grpc = service.copy_backup project_id: dest_project_id,
+                                     instance_id: dest_instance_id,
+                                     cluster_id: dest_cluster_id,
+                                     backup_id: new_backup_id,
+                                     source_backup: service.backup_path(source_instance_id,
+                                                                        source_cluster_id,
+                                                                        source_backup_id),
+                                     expire_time: expire_time
+          Backup::Job.from_grpc grpc, service
+        end
+
         protected
 
         # @private

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

@@ -20,6 +20,9 @@ require "google/cloud/bigtable/errors"
 require "google/cloud/bigtable/credentials"
 require "google/cloud/bigtable/v2"
 require "google/cloud/bigtable/admin/v2"
+require "google/cloud/bigtable/convert"
+require "gapic/lru_hash"
+require "concurrent"
 
 module Google
   module Cloud
@@ -49,12 +52,17 @@ module Google
         # @param timeout [Integer]
         #   The default timeout, in seconds, for calls made through this client.
         #
-        def initialize project_id, credentials, host: nil, host_admin: nil, timeout: nil
+        def initialize project_id, credentials, host: nil, host_admin: nil, timeout: nil,
+                       channel_selection: nil, channel_count: nil
           @project_id = project_id
           @credentials = credentials
           @host = host
           @host_admin = host_admin
           @timeout = timeout
+          @channel_selection = channel_selection
+          @channel_count = channel_count
+          @bigtable_clients = ::Gapic::LruHash.new 10
+          @mutex = Mutex.new
         end
 
         def instances
@@ -83,15 +91,15 @@ module Google
         end
         attr_accessor :mocked_tables
 
-        def client
+        def client table_path, app_profile_id
           return mocked_client if mocked_client
-          @client ||= V2::Bigtable::Client.new do |config|
-            config.credentials = credentials if credentials
-            config.timeout = timeout if timeout
-            config.endpoint = host if host
-            config.lib_name = "gccl"
-            config.lib_version = Google::Cloud::Bigtable::VERSION
-            config.metadata = { "google-cloud-resource-prefix": "projects/#{@project_id}" }
+          table_key = "#{table_path}_#{app_profile_id}"
+          @mutex.synchronize do
+            if @bigtable_clients.get(table_key).nil?
+              bigtable_client = create_bigtable_client table_path, app_profile_id
+              @bigtable_clients.put table_key, bigtable_client
+            end
+            @bigtable_clients.get table_key
           end
         end
         attr_accessor :mocked_client
@@ -649,7 +657,7 @@ module Google
         end
 
         def read_rows instance_id, table_id, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil
-          client.read_rows(
+          client(table_path(instance_id, table_id), app_profile_id).read_rows(
             **{
               table_name:     table_path(instance_id, table_id),
               rows:           rows,
@@ -661,11 +669,11 @@ module Google
         end
 
         def sample_row_keys table_name, app_profile_id: nil
-          client.sample_row_keys table_name: table_name, app_profile_id: app_profile_id
+          client(table_name, app_profile_id).sample_row_keys table_name: table_name, app_profile_id: app_profile_id
         end
 
         def mutate_row table_name, row_key, mutations, app_profile_id: nil
-          client.mutate_row(
+          client(table_name, app_profile_id).mutate_row(
             **{
               table_name:     table_name,
               app_profile_id: app_profile_id,
@@ -676,7 +684,7 @@ module Google
         end
 
         def mutate_rows table_name, entries, app_profile_id: nil
-          client.mutate_rows(
+          client(table_name, app_profile_id).mutate_rows(
             **{
               table_name:     table_name,
               app_profile_id: app_profile_id,
@@ -691,7 +699,7 @@ module Google
                                  predicate_filter: nil,
                                  true_mutations: nil,
                                  false_mutations: nil
-          client.check_and_mutate_row(
+          client(table_name, app_profile_id).check_and_mutate_row(
             **{
               table_name:       table_name,
               app_profile_id:   app_profile_id,
@@ -704,7 +712,7 @@ module Google
         end
 
         def read_modify_write_row table_name, row_key, rules, app_profile_id: nil
-          client.read_modify_write_row(
+          client(table_name, app_profile_id).read_modify_write_row(
             **{
               table_name:     table_name,
               app_profile_id: app_profile_id,
@@ -725,6 +733,19 @@ module Google
           tables.create_backup parent: cluster_path(instance_id, cluster_id), backup_id: backup_id, backup: backup
         end
 
+        ##
+        # Starts copying the selected backup to the chosen location.
+        # The underlying Google::Longrunning::Operation tracks the copying of backup.
+        #
+        # @return [Gapic::Operation]
+        #
+        def copy_backup project_id:, instance_id:, cluster_id:, backup_id:, source_backup:, expire_time:
+          tables.copy_backup parent: "projects/#{project_id}/instances/#{instance_id}/clusters/#{cluster_id}",
+                             backup_id: backup_id,
+                             source_backup: source_backup,
+                             expire_time: expire_time
+        end
+
         ##
         # @return [Google::Cloud::Bigtable::Admin::V2::Backup]
         #
@@ -872,6 +893,23 @@ module Google
         def inspect
           "#{self.class}(#{@project_id})"
         end
+
+        def create_bigtable_client table_path, app_profile_id
+          V2::Bigtable::Client.new do |config|
+            config.credentials = credentials if credentials
+            config.timeout = timeout if timeout
+            config.endpoint = host if host
+            config.lib_name = "gccl"
+            config.lib_version = Google::Cloud::Bigtable::VERSION
+            config.metadata = { "google-cloud-resource-prefix": "projects/#{@project_id}" }
+            config.channel_pool.channel_selection = @channel_selection
+            config.channel_pool.channel_count = @channel_count
+            request, options = Convert.ping_and_warm_request table_path, app_profile_id, timeout
+            config.channel_pool.on_channel_create = proc do |channel|
+              channel.call_rpc :ping_and_warm, request, options: options
+            end
+          end
+        end
       end
     end
   end

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

@@ -72,11 +72,13 @@ module Google
         # @private
         #
         # Creates a new Table instance.
-        def initialize grpc, service, view:
+        def initialize grpc, service, view:, app_profile_id: nil
           @grpc = grpc
           @service = service
+          @app_profile_id = app_profile_id
           raise ArgumentError, "view must not be nil" if view.nil?
           @loaded_views = Set[view]
+          @service.client path, app_profile_id
         end
 
         ##
@@ -659,8 +661,8 @@ module Google
         # @param view [Symbol] View type.
         # @return [Google::Cloud::Bigtable::Table]
         #
-        def self.from_grpc grpc, service, view:
-          new grpc, service, view: view
+        def self.from_grpc grpc, service, view:, app_profile_id: nil
+          new grpc, service, view: view, app_profile_id: app_profile_id
         end
 
         # @private
@@ -672,9 +674,9 @@ module Google
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Table]
         #
-        def self.from_path path, service
+        def self.from_path path, service, app_profile_id: nil
           grpc = Google::Cloud::Bigtable::Admin::V2::Table.new name: path
-          new grpc, service, view: :NAME_ONLY
+          new grpc, service, view: :NAME_ONLY, app_profile_id: app_profile_id
         end
 
         protected

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

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

data/lib/google/cloud/bigtable.rb

@@ -63,6 +63,10 @@ module Google
       #   updater_proc is supplied.
       # @param timeout [Integer]
       #   The default timeout, in seconds, for calls made through this client. Optional.
+      # @param channel_selection [Symbol] The algorithm for selecting a channel from the
+      #   pool of available channels. This parameter can have the following symbols:
+      #   *  `:least_loaded` selects the channel having least number of concurrent streams.
+      # @param channel_count [Integer] The number of channels in the pool.
       # @return [Google::Cloud::Bigtable::Project]
       #
       # @example
@@ -70,19 +74,25 @@ module Google
       #
       #   client = Google::Cloud::Bigtable.new
       #
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/AbcSize
       def self.new project_id: nil,
                    credentials: nil,
                    emulator_host: nil,
                    scope: nil,
                    endpoint: nil,
                    endpoint_admin: nil,
-                   timeout: nil
-        project_id    ||= default_project_id
-        scope         ||= configure.scope
-        timeout       ||= configure.timeout
+                   timeout: nil,
+                   channel_selection: nil,
+                   channel_count: nil
+        project_id ||= default_project_id
+        scope ||= configure.scope
+        timeout ||= configure.timeout
         emulator_host ||= configure.emulator_host
-        endpoint      ||= configure.endpoint
+        endpoint ||= configure.endpoint
         endpoint_admin ||= configure.endpoint_admin
+        channel_selection ||= configure.channel_selection
+        channel_count ||= configure.channel_count
 
         return new_with_emulator project_id, emulator_host, timeout if emulator_host
 
@@ -90,10 +100,15 @@ module Google
         project_id = resolve_project_id project_id, credentials
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        service = Bigtable::Service.new \
-          project_id, credentials, host: endpoint, host_admin: endpoint_admin, timeout: timeout
+        service = Bigtable::Service.new project_id, credentials, host: endpoint,
+                                        host_admin: endpoint_admin, timeout: timeout,
+                                        channel_selection: channel_selection,
+                                        channel_count: channel_count
         Bigtable::Project.new service
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize
+
 
       ##
       # Configure the Google Cloud Bigtable library.
@@ -116,6 +131,10 @@ module Google
       #   to use the default endpoint.
       # * `endpoint_admin` - (String) Override of the admin service endpoint
       #   host name, or `nil` to use the default admin endpoint.
+      # * `channel_selection` - (Symbol) The algorithm for selecting a channel from the
+      #   pool of available channels. This parameter can have the following symbols:
+      #     `:least_loaded` selects the channel having least number of concurrent streams.
+      # * `channel_count` - (Integer) The number of channels in the pool.
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::Bigtable library uses.

data/lib/google-cloud-bigtable.rb

@@ -171,4 +171,6 @@ Google::Cloud.configure.add_config! :bigtable do |config|
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :endpoint, "bigtable.googleapis.com", match: String
   config.add_field! :endpoint_admin, "bigtableadmin.googleapis.com", match: String
+  config.add_field! :channel_selection, :least_loaded, match: Symbol
+  config.add_field! :channel_count, 1, match: Integer
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: google-cloud-bigtable-admin-v2
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: API Client library for Cloud Bigtable API