google-cloud-bigquery 1.27.0 → 1.32.0

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

@@ -121,12 +121,12 @@ module Google
           #     puts project.name
           #   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.negative?

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

@@ -514,7 +514,7 @@ module Google
         # Checks if the destination table will be time-partitioned. See
         # [Partitioned Tables](https://cloud.google.com/bigquery/docs/partitioned-tables).
         #
-        # @return [Boolean, nil] `true` when the table will be time-partitioned,
+        # @return [Boolean] `true` when the table will be time-partitioned,
         #   or `false` otherwise.
         #
         # @!group Attributes
@@ -589,10 +589,15 @@ module Google
         ###
         # Checks if the destination table will be clustered.
         #
+        # See {QueryJob::Updater#clustering_fields=}, {Table#clustering_fields} and
+        # {Table#clustering_fields=}.
+        #
         # @see https://cloud.google.com/bigquery/docs/clustered-tables
-        #   Introduction to Clustered Tables
+        #   Introduction to clustered tables
+        # @see https://cloud.google.com/bigquery/docs/creating-clustered-tables
+        #   Creating and using clustered tables
         #
-        # @return [Boolean, nil] `true` when the table will be clustered,
+        # @return [Boolean] `true` when the table will be clustered,
         #   or `false` otherwise.
         #
         # @!group Attributes
@@ -607,14 +612,16 @@ module Google
         # be first partitioned and subsequently clustered. The order of the
         # returned fields determines the sort order of the data.
         #
-        # See {QueryJob::Updater#clustering_fields=}.
+        # BigQuery supports clustering for both partitioned and non-partitioned
+        # tables.
+        #
+        # See {QueryJob::Updater#clustering_fields=}, {Table#clustering_fields} and
+        # {Table#clustering_fields=}.
         #
-        # @see https://cloud.google.com/bigquery/docs/partitioned-tables
-        #   Partitioned Tables
         # @see https://cloud.google.com/bigquery/docs/clustered-tables
-        #   Introduction to Clustered Tables
+        #   Introduction to clustered tables
         # @see https://cloud.google.com/bigquery/docs/creating-clustered-tables
-        #   Creating and Using Clustered Tables
+        #   Creating and using clustered tables
         #
         # @return [Array<String>, nil] The clustering fields, or `nil` if the
         #   destination table will not be clustered.
@@ -692,8 +699,11 @@ module Google
           end
           ensure_schema!
 
-          options = { token: token, max: max, start: start }
-          data_hash = service.list_tabledata destination_table_dataset_id, destination_table_table_id, options
+          data_hash = service.list_tabledata destination_table_dataset_id,
+                                             destination_table_table_id,
+                                             token: token,
+                                             max: max,
+                                             start: start
           Data.from_gapi_json data_hash, destination_table_gapi, @gapi, service
         end
         alias query_results data
@@ -704,12 +714,11 @@ module Google
           ##
           # @private Create an Updater object.
           def initialize service, gapi
+            super()
             @service = service
             @gapi = gapi
           end
 
-          # rubocop:disable all
-
           ##
           # @private Create an Updater from an options hash.
           #
@@ -748,8 +757,6 @@ module Google
             updater
           end
 
-          # rubocop:enable all
-
           ##
           # Sets the geographic location where the job should run. Required
           # except for US and EU.
@@ -853,20 +860,21 @@ module Google
           #
           #   Ruby types are mapped to BigQuery types as follows:
           #
