google-cloud-bigtable 2.11.1 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 181c696f1d64a700deb5f67d1016a4418fb204b3830da7ee07eac490b7215214
-  data.tar.gz: 550c9917f375b880c02862916f15b22a7d5ebf82ee75c097d96160dc847a6b3d
+  metadata.gz: d532accadd2ab9206259a83bc75b52a460d8e15e2253c81ee9f7124fdefbfa83
+  data.tar.gz: d1bee0fb74cf2522095176d827323731d347e6a60575f3b2beb1f664879aa616
 SHA512:
-  metadata.gz: f0b52d13a6236bbf5ec702dd3e5f157113ae8a9926cf7450c5c5823d268066d12e3380fc6b79016d9e7e7298a6db540c2b8571032805c926fc3bafaec795d94c
-  data.tar.gz: 9edb14a3040f7fff3ea9fb4b07efcdbd4dadc41bb687f2d9efc8a3c167b7a2e46d96fbff2293e0cd20ce2066149c8195bb3f588d9634ac5583e57a6be73a6e24
+  metadata.gz: 3c7164cb81c2f57bbfadb426cc1038fe1fe817cb102e6305e468c41034e0f081e4e13183c6490b49c93203b8390b4415e8288e84a3c2a330beb2a0f4b80b0fae
+  data.tar.gz: e8c61bb38bc9a0297cbf2954323239bd4ebd95a4578627b1a1707683b7e40b35e50bfd3e5f2dd8d90389330cad1562e88cd0de946006a71500db0060d4d00143

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+### 2.12.0 (2025-02-25)
+
+#### Features
+
+* Provide easier access to the admin clients ([#28917](https://github.com/googleapis/google-cloud-ruby/issues/28917)) 
+* Support for setting the universe domain ([#29173](https://github.com/googleapis/google-cloud-ruby/issues/29173)) 
+
 ### 2.11.1 (2024-12-12)
 
 #### Bug Fixes

data/OVERVIEW.md

@@ -25,22 +25,34 @@ allocation of resources that are used by Cloud Bigtable. When you create an
 instance, you must specify at least one cluster. Clusters describe where your
 data is stored and how many nodes are used for your data.
 
-Use {Google::Cloud::Bigtable::Project#create_instance Project#create_instance}
-to create an instance. The following example creates a production instance with
-one cluster and three nodes:
+To create an instance, use the instance admin client, which you can get from
+{Google::Cloud::Bigtable::Project#instance_admin_client Project#instance_admin_client}.
+The following example creates a production instance with one cluster and three
+nodes:
 
 ```ruby
 require "google/cloud/bigtable"
 
 bigtable = Google::Cloud::Bigtable.new
+instance_client = bigtable.instance_admin_client
 
-job = bigtable.create_instance(
-  "my-instance",
+instance_attrs = {
   display_name: "Instance for user data",
   labels: { "env" => "dev"}
-) do |clusters|
-  clusters.add("test-cluster", "us-east1-b", nodes: 3, storage_type: :SSD)
-end
+}
+clusters = {
+  "test-cluster" => {
+    location: "us-east1-b",
+    nodes: 3,
+    storage_type: :SSD
+  }
+}
+job = instance_client.create_instance(
+  parent: "projects/my-project",
+  instance_id: "my-instance",
+  instance: instance_attrs,
+  clusters: clusters
+)
 
 job.done? #=> false
 
@@ -51,7 +63,7 @@ job.done? #=> true
 if job.error?
   status = job.error
 else
-  instance = job.instance
+  instance = job.response.instance
 end
 ```
 
@@ -61,19 +73,28 @@ monitoring or throughput guarantees; replication is not available; and the SLA
 does not apply. When creating a development instance, you do not specify `nodes`
 for your clusters:
 
- ```ruby
+```ruby
 require "google/cloud/bigtable"
 
 bigtable = Google::Cloud::Bigtable.new
+instance_client = bigtable.instance_admin_client
 
-job = bigtable.create_instance(
-  "my-instance",
+instance_attrs = {
   display_name: "Instance for user data",
   type: :DEVELOPMENT,
   labels: { "env" => "dev"}
-) do |clusters|
-  clusters.add("test-cluster", "us-east1-b") # nodes not allowed
-end
+}
+clusters = {
+  "test-cluster" => {
+    location: "us-east1-b", # nodes not allowed
+  }
+}
+job = instance_client.create_instance(
+  parent: "projects/my-project",
+  instance_id: "my-instance",
+  instance: instance_attrs,
+  clusters: clusters
+)
 
 job.done? #=> false
 
@@ -84,9 +105,9 @@ job.done? #=> true
 if job.error?
   status = job.error
 else
-  instance = job.instance
+  instance = job.response.instance
 end
- ```
+```
 
 You can upgrade a development instance to a production instance at any time.
 
@@ -105,20 +126,25 @@ different timestamps, providing a record of how the stored data has been altered
 over time. Cloud Bigtable tables are sparse; if a cell does not contain any
 data, it does not take up any space.
 
-Use {Google::Cloud::Bigtable::Project#create_table Project#create_table} or
-{Google::Cloud::Bigtable::Instance#create_table Instance#create_table} to
-create a table:
+To create an instance, use the table admin client, which you can get from
+{Google::Cloud::Bigtable::Project#table_admin_client Project#table_admin_client},
+as illustrated in the following example:
 
 ```ruby
 require "google/cloud/bigtable"
 
 bigtable = Google::Cloud::Bigtable.new
+table_client = bigtable.table_admin_client
+
+instance_name = table_client.instance_path project: "my-project", instance: "my-instance"
+table = table_client.create_table parent: instance_name,
+                                  table_id: "my-table",
+                                  table: {}
 
-table = bigtable.create_table("my-instance", "my-table")
 puts table.name
 ```
 
-When you create a table, you may specify the column families to use in the
+When you create a table, you can specify the column families to use in the
 table, as well as a list of row keys that will be used to initially split the
 table into several tablets (tablets are similar to HBase regions):
 
@@ -126,45 +152,75 @@ table into several tablets (tablets are similar to HBase regions):
 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 |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)
-end
+table_client = bigtable.table_admin_client
+
+instance_name = table_client.instance_path project: "my-project", instance: "my-instance"
+initial_splits = [
+  {key: "user-00001"},
+  {key: "user-100000"},
+  {key: "others"}
+]
+column_families = {
+  "cf1" => {
+    gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.max_num_versions(5)
+  },
+  "cf2" => {
+    gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.max_age(600)
+  },
+  "cf3" => {
+    gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.union(
+      Google::Cloud::Bigtable::Admin::V2::GcRule.max_age(1800),
+      Google::Cloud::Bigtable::Admin::V2::GcRule.max_num_versions(3)
+    )
+  }
+}
+table = table_client.create_table parent: instance_name,
+                                  table_id: "my-table",
+                                  table: {column_families: column_families},
+                                  initial_splits: initial_splits
 
 puts table
 ```
 
-You may also add, update, and delete column families later by passing a block to
-{Google::Cloud::Bigtable::Table#column_families Table#column_families}:
+You can also add, update, and delete column families later:
 
 ```ruby
 require "google/cloud/bigtable"
 
 bigtable = Google::Cloud::Bigtable.new
-
-table = bigtable.table("my-instance", "my-table", perform_lookup: true)
-
-table.column_families do |cfm|
-  cfm.add "cf4", gc_rule: Google::Cloud::Bigtable::GcRule.max_age(600)
-  cfm.add "cf5", gc_rule: Google::Cloud::Bigtable::GcRule.max_versions(5)
-
-  rule_1 = Google::Cloud::Bigtable::GcRule.max_versions(3)
-  rule_2 = Google::Cloud::Bigtable::GcRule.max_age(600)
-  rule_union = Google::Cloud::Bigtable::GcRule.union(rule_1, rule_2)
-  cfm.update "cf2", gc_rule: rule_union
-
-  cfm.delete "cf3"
-end
-
-puts table.column_families["cf3"] #=> nil
+table_client = bigtable.table_admin_client
+
+table_name = table_client.table_path project: "my-project",
+                                     instance: "my-instance",
+                                     table: "my-table"
+modifications = [
+  {
+    id: "cf4",
+    create: {
+      gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.max_age(600)
+    }
+  },
+  {
+    id: "cf5",
+    create: {
+      gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.max_num_versions(5)
+    }
+  },
+  {
+    id: "cf2",
+    update: {
+      gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.union(
+        Google::Cloud::Bigtable::Admin::V2::GcRule.max_age(600),
+        Google::Cloud::Bigtable::Admin::V2::GcRule.max_num_versions(3)
+      )
+    }
+  },
+  {
+    id: "cf3",
+    drop: true
+  }
+]
+table_client.modify_column_families name: table_name, modifications: modifications
 ```
 
 ## Writing data

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

@@ -61,6 +61,41 @@ module Google
           @service = service
         end
 
+        ##
+        # Retrieve a client for instance administration. This client should be
+        # used for instance administration operations such as managing
+        # clusters, instances, and app profiles. See
+        # https://cloud.google.com/ruby/docs/reference/google-cloud-bigtable-admin-v2/latest/Google-Cloud-Bigtable-Admin-V2-BigtableInstanceAdmin-Client
+        # for documentation on this class.
+        #
+        # @return [Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client]
+        #
+        def instance_admin_client
+          service.instances
+        end
+
+        ##
+        # Retrieve a client for table administration. This client should be
+        # used for table administration operations such as managing tables,
+        # backups, snapshots, and authorized views. See
+        # https://cloud.google.com/ruby/docs/reference/google-cloud-bigtable-admin-v2/latest/Google-Cloud-Bigtable-Admin-V2-BigtableTableAdmin-Client
+        # for documentation on this class.
+        #
+        # @return [Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client]
+        #
+        def table_admin_client
+          service.tables
+        end
+
+        # The universe domain the client is connected to
+        #
+        # @return [String]
+        #
+        def universe_domain
+          ensure_service!
+          service.universe_domain
+        end
+
         ##
         # The identifier for the Cloud Bigtable project.
         #

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

@@ -33,6 +33,11 @@ module Google
         # @private
         attr_accessor :project_id, :credentials, :host, :host_admin, :timeout
 
+        # @private
+        def universe_domain
+          tables.universe_domain
+        end
+
         # @private
         # Creates a new Service instance.
         #
@@ -53,7 +58,7 @@ module Google
         #   The default timeout, in seconds, for calls made through this client.
         #
         def initialize project_id, credentials, host: nil, host_admin: nil, timeout: nil,
-                       channel_selection: nil, channel_count: nil
+                       channel_selection: nil, channel_count: nil, universe_domain: nil
           @project_id = project_id
           @credentials = credentials
           @host = host
@@ -61,6 +66,7 @@ module Google
           @timeout = timeout
           @channel_selection = channel_selection
           @channel_count = channel_count
+          @universe_domain_override = universe_domain
           @bigtable_clients = ::Gapic::LruHash.new 10
           @mutex = Mutex.new
         end
@@ -68,6 +74,7 @@ module Google
         def instances
           return mocked_instances if mocked_instances
           @instances ||= Admin::V2::BigtableInstanceAdmin::Client.new do |config|
+            config.universe_domain = @universe_domain_override if @universe_domain_override
             config.credentials = credentials if credentials
             config.timeout = timeout if timeout
             config.endpoint = host_admin if host_admin
@@ -81,6 +88,7 @@ module Google
         def tables
           return mocked_tables if mocked_tables
           @tables ||= Admin::V2::BigtableTableAdmin::Client.new do |config|
+            config.universe_domain = @universe_domain_override if @universe_domain_override
             config.credentials = credentials if credentials
             config.timeout = timeout if timeout
             config.endpoint = host_admin if host_admin
@@ -895,6 +903,7 @@ module Google
         def create_bigtable_client table_path, app_profile_id
           V2::Bigtable::Client.new do |config|
             config.credentials = credentials if credentials
+            config.universe_domain = @universe_domain_override if @universe_domain_override
             config.timeout = timeout if timeout
             config.endpoint = host if host
             config.lib_name = "gccl"

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

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

data/lib/google/cloud/bigtable.rb

@@ -27,6 +27,9 @@ module Google
     # See {file:OVERVIEW.md Bigtable Overview}.
     #
     module Bigtable
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/AbcSize
+
       ##
       # Service for managing Cloud Bigtable instances and tables and for reading from and
       # writing to Bigtable tables.
@@ -49,11 +52,12 @@ module Google
       #   should already be composed with a `GRPC::Core::CallCredentials` object.
       #   `Proc` will be used as an updater_proc for the gRPC channel. The proc transforms the
       #   metadata for requests, generally, to give OAuth credentials.
-      # @param [String] endpoint Override of the endpoint host name. Optional.
+      # @param universe_domain [String] Override of the universe domain. Optional.
+      # @param endpoint [String] Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
-      # @param [String] endpoint_admin Override of the admin service endpoint host name. Optional.
+      # @param endpoint_admin [String] Override of the admin service endpoint host name. Optional.
       #   If the param is nil, uses the default admin endpoint.
-      # @param [String] emulator_host Bigtable emulator host. Optional.
+      # @param emulator_host [String] Bigtable emulator host. Optional.
       #   If the parameter is nil, uses the value of the `emulator_host` config.
       # @param scope [Array<String>]
       #   The OAuth 2.0 scopes controlling the set of resources and operations
@@ -74,10 +78,9 @@ module Google
       #
       #   client = Google::Cloud::Bigtable.new
       #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/AbcSize
       def self.new project_id: nil,
                    credentials: nil,
+                   universe_domain: nil,
                    emulator_host: nil,
                    scope: nil,
                    endpoint: nil,
@@ -86,6 +89,7 @@ module Google
                    channel_selection: nil,
                    channel_count: nil
         project_id ||= default_project_id
+        universe_domain ||= configure.universe_domain
         scope ||= configure.scope
         timeout ||= configure.timeout
         emulator_host ||= configure.emulator_host
@@ -100,8 +104,11 @@ 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,
+                                        universe_domain: universe_domain,
+                                        host: endpoint,
+                                        host_admin: endpoint_admin,
+                                        timeout: timeout,
                                         channel_selection: channel_selection,
                                         channel_count: channel_count
         Bigtable::Project.new service
@@ -109,7 +116,6 @@ module Google
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/AbcSize
 
-
       ##
       # Configure the Google Cloud Bigtable library.
       #

data/lib/google-cloud-bigtable.rb

@@ -171,8 +171,9 @@ Google::Cloud.configure.add_config! :bigtable do |config|
   config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
   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! :endpoint, nil, match: String
+  config.add_field! :endpoint_admin, nil, match: String
   config.add_field! :channel_selection, :least_loaded, match: Symbol
   config.add_field! :channel_count, 1, match: Integer
+  config.add_field! :universe_domain, nil, match: String, allow_nil: true
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.12.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -28,42 +27,30 @@ dependencies:
   name: google-cloud-bigtable-admin-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: google-cloud-bigtable-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +135,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-clo
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -156,15 +142,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
 summary: API Client library for Cloud Bigtable API
 test_files: []