google-cloud-bigquery 1.52.1 → 1.61.1

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

@@ -652,6 +652,111 @@ module Google
           @gapi.configuration.load.clustering.fields if clustering?
         end
 
+        ##
+        # Format used to parse DATE values. Supports SQL-style values. See
+        # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+        #
+        # @return [String, nil] The date format pattern, such as
+        #   `YYYY-MM-DD`. `nil` if not set.
+        def date_format
+          @gapi.configuration.load.date_format
+        end
+
+        ##
+        # Format used to parse DATETIME values. Supports SQL-style values. See
+        # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+        #
+        # @return [String, nil] The datetime format pattern, such as
+        #   `YYYY-MM-DD HH24:MI:SS`. `nil` if not set.
+        def datetime_format
+          @gapi.configuration.load.datetime_format
+        end
+
+        ##
+        # Format used to parse TIME values. Supports SQL-style values. See
+        # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+        #
+        # @return [String, nil] The time format pattern, such as
+        #   `HH24:MI:SS`. `nil` if not set.
+        def time_format
+          @gapi.configuration.load.time_format
+        end
+
+        ##
+        # Format used to parse TIMESTAMP values. Supports SQL-style values. See
+        # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+        #
+        # @return [String, nil] The timestamp format pattern, such as
+        #   `YYYY-MM-DD HH24:MI:SS.FF3 TZH`. `nil` if not set.
+        def timestamp_format
+          @gapi.configuration.load.timestamp_format
+        end
+
+        ##
+        # A list of strings represented as SQL NULL value in a CSV file.
+        # null_marker and null_markers can't be set at the same time. If null_marker
+        # is set, null_markers has to be not set. If null_markers is set, null_marker
+        # has to be not set. If both null_marker and null_markers are set at the same
+        # time, a user error would be thrown. Any strings listed in null_markers,
+        # including empty string would be interpreted as SQL NULL. This applies to all
+        # column types.
+        #
+        # @return [Array<String>] The array of null marker strings.
+        def null_markers
+          @gapi.configuration.load.null_markers || []
+        end
+
+        ##
+        # Controls the strategy used to match loaded columns to the schema. If
+        # not set, a sensible default is chosen based on how the schema is provided.
+        # If autodetect is used, then columns are matched by name. Otherwise,
+        # columns are matched by position. This is done to keep the behavior
+        # backward-compatible.
+        #
+        # Acceptable values are:
+        # * `POSITION` - matches by position. This assumes that the columns are
+        #   ordered the same way as the schema.
+        # * `NAME` - matches by name. This reads the header row as column names
+        #   and reorders columns to match the field names in the schema.
+        #
+        # @return [String, nil] The source column match strategy, such as
+        #   `POSITION`. `nil` if not set.
+        def source_column_match
+          @gapi.configuration.load.source_column_match
+        end
+
+        ##
+        # Time zone used when parsing timestamp values that do not have specific
+        # time zone information (e.g. `2024-04-20 12:34:56`). The expected format
+        # is an IANA timezone string (e.g. `America/Los_Angeles`).
+        #
+        # @return [String, nil] The IANA time zone name, such as
+        #   `America/Los_Angeles`. `nil` if not set.
+        def time_zone
+          @gapi.configuration.load.time_zone
+        end
+
+        ##
+        # 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`.
+        #
+        # @return [String, nil] The URI of the reference file, or `nil` if not set.
+        def reference_file_schema_uri
+          @gapi.configuration.load.reference_file_schema_uri
+        end
+
+        # 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.
+        #
+        # @return [Boolean, nil] whether or not ASCII control characters are
+        #   preserved. `nil` if not set.
+        def preserve_ascii_control_characters
+          @gapi.configuration.load.preserve_ascii_control_characters
+        end
+
         ##
         # Yielded to a block to accumulate changes for a patch request.
         class Updater < LoadJob
@@ -2585,6 +2690,128 @@ module Google
             @gapi.configuration.load.clustering.fields = fields
           end
 
