google-cloud-bigquery 1.21.1 → 1.25.0

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

@@ -43,12 +43,13 @@ module Google
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, retries: nil, timeout: nil, host: nil
+        def initialize project, credentials, retries: nil, timeout: nil, host: nil, quota_project: nil
           @project = project
           @credentials = credentials
           @retries = retries
           @timeout = timeout
           @host = host
+          @quota_project = quota_project
         end
 
         def service
@@ -64,6 +65,9 @@ module Google
             service.request_options.header ||= {}
             service.request_options.header["x-goog-api-client"] = \
               "gl-ruby/#{RUBY_VERSION} gccl/#{Google::Cloud::Bigquery::VERSION}"
+            service.request_options.query ||= {}
+            service.request_options.query["prettyPrint"] = false
+            service.request_options.quota_project = @quota_project if @quota_project
             service.authorization = @credentials.client
             service.root_url = host if host
             service
@@ -138,6 +142,8 @@ module Google
           end
         end
 
+        ##
+        # Gets the specified table resource by full table reference.
         def get_project_table project_id, dataset_id, table_id
           # The get operation is considered idempotent
           execute backoff: true do
@@ -151,10 +157,7 @@ module Google
         # it only returns the table resource,
         # which describes the structure of this table.
         def get_table dataset_id, table_id
-          # The get operation is considered idempotent
-          execute backoff: true do
-            get_project_table @project, dataset_id, table_id
-          end
+          get_project_table @project, dataset_id, table_id
         end
 
         ##
@@ -179,6 +182,34 @@ module Google
           end
         end
 
+        ##
+        # Returns Google::Apis::BigqueryV2::Policy
+        def get_table_policy dataset_id, table_id
+          policy_options = API::GetPolicyOptions.new requested_policy_version: 1
+          execute do
+            service.get_table_iam_policy table_path(dataset_id, table_id),
+                                         API::GetIamPolicyRequest.new(options: policy_options)
+          end
+        end
+
+        ##
+        # @param [Google::Apis::BigqueryV2::Policy] new_policy
+        def set_table_policy dataset_id, table_id, new_policy
+          execute do
+            service.set_table_iam_policy table_path(dataset_id, table_id),
+                                         API::SetIamPolicyRequest.new(policy: new_policy)
+          end
+        end
+
+        ##
+        # Returns Google::Apis::BigqueryV2::TestIamPermissionsResponse
+        def test_table_permissions dataset_id, table_id, permissions
+          execute do
+            service.test_table_iam_permissions table_path(dataset_id, table_id),
+                                               API::TestIamPermissionsRequest.new(permissions: permissions)
+          end
+        end
+
         ##
         # Deletes the table specified by tableId from the dataset.
         # If the table contains data, all the data will be deleted.
@@ -250,18 +281,21 @@ module Google
           end
         end
 
-        # Gets the specified model resource by model ID.
-        # This method does not return the data in the model,
-        # it only returns the model resource,
-        # which describes the structure of this model.
-        def get_model dataset_id, model_id
+        # Gets the specified model resource by full model reference.
+        def get_project_model project_id, dataset_id, model_id
           # The get operation is considered idempotent
           execute backoff: true do
-            json_txt = service.get_model @project, dataset_id, model_id, options: { skip_deserialization: true }
+            json_txt = service.get_model project_id, dataset_id, model_id, options: { skip_deserialization: true }
             JSON.parse json_txt, symbolize_names: true
           end
         end
 
+        # Gets the specified model resource by model ID. This method does not return the data in the model, it only
+        # returns the model resource, which describes the structure of this model.
+        def get_model dataset_id, model_id
+          get_project_model @project, dataset_id, model_id
+        end
+
         ##
         # Updates information in an existing model, replacing fields that
         # are provided in the submitted model resource.
@@ -502,6 +536,11 @@ module Google
 
         protected
 
+        # Creates a formatted table path.
+        def table_path dataset_id, table_id
+          "projects/#{@project}/datasets/#{dataset_id}/tables/#{table_id}"
+        end
+
         # Generate a random string similar to the BigQuery service job IDs.
         def generate_id
           SecureRandom.urlsafe_base64 21

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

@@ -23,6 +23,7 @@ require "google/cloud/bigquery/external"
 require "google/cloud/bigquery/insert_response"
 require "google/cloud/bigquery/table/async_inserter"
 require "google/cloud/bigquery/convert"
+require "google/cloud/bigquery/policy"
 require "google/apis/bigquery_v2"
 
 module Google
