google-cloud-bigtable 0.7.0 → 1.1.0

data/lib/google/cloud/bigtable/row_filter/simple_filter.rb

@@ -102,7 +102,7 @@ module Google
           #
           def sample probability
             if probability >= 1 || probability <= 0
-              raise RowFilterError, "Probability must be greather then 0 and less then 1.0"
+              raise RowFilterError, "Probability must be greater than 0 and less than 1.0."
             end
             @grpc.row_sample_filter = probability
             self
@@ -165,7 +165,7 @@ module Google
           #
           # Due to a technical limitation, it is not possible to apply
           # multiple labels to a cell. As a result, a chain may have no more than
-          # one sub-filter whithatch contains an `apply_label_transformer`. It is okay for
+          # one sub-filter that contains an `apply_label_transformer`. It is okay for
           # an interleave to contain multiple `apply_label_transformers`, as they
           # will be applied to separate copies of the input.
           #
@@ -220,7 +220,7 @@ module Google
           end
 
           ##
-          # Creates a timestamp-range filter instance.
+          # Creates a timestamp-range filter.
           #
           # Matches only cells with timestamps within the given range.
           # Specifies a contiguous range of timestamps.

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

@@ -83,14 +83,10 @@ module Google
         # @return [Array<Google::Bigtable::V2::MutateRowsResponse::Entry>]
         #
         def mutate_rows entries
-          response = @table.client.mutate_rows @table.path, entries, app_profile_id: @table.app_profile_id
+          response = @table.service.mutate_rows @table.path, entries, app_profile_id: @table.app_profile_id
           response.each_with_object [] do |res, statuses|
             statuses.concat res.entries
           end
-        rescue Google::Gax::GaxError => e
-          raise Google::Cloud::Error.from_error(e.cause)
-        rescue GRPC::BadStatus => e
-          raise Google::Cloud::Error.from_error(e)
         end
 
         ##

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

@@ -23,7 +23,7 @@ module Google
       # @private
       # # RowsReader
       #
-      # Retyable read rows helper
+      # Retryable read rows helper
       #
       class RowsReader
         # @private
@@ -75,8 +75,9 @@ module Google
         #   Array of row or yield block for each processed row.
         #
         def read rows: nil, filter: nil, rows_limit: nil
