google-cloud-bigtable 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fec9bf567174a851d94a1b7106810e58803607f39e368d76bb54eb6583e7b40
-  data.tar.gz: b86b5f22e24f921a46f2b8335062d129c8ec46be254063ec63e923e7cb5c1fa5
+  metadata.gz: 665533520e4313e0ea1f2f4f282813b1fa98bc559c514ba6915aa0b8a0a4d716
+  data.tar.gz: 914b02d9cf075399b9ef9b7939aa87571a652316433177368868e51c2377cdee
 SHA512:
-  metadata.gz: a86ed842c65b0b550becf97f35ee23d725693302cec3357fe739103e5cfca937def10a0e6601d6475eb7293a4a4b56e66495029c83a3cbd328d9c8e71c46ed72
-  data.tar.gz: e5560028f08f23a644d8b1132628f1b568c3fb08ee81df3effd22b0c280339c27fb84979e894ce6c5a1d1c24f37c5d428b0e682615665a7460571af8151d8093
+  metadata.gz: 0b41055d5f6e073904d490e5a6ac68cdcd74120b355d85861fdfdb836ece6167d53294e7e7c98cd70bda1a25c5b1d70f628fd2a1a33a02339c48a99e4a134e21
+  data.tar.gz: 9dce87041635829275f25691849b46c634ee937ba71b1379f4c1bc7712f97ad6477762a3c9847d03b2d688ed12fb47f29b1fb90c0d3e5bd5fe4e628d112c73f5

data/.yardopts

@@ -10,6 +10,7 @@
 -
 OVERVIEW.md
 AUTHENTICATION.md
+EMULATOR.md
 LOGGING.md
 CONTRIBUTING.md
 TROUBLESHOOTING.md

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 0.2.0 / 2018-11-15
+
+* Update network configuration.
+* Allow the emulator host to be provided in the BIGTABLE_EMULATOR_HOST
+  environment variable, or the emulator_host argument.
+* Add EMULATOR guide to show how to configure and use the emulator.
+* Update documentation.
+
 ### 0.1.3 / 2018-09-20
 
 * Update connectivity configuration.

data/EMULATOR.md

@@ -0,0 +1,30 @@
+# Cloud Bigtable Emulator
+
+To develop and test your application locally, you can use the [Cloud Bigtable
+Emulator](https://cloud.google.com/bigtable/docs/emulator), which provides
+[local emulation](https://cloud.google.com/sdk/gcloud/reference/beta/emulators/)
+of the production Cloud Bigtable environment. You can start the Cloud Bigtable
+emulator using the `gcloud` command-line tool.
+
+To configure your ruby code to use the emulator, set the
+`BIGTABLE_EMULATOR_HOST` environment variable to the host and port where the
+emulator is running. The value can be set as an environment variable in the
+shell running the ruby code, or can be set directly in the ruby code as shown
+below.
+
+```ruby
+require "google/cloud/bigtable"
+
+# Make Pub/Sub use the emulator
+ENV["BIGTABLE_EMULATOR_HOST"] = "localhost:8086"
+
+bigtable = Google::Cloud::Bigtable.new "emulator-project-id"
+```
+
+Or by providing the `emulator_host` argument:
+
+```ruby
+require "google/cloud/bigtable"
+
+bigtable = Google::Cloud::Bigtable.new emulator_host: "localhost:8086"
+```

data/OVERVIEW.md

@@ -24,7 +24,8 @@ steps:
 
 ## Additional information
 
-Google Bigtable can be configured to use gRPC's logging. To learn more, see the
+Google Bigtable can be configured to use an emulator or to enable gRPC's
+logging. To learn more, see the {file:EMULATOR.md Emulator guide} and
 {file:LOGGING.md Logging guide}.
 
 [Product Documentation]: https://cloud.google.com/bigtable

data/lib/google-cloud-bigtable.rb

@@ -26,9 +26,9 @@ require "google/cloud/config"
 
 module Google
   module Cloud
-    # Creates a new object for connecting to the Bigtable service.
+    # Creates a new object for connecting to the Cloud Bigtable service.
     #
-    # For more information on connecting to Google Cloud see the
+    # For more information on connecting to Google Cloud Platform, see the
     # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param scope [Array<String>]
@@ -41,20 +41,20 @@ module Google
     #   The default timeout, in seconds, for calls made through this client.
     # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
     #   Provides the means for authenticating requests made by the client. This parameter can
-    #   be many types.
-    #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+    #   be one of the following types.
+    #   `Google::Auth::Credentials` uses the properties of its represented keyfile for
     #   authenticating requests made by this client.
-    #   A `String` will be treated as the path to the keyfile to be used for the construction of
+    #   `String` will be treated as the path to the keyfile to use to construct
     #   credentials for this client.
-    #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+    #   `Hash` will be treated as the contents of a keyfile to use to construct
     #   credentials for this client.
-    #   A `GRPC::Core::Channel` will be used to make calls through.
-    #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+    #   `GRPC::Core::Channel` will be used to make calls through.
+    #   `GRPC::Core::ChannelCredentials` will be used to set up the gRPC client. The channel credentials
     #   should already be composed with a `GRPC::Core::CallCredentials` object.
-    #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+    #   `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.
+    #   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.
@@ -78,27 +78,28 @@ module Google
       )
     end
 
-    # Create bigtable client instance for data, table admin and instance admin
-    # operartions.
+    # Creates a Cloud Bigtable client instance for data, table admin and instance admin
+    # operations.
     #
     # @param project_id [String]
     #   Project identifier for the Bigtable service you
     #   are connecting to. If not present, the default project for the
     #   credentials is used.
     # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
-    #   Provides the means for authenticating requests made by the client. This parameter can
-    #   be many types.
-    #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+    #   The means for authenticating requests made by the client. This parameter can
+    #   be one of the following types.
+    #   `Google::Auth::Credentials` uses the properties of its represented keyfile for
     #   authenticating requests made by this client.
-    #   A `String` will be treated as the path to the keyfile to be used for the construction of
+    #   `String` will be treated as the path to the keyfile to use to construct
     #   credentials for this client.
-    #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+    #   `Hash` will be treated as the contents of a keyfile to use to construct
     #   credentials for this client.
-    #   A `GRPC::Core::Channel` will be used to make calls through.
-    #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+    #   `GRPC::Core::Channel` will be used to make calls through.
+    #   `GRPC::Core::ChannelCredentials` will be used to set up the gRPC client. The channel credentials
     #   should already be composed with a `GRPC::Core::CallCredentials` object.
-    #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+    #   `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 timeout [Integer]
     # @param scope [Array<String>]
     #   The OAuth 2.0 scopes controlling the set of resources and operations
     #   that the connection can access. See [Using OAuth 2.0 to Access Google
@@ -108,7 +109,7 @@ module Google
     # @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.
+    #   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.
@@ -137,7 +138,7 @@ module Google
   end
 end
 
-# Set the default BIGTABLE configuration
+# Sets the default Bigtable configuration
 Google::Cloud.configure.add_config! :bigtable do |config|
   default_project = Google::Cloud::Config.deferred do
     ENV["BIGTABLE_PROJECT"]
@@ -148,6 +149,9 @@ Google::Cloud.configure.add_config! :bigtable do |config|
       "BIGTABLE_KEYFILE", "BIGTABLE_KEYFILE_JSON"
     )
   end
