google-cloud-bigquery 1.58.0 → 1.60.0

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

@@ -178,6 +178,12 @@ module Google
         #   * 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 [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.
@@ -199,9 +205,11 @@ module Google
         #
         # @!group Data
         #
-        def copy_job source_table, destination_table, create: nil, write: nil, job_id: nil, prefix: nil, labels: nil
+        def copy_job source_table, destination_table, create: nil, write: nil, job_id: nil, prefix: nil, labels: nil,
+                     reservation: nil
           ensure_service!
-          options = { create: create, write: write, labels: labels, job_id: job_id, prefix: prefix }
+          options = { create: create, write: write, labels: labels, job_id: job_id, prefix: prefix,
+            reservation: reservation }
 
           updater = CopyJob::Updater.from_options(
             service,
@@ -258,6 +266,12 @@ module Google
         #   * `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.
@@ -276,8 +290,8 @@ module Google
         #
         # @!group Data
         #
-        def copy source_table, destination_table, create: nil, write: nil, &block
-          job = copy_job source_table, destination_table, create: create, write: write, &block
+        def copy source_table, destination_table, create: nil, write: nil, reservation: nil, &block
+          job = copy_job source_table, destination_table, create: create, write: write, reservation: reservation, &block
           job.wait_until_done!
           ensure_job_succeeded! job
           true
@@ -479,6 +493,12 @@ module Google
         #   The default value is false.
         # @param [String] session_id The ID of an existing session. See also the
         #   `create_session` param and {Job#session_id}.
+        # @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::QueryJob::Updater] job a job
         #   configuration object for setting query options.
@@ -631,7 +651,8 @@ module Google
                       labels: nil,
                       udfs: nil,
                       create_session: nil,
-                      session_id: nil
+                      session_id: nil,
+                      reservation: nil
           ensure_service!
           project ||= self.project
           options = {
@@ -657,7 +678,8 @@ module Google
             labels: labels,
             udfs: udfs,
             create_session: create_session,
-            session_id: session_id
+            session_id: session_id,
+            reservation: reservation
           }
 
           updater = QueryJob::Updater.from_options service, query, options
@@ -785,6 +807,11 @@ module Google
         #   `create_session` param in {#query_job} and {Job#session_id}.
         # @param [Boolean] format_options_use_int64_timestamp Output timestamp
         #   as usec int64. 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::QueryJob::Updater] job a job
@@ -933,6 +960,7 @@ module Google
                   legacy_sql: nil,
                   session_id: nil,
                   format_options_use_int64_timestamp: true,
+                  reservation: nil,
                   &block
           job = query_job query,
                           params: params,
@@ -944,6 +972,7 @@ module Google
                           standard_sql: standard_sql,
                           legacy_sql: legacy_sql,
                           session_id: session_id,
+                          reservation: reservation,
                           &block
           job.wait_until_done!
 
@@ -1152,6 +1181,20 @@ module Google
         #     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 and other
         #   options for the destination table. The schema can be omitted if the
@@ -1178,7 +1221,8 @@ module Google
                      skip_leading: nil, schema: nil, job_id: nil, prefix: nil, labels: nil, autodetect: nil,
                      null_marker: nil, dryrun: nil, create_session: nil, session_id: nil, project_id: nil,
                      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
           ensure_service!
           dataset_id ||= "_SESSION" unless create_session.nil? && session_id.nil?
           session_dataset = dataset dataset_id, skip_lookup: true, project_id: project_id
@@ -1193,7 +1237,9 @@ module Google
                           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, &block
+                          time_zone: time_zone, reference_file_schema_uri: reference_file_schema_uri,
+                          preserve_ascii_control_characters: preserve_ascii_control_characters,
+                          reservation: reservation, &block
         end
 
         ##
@@ -1348,6 +1394,20 @@ module Google
         #     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
@@ -1379,7 +1439,8 @@ module Google
                  delimiter: nil, ignore_unknown: nil, max_bad_records: nil, quote: nil,
                  skip_leading: nil, schema: nil, autodetect: nil, null_marker: 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, &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 table_id, files, dataset_id: dataset_id,
                         format: format, create: create, write: write, projection_fields: projection_fields,
                         jagged_rows: jagged_rows, quoted_newlines: quoted_newlines, encoding: encoding,
@@ -1388,7 +1449,10 @@ module Google
                         null_marker: null_marker, 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, &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
@@ -2091,6 +2155,12 @@ module Google
         #   * 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 [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.
@@ -2119,10 +2189,10 @@ module Google
         # @!group Data
         #
         def extract_job source, extract_url, format: nil, compression: nil, delimiter: nil, header: nil, job_id: nil,
-                        prefix: nil, labels: nil
+                        prefix: nil, labels: nil, reservation: nil
           ensure_service!
           options = { format: format, compression: compression, delimiter: delimiter, header: header, job_id: job_id,
-                      prefix: prefix, labels: labels }
+                      prefix: prefix, labels: labels, reservation: reservation }
           source_ref = if source.respond_to? :model_ref
                          source.model_ref
                        else
