google-cloud-bigtable 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 109fb6841cdecd45ebfadc3c2bafd019010847bbe9592ad9f2d9d44e56000d06
-  data.tar.gz: 41b10cd762bc1c11ef42754af3fb6dc3e9bc5d97bd75e84c74752228596bb245
+  metadata.gz: de71e1f2a03370a9bd442bca36beaf69923ad0dab0767961e993b0898f4c0f05
+  data.tar.gz: a7ea6cd88e7be07631df6d0cb028b4ced5c063ef037ec1275cd854e18162f1d7
 SHA512:
-  metadata.gz: 63fda26d33b5b2185086377ecf4ca64d99d20e19013b97b7a34a11164baefbc2e09e444e4304a22a4ac5da49013bb09803e0d81b55bcd3ac8f94f712e320043d
-  data.tar.gz: ec6d0a4356a0fb357264bd72654cfb21581c9787e5594e016e81d286345ef25ad6b8b8eb450dd26de061e5ca0ee32bf337fb43beb0847197d039b4007f74b5f0
+  metadata.gz: 02cd4a50305ea55e92d3abd02644da93900877ee91678ffc4831413862f8b22f371d11e29f10b3e3a369c1b062707b34225f19800fb779882998ee687aeeae2c
+  data.tar.gz: 180333779e76960db0e306c3cc80b9c17eeda1d289825f10bee6716cc253fc811a58952a62143bfbc6befd5de23e70e9ce2e42db2dbda737e5af40cf8ea8042d

data/AUTHENTICATION.md

@@ -76,7 +76,7 @@ The environment variables that google-cloud-bigtable checks for project ID are:
 1. `BIGTABLE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-bigtable checks for credentials are configured on {Google::Cloud::Bigtable::V2::Credentials}:
+The environment variables that google-cloud-bigtable checks for credentials are configured on {Google::Cloud::Bigtable::Credentials}:
 
 1. `BIGTABLE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `BIGTABLE_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release History
 
+### 2.0.0 / 2020-08-06
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-bigtable-v2` and
+`google-cloud-bigtable-admin-v2` gems as dependencies. The new dependencies
+are rewritten low-level clients, produced by a next-generation client code
+generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-bigtable-v2` and
+`google-cloud-bigtable-admin-v2`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Bigtable::V2` or
+`Google::Cloud::Bigtable::Admin::V2` modules, please review the docs for the
+new `google-cloud-bigtable-v2` and `google-cloud-bigtable-admin-v2` gems.
+In particular:
+
+* Some classes have been renamed, notably the client classes themselves.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
 ### 1.3.0 / 2020-07-21
 
 #### Features

data/lib/google-cloud-bigtable.rb

@@ -55,11 +55,6 @@ 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 client_config [Hash]
-    #   A hash for call options for each method.
-    #   See Google::Gax#construct_settings for the structure of
-    #   this data. Falls back to the default config if not specified
-    #   or the specified config is missing data points.
     # @return [Google::Cloud::Bigtable::Project]
     #
     # @example
@@ -69,13 +64,12 @@ module Google
     #
     #   bigtable = gcloud.bigtable
     #
-    def bigtable scope: nil, timeout: nil, credentials: nil, client_config: nil
+    def bigtable scope: nil, timeout: nil, credentials: nil
       Google::Cloud.bigtable(
-        project_id:    @project,
-        credentials:   (credentials || @keyfile),
-        scope:         scope,
-        timeout:       (timeout || @timeout),
-        client_config: client_config
+        project_id:  @project,
+        credentials: (credentials || @keyfile),
+        scope:       scope,
+        timeout:     (timeout || @timeout)
       )
     end
 
@@ -110,11 +104,6 @@ module Google
     #   updater_proc is supplied.
     # @param timeout [Integer]
     #   The default timeout, in seconds, for calls made through this client.