@@ -250,9 +251,10 @@ module Google
         # The period for which the table is time partitioned, if any. See
         # [Partitioned Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
         #
-        # @return [String, nil] The time partition type. Currently the only supported
-        #   value is "DAY", or `nil` if the object is a reference (see
-        #   {#reference?}).
+        # @return [String, nil] The time partition type. The supported types are `DAY`,
+        #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+        #   hour, month, and year, respectively; or `nil` if not set or the object is a
+        #   reference (see {#reference?}).
         #
         # @!group Attributes
         #
@@ -265,13 +267,16 @@ module Google
         ##
         # Sets the time partitioning type for the table. See [Partitioned
         # Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
+        # The supported types are `DAY`, `HOUR`, `MONTH`, and `YEAR`, which will
+        # generate one partition per day, hour, month, and year, respectively.
         #
         # You can only set time partitioning when creating a table as in
         # the example below. BigQuery does not allow you to change time partitioning
         # on an existing table.
         #
-        # @param [String] type The time partition type. Currently the only
-        #   supported value is "DAY".
+        # @param [String] type The time partition type. The supported types are `DAY`,
+        #   `HOUR`, `MONTH`, and `YEAR`, which will generate one partition per day,
+        #   hour, month, and year, respectively.
         #
         # @example
         #   require "google/cloud/bigquery"
@@ -820,12 +825,19 @@ module Google
         # @param [Hash<String, String>] labels A hash containing key/value
         #   pairs.
         #
-        #   * Label keys and values can be no longer than 63 characters.
-        #   * Label keys and values can contain only lowercase letters, numbers,
-        #     underscores, hyphens, and international characters.
-        #   * Label keys and values cannot exceed 128 bytes in size.
-        #   * Label keys must begin with a letter.
-        #   * Label keys must be unique within a table.
+        #   The labels applied to a resource must meet the following requirements:
+        #
+        #   * Each resource can have multiple labels, up to a maximum of 64.
+        #   * Each label must be a key-value pair.
+        #   * Keys have a minimum length of 1 character and a maximum length of
+        #     63 characters, and cannot be empty. Values can be empty, and have
+        #     a maximum length of 63 characters.
+        #   * Keys and values can contain only lowercase letters, numeric characters,
+        #     underscores, and dashes. All characters must use UTF-8 encoding, and
+        #     international characters are allowed.
+        #   * The key portion of a label must be unique. However, you can use the
+        #     same key with multiple resources.
+        #   * Keys must start with a lowercase letter or international character.
         #
         # @example
         #   require "google/cloud/bigquery"
@@ -1263,6 +1275,107 @@ module Google
           Array(udfs_gapi).map { |udf| udf.inline_code || udf.resource_uri }
         end
 
+        ##
+        # Gets the Cloud IAM access control policy for the table. The latest policy will be read from the service. See
+        # also {#update_policy}.
+        #
+        # @see https://cloud.google.com/iam/docs/managing-policies Managing Policies
+        # @see https://cloud.google.com/bigquery/docs/table-access-controls-intro Controlling access to tables
+        #
+        # @return [Policy] The frozen policy for the table.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   policy = table.policy
+        #
+        #   policy.frozen? #=> true
+        #   binding_owner = policy.bindings.find { |b| b.role == "roles/owner" }
+        #   binding_owner.role #=> "roles/owner"
+        #   binding_owner.members #=> ["user:owner@example.com"]
+        #   binding_owner.frozen? #=> true
+        #   binding_owner.members.frozen? #=> true
+        #
+        def policy
+          raise ArgumentError, "Block argument not supported: Use #update_policy instead." if block_given?
+          ensure_service!
+          gapi = service.get_table_policy dataset_id, table_id
+          Policy.from_gapi(gapi).freeze
+        end
+
+        ##
+        # Updates the Cloud IAM access control policy for the table. The latest policy will be read from the service.
+        # See also {#policy}.
+        #
+        # @see https://cloud.google.com/iam/docs/managing-policies Managing Policies
+        # @see https://cloud.google.com/bigquery/docs/table-access-controls-intro Controlling access to tables
+        #
+        # @yield [policy] A block for updating the policy. The latest policy will be read from the service and passed to
+        #   the block. After the block completes, the modified policy will be written to the service.
+        # @yieldparam [Policy] policy The mutable Policy for the table.
+        #
+        # @return [Policy] The updated and frozen policy for the table.
+        #
+        # @example Update the policy by passing a block.
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   table.update_policy do |p|
+        #     p.grant role: "roles/viewer", members: "user:viewer@example.com"
+        #     p.revoke role: "roles/editor", members: "user:editor@example.com"
+        #     p.revoke role: "roles/owner"
+        #   end # 2 API calls
+        #
+        def update_policy
+          raise ArgumentError, "A block updating the policy must be provided" unless block_given?
+          ensure_service!
+          gapi = service.get_table_policy dataset_id, table_id
+          policy = Policy.from_gapi gapi
+          yield policy
+          # TODO: Check for changes before calling RPC
+          gapi = service.set_table_policy dataset_id, table_id, policy.to_gapi
+          Policy.from_gapi(gapi).freeze
+        end
+
+        ##
+        # 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
+        #
+        # @param [String, Array<String>] permissions The set of permissions
+        #   against which to check access. Permissions must be of the format
+        #   `bigquery.resource.capability`.
+        #   See https://cloud.google.com/bigquery/docs/access-control#bigquery.
+        #
+        # @return [Array<String>] The frozen array of permissions held by the caller.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   permissions = table.test_iam_permissions "bigquery.tables.get",
+        #                                            "bigquery.tables.delete"
+        #   permissions.include? "bigquery.tables.get"    #=> true
+        #   permissions.include? "bigquery.tables.delete" #=> false
+        #
+        def test_iam_permissions *permissions
+          permissions = Array(permissions).flatten
+          ensure_service!
+          gapi = service.test_table_permissions dataset_id, table_id, permissions
+          gapi.permissions.freeze
+        end
+
         ##
         # Retrieves data from the table.
         #
