google-cloud-bigquery 1.59.0 → 1.61.0

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

@@ -1848,6 +1848,12 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         # @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.
+        # @param [String] operation_type The type of operation for this job.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
         #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
@@ -1880,7 +1886,7 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         # @!group Data
         #
         def copy_job destination_table, create: nil, write: nil, job_id: nil, prefix: nil, labels: nil, dryrun: nil,
-                     operation_type: nil
+                     operation_type: nil, reservation: nil
           ensure_service!
           options = { create: create,
                       write: write,
@@ -1888,7 +1894,8 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                       labels: labels,
                       job_id: job_id,
                       prefix: prefix,
-                      operation_type: operation_type }
+                      operation_type: operation_type,
+                      reservation: reservation }
           updater = CopyJob::Updater.from_options(
             service,
             table_ref,
@@ -1941,6 +1948,12 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #   * `append` - BigQuery appends the data to the table.
         #   * `empty` - An error will be returned if the destination table
         #     already contains data.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
+        #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
         #   configuration object for setting additional options.
@@ -1968,11 +1981,12 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #
         # @!group Data
         #
-        def copy destination_table, create: nil, write: nil, &block
+        def copy destination_table, create: nil, write: nil, reservation: nil, &block
           copy_job_with_operation_type destination_table,
                                        create: create,
                                        write: write,
                                        operation_type: OperationType::COPY,
+                                       reservation: reservation,
                                        &block
         end
 
@@ -1998,6 +2012,11 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #   Reference](https://cloud.google.com/bigquery/query-reference#from)
         #   (`project-name:dataset_id.table_id`). This is useful for referencing
         #   tables in other projects and datasets.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
         #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
@@ -2026,9 +2045,10 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #
         # @!group Data
         #
-        def clone destination_table, &block
+        def clone destination_table, reservation: nil, &block
           copy_job_with_operation_type destination_table,
                                        operation_type: OperationType::CLONE,
+                                       reservation: reservation,
                                        &block
         end
 
@@ -2053,6 +2073,11 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #   Reference](https://cloud.google.com/bigquery/query-reference#from)
         #   (`project-name:dataset_id.table_id`). This is useful for referencing
         #   tables in other projects and datasets.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
         #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
@@ -2081,9 +2106,10 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #
         # @!group Data
         #
-        def snapshot destination_table, &block
+        def snapshot destination_table, reservation: nil, &block
           copy_job_with_operation_type destination_table,
                                        operation_type: OperationType::SNAPSHOT,
+                                       reservation: reservation,
                                        &block
         end
 
@@ -2125,6 +2151,12 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #   * `append` - BigQuery appends the data to the table.
         #   * `empty` - An error will be returned if the destination table
         #     already contains data.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
+        #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
         #   configuration object for setting additional options.
@@ -2152,11 +2184,12 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #
         # @!group Data
         #
-        def restore destination_table, create: nil, write: nil, &block
+        def restore destination_table, create: nil, write: nil, reservation: nil, &block
           copy_job_with_operation_type destination_table,
                                        create: create,
                                        write: write,
                                        operation_type: OperationType::RESTORE,
+                                       reservation: reservation,
                                        &block
         end
 
@@ -2229,6 +2262,11 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         # @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.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
         #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::ExtractJob::Updater] job a job
@@ -2251,10 +2289,10 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         # @!group Data
         #
         def extract_job extract_url, format: nil, compression: nil, delimiter: nil, header: nil, job_id: nil,
-                        prefix: nil, labels: nil, dryrun: nil
+                        prefix: nil, labels: nil, dryrun: nil, reservation: nil
           ensure_service!
           options = { format: format, compression: compression, delimiter: delimiter, header: header, dryrun: dryrun,
-                      job_id: job_id, prefix: prefix, labels: labels }
+                      job_id: job_id, prefix: prefix, labels: labels, reservation: reservation }
           updater = ExtractJob::Updater.from_options service, table_ref, extract_url, options
           updater.location = location if location # may be table reference
 
@@ -2298,6 +2336,12 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #   exported data. Default is <code>,</code>.
         # @param [Boolean] header Whether to print out a header row in the
         #   results. Default is `true`.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
+        #
         # @yield [job] a job configuration object
         # @yieldparam [Google::Cloud::Bigquery::ExtractJob::Updater] job a job
         #   configuration object for setting additional options.
@@ -2326,12 +2370,13 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #
         # @!group Data
         #