-          #   | BigQuery    | Ruby                                 | Notes                                          |
-          #   |-------------|--------------------------------------|------------------------------------------------|
-          #   | `BOOL`      | `true`/`false`                       |                                                |
-          #   | `INT64`     | `Integer`                            |                                                |
-          #   | `FLOAT64`   | `Float`                              |                                                |
-          #   | `NUMERIC`   | `BigDecimal`                         | Will be rounded to 9 decimal places            |
-          #   | `STRING`    | `String`                             |                                                |
-          #   | `DATETIME`  | `DateTime`                           | `DATETIME` does not support time zone.         |
-          #   | `DATE`      | `Date`                               |                                                |
-          #   | `TIMESTAMP` | `Time`                               |                                                |
-          #   | `TIME`      | `Google::Cloud::BigQuery::Time`      |                                                |
-          #   | `BYTES`     | `File`, `IO`, `StringIO`, or similar |                                                |
-          #   | `ARRAY`     | `Array`                              | Nested arrays, `nil` values are not supported. |
-          #   | `STRUCT`    | `Hash`                               | Hash keys may be strings or symbols.           |
+          #   | BigQuery     | Ruby                                 | Notes                                            |
+          #   |--------------|--------------------------------------|--------------------------------------------------|
+          #   | `BOOL`       | `true`/`false`                       |                                                  |
+          #   | `INT64`      | `Integer`                            |                                                  |
+          #   | `FLOAT64`    | `Float`                              |                                                  |
+          #   | `NUMERIC`    | `BigDecimal`                         | `BigDecimal` values will be rounded to scale 9.  |
+          #   | `BIGNUMERIC` |                                      | Query param values must be mapped in `types`.    |
+          #   | `STRING`     | `String`                             |                                                  |
+          #   | `DATETIME`   | `DateTime`                           | `DATETIME` does not support time zone.           |
+          #   | `DATE`       | `Date`                               |                                                  |
+          #   | `TIMESTAMP`  | `Time`                               |                                                  |
+          #   | `TIME`       | `Google::Cloud::BigQuery::Time`      |                                                  |
+          #   | `BYTES`      | `File`, `IO`, `StringIO`, or similar |                                                  |
+          #   | `ARRAY`      | `Array`                              | Nested arrays, `nil` values are not supported.   |
+          #   | `STRUCT`     | `Hash`                               | Hash keys may be strings or symbols.             |
           #
           #   See [Data Types](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types) for an overview
           #   of each BigQuery data type, including allowed values.
@@ -887,35 +895,37 @@ module Google
           #
           #   Ruby types are mapped to BigQuery types as follows:
           #
-          #   | BigQuery    | Ruby                                 | Notes                                          |
-          #   |-------------|--------------------------------------|------------------------------------------------|
-          #   | `BOOL`      | `true`/`false`                       |                                                |
-          #   | `INT64`     | `Integer`                            |                                                |
-          #   | `FLOAT64`   | `Float`                              |                                                |
-          #   | `NUMERIC`   | `BigDecimal`                         | Will be rounded to 9 decimal places            |
-          #   | `STRING`    | `String`                             |                                                |
-          #   | `DATETIME`  | `DateTime`                           | `DATETIME` does not support time zone.         |
-          #   | `DATE`      | `Date`                               |                                                |
-          #   | `TIMESTAMP` | `Time`                               |                                                |
-          #   | `TIME`      | `Google::Cloud::BigQuery::Time`      |                                                |
-          #   | `BYTES`     | `File`, `IO`, `StringIO`, or similar |                                                |
-          #   | `ARRAY`     | `Array`                              | Nested arrays, `nil` values are not supported. |
-          #   | `STRUCT`    | `Hash`                               | Hash keys may be strings or symbols.           |
+          #   | BigQuery     | Ruby                                 | Notes                                            |
+          #   |--------------|--------------------------------------|--------------------------------------------------|
+          #   | `BOOL`       | `true`/`false`                       |                                                  |
+          #   | `INT64`      | `Integer`                            |                                                  |
+          #   | `FLOAT64`    | `Float`                              |                                                  |
+          #   | `NUMERIC`    | `BigDecimal`                         | `BigDecimal` values will be rounded to scale 9.  |
+          #   | `BIGNUMERIC` |                                      | Query param values must be mapped in `types`.    |
+          #   | `STRING`     | `String`                             |                                                  |
+          #   | `DATETIME`   | `DateTime`                           | `DATETIME` does not support time zone.           |
+          #   | `DATE`       | `Date`                               |                                                  |
+          #   | `TIMESTAMP`  | `Time`                               |                                                  |
+          #   | `TIME`       | `Google::Cloud::BigQuery::Time`      |                                                  |
+          #   | `BYTES`      | `File`, `IO`, `StringIO`, or similar |                                                  |
+          #   | `ARRAY`      | `Array`                              | Nested arrays, `nil` values are not supported.   |
+          #   | `STRUCT`     | `Hash`                               | Hash keys may be strings or symbols.             |
           #
           #   See [Data Types](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types) for an overview
           #   of each BigQuery data type, including allowed values.