+  default_emulator = Google::Cloud::Config.deferred do
+    ENV["BIGTABLE_EMULATOR_HOST"]
+  end
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -164,4 +168,6 @@ Google::Cloud.configure.add_config! :bigtable do |config|
   config.add_field! :scope, nil, 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
 end

data/lib/google/cloud/bigtable.rb

@@ -26,26 +26,28 @@ module Google
     # See {file:OVERVIEW.md Bigtable Overview}.
     #
     module Bigtable
-      # Service for managing Bigtable instance, tables and reading from and
-      # writing to existing Bigtable tables.
+      # Service for managing Cloud Bigtable instances and tables and for reading from and
+      # writing to Bigtable tables.
       #
       # @param project_id [String]
       #   Project identifier for the Bigtable service you are connecting to.
       #   If not present, the default project for the credentials is used.
       # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
       #   Provides the means for authenticating requests made by the client. This parameter can
-      #   be many types.
-      #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+      #   be one of the following types:
+      #   `Google::Auth::Credentials` uses the properties of its represented keyfile for
       #   authenticating requests made by this client.
-      #   A `String` will be treated as the path to the keyfile to be used for the construction of
+      #   `String` will be treated as the path to the keyfile to use to construct
       #   credentials for this client.
-      #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+      #   `Hash` will be treated as the contents of a keyfile to use to construct
       #   credentials for this client.
-      #   A `GRPC::Core::Channel` will be used to make calls through.
-      #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+      #   `GRPC::Core::Channel` will be used to make calls through.
+      #   `GRPC::Core::ChannelCredentials` for the setting up the gRPC client. The channel credentials
       #   should already be composed with a `GRPC::Core::CallCredentials` object.
-      #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+      #   `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] emulator_host 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
       #   that the connection can access. See [Using OAuth 2.0 to Access Google
@@ -53,7 +55,7 @@ module Google
       #   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.
+      #   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.
@@ -69,18 +71,28 @@ module Google
       def self.new \
           project_id: nil,
           credentials: nil,
+          emulator_host: nil,
           scope: nil,
           client_config: nil,
           timeout: nil
         project_id = (project_id || default_project_id).to_s