-        def extract extract_url, format: nil, compression: nil, delimiter: nil, header: nil, &block
+        def extract extract_url, format: nil, compression: nil, delimiter: nil, header: nil, reservation: nil, &block
           job = extract_job extract_url,
                             format:      format,
                             compression: compression,
                             delimiter:   delimiter,
                             header:      header,
+                            reservation: reservation,
                             &block
           job.wait_until_done!
           ensure_job_succeeded! job
@@ -2515,6 +2560,20 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #     and reorders columns to match the field names in the schema.
         # @param [String] time_zone The time zone used when parsing timestamp
         #   values.
+        # @param [String] reference_file_schema_uri The URI of the reference
+        #   file with the reader schema. This file is only loaded if it is part
+        #   of source URIs, but is not loaded otherwise. It is enabled for the
+        #   following formats: `AVRO`, `PARQUET`, `ORC`.
+        # @param [Boolean] preserve_ascii_control_characters When source_format
+        #   is set to `CSV`, indicates if the embedded ASCII control characters
+        #   (the first 32 characters in the ASCII-table, from `\x00` to `\x1F`)
+        #   are preserved. By default, ASCII control characters are not
+        #   preserved.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
         #
         # @yield [load_job] a block for setting the load job
         # @yieldparam [LoadJob] load_job the load job object to be updated
@@ -2573,7 +2632,8 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                      quote: nil, skip_leading: nil, job_id: nil, prefix: nil, labels: nil, autodetect: nil,
                      null_marker: nil, dryrun: nil, create_session: nil, session_id: nil, schema: self.schema,
                      date_format: nil, datetime_format: nil, time_format: nil, timestamp_format: nil,
-                     null_markers: nil, source_column_match: nil, time_zone: nil
+                     null_markers: nil, source_column_match: nil, time_zone: nil, reference_file_schema_uri: nil,
+                     preserve_ascii_control_characters: nil, reservation: nil
           ensure_service!
 
           updater = load_job_updater format: format, create: create, write: write, projection_fields: projection_fields,
@@ -2585,7 +2645,10 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                                      session_id: session_id, date_format: date_format,
                                      datetime_format: datetime_format, time_format: time_format,
                                      timestamp_format: timestamp_format, null_markers: null_markers,
-                                     source_column_match: source_column_match, time_zone: time_zone
+                                     source_column_match: source_column_match, time_zone: time_zone,
+                                     reference_file_schema_uri: reference_file_schema_uri,
+                                     preserve_ascii_control_characters: preserve_ascii_control_characters,
+                                     reservation: reservation
 
           yield updater if block_given?
 
@@ -2734,6 +2797,20 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
         #     and reorders columns to match the field names in the schema.
         # @param [String] time_zone The time zone used when parsing timestamp
         #   values.
+        # @param [String] reference_file_schema_uri The URI of the reference
+        #   file with the reader schema. This file is only loaded if it is part
+        #   of source URIs, but is not loaded otherwise. It is enabled for the
+        #   following formats: `AVRO`, `PARQUET`, `ORC`.
+        # @param [Boolean] preserve_ascii_control_characters When source_format
+        #   is set to `CSV`, indicates if the embedded ASCII control characters
+        #   (the first 32 characters in the ASCII-table, from `\x00` to `\x1F`)
+        #   are preserved. By default, ASCII control characters are not
+        #   preserved.
+        # @param [String] reservation The reservation that job would use. User
+        #    can specify a reservation to execute the job. If reservation is not
+        #    set, reservation is determined based on the rules defined by the
+        #    reservation assignments. The expected format is
+        #    `projects/`project`/locations/`location`/reservations/`reservation``.
         #
         # @yield [updater] A block for setting the schema of the destination
         #   table and other options for the load job. The schema can be omitted
@@ -2797,7 +2874,8 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                  quoted_newlines: nil, encoding: nil, delimiter: nil, ignore_unknown: nil, max_bad_records: nil,
                  quote: nil, skip_leading: nil, autodetect: nil, null_marker: nil, session_id: nil,
                  schema: self.schema, date_format: nil, datetime_format: nil, time_format: nil, timestamp_format: nil,
-                 null_markers: nil, source_column_match: nil, time_zone: nil, &block
+                 null_markers: nil, source_column_match: nil, time_zone: nil, reference_file_schema_uri: nil,
+                 preserve_ascii_control_characters: nil, reservation: nil, &block
           job = load_job files, format: format, create: create, write: write, projection_fields: projection_fields,
                                 jagged_rows: jagged_rows, quoted_newlines: quoted_newlines, encoding: encoding,
                                 delimiter: delimiter, ignore_unknown: ignore_unknown, max_bad_records: max_bad_records,