-          response = @table.client.read_rows(
-            @table.path,
+          response = @table.service.read_rows(
+            @table.instance_id,
+            @table.table_id,
             rows:           rows,
             filter:         filter,
             rows_limit:     rows_limit,
@@ -105,7 +106,7 @@ module Google
         end
 
         ##
-        # Calucates and returns the read rows limit and row set based on last read key.
+        # Calculates and returns the read rows limit and row set based on last read key.
         #
         # @param rows_limit [Integer]
         #   The read will terminate after committing to N rows' worth of results.

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

@@ -31,7 +31,7 @@ module Google
       #   Note: that row keys in this list may not have ever been written to or read
       #   from, and users should therefore not make any assumptions about the row key
       #   structure that are specific to their use case.
-
+      #
       # * offset_bytes : Approximate total storage space used by all rows in the table which precede
       #   `row_key`. Buffering the contents of all rows between two subsequent
       #   samples would require space roughly equal to the difference in their

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

@@ -640,6 +640,100 @@ module Google
           end
         end
 
+        ##
+        # Gets the access control policy for an table resource. Returns an empty
+        # policy if an table exists but does not have a policy set.
+        #
+        # @param table_id [String]
+        #   Unique ID of the table for which the policy is being requested.
+        # @return [Google::Iam::V1::Policy]
+        #
+        def get_table_policy instance_id, table_id
+          execute do
+            tables.get_iam_policy table_path(instance_id, table_id)
+          end
+        end
+
+        ##
+        # Sets the access control policy on an table resource. Replaces any
+        # existing policy.
+        #
+        # @param table_id [String]
+        #   Unique ID of the table the policy is for.
+        # @param policy [Google::Iam::V1::Policy | Hash]
+        #   REQUIRED: The complete policy to be applied to the +resource+. The size of
+        #   the policy is limited to a few 10s of KB. An empty policy is valid
+        #   for Cloud Bigtable, but certain Cloud Platform services (such as Projects)
+        #   might reject an empty policy.
+        #   Alternatively, provide a hash similar to `Google::Iam::V1::Policy`.
+        # @return [Google::Iam::V1::Policy]
+        #
+        def set_table_policy instance_id, table_id, policy
+          execute do
+            tables.set_iam_policy table_path(instance_id, table_id), policy
+          end
+        end
+
+        ##
+        # Returns permissions that the caller has for the specified table resource.
+        #
+        # @param table_id [String]
+        #   The table ID that the policy detail is being requested for.
+        # @param permissions [Array<String>]
+        #   The set of permissions to check for the +resource+. Permissions with
+        #   wildcards (such as '*' or 'storage.*') are not allowed. For more
+        #   information see
+        #   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+        # @return [Google::Iam::V1::TestIamPermissionsResponse]
+        #
+        def test_table_permissions instance_id, table_id, permissions
+          execute do
+            tables.test_iam_permissions table_path(instance_id, table_id), permissions
+          end
+        end
+
+        def read_rows instance_id, table_id, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil
+          # execute is not used because error handling is in ReadOperations#read_rows
+          client.read_rows table_path(instance_id, table_id),
+                           rows:           rows,
+                           filter:         filter,
+                           rows_limit:     rows_limit,
+                           app_profile_id: app_profile_id
+        end
+
+        def sample_row_keys table_name, app_profile_id: nil
+          execute do
+            client.sample_row_keys table_name, app_profile_id: app_profile_id
+          end
+        end
+
+        def mutate_row table_name, row_key, mutations, app_profile_id: nil
+          execute do
+            client.mutate_row table_name, row_key, mutations, app_profile_id: app_profile_id
+          end
+        end
+
+        def mutate_rows table_name, entries, app_profile_id: nil
+          execute do
+            client.mutate_rows table_name, entries, app_profile_id: app_profile_id
+          end
+        end
+
+        def check_and_mutate_row table_name, row_key, app_profile_id: nil, predicate_filter: nil, true_mutations: nil,
+                                 false_mutations: nil
+          execute do
+            client.check_and_mutate_row table_name, row_key, app_profile_id: app_profile_id,
+                                        predicate_filter: predicate_filter, true_mutations: true_mutations,
+                                        false_mutations: false_mutations
+          end
+        end
+
+        def read_modify_write_row table_name, row_key, rules, app_profile_id: nil
+          execute do
+            client.read_modify_write_row table_name, row_key, rules, app_profile_id: app_profile_id
+          end
+        end
+
         ##
         # Executes the API call and wrap errors to {Google::Cloud::Error}.
         #
@@ -714,20 +808,6 @@ module Google
           Admin::V2::BigtableTableAdminClient.table_path project_id, instance_id, table_id
         end
 
-        ##
-        # Creates a formatted snapshot path.
-        #
-        # @param instance_id [String]
-        # @param cluster_id [String]
-        # @param snapshot_id [String]
-        # @return [String]
-        #   Formatted snapshot path
-        #   +projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>+
-        #
-        def snapshot_path instance_id, cluster_id, snapshot_id
-          Admin::V2::BigtableTableAdminClient.snapshot_path project_id, instance_id, cluster_id, snapshot_id
-        end
-
         ##
         # Creates a formatted app profile path.
         #

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

@@ -20,6 +20,7 @@ require "google/cloud/bigtable/table/cluster_state"
 require "google/cloud/bigtable/column_family_map"
 require "google/cloud/bigtable/gc_rule"
 require "google/cloud/bigtable/mutation_operations"
+require "google/cloud/bigtable/policy"
 require "google/cloud/bigtable/read_operations"
 
 module Google
@@ -70,7 +71,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the project.
+        # The unique identifier for the project to which the table belongs.
         #
         # @return [String]
         #
@@ -79,7 +80,7 @@ module Google
         end
 
         ##
-        # The unique identifier for the instance.
+        # The unique identifier for the instance to which the table belongs.
         #
         # @return [String]
         #
@@ -108,16 +109,16 @@ module Google
         end
 
         ##
-        # Reload table information.
+        # Reloads table data.
         #
         # @param view [Symbol] Table view type.
-        #   Default view type is `:SCHEMA_VIEW`
+        #   Default view type is `:SCHEMA_VIEW`.
         #   Valid view types are:
         #
-        #   * `:NAME_ONLY` - Only populates `name`
-        #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema
+        #   * `:NAME_ONLY` - Only populates `name`.
+        #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema.
         #   * `:REPLICATION_VIEW` - Only populates `name` and fields related to the table's replication state.
-        #   * `:FULL` - Populates all fields
+        #   * `:FULL` - Populates all fields.
         #
         # @return [Google::Cloud::Bigtable::Table]
         #
@@ -132,7 +133,7 @@ module Google
         # If it could not be determined whether or not the table has data in a
         # particular cluster (for example, if its zone is unavailable), then
         # there will be an entry for the cluster with UNKNOWN `replication_status`.
-        # Views: `FULL`
+        # Views: `FULL`.
         #
         # @return [Array<Google::Cloud::Bigtable::Table::ClusterState>]
         #
@@ -221,7 +222,7 @@ module Google
         # The granularity (e.g. `MILLIS`, `MICROS`) at which timestamps are stored in
         # this table. Timestamps not matching the granularity will be rejected.
         # If unspecified at creation time, the value will be set to `MILLIS`.
-        # Views: `SCHEMA_VIEW`, `FULL`
+        # Views: `SCHEMA_VIEW`, `FULL`.
         #
         # @return [Symbol]
         #
@@ -239,6 +240,117 @@ module Google
           granularity == :MILLIS
         end
 
+        ##
+        # Gets the [Cloud IAM](https://cloud.google.com/iam/) access control
+        # policy for the table.
+        #
+        # @see https://cloud.google.com/bigtable/docs/access-control
+        #
+        # @yield [policy] A block for updating the policy. The latest policy
+        #   will be read from the Bigtable service and passed to the block. After
+        #   the block completes, the modified policy will be written to the
+        #   service.
+        # @yieldparam [Policy] policy the current Cloud IAM Policy for this
+        #   table.
+        #
+        # @return [Policy] The current Cloud IAM Policy for the table.
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true)
+        #   policy = table.policy
+        #
+        # @example Update the policy by passing a block.
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true)
+        #
+        #   table.policy do |p|
+        #     p.add("roles/owner", "user:owner@example.com")
+        #   end # 2 API calls
+        #
+        def policy
+          ensure_service!
+          grpc = service.get_table_policy instance_id, name
+          policy = Policy.from_grpc grpc
+          return policy unless block_given?
+          yield policy
+          update_policy policy
+        end
+
+        ##
+        # Updates the [Cloud IAM](https://cloud.google.com/iam/) access control
+        # policy for the table. The policy should be read from {#policy}.
+        # See {Google::Cloud::Bigtable::Policy} for an explanation of the policy
+        # `etag` property and how to modify policies.
+        #
+        # You can also update the policy by passing a block to {#policy}, which
+        # will call this method internally after the block completes.
+        #
+        # @param new_policy [Policy] a new or modified Cloud IAM Policy for this
+        #   table
+        #
+        # @return [Policy] The policy returned by the API update operation.
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true)
+        #
+        #   policy = table.policy
+        #   policy.add("roles/owner", "user:owner@example.com")
+        #   updated_policy = table.update_policy(policy)
+        #
+        #   puts updated_policy.roles
+        #
+        def update_policy new_policy
+          ensure_service!
+          grpc = service.set_table_policy instance_id, name, new_policy.to_grpc
+          Policy.from_grpc grpc
+        end
+        alias policy= update_policy
+
+        ##
+        # Tests the specified permissions against the [Cloud
+        # IAM](https://cloud.google.com/iam/) access control policy.
+        #
+        # @see https://cloud.google.com/iam/docs/managing-policies Managing Policies
+        # @see https://cloud.google.com/bigtable/docs/access-control Access Control
+        #
+        # @param permissions [String, Array<String>] permissions The set of permissions to
+        #   check access for. Permissions with wildcards (such as `*` or
+        #   `bigtable.*`) are not allowed.
+        #   See [Access Control](https://cloud.google.com/bigtable/docs/access-control).
+        #
+        # @return [Array<String>] The permissions that are configured for the policy.
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   table = bigtable.table("my-instance", "my-table", perform_lookup: true)
+        #
+        #   permissions = table.test_iam_permissions(
+        #     "bigtable.tables.delete",
+        #     "bigtable.tables.get"
+        #   )
+        #   permissions.include? "bigtable.tables.delete" #=> false
+        #   permissions.include? "bigtable.tables.get" #=> true
+        #
+        def test_iam_permissions *permissions
+          ensure_service!
+          grpc = service.test_table_permissions instance_id, name, permissions.flatten
+          grpc.permissions.to_a
+        end
+
         ##
         # Permanently deletes the table from a instance.
         #