-          # @param [Array, Hash] types Standard SQL only. Types of the SQL parameters in `params`. It is not always to
-          #   infer the right SQL type from a value in `params`. In these cases, `types` must be used to specify the SQL
-          #   type for these values.
+          # @param [Array, Hash] types Standard SQL only. Types of the SQL parameters in `params`. It is not always
+          #   possible to infer the right SQL type from a value in `params`. In these cases, `types` must be used to
+          #   specify the SQL type for these values.
           #
-          #   Must match the value type passed to `params`. This must be an `Array` when the query uses positional query
-          #   parameters. This must be an `Hash` when the query uses named query parameters. The values should be
-          #   BigQuery type codes from the following list:
+          #   Arguments must match the value type passed to `params`. This must be an `Array` when the query uses
+          #   positional query parameters. This must be an `Hash` when the query uses named query parameters. The values
+          #   should be BigQuery type codes from the following list:
           #
           #   * `:BOOL`
           #   * `:INT64`
           #   * `:FLOAT64`
           #   * `:NUMERIC`
+          #   * `:BIGNUMERIC`
           #   * `:STRING`
           #   * `:DATETIME`
           #   * `:DATE`
@@ -935,13 +945,13 @@ module Google
             raise ArgumentError, "types must use the same format as params" if types.class != params.class
 
             case params
-            when Array then
+            when Array
               @gapi.configuration.query.use_legacy_sql = false
               @gapi.configuration.query.parameter_mode = "POSITIONAL"
               @gapi.configuration.query.query_parameters = params.zip(types).map do |param, type|
                 Convert.to_query_param param, type
               end
-            when Hash then
+            when Hash
               @gapi.configuration.query.use_legacy_sql = false
               @gapi.configuration.query.parameter_mode = "NAMED"
               @gapi.configuration.query.query_parameters = params.map do |name, param|
@@ -1442,23 +1452,23 @@ module Google
           end
 
           ##
-          # Sets one or more fields on which the destination table should be
-          # clustered. Must be specified with time-based partitioning, data in
-          # the table will be first partitioned and subsequently clustered.
+          # Sets the list of fields on which data should be clustered.
           #
           # Only top-level, non-repeated, simple-type fields are supported. When
           # you cluster a table using multiple columns, the order of columns you
           # specify is important. The order of the specified columns determines
           # the sort order of the data.
           #
-          # See {QueryJob#clustering_fields}.
+          # BigQuery supports clustering for both partitioned and non-partitioned
+          # tables.
+          #
+          # See {QueryJob#clustering_fields}, {Table#clustering_fields} and
+          # {Table#clustering_fields=}.
           #
-          # @see https://cloud.google.com/bigquery/docs/partitioned-tables
-          #   Partitioned Tables
           # @see https://cloud.google.com/bigquery/docs/clustered-tables
-          #   Introduction to Clustered Tables
+          #   Introduction to clustered tables
           # @see https://cloud.google.com/bigquery/docs/creating-clustered-tables
-          #   Creating and Using Clustered Tables
+          #   Creating and using clustered tables
           #
           # @param [Array<String>] fields The clustering fields. Only top-level,
           #   non-repeated, simple-type fields are supported.
@@ -1592,9 +1602,20 @@ module Google
         #   end
         #
         class Stage
-          attr_reader :compute_ratio_avg, :compute_ratio_max, :id, :name, :read_ratio_avg, :read_ratio_max,
-                      :records_read, :records_written, :status, :steps, :wait_ratio_avg, :wait_ratio_max,
-                      :write_ratio_avg, :write_ratio_max
+          attr_reader :compute_ratio_avg
+          attr_reader :compute_ratio_max
+          attr_reader :id
+          attr_reader :name
+          attr_reader :read_ratio_avg
+          attr_reader :read_ratio_max
+          attr_reader :records_read
+          attr_reader :records_written
+          attr_reader :status
+          attr_reader :steps
+          attr_reader :wait_ratio_avg
+          attr_reader :wait_ratio_max
+          attr_reader :write_ratio_avg
+          attr_reader :write_ratio_max
 
           ##
           # @private Creates a new Stage instance.
@@ -1657,7 +1678,8 @@ module Google
         #   end
         #
         class Step
-          attr_reader :kind, :substeps
+          attr_reader :kind
+          attr_reader :substeps
 
           ##
           # @private Creates a new Stage instance.

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

@@ -1006,6 +1006,7 @@ module Google
           ##
           # @private Create an Updater object.
           def initialize gapi
+            super()
             @original_gapi = gapi
             @gapi = gapi.dup
           end