@@ -1286,12 +1399,13 @@ module Google
         #   table = dataset.table "my_table"
         #
         #   data = table.data
+        #
+        #   # Iterate over the first page of results
         #   data.each do |row|
-        #     puts row[:first_name]
-        #   end
-        #   if data.next?
-        #     more_data = data.next if data.next?
+        #     puts row[:name]
         #   end
+        #   # Retrieve the next page of results
+        #   data = data.next if data.next?
         #
         # @example Retrieve all rows of data: (See {Data#all})
         #   require "google/cloud/bigquery"
@@ -1301,8 +1415,9 @@ module Google
         #   table = dataset.table "my_table"
         #
         #   data = table.data
+        #
         #   data.all do |row|
-        #     puts row[:first_name]
+        #     puts row[:name]
         #   end
         #
         # @!group Data
@@ -1368,13 +1483,21 @@ module Google
         #   is 1,024 characters. If `job_id` is provided, then `prefix` will not
         #   be used.
         # @param [Hash] labels A hash of user-provided labels associated with
-        #   the job. You can use these to organize and group your jobs. Label
-        #   keys and values can be no longer than 63 characters, can only
-        #   contain lowercase letters, numeric characters, underscores and
-        #   dashes. International characters are allowed. Label values are
-        #   optional. Label keys must start with a letter and each label in the
-        #   list must have a different key. See [Requirements for
-        #   labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#requirements).
+        #   the job. You can use these to organize and group your jobs.
+        #
+        #   The labels applied to a resource must meet the following requirements:
+        #
+        #   * Each resource can have multiple labels, up to a maximum of 64.
+        #   * Each label must be a key-value pair.
+        #   * Keys have a minimum length of 1 character and a maximum length of
+        #     63 characters, and cannot be empty. Values can be empty, and have
+        #     a maximum length of 63 characters.
+        #   * Keys and values can contain only lowercase letters, numeric characters,
+        #     underscores, and dashes. All characters must use UTF-8 encoding, and
+        #     international characters are allowed.
+        #   * The key portion of a label must be unique. However, you can use the
+        #     same key with multiple resources.
+        #   * Keys must start with a lowercase letter or international character.
         # @param [Boolean] dryrun  If set, don't actually run this job. Behavior
         #   is undefined however for non-query jobs and may result in an error.
         #   Deprecated.
@@ -1509,11 +1632,11 @@ module Google
         # The geographic location for the job ("US", "EU", etc.) can be set via
         # {ExtractJob::Updater#location=} in a block passed to this method. If
         # the table is a full resource representation (see {#resource_full?}),
-        # the location of the job will be automatically set to the location of
+        # the location of the job will automatically be set to the location of
         # the table.
         #
-        # @see https://cloud.google.com/bigquery/exporting-data-from-bigquery
-        #   Exporting Data From BigQuery
+        # @see https://cloud.google.com/bigquery/docs/exporting-data
+        #   Exporting table data
         #
         # @param [Google::Cloud::Storage::File, String, Array<String>]
         #   extract_url The Google Storage file or file URI pattern(s) to which