@@ -334,7 +446,7 @@ module Google
         # before this call started have been replicated. The tokens will be available
         # for 90 days.
         #
-        # @return [String] Generated consistency token
+        # @return [String] The generated consistency token
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -357,7 +469,7 @@ module Google
         # considered consistent if replication has caught up based on the conditions
         # specified in the token and the check request.
         # @param token [String] Consistency token
-        # @return [Boolean] Replication is consistent or not.
+        # @return [Boolean] `true` if replication is consistent
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -383,7 +495,7 @@ module Google
         # Wait for replication to check replication consistency.
         # Checks replication consistency by generating a consistency token and
         # making the `check_consistency` API call 5 times (by default).
-        # If the response is consistent, returns true. Otherwise tries again
+        # If the response is consistent, returns `true`. Otherwise tries again
         # repeatedly until the timeout. If the check does not succeed by the
         # timeout, returns `false`.
         #
@@ -391,7 +503,7 @@ module Google
         #   Timeout in seconds. Defaults value is 600 seconds.
         # @param check_interval [Integer]
         #   Consistency check interval in seconds. Default is 5 seconds.
-        # @return [Boolean] Replication is consistent or not.
+        # @return [Boolean] `true` if replication is consistent
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -410,7 +522,7 @@ module Google
         #   end
         #
         def wait_for_replication timeout: 600, check_interval: 5