@@ -1210,15 +1211,11 @@ module Google
           end
           alias refresh! reload!
 
-          # rubocop:disable Style/CaseEquality
-
           # @private
           def updates?
             !(@gapi === @original_gapi)
           end
 
-          # rubocop:enable Style/CaseEquality
-
           # @private
           def to_gapi
             @gapi

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

@@ -124,12 +124,12 @@ module Google
           #     puts routine.routine_id
           #   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.negative?

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

@@ -332,9 +332,18 @@ module Google
         end
 
         ##
-        # Adds a numeric number field to the schema. Numeric is a
-        # fixed-precision numeric type with 38 decimal digits, 9 that follow the
-        # decimal point.
+        # Adds a numeric number field to the schema. `NUMERIC` is a decimal
+        # type with fixed precision and scale. Precision is the number of
+        # digits that the number contains. Scale is how many of these
+        # digits appear after the decimal point. It supports:
+        #
+        # Precision: 38
+        # Scale: 9
+        # Min: -9.9999999999999999999999999999999999999E+28
+        # Max: 9.9999999999999999999999999999999999999E+28
+        #
+        # This type can represent decimal fractions exactly, and is suitable
+        # for financial calculations.
         #
         # @param [String] name The field name. The name must contain only
         #   letters (a-z, A-Z), numbers (0-9), or underscores (_), and must
@@ -349,6 +358,33 @@ module Google
           add_field name, :numeric, description: description, mode: mode
         end
 
+        ##
+        # Adds a bignumeric number field to the schema. `BIGNUMERIC` is a
+        # decimal type with fixed precision and scale. Precision is the
+        # number of digits that the number contains. Scale is how many of
+        # these digits appear after the decimal point. It supports:
+        #
+        # Precision: 76.76 (the 77th digit is partial)
+        # Scale: 38
+        # Min: -5.7896044618658097711785492504343953926634992332820282019728792003956564819968E+38
+        # Max: 5.7896044618658097711785492504343953926634992332820282019728792003956564819967E+38
+        #
+        # This type can represent decimal fractions exactly, and is suitable
+        # for financial calculations.
+        #
+        # @param [String] name The field name. The name must contain only
+        #   letters (a-z, A-Z), numbers (0-9), or underscores (_), and must
+        #   start with a letter or underscore. The maximum length is 128
+        #   characters.
+        # @param [String] description A description of the field.
+        # @param [Symbol] mode The field's mode. The possible values are
+        #   `:nullable`, `:required`, and `:repeated`. The default value is
+        #   `:nullable`.
+        #
+        def bignumeric name, description: nil, mode: :nullable
+          add_field name, :bignumeric, description: description, mode: mode
+        end
+
         ##
         # Adds a boolean field to the schema.
         #

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

@@ -40,8 +40,8 @@ module Google
           MODES = ["NULLABLE", "REQUIRED", "REPEATED"].freeze
 
           # @private
-          TYPES = ["STRING", "INTEGER", "INT64", "FLOAT", "FLOAT64", "NUMERIC", "BOOLEAN", "BOOL", "BYTES", "TIMESTAMP",
-                   "TIME", "DATETIME", "DATE", "RECORD", "STRUCT"].freeze
+          TYPES = ["STRING", "INTEGER", "INT64", "FLOAT", "FLOAT64", "NUMERIC", "BIGNUMERIC", "BOOLEAN", "BOOL",
+                   "BYTES", "TIMESTAMP", "TIME", "DATETIME", "DATE", "RECORD", "STRUCT"].freeze
 
           ##
           # The name of the field.
@@ -72,10 +72,10 @@ module Google
           #
           # @return [String] The field data type. Possible values include
           #   `STRING`, `BYTES`, `INTEGER`, `INT64` (same as `INTEGER`),
-          #   `FLOAT`, `FLOAT64` (same as `FLOAT`), `NUMERIC`, `BOOLEAN`, `BOOL`
-          #   (same as `BOOLEAN`), `TIMESTAMP`, `DATE`, `TIME`, `DATETIME`,
-          #   `RECORD` (where `RECORD` indicates that the field contains a
-          #   nested schema) or `STRUCT` (same as `RECORD`).
+          #   `FLOAT`, `FLOAT64` (same as `FLOAT`), `NUMERIC`, `BIGNUMERIC`,
+          #   `BOOLEAN`, `BOOL` (same as `BOOLEAN`), `TIMESTAMP`, `DATE`,
+          #   `TIME`, `DATETIME`, `RECORD` (where `RECORD` indicates that the
+          #   field contains a nested schema) or `STRUCT` (same as `RECORD`).
           #
           def type
             @gapi.type
