google-cloud-bigquery 1.14.0 → 1.42.0

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

@@ -17,6 +17,24 @@ require "google/cloud/bigquery/encryption_configuration"
 module Google
   module Cloud
     module Bigquery
+      module OperationType
+        # Different operation types supported in table copy job.
+        # https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#operationtype
+
+        # The source and destination table have the same table type.
+        COPY = "COPY".freeze
+
+        # The source table type is TABLE and the destination table type is SNAPSHOT.
+        SNAPSHOT = "SNAPSHOT".freeze
+
+        # The source table type is SNAPSHOT and the destination table type is TABLE.
+        RESTORE = "RESTORE".freeze
+
+        # The source and destination table have the same table type, but only bill for
+        # unique data.
+        CLONE = "CLONE".freeze
+      end
+
       ##
       # # CopyJob
       #
@@ -46,27 +64,35 @@ module Google
         # The table from which data is copied. This is the table on
         # which {Table#copy_job} was called.
         #
+        # @param [String] view Specifies the view that determines which table information is returned.
+        #   By default, basic table information and storage statistics (STORAGE_STATS) are returned.
+        #   Accepted values include `:unspecified`, `:basic`, `:storage`, and
+        #   `:full`. For more information, see [BigQuery Classes](@todo: Update the link).
+        #   The default value is the `:unspecified` view type.
+        #
         # @return [Table] A table instance.
         #
-        def source
+        def source view: nil
           table = @gapi.configuration.copy.source_table
           return nil unless table
-          retrieve_table table.project_id,
-                         table.dataset_id,
-                         table.table_id
+          retrieve_table table.project_id, table.dataset_id, table.table_id, metadata_view: view
         end
 
         ##
         # The table to which data is copied.
         #
+        # @param [String] view Specifies the view that determines which table information is returned.
+        #   By default, basic table information and storage statistics (STORAGE_STATS) are returned.
+        #   Accepted values include `:unspecified`, `:basic`, `:storage`, and
+        #   `:full`. For more information, see [BigQuery Classes](@todo: Update the link).
+        #   The default value is the `:unspecified` view type.
+        #
         # @return [Table] A table instance.
         #
-        def destination
+        def destination view: nil
           table = @gapi.configuration.copy.destination_table
           return nil unless table
-          retrieve_table table.project_id,
-                         table.dataset_id,
-                         table.table_id
+          retrieve_table table.project_id, table.dataset_id, table.table_id, metadata_view: view
         end
 
         ##
@@ -139,9 +165,7 @@ module Google
         #
         # @!group Attributes
         def encryption
-          EncryptionConfiguration.from_gapi(
-            @gapi.configuration.copy.destination_encryption_configuration
-          )
+          EncryptionConfiguration.from_gapi @gapi.configuration.copy.destination_encryption_configuration
         end
 
         ##
@@ -150,6 +174,7 @@ module Google
           ##
           # @private Create an Updater object.
           def initialize gapi
+            super()
             @gapi = gapi
           end
 
@@ -158,11 +183,12 @@ module Google
           #
           # @return [Google::Cloud::Bigquery::CopyJob::Updater] A job
           #   configuration object for setting copy options.