-    # @param client_config [Hash]
-    #   A hash for call options for each method.
-    #   See Google::Gax#construct_settings for the structure of
-    #   this data. Falls back to the default config if not specified
-    #   or the specified config is missing data points. Optional.
     # @return [Google::Cloud::Bigtable::Project]
     #
     # @example
@@ -122,14 +111,13 @@ module Google
     #
     #   bigtable = Google::Cloud.bigtable
     #
-    def self.bigtable project_id: nil, credentials: nil, scope: nil, timeout: nil, client_config: nil
+    def self.bigtable project_id: nil, credentials: nil, scope: nil, timeout: nil
       require "google/cloud/bigtable"
       Google::Cloud::Bigtable.new(
-        project_id:    project_id,
-        credentials:   credentials,
-        scope:         scope,
-        timeout:       timeout,
-        client_config: client_config
+        project_id:  project_id,
+        credentials: credentials,
+        scope:       scope,
+        timeout:     timeout
       )
     end
   end
@@ -149,6 +137,21 @@ Google::Cloud.configure.add_config! :bigtable do |config|
   default_emulator = Google::Cloud::Config.deferred do
     ENV["BIGTABLE_EMULATOR_HOST"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/bigtable.admin",
+    "https://www.googleapis.com/auth/bigtable.admin.cluster",
+    "https://www.googleapis.com/auth/bigtable.admin.instance",
+    "https://www.googleapis.com/auth/bigtable.admin.table",
+    "https://www.googleapis.com/auth/bigtable.data",
+    "https://www.googleapis.com/auth/bigtable.data.readonly",
+    "https://www.googleapis.com/auth/cloud-bigtable.admin",
+    "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
+    "https://www.googleapis.com/auth/cloud-bigtable.admin.table",
+    "https://www.googleapis.com/auth/cloud-bigtable.data",
+    "https://www.googleapis.com/auth/cloud-bigtable.data.readonly",
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/cloud-platform.read-only"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -162,10 +165,9 @@ Google::Cloud.configure.add_config! :bigtable do |config|
                       Proc
                     ],
                     allow_nil: true
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :emulator_host, default_emulator,
-                    match: String, allow_nil: true
-  config.add_field! :endpoint, nil, match: String
+  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
 end

data/lib/google/cloud/bigtable.rb

@@ -51,6 +51,8 @@ module Google
       #   metadata for requests, generally, to give OAuth credentials.
       # @param [String] endpoint 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.
+      #   If the param is nil, uses the default admin endpoint.
       # @param [String] emulator_host Bigtable emulator host. Optional.
       #   If the parameter is nil, uses the value of the `emulator_host` config.
       # @param scope [Array<String>]
@@ -59,11 +61,6 @@ module Google
       #   APIs](https://developers.google.com/identity/protocols/OAuth2).
       #   The OAuth scopes for this service. This parameter is ignored if an
       #   updater_proc is supplied.
-      # @param client_config [Hash]
-      #   A hash for call options for each method.
-      #   See Google::Gax#construct_settings for the structure of
-      #   this data. Falls back to the default config if not specified
-      #   or the specified config is missing data points.
       # @param timeout [Integer]
       #   The default timeout, in seconds, for calls made through this client. Optional.
       # @return [Google::Cloud::Bigtable::Project]
@@ -73,28 +70,28 @@ module Google
       #
       #   client = Google::Cloud::Bigtable.new
       #
-      def self.new project_id: nil, credentials: nil, emulator_host: nil, scope: nil, client_config: nil, endpoint: nil,
+      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
-        client_config ||= configure.client_config
         emulator_host ||= configure.emulator_host
         endpoint      ||= configure.endpoint
+        endpoint_admin ||= configure.endpoint_admin
 
-        if emulator_host
-          return new_with_emulator project_id, emulator_host, timeout,
-                                   client_config
-        end
+        return new_with_emulator project_id, emulator_host, timeout if emulator_host
 
         credentials = resolve_credentials credentials, scope
         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, timeout: timeout, client_config: client_config