-          raise InvalidArgumentError, "'check_interval' can not be greather then timeout" if check_interval > timeout
+          raise InvalidArgumentError, "'check_interval' cannot be greater than timeout" if check_interval > timeout
           token = generate_consistency_token
           status = false
           start_at = Time.now
@@ -424,19 +536,10 @@ module Google
           status
         end
 
-        # @private
-        # Gets the data client instance.
-        #
-        # @return [Google::Cloud::Bigtable::V2::BigtableClient]
-        #
-        def client
-          service.client
-        end
-
         ##
         # Deletes all rows.
         #
-        # @param timeout [Integer] Call timeout in seconds
+        # @param timeout [Integer] Call timeout in seconds.
         #   Use in case of insufficient deadline for DropRowRange, then
         #   try again with a longer request deadline.
         # @return [Boolean]
@@ -460,8 +563,8 @@ module Google
         ##
         # Deletes rows using row key prefix.
         #
-        # @param prefix [String] Row key prefix (for example, "user")
-        # @param timeout [Integer] Call timeout in seconds
+        # @param prefix [String] Row key prefix (for example, "user").
+        # @param timeout [Integer] Call timeout in seconds.
         # @return [Boolean]
         # @example
         #   require "google/cloud/bigtable"
@@ -482,7 +585,7 @@ module Google
         ##
         # Drops row range by row key prefix or deletes all.
         #
-        # @param row_key_prefix [String] Row key prefix (for example, "user")
+        # @param row_key_prefix [String] Row key prefix (for example, "user").
         # @param delete_all_data [Boolean]
         # @return [Boolean]
         #