+          ##
+          # Sets the format used to parse DATE values. Supports SQL-style
+          # values. See
+          # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+          #
+          # @param [String, nil] date_format The date format pattern, such as
+          #   `YYYY-MM-DD`. `nil` to unset.
+          def date_format= date_format
+            @gapi.configuration.load.update! date_format: date_format
+          end
+
+          ##
+          # Sets the format used to parse DATETIME values. Supports SQL-style
+          # values. See
+          # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+          #
+          # @param [String, nil] datetime_format The datetime format pattern, such as
+          #   `YYYY-MM-DD HH24:MI:SS`. `nil` to unset.
+          def datetime_format= datetime_format
+            @gapi.configuration.load.update! datetime_format: datetime_format
+          end
+
+          ##
+          # Sets the format used to parse TIME values. Supports SQL-style
+          # values. See
+          # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+          #
+          # @param [String, nil] time_format The time format pattern, such as
+          #   `HH24:MI:SS`. `nil` to unset.
+          def time_format= time_format
+            @gapi.configuration.load.update! time_format: time_format
+          end
+
+          ##
+          # Sets the format used to parse TIMESTAMP values. Supports SQL-style
+          # values. See
+          # [date and time formatting guide](https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#format_date_time_as_string)
+          #
+          # @param [String, nil] timestamp_format The timestamp format pattern, such as
+          #   `YYYY-MM-DD HH24:MI:SS.FF3 TZH`. `nil` to unset.
+          def timestamp_format= timestamp_format
+            @gapi.configuration.load.update! timestamp_format: timestamp_format
+          end
+
+          ##
+          # Sets the list of strings represented as SQL NULL value in a CSV file.
+          # null_marker and null_markers can't be set at the same time. If null_marker is
+          # set, null_markers has to be not set. If null_markers is set, null_marker has
+          # to be not set. If both null_marker and null_markers are set at the same time,
+          # a user error would be thrown. Any strings listed in null_markers, including
+          # empty string would be interpreted as SQL NULL. This applies to all column
+          # types.
+          #
+          # @param [Array<String>] null_markers The array of null marker strings.
+          def null_markers= null_markers
+            @gapi.configuration.load.update! null_markers: null_markers
+          end
+
+          # Sets the strategy used to match loaded columns to the schema.
+          # If not set, a sensible default is chosen based on how the schema is
+          # provided. If autodetect is used, then columns are matched by name.
+          # Otherwise, columns are matched by position. This is done to keep the
+          # behavior backward-compatible.
+          #
+          # Acceptable values are:
+          # - `POSITION`: matches by position. Assumes columns are ordered the
+          #   same way as the schema.
+          # - `NAME`: matches by name. Reads the header row as column names and
+          #   reorders columns to match the schema.
+          #
+          # @param [String, nil] source_column_match The new source column match value.
+          #   `nil` to unset.
+          def source_column_match= source_column_match
+            @gapi.configuration.load.update! source_column_match: source_column_match
+          end
+
+          ##
+          # Sets the time zone used when parsing timestamp values that do not have
+          # specific time zone information (e.g. `2024-04-20 12:34:56`). The expected
+          # format is an IANA timezone string (e.g. `America/Los_Angeles`).
+          #
+          # @param [String, nil] time_zone The IANA time zone name, such as
+          #   `America/Los_Angeles`. `nil` to unset.
+          def time_zone= time_zone
+            @gapi.configuration.load.update! time_zone: time_zone
+          end
+
+          ##
+
+          # Sets 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 [String, nil] uri The URI of the reference file, or `nil` to unset.
+          def reference_file_schema_uri= uri
+            @gapi.configuration.load.update! reference_file_schema_uri: uri
+          end
+
+          # When source_format is set to `CSV`, sets whether 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 [Boolean, nil] val whether or not ASCII control characters
+          #   are preserved. `nil` to unset.
+          def preserve_ascii_control_characters= val
+            @gapi.configuration.load.update! preserve_ascii_control_characters: val
+          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/model.rb

@@ -545,6 +545,11 @@ 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
@@ -566,9 +571,9 @@ module Google
         #
         # @!group Data
         #
-        def extract_job extract_url, format: nil, job_id: nil, prefix: nil, labels: nil
+        def extract_job extract_url, format: nil, job_id: nil, prefix: nil, labels: nil, reservation: nil
           ensure_service!
-          options = { format: format, job_id: job_id, prefix: prefix, labels: labels }
+          options = { format: format, job_id: job_id, prefix: prefix, labels: labels, reservation: reservation }
           updater = ExtractJob::Updater.from_options service, model_ref, extract_url, options
           updater.location = location if location # may be model reference
 
@@ -603,6 +608,12 @@ module Google
         #
         #   * `ml_tf_saved_model` - TensorFlow SavedModel
         #   * `ml_xgboost_booster` - XGBoost Booster
+        # @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.
@@ -620,8 +631,8 @@ module Google
         #
         # @!group Data
         #
-        def extract extract_url, format: nil, &block
-          job = extract_job extract_url, format: format, &block
+        def extract extract_url, format: nil, reservation: nil, &block
+          job = extract_job extract_url, format: format, reservation: reservation, &block
           job.wait_until_done!
           ensure_job_succeeded! job
           true