-        )
+        service = Bigtable::Service.new \
+          project_id, credentials, host: endpoint, host_admin: endpoint_admin, timeout: timeout
         Bigtable::Project.new service
       end
 
@@ -113,10 +110,10 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
+      # * `endpoint_admin` - (String) Override of the admin service endpoint
+      #   host name, or `nil` to use the default admin endpoint.
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::Bigtable library uses.
@@ -130,18 +127,13 @@ module Google
       # @private
       # New client given an emulator host.
       #
-      def self.new_with_emulator project_id, emulator_host, timeout,
-                                 client_config
+      def self.new_with_emulator project_id, emulator_host, timeout
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        Bigtable::Project.new(
-          Bigtable::Service.new(
-            project_id, :this_channel_is_insecure,
-            host: emulator_host, timeout: timeout,
-            client_config: client_config
-          )
-        )
+        service = Bigtable::Service.new \
+          project_id, :this_channel_is_insecure, host: emulator_host, host_admin: emulator_host, timeout: timeout
+        Bigtable::Project.new service
       end
 
       # @private

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

@@ -193,7 +193,7 @@ module Google
         #
         def routing_policy= policy
           routing_policy_grpc = policy.to_grpc
-          if routing_policy_grpc.is_a? Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting
+          if routing_policy_grpc.is_a? Google::Cloud::Bigtable::Admin::V2::AppProfile::SingleClusterRouting
             @grpc.single_cluster_routing = routing_policy_grpc
             @changed_fields["routing_policy"] = "single_cluster_routing"
           else
@@ -417,8 +417,8 @@ module Google
         # @private
         #
         # Creates a new Instance instance from a
-        # Google::Bigtable::Admin::V2::Table.
-        # @param grpc [Google::Bigtable::Admin::V2::Table]
+        # Google::Cloud::Bigtable::Admin::V2::Table.
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::Table]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Table]
         def self.from_grpc grpc, service

data/lib/google/cloud/bigtable/app_profile/list.rb

@@ -135,8 +135,10 @@ module Google
           end
 
           # @private
-          # New Snapshot::List from a Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::AppProfile> object.
-          # @param grpc [Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::AppProfile> ]
+          # New Snapshot::List from a Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::AppProfile>
+          # object.
+          #
+          # @param grpc [Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::AppProfile> ]
           # @param service [Google::Cloud::Bigtable::Service]
           # @return [Array<Google::Cloud::Bigtable::AppProfile>]
           def self.from_grpc grpc, service

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

@@ -301,9 +301,9 @@ module Google
 
         # @private
         #
-        # Creates a new Backup instance from a Google::Bigtable::Admin::V2::Backup.
+        # Creates a new Backup instance from a Google::Cloud::Bigtable::Admin::V2::Backup.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::Backup]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::Backup]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Backup]
         def self.from_grpc grpc, service

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

@@ -137,8 +137,8 @@ module Google
           end
 
           # @private
-          # New Snapshot::List from a Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Backup> object.
-          # @param grpc [Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Backup> ]
+          # New Snapshot::List from a Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::Backup> object.
+          # @param grpc [Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::Backup> ]
           # @param service [Google::Cloud::Bigtable::Service]
           # @return [Array<Google::Cloud::Bigtable::Backup>]
           def self.from_grpc grpc, service

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

@@ -49,7 +49,7 @@ module Google
         ##
         # Process chunk and build full row with cells
         #
-        # @param chunk [Google::Bigtable::V2::ReadRowsResponse::CellChunk]
+        # @param chunk [Google::Cloud::Bigtable::V2::ReadRowsResponse::CellChunk]
         #
         def process chunk
           self.chunk = chunk

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

@@ -366,9 +366,9 @@ module Google
         # @private
         #
         # Creates a new Cluster instance from a