@@ -2189,6 +2259,12 @@ module Google
         #   models.
         # @param [Boolean] header Whether to print out a header row in table
         #   exports. Default is `true`. Not applicable when extracting models.
+        # @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.
@@ -2214,12 +2290,14 @@ module Google
         #
         # @!group Data
         #
-        def extract source, extract_url, format: nil, compression: nil, delimiter: nil, header: nil, &block
+        def extract source, extract_url, format: nil, compression: nil, delimiter: nil, header: nil, reservation: nil,
+                    &block
           job = extract_job source, extract_url,
                             format:      format,
                             compression: compression,
                             delimiter:   delimiter,
                             header:      header,
+                            reservation: reservation,
                             &block
           job.wait_until_done!
           ensure_job_succeeded! job

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

@@ -792,7 +792,8 @@ module Google
                   query: query,
                   default_dataset: dataset_config,
                   maximum_billing_tier: options[:maximum_billing_tier]
-                )
+                ),
+                reservation: options[:reservation]
               )
             )
 
@@ -1596,6 +1597,18 @@ module Google
             @gapi.configuration.query.clustering.fields = fields
           end
 
+          ##
+          # Sets 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``.
+          # @param [String] value The reservation name.
+          #
+          # @!group Attributes
+          def reservation= value
+            @gapi.configuration.update! reservation: value
+          end
+
           def cancel
             raise "not implemented in #{self.class}"
           end

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

@@ -351,6 +351,31 @@ module Google
             @gapi.scale
           end
 
+          ##
+          # The collation of the field.
+          #
+          # Collation can be set only when the type of field is `STRING`.
+          # The following values are supported:
+          #
+          # * `und:ci`: undetermined locale, case insensitive.
+          # * (empty string): Default to case-sensitive behavior.
+          #
+          # @return [String, nil] The collation for the field, or `nil`.
+          #
+          def collation
+            @gapi.collation
+          end
+
+          ##
+          # Updates the collation of the field.
+          #
+          # @param [String] new_collation The new collation. See {#collation}
+          #   for supported values.
+          #
+          def collation= new_collation
+            @gapi.update! collation: new_collation
+          end
+
           ##
           # Checks if the type of the field is `STRING`.
           #
@@ -568,7 +593,7 @@ module Google
           # @param [Integer] max_length The maximum UTF-8 length of strings
           #   allowed in the field.
           #
-          def string name, description: nil, mode: :nullable, policy_tags: nil, max_length: nil
+          def string name, description: nil, mode: :nullable, policy_tags: nil, max_length: nil, collation: nil
             record_check!
 
             add_field name,
@@ -576,7 +601,8 @@ module Google
                       description: description,
                       mode: mode,
                       policy_tags: policy_tags,
-                      max_length: max_length
+                      max_length: max_length,
+                      collation: collation
           end
 
           ##
@@ -1029,7 +1055,8 @@ module Google
                         policy_tags: nil,
                         max_length: nil,
                         precision: nil,
-                        scale: nil
+                        scale: nil,
+                        collation: nil
             frozen_check!
 
             new_gapi = Google::Apis::BigqueryV2::TableFieldSchema.new(
@@ -1046,6 +1073,7 @@ module Google
             new_gapi.max_length = max_length if max_length
             new_gapi.precision = precision if precision
             new_gapi.scale = scale if scale
+            new_gapi.collation = collation if collation
             # Remove any existing field of this name
             @gapi.fields ||= []
             @gapi.fields.reject! { |f| f.name == new_gapi.name }

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

@@ -318,13 +318,14 @@ module Google
         #         "[CURRENT_DATE(), DATE '2020-01-01'"]
         #
         def string name, description: nil, mode: :nullable, policy_tags: nil,
-                   max_length: nil, default_value_expression: nil
+                   max_length: nil, default_value_expression: nil, collation: nil
           add_field name, :string,
                     description: description,
                     mode: mode,
                     policy_tags: policy_tags,
                     max_length: max_length,
-                    default_value_expression: default_value_expression
+                    default_value_expression: default_value_expression,
+                    collation: collation
         end
 
         ##
@@ -981,7 +982,8 @@ module Google
                       max_length: nil,
                       precision: nil,
                       scale: nil,
-                      default_value_expression: nil
+                      default_value_expression: nil,
+                      collation: nil
           frozen_check!
 
           new_gapi = Google::Apis::BigqueryV2::TableFieldSchema.new(
@@ -999,6 +1001,7 @@ module Google
           new_gapi.precision = precision if precision
           new_gapi.scale = scale if scale
           new_gapi.default_value_expression = default_value_expression if default_value_expression
+          new_gapi.collation = collation if collation
           # Remove any existing field of this name
           @gapi.fields ||= []
           @gapi.fields.reject! { |f| f.name == new_gapi.name }