@@ -2805,7 +2883,10 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                                 null_marker: null_marker, session_id: session_id, schema: schema,
                                 date_format: date_format, datetime_format: datetime_format, time_format: time_format,
                                 timestamp_format: timestamp_format, null_markers: null_markers,
-                                source_column_match: source_column_match, time_zone: time_zone, &block
+                                source_column_match: source_column_match, time_zone: time_zone,
+                                reference_file_schema_uri: reference_file_schema_uri,
+                                preserve_ascii_control_characters: preserve_ascii_control_characters,
+                                reservation: reservation, &block
 
           job.wait_until_done!
           ensure_job_succeeded! job
@@ -3199,11 +3280,13 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
 
         protected
 
-        def copy_job_with_operation_type destination_table, create: nil, write: nil, operation_type: nil, &block
+        def copy_job_with_operation_type destination_table, create: nil, write: nil, operation_type: nil,
+                                         reservation: nil, &block
           job = copy_job destination_table,
                          create: create,
                          write: write,
                          operation_type: operation_type,
+                         reservation: reservation,
                          &block
           job.wait_until_done!
           ensure_job_succeeded! job
@@ -3254,7 +3337,7 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
           end
         end
 
-        def load_job_gapi table_id, dryrun, job_id: nil, prefix: nil
+        def load_job_gapi table_id, dryrun, job_id: nil, prefix: nil, reservation: nil
           job_ref = service.job_ref_from job_id, prefix
           Google::Apis::BigqueryV2::Job.new(
             job_reference: job_ref,
@@ -3266,13 +3349,15 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                   table_id:   table_id
                 )
               ),
-              dry_run: dryrun
+              dry_run: dryrun,
+              reservation: reservation
             )
           )
         end
 
         def load_job_csv_options! job, jagged_rows: nil, quoted_newlines: nil, delimiter: nil, quote: nil,
-                                  skip_leading: nil, null_marker: nil, null_markers: nil, source_column_match: nil
+                                  skip_leading: nil, null_marker: nil, null_markers: nil, source_column_match: nil,
+                                  preserve_ascii_control_characters: nil
           job.jagged_rows = jagged_rows unless jagged_rows.nil?
           job.quoted_newlines = quoted_newlines unless quoted_newlines.nil?
           job.delimiter = delimiter unless delimiter.nil?
@@ -3281,13 +3366,16 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
           job.skip_leading = skip_leading unless skip_leading.nil?
           job.null_markers = null_markers unless null_markers.nil?
           job.source_column_match = source_column_match unless source_column_match.nil?
+          job.preserve_ascii_control_characters = preserve_ascii_control_characters unless
+            preserve_ascii_control_characters.nil?
         end
 
         def load_job_file_options! job, format: nil, projection_fields: nil, jagged_rows: nil, quoted_newlines: nil,
                                    encoding: nil, delimiter: nil, ignore_unknown: nil, max_bad_records: nil, quote: nil,
                                    skip_leading: nil, null_marker: nil, date_format: nil, datetime_format: nil,
                                    time_format: nil, timestamp_format: nil, null_markers: nil, source_column_match: nil,
-                                   time_zone: nil
+                                   time_zone: nil, reference_file_schema_uri: nil,
+                                   preserve_ascii_control_characters: nil
           job.format = format unless format.nil?
           job.projection_fields = projection_fields unless projection_fields.nil?
           job.encoding = encoding unless encoding.nil?
@@ -3298,6 +3386,7 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
           job.time_format = time_format unless time_format.nil?
           job.timestamp_format = timestamp_format unless timestamp_format.nil?
           job.time_zone = time_zone unless time_zone.nil?
+          job.reference_file_schema_uri = reference_file_schema_uri unless reference_file_schema_uri.nil?
           load_job_csv_options! job, jagged_rows:     jagged_rows,
                                      quoted_newlines: quoted_newlines,
                                      delimiter:       delimiter,
@@ -3305,7 +3394,8 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                                      skip_leading:    skip_leading,
                                      null_marker:     null_marker,
                                      null_markers:    null_markers,
-                                     source_column_match: source_column_match
+                                     source_column_match: source_column_match,
+                                     preserve_ascii_control_characters: preserve_ascii_control_characters
         end
 
         def load_job_updater format: nil, create: nil, write: nil, projection_fields: nil, jagged_rows: nil,