-        # Google::Bigtable::Admin::V2::Cluster.
+        # Google::Cloud::Bigtable::Admin::V2::Cluster.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::Cluster]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::Cluster]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Cluster]
         def self.from_grpc grpc, service

data/lib/google/cloud/bigtable/cluster/list.rb

@@ -142,7 +142,7 @@ module Google
 
           # @private
           #
-          # New Cluster::List from a Google::Bigtable::Admin::V2::ListClustersResponse object.
+          # New Cluster::List from a Google::Cloud::Bigtable::Admin::V2::ListClustersResponse object.
           def self.from_grpc grpc, service, instance_id: nil
             clusters = List.new(Array(grpc.clusters).map do |cluster|
               Cluster.from_grpc cluster, service

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

@@ -56,9 +56,9 @@ module Google
 
         # @private
         #
-        # Create a new ColumnFamily instance from a {Google::Bigtable::Admin::V2::ColumnFamily}.
+        # Create a new ColumnFamily instance from a {Google::Cloud::Bigtable::Admin::V2::ColumnFamily}.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::ColumnFamily]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::ColumnFamily]
         # @param name [String] Column family name
         # @return [Google::Cloud::Bigtable::ColumnFamily]
         #

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

@@ -211,7 +211,7 @@ module Google
             warn "The positional gc_rule argument is deprecated. Use the named gc_rule argument instead."
           end
 
-          column_family = Google::Bigtable::Admin::V2::ColumnFamily.new
+          column_family = Google::Cloud::Bigtable::Admin::V2::ColumnFamily.new
           column_family.gc_rule = gc_rule.to_grpc if gc_rule
           @column_families[name] = column_family
 
@@ -248,7 +248,7 @@ module Google
         def update name, gc_rule: nil
           raise ArgumentError, "column family #{name.inspect} does not exist" unless @column_families.has_key? name
 
-          column_family = Google::Bigtable::Admin::V2::ColumnFamily.new
+          column_family = Google::Cloud::Bigtable::Admin::V2::ColumnFamily.new
           column_family.gc_rule = gc_rule.to_grpc if gc_rule
           @column_families[name] = column_family
 
@@ -299,7 +299,7 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def modifications comparison_map = nil
           comparison_map ||= empty_map
@@ -352,7 +352,7 @@ module Google
         ##
         # Create an empty Google::Protobuf::Map suitable for column_families.
         def empty_map
-          Google::Bigtable::Admin::V2::Table.new.column_families
+          Google::Cloud::Bigtable::Admin::V2::Table.new.column_families
         end
 
         ##
@@ -362,13 +362,13 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def created_modifications comparison_map
           added_keys = @column_families.keys - comparison_map.keys
 
           added_keys.map do |name|
-            Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
             Modification.new(
               id:     name,
               create: @column_families[name]
@@ -383,7 +383,7 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def updated_modifications comparison_map
           possibly_updated_keys = @column_families.keys & comparison_map.keys
@@ -392,7 +392,7 @@ module Google
           end
 
           updated_keys.map do |name|
-            Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
             Modification.new(
               id:     name,
               update: @column_families[name]
@@ -407,13 +407,13 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def dropped_modifications comparison_map
           dropped_keys = comparison_map.keys - @column_families.keys
 
           dropped_keys.map do |name|
-            Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
             Modification.new(
               id:   name,
               drop: true

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

@@ -56,7 +56,7 @@ module Google
         # @param family [String] Column family name.
         #
         def initialize family
-          @grpc = Google::Bigtable::V2::ColumnRange.new family_name: family
+          @grpc = Google::Cloud::Bigtable::V2::ColumnRange.new family_name: family
         end
 
         ##
@@ -183,7 +183,7 @@ module Google
 
         # @private
         #
-        # @return [Google::Bigtable::V2::ColumnRange]
+        # @return [Google::Cloud::Bigtable::V2::ColumnRange]
         #
         def to_grpc
           @grpc