@@ -86,10 +86,10 @@ module Google
           #
           # @param [String] new_type The data type. Possible values include
           #   `STRING`, `BYTES`, `INTEGER`, `INT64` (same as `INTEGER`),
-          #   `FLOAT`, `FLOAT64` (same as `FLOAT`), `NUMERIC`, `BOOLEAN`, `BOOL`
-          #   (same as `BOOLEAN`), `TIMESTAMP`, `DATE`, `TIME`, `DATETIME`,
-          #   `RECORD` (where `RECORD` indicates that the field contains a
-          #   nested schema) or `STRUCT` (same as `RECORD`).
+          #   `FLOAT`, `FLOAT64` (same as `FLOAT`), `NUMERIC`, `BIGNUMERIC`,
+          #   `BOOLEAN`, `BOOL` (same as `BOOLEAN`), `TIMESTAMP`, `DATE`,
+          #   `TIME`, `DATETIME`, `RECORD` (where `RECORD` indicates that the
+          #   field contains a nested schema) or `STRUCT` (same as `RECORD`).
           #
           def type= new_type
             @gapi.update! type: verify_type(new_type)
@@ -199,6 +199,15 @@ module Google
             type == "NUMERIC"
           end
 
+          ##
+          # Checks if the type of the field is `BIGNUMERIC`.
+          #
+          # @return [Boolean] `true` when `BIGNUMERIC`, `false` otherwise.
+          #
+          def bignumeric?
+            type == "BIGNUMERIC"
+          end
+
           ##
           # Checks if the type of the field is `BOOLEAN`.
           #
@@ -299,6 +308,7 @@ module Google
           # * `:INT64`
           # * `:FLOAT64`
           # * `:NUMERIC`
+          # * `:BIGNUMERIC`
           # * `:STRING`
           # * `:DATETIME`
           # * `:DATE`
@@ -394,9 +404,18 @@ module Google
           end
 
           ##
-          # Adds a numeric number field to the schema. Numeric is a
-          # fixed-precision numeric type with 38 decimal digits, 9 that follow
-          # the decimal point.
+          # Adds a numeric number field to the schema. `NUMERIC` is a decimal
+          # type with fixed precision and scale. Precision is the number of
+          # digits that the number contains. Scale is how many of these
+          # digits appear after the decimal point. It supports:
+          #
+          # Precision: 38
+          # Scale: 9
+          # Min: -9.9999999999999999999999999999999999999E+28
+          # Max: 9.9999999999999999999999999999999999999E+28
+          #
+          # This type can represent decimal fractions exactly, and is suitable
+          # for financial calculations.
           #
           # This can only be called on fields that are of type `RECORD`.
           #
@@ -415,6 +434,37 @@ module Google
             add_field name, :numeric, description: description, mode: mode
           end
 
+          ##
+          # Adds a bignumeric number field to the schema. `BIGNUMERIC` is a
+          # decimal type with fixed precision and scale. Precision is the
+          # number of digits that the number contains. Scale is how many of
+          # these digits appear after the decimal point. It supports:
+          #
+          # Precision: 76.76 (the 77th digit is partial)
+          # Scale: 38
+          # Min: -5.7896044618658097711785492504343953926634992332820282019728792003956564819968E+38
+          # Max: 5.7896044618658097711785492504343953926634992332820282019728792003956564819967E+38
+          #
+          # This type can represent decimal fractions exactly, and is suitable
+          # for financial calculations.
+          #
+          # This can only be called on fields that are of type `RECORD`.
+          #
+          # @param [String] name The field name. The name must contain only
+          #   letters (a-z, A-Z), numbers (0-9), or underscores (_), and must
+          #   start with a letter or underscore. The maximum length is 128
+          #   characters.
+          # @param [String] description A description of the field.
+          # @param [Symbol] mode The field's mode. The possible values are
+          #   `:nullable`, `:required`, and `:repeated`. The default value is
+          #   `:nullable`.
+          #
+          def bignumeric name, description: nil, mode: :nullable
+            record_check!
+
+            add_field name, :bignumeric, description: description, mode: mode
+          end
+
           ##
           # Adds a boolean field to the nested schema of a record field.
           #