-
-        raise InvalidArgumentError, "project_id is required" unless project_id
+        raise ArgumentError, "project_id is required" if project_id.empty?
 
         scope ||= configure.scope
         timeout ||= configure.timeout
         client_config ||= configure.client_config
-        credentials ||= default_credentials(scope: scope)
+        emulator_host ||= configure.emulator_host
+        if emulator_host
+          return Bigtable::Project.new(
+            Bigtable::Service.new(
+              project_id, :this_channel_is_insecure,
+              host: emulator_host, timeout: timeout,
+              client_config: client_config
+            )
+          )
+        end
 
+        credentials ||= default_credentials(scope: scope)
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Bigtable::Credentials.new credentials, scope: scope
         end

data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client_config.json

@@ -28,12 +28,12 @@
           "retry_params_name": "default"
         },
         "GetInstance": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "ListInstances": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
@@ -48,7 +48,7 @@
           "retry_params_name": "default"
         },
         "DeleteInstance": {
-          "timeout_millis": 150000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
@@ -58,12 +58,12 @@
           "retry_params_name": "default"
         },
         "GetCluster": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "ListClusters": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
@@ -73,47 +73,47 @@
           "retry_params_name": "default"
         },
         "DeleteCluster": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
         "CreateAppProfile": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
         "GetAppProfile": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "ListAppProfiles": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "UpdateAppProfile": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "DeleteAppProfile": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
         "GetIamPolicy": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "SetIamPolicy": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
         "TestIamPermissions": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         }

data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client_config.json

@@ -21,7 +21,7 @@
       },
       "methods": {
         "CreateTable": {
-          "timeout_millis": 900000,
+          "timeout_millis": 130000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
@@ -31,22 +31,22 @@
           "retry_params_name": "default"
         },
         "ListTables": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "GetTable": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
         "DeleteTable": {
-          "timeout_millis": 120000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
         "ModifyColumnFamilies": {
-          "timeout_millis": 900000,
+          "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },

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

@@ -116,28 +116,28 @@ module Google
           @grpc.multi_cluster_routing_use_any
         end
 
-        # Get value of single cluster routing policy
+        # Get value of single cluster routing policy.
         #
         # @return [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting]
         def single_cluster_routing
           @grpc.single_cluster_routing
         end
 
-        # Set routing policy
+        # Set routing policy.
         #
         # @param policy [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting | Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
-        #   The routing policy for all read/write requests which use this app profile.
+        #   The routing policy for all read/write requests that use this app profile.
         #   A value must be explicitly set.
         #
         #   Routing Policies:
         #   * `multi_cluster_routing` - Read/write requests may be routed to any
-        #     cluster in the instance, and will fail over to another cluster in the event
+        #     cluster in the instance and will fail over to another cluster in the event
         #     of transient errors or delays. Choosing this option sacrifices
         #     read-your-writes consistency to improve availability.
         #   * `single_cluster_routing` - Unconditionally routes all read/write requests
-        #     to a specific cluster. This option preserves read-your-writes consistency,
+        #     to a specific cluster. This option preserves read-your-writes consistency
         #     but does not improve availability.
-        #     Value contain `cluster_id` and optional field `allow_transactional_writes`.
+        #     The value contains `cluster_id` and optional field `allow_transactional_writes`.
         #
         # @example Set multi cluster routing policy
         #   require "google/cloud/bigtable"
@@ -173,7 +173,7 @@ module Google
           end
         end
 
-        # Get routing policy
+        # Get routing policy.
         #
         # @return [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting, Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
         #
@@ -300,10 +300,10 @@ module Google
 
         # Create instance of multi cluster routing policy.
         #
-        # Read/write requests may be routed to any cluster in the instance, and will
-        # Fail over to another cluster in the event of transient errors or delays.
+        # Read/write requests may be routed to any cluster in the instance and will
+        # fail over to another cluster in the event of transient errors or delays.
         # Choosing this option sacrifices read-your-writes consistency to improve
-        # availability
+        # availability.
         # @return [Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
         #
         # @example Create instance of multi cluster routing
@@ -314,19 +314,19 @@ module Google
           Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny.new
         end
 
-        # Create instance of single cluster routing
+        # Create instance of single cluster routing.
         #
         # Unconditionally routes all read/write requests to a specific cluster.
-        # This option preserves read-your-writes consistency, but does not improve
+        # This option preserves read-your-writes consistency but does not improve
         # availability.
         #
         # @param cluster_id [String]
         #   The cluster to which read/write requests should be routed.
         # @param allow_transactional_writes [Boolean]
-        #   Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
+        #   If true, `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
         #   allowed by this app profile. It is unsafe to send these requests to
         #   the same table/row/column in multiple clusters.
-        #    Default value is false.
+        #   Default value is false.
         # @return [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting]
         #
         # @example Create instance of single cluster routing