@@ -1549,13 +1672,21 @@ module Google
         #   is 1,024 characters. If `job_id` is provided, then `prefix` will not
         #   be used.
         # @param [Hash] labels A hash of user-provided labels associated with
-        #   the job. You can use these to organize and group your jobs. Label
-        #   keys and values can be no longer than 63 characters, can only
-        #   contain lowercase letters, numeric characters, underscores and
-        #   dashes. International characters are allowed. Label values are
-        #   optional. Label keys must start with a letter and each label in the
-        #   list must have a different key. See [Requirements for
-        #   labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#requirements).
+        #   the job. You can use these to organize and group your jobs.
+        #
+        #   The labels applied to a resource must meet the following requirements:
+        #
+        #   * Each resource can have multiple labels, up to a maximum of 64.
+        #   * Each label must be a key-value pair.
+        #   * Keys have a minimum length of 1 character and a maximum length of
+        #     63 characters, and cannot be empty. Values can be empty, and have
+        #     a maximum length of 63 characters.
+        #   * Keys and values can contain only lowercase letters, numeric characters,
+        #     underscores, and dashes. All characters must use UTF-8 encoding, and
+        #     international characters are allowed.
+        #   * The key portion of a label must be unique. However, you can use the
+        #     same key with multiple resources.
+        #   * Keys must start with a lowercase letter or international character.
         # @param [Boolean] dryrun  If set, don't actually run this job. Behavior
         #   is undefined however for non-query jobs and may result in an error.
         #   Deprecated.
@@ -1607,8 +1738,8 @@ module Google
         # the location of the job will be automatically set to the location of
         # the table.
         #
-        # @see https://cloud.google.com/bigquery/exporting-data-from-bigquery
-        #   Exporting Data From BigQuery
+        # @see https://cloud.google.com/bigquery/docs/exporting-data
+        #   Exporting table data
         #
         # @param [Google::Cloud::Storage::File, String, Array<String>]
         #   extract_url The Google Storage file or file URI pattern(s) to which
@@ -1789,13 +1920,21 @@ module Google
         #   is 1,024 characters. If `job_id` is provided, then `prefix` will not
         #   be used.
         # @param [Hash] labels A hash of user-provided labels associated with
-        #   the job. You can use these to organize and group your jobs. Label
-        #   keys and values can be no longer than 63 characters, can only
-        #   contain lowercase letters, numeric characters, underscores and
-        #   dashes. International characters are allowed. Label values are
-        #   optional. Label keys must start with a letter and each label in the
-        #   list must have a different key. See [Requirements for
-        #   labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#requirements).
+        #   the job. You can use these to organize and group your jobs.
+        #
+        #   The labels applied to a resource must meet the following requirements:
+        #
+        #   * Each resource can have multiple labels, up to a maximum of 64.
+        #   * Each label must be a key-value pair.
+        #   * Keys have a minimum length of 1 character and a maximum length of
+        #     63 characters, and cannot be empty. Values can be empty, and have
+        #     a maximum length of 63 characters.
+        #   * Keys and values can contain only lowercase letters, numeric characters,
+        #     underscores, and dashes. All characters must use UTF-8 encoding, and
+        #     international characters are allowed.
+        #   * The key portion of a label must be unique. However, you can use the
+        #     same key with multiple resources.
+        #   * Keys must start with a lowercase letter or international character.
         # @param [Boolean] dryrun  If set, don't actually run this job. Behavior
         #   is undefined however for non-query jobs and may result in an error.
         #   Deprecated.

data/lib/google/cloud/bigquery/time.rb

@@ -34,9 +34,12 @@ module Google
       #                         "WHERE time_of_date = @time",
       #                         params: { time: fourpm }
       #
+      #   # Iterate over the first page of results
       #   data.each do |row|
       #     puts row[:name]
       #   end
+      #   # Retrieve the next page of results
+      #   data = data.next if data.next?
       #
       # @example Create Time with fractional seconds:
       #   require "google/cloud/bigquery"
@@ -49,9 +52,12 @@ module Google
       #                         "WHERE time_of_date >= @time",
       #                         params: { time: precise_time }
       #
+      #   # Iterate over the first page of results
       #   data.each do |row|
       #     puts row[:name]
       #   end
+      #   # Retrieve the next page of results
+      #   data = data.next if data.next?
       #
       Time = Struct.new :value
     end