-          def self.from_options service, source, target, options = {}
+          def self.from_options service, source, target, options
             job_ref = service.job_ref_from options[:job_id], options[:prefix]
             copy_cfg = Google::Apis::BigqueryV2::JobConfigurationTableCopy.new(
               source_table:      source,
-              destination_table: target
+              destination_table: target,
+              operation_type:    options[:operation_type]
             )
             req = Google::Apis::BigqueryV2::Job.new(
               job_reference: job_ref,
@@ -227,8 +253,7 @@ module Google
           #
           # @!group Attributes
           def create= new_create
-            @gapi.configuration.copy.update! \
-              create_disposition: Convert.create_disposition(new_create)
+            @gapi.configuration.copy.update! create_disposition: Convert.create_disposition(new_create)
           end
 
           ##
@@ -248,8 +273,7 @@ module Google
           #
           # @!group Attributes
           def write= new_write
-            @gapi.configuration.copy.update! \
-              write_disposition: Convert.write_disposition(new_write)
+            @gapi.configuration.copy.update! write_disposition: Convert.write_disposition(new_write)
           end
 
           ##
@@ -273,27 +297,51 @@ module Google
           #
           # @!group Attributes
           def encryption= val
-            @gapi.configuration.copy.update!(
-              destination_encryption_configuration: val.to_gapi
-            )
+            @gapi.configuration.copy.update! destination_encryption_configuration: val.to_gapi
           end
 
           ##
           # Sets the labels to use for the job.
           #
           # @param [Hash] value 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.
+          #   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.
           #
           # @!group Attributes
           def labels= value
             @gapi.configuration.update! labels: value
           end
 
+          def cancel
+            raise "not implemented in #{self.class}"
+          end
+
+          def rerun!
+            raise "not implemented in #{self.class}"
+          end
+
+          def reload!
+            raise "not implemented in #{self.class}"
+          end
+          alias refresh! reload!
+
+          def wait_until_done!
+            raise "not implemented in #{self.class}"
+          end
+
           ##
           # @private Returns the Google API client library version of this job.
           #

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

@@ -39,18 +39,11 @@ module Google
       #
       class Credentials < Google::Auth::Credentials
         SCOPE = ["https://www.googleapis.com/auth/bigquery"].freeze
-        PATH_ENV_VARS = %w[BIGQUERY_CREDENTIALS
-                           GOOGLE_CLOUD_CREDENTIALS
-                           BIGQUERY_KEYFILE
-                           GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE].freeze
-        JSON_ENV_VARS = %w[BIGQUERY_CREDENTIALS_JSON
-                           GOOGLE_CLOUD_CREDENTIALS_JSON
-                           BIGQUERY_KEYFILE_JSON
-                           GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON].freeze
-        DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"].freeze
+        PATH_ENV_VARS = ["BIGQUERY_CREDENTIALS", "GOOGLE_CLOUD_CREDENTIALS", "BIGQUERY_KEYFILE", "GOOGLE_CLOUD_KEYFILE",
+                         "GCLOUD_KEYFILE"].freeze
+        JSON_ENV_VARS = ["BIGQUERY_CREDENTIALS_JSON", "GOOGLE_CLOUD_CREDENTIALS_JSON", "BIGQUERY_KEYFILE_JSON",
+                         "GOOGLE_CLOUD_KEYFILE_JSON", "GCLOUD_KEYFILE_JSON"].freeze
+        DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

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

@@ -41,9 +41,12 @@ module Google
       #
       #   data.count # 100000
       #   data.total # 164656
+      #
+      #   # Iterate over the first page of results
       #   data.each do |row|
       #     puts row[:word]
       #   end
+      #   # Retrieve the next page of results
       #   data = data.next if data.next?
       #
       class Data < DelegateClass(::Array)
@@ -117,9 +120,12 @@ module Google
         #
         #   data.count # 100000
         #   data.total # 164656
+        #
+        #   # Iterate over the first page of results
         #   data.each do |row|
         #     puts row[:word]
         #   end
+        #   # Retrieve the next page of results
         #   data = data.next if data.next?
         #
         def total
@@ -200,10 +206,34 @@ module Google
           schema.headers
         end
 
+        ##
+        # The types of the fields in the data, obtained from the schema of the
+        # table from which the data was read. Types use the same format as the
+        # optional query parameter types.
+        #
+        # @return [Hash] A hash with field names as keys, and types as values.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   data = table.data
+        #
+        #   data.param_types
+        #
+        def param_types
+          schema.param_types
+        end
+
         ##
         # The type of query statement, if valid. Possible values (new values
         # might be added in the future):
         #
+        # * "ALTER_TABLE": DDL statement, see [Using Data Definition Language
+        #   Statements](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language)
         # * "CREATE_MODEL": DDL statement, see [Using Data Definition Language
         #   Statements](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language)
         # * "CREATE_TABLE": DDL statement, see [Using Data Definition Language
@@ -227,8 +257,7 @@ module Google
         # @return [String, nil] The type of query statement.
         #
         def statement_type
-          return nil unless job_gapi && job_gapi.statistics.query
-          job_gapi.statistics.query.statement_type
+          job_gapi&.statistics&.query&.statement_type
         end
 
         ##
@@ -249,8 +278,16 @@ module Google
         #   data.ddl? #=> true
         #
         def ddl?
-          %w[CREATE_MODEL CREATE_TABLE CREATE_TABLE_AS_SELECT CREATE_VIEW \
-             DROP_MODEL DROP_TABLE DROP_VIEW].include? statement_type
+          [
+            "ALTER_TABLE",
+            "CREATE_MODEL",
+            "CREATE_TABLE",
+            "CREATE_TABLE_AS_SELECT",
+            "CREATE_VIEW",
+            "DROP_MODEL",
+            "DROP_TABLE",
+            "DROP_VIEW"
+          ].include? statement_type
         end
 
         ##
@@ -273,7 +310,12 @@ module Google
         #   data.dml? #=> true
         #
         def dml?
-          %w[INSERT UPDATE MERGE DELETE].include? statement_type
+          [
+            "INSERT",
+            "UPDATE",
+            "MERGE",
+            "DELETE"
+          ].include? statement_type
         end
 
         ##
@@ -292,8 +334,22 @@ module Google
         # @return [String, nil] The DDL operation performed.
         #
         def ddl_operation_performed
-          return nil unless job_gapi && job_gapi.statistics.query
-          job_gapi.statistics.query.ddl_operation_performed
+          job_gapi&.statistics&.query&.ddl_operation_performed
+        end
+
+        ##
+        # The DDL target routine, in reference state. (See {Routine#reference?}.)
+        # Present only for `CREATE/DROP FUNCTION/PROCEDURE` queries. (See
+        # {#statement_type}.)
+        #
+        # @return [Google::Cloud::Bigquery::Routine, nil] The DDL target routine, in
+        #   reference state.
+        #
+        def ddl_target_routine
+          ensure_service!
+          routine = job_gapi&.statistics&.query&.ddl_target_routine
+          return nil if routine.nil?
+          Google::Cloud::Bigquery::Routine.new_reference_from_gapi routine, service
         end
 
         ##
@@ -305,10 +361,9 @@ module Google
         #   reference state.
         #
         def ddl_target_table
-          return nil unless job_gapi && job_gapi.statistics.query
           ensure_service!
-          table = job_gapi.statistics.query.ddl_target_table
-          return nil unless table
+          table = job_gapi&.statistics&.query&.ddl_target_table
+          return nil if table.nil?
           Google::Cloud::Bigquery::Table.new_reference_from_gapi table, service
         end
 
@@ -320,8 +375,40 @@ module Google
         #   or `nil` if the query is not a DML statement.
         #
         def num_dml_affected_rows
-          return nil unless job_gapi && job_gapi.statistics.query
-          job_gapi.statistics.query.num_dml_affected_rows
+          job_gapi&.statistics&.query&.num_dml_affected_rows
+        end
+
+        ##
+        # The number of deleted rows. Present only for DML statements `DELETE`,
+        # `MERGE` and `TRUNCATE`. (See {#statement_type}.)
+        #
+        # @return [Integer, nil] The number of deleted rows, or `nil` if not
+        #   applicable.
+        #
+        def deleted_row_count
+          job_gapi&.statistics&.query&.dml_stats&.deleted_row_count
+        end
+
+        ##
+        # The number of inserted rows. Present only for DML statements `INSERT`
+        # and `MERGE`. (See {#statement_type}.)
+        #
+        # @return [Integer, nil] The number of inserted rows, or `nil` if not
+        #   applicable.
+        #
+        def inserted_row_count
+          job_gapi&.statistics&.query&.dml_stats&.inserted_row_count
+        end
+
+        ##
+        # The number of updated rows. Present only for DML statements `UPDATE`
+        # and `MERGE`. (See {#statement_type}.)
+        #
+        # @return [Integer, nil] The number of updated rows, or `nil` if not
+        #   applicable.
+        #
+        def updated_row_count
+          job_gapi&.statistics&.query&.dml_stats&.updated_row_count
         end
 
         ##
@@ -342,9 +429,12 @@ module Google
         #
         #   data.count # 100000
         #   data.total # 164656
+        #
+        #   # Iterate over the first page of results
         #   data.each do |row|
         #     puts row[:word]
         #   end
+        #   # Retrieve the next page of results
         #   data = data.next if data.next?
         #
         def next?
@@ -369,9 +459,12 @@ module Google
         #
         #   data.count # 100000
         #   data.total # 164656
+        #
+        #   # Iterate over the first page of results
         #   data.each do |row|
         #     puts row[:word]
         #   end
+        #   # Retrieve the next page of results
         #   data = data.next if data.next?
         #
         def next
@@ -437,17 +530,17 @@ module Google
         #     puts row[:word]
         #   end
         #
-        def all request_limit: nil
+        def all request_limit: nil, &block
           request_limit = request_limit.to_i if request_limit
 
           return enum_for :all, request_limit: request_limit unless block_given?
 
           results = self
           loop do
-            results.each { |r| yield r }
+            results.each(&block)
             if request_limit
               request_limit -= 1
-              break if request_limit < 0
+              break if request_limit.negative?
             end
             break unless results.next?
             results = results.next
@@ -458,9 +551,7 @@ module Google
         # @private New Data from a response object.
         def self.from_gapi_json gapi_json, table_gapi, job_gapi, service
           rows = gapi_json[:rows] || []
-          unless rows.empty?
-            rows = Convert.format_rows rows, table_gapi.schema.fields
-          end
+          rows = Convert.format_rows rows, table_gapi.schema.fields unless rows.empty?
 
           data = new rows
           data.table_gapi = table_gapi