@@ -3314,8 +3404,9 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                              prefix: nil, labels: nil, autodetect: nil, null_marker: nil,
                              create_session: nil, session_id: nil, date_format: nil, datetime_format: nil,
                              time_format: nil, timestamp_format: nil, null_markers: nil, source_column_match: nil,
-                             time_zone: nil
-          new_job = load_job_gapi table_id, dryrun, job_id: job_id, prefix: prefix
+                             time_zone: nil, reference_file_schema_uri: nil, preserve_ascii_control_characters: nil,
+                             reservation: nil
+          new_job = load_job_gapi table_id, dryrun, job_id: job_id, prefix: prefix, reservation: reservation
           LoadJob::Updater.new(new_job).tap do |job|
             job.location = location if location # may be table reference
             job.create = create unless create.nil?
@@ -3342,7 +3433,9 @@ format_options_use_int64_timestamp: format_options_use_int64_timestamp
                                         timestamp_format:  timestamp_format,
                                         null_markers:      null_markers,
                                         source_column_match: source_column_match,
-                                        time_zone:         time_zone
+                                        time_zone:         time_zone,
+                                        reference_file_schema_uri: reference_file_schema_uri,
+                                        preserve_ascii_control_characters: preserve_ascii_control_characters
           end
         end
 

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigquery
-      VERSION = "1.59.0".freeze
+      VERSION = "1.61.0".freeze
     end
   end
 end

data/lib/google/cloud/bigquery.rb

@@ -37,9 +37,26 @@ module Google
       #
       # @param [String] project_id Identifier for a BigQuery project. If not
       #   present, the default project for the credentials is used.
-      # @param [String, Hash, Google::Auth::Credentials] credentials The path to
-      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Bigquery::Credentials})
+      # @param [Google::Auth::Credentials] credentials A Google::Auth::Credentials
+      #   object. (See {Bigquery::Credentials})
+      #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+      #     is deprecated. Providing an unvalidated credential configuration to
+      #     Google APIs can compromise the security of your systems and data.
+      #
+      #   @example
+      #
+      #     # The recommended way to provide credentials is to use the `make_creds` method
+      #     # on the appropriate credentials class for your environment.
+      #
+      #     require "googleauth"
+      #
+      #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+      #       json_key_io: ::File.open("/path/to/keyfile.json")
+      #     )
+      #
+      #     client = ::Google::Cloud::Bigquery.new do |config|
+      #       config.credentials = credentials
+      #     end
       # @param [String, Array<String>] scope 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 #
@@ -98,12 +115,11 @@ module Google
       #
       # * `project_id` - (String) Identifier for a BigQuery project. (The
       #   parameter `project` is considered deprecated, but may also be used.)
-      # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to
-      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Bigquery::Credentials}) (The
-      #   parameter `keyfile` is considered deprecated, but may also be used.)
-      # * `endpoint` - (String) Override of the endpoint host name, or `nil`
-      #   to use the default endpoint.
+      # * `credentials` - (Google::Auth::Credentials) A Google::Auth::Credentials
+      #   object. (See {Bigquery::Credentials})
+      #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+      #     is deprecated. Providing an unvalidated credential configuration to
+      #     Google APIs can compromise the security of your systems and data.
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `retries` - (Integer) Number of times to retry requests on server

data/lib/google-cloud-bigquery.rb

@@ -87,9 +87,25 @@ module Google
     #
     # @param [String] project_id Identifier for a BigQuery project. If not
     #   present, the default project for the credentials is used.
-    # @param [String, Hash, Google::Auth::Credentials] credentials The path to
-    #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-    #   Google::Auth::Credentials object. (See {Bigquery::Credentials})
+    # @param [Google::Auth::Credentials] credentials A Google::Auth::Credentials
+    #     object. (See {Bigquery::Credentials})
+    #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+    #     is deprecated. Providing an unvalidated credential configuration to
+    #     Google APIs can compromise the security of your systems and data.
+    #
+    #   @example
+    #
+    #     # The recommended way to provide credentials is to use the `make_creds` method
+    #     # on the appropriate credentials class for your environment.
+    #
+    #     require "googleauth"
+    #
+    #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+    #       json_key_io: ::File.open("/path/to/keyfile.json")
+    #     )
+    #
+    #     client = ::Google::Cloud::Bigquery.new credentials: credentials
+    #
     # @param [String, Array<String>] scope 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery
 version: !ruby/object:Gem::Version
-  version: 1.59.0
+  version: 1.61.0
 platform: ruby
 authors:
 - Mike Moore