google-cloud-bigquery 1.40.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0cd69b913db71840e3b893b15edfefe3c18bb204c8a8e542a82afcee37c0eeb
-  data.tar.gz: cfd00e65e67aac9e07e1eada563f221c462004319c7fa2a6d38915434ef21f19
+  metadata.gz: 8f13891ae7f46f3a0561140fabe4eed4cc426923258e17ed4cc10cc8155f9129
+  data.tar.gz: 65eb5cfc6fb0feadae0d4503bcf2bd1942a0a9740a6f4f1b6f6aaddf7ee244c0
 SHA512:
-  metadata.gz: b9027b585d39714f8977ccdc397d04f8caf4f036f6be86ff091f0b1268379ef0c7410247d4186b6a164ceece002ade98bdea6efb3473747e14b1b11bf90649a5
-  data.tar.gz: 40d261fc0e31e07b05aa619099588a3341f74cd3ec0cf7a3e0ba46efc629a94069076e190987484b3450212c310f6230abd5e8186679bfbe16dedc50509efc03
+  metadata.gz: cecf4d1450deb04f33772ebc0bf18892816dda84e9e2b43668615dc37c49b3319465c3d0f3cb9c07ca9cc5a5e7a7118daab1f1aa51c25bf83ebadc925bd52eef
+  data.tar.gz: c678e3b5420f82894c1d4935f4f89959fda4ea6e66faffa7fb649c0ff3c0e2fec91daf3e77208e02eb4747cf1a3d41ef5764a4b4da8b76b2a03328861121c7c2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History
 
+### 1.41.0 (2023-01-05)
+
+#### Features
+
+* Add support for partial projection of table metadata 
+#### Bug Fixes
+
+* Fix querying of array of structs in named parameters ([#19466](https://github.com/googleapis/google-cloud-ruby/issues/19466)) 
+
 ### 1.40.0 (2022-12-14)
 
 #### Features

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

@@ -254,11 +254,11 @@ module Google
 
         ##
         # Lists are specified by providing the type code in an array. For example, an array of integers are specified as
-        # `[:INT64]`. Extracts the symbol.
+        # `[:INT64]`. Extracts the symbol/hash.
         def self.extract_array_type type
           return nil if type.nil?
-          unless type.is_a?(Array) && type.count == 1 && type.first.is_a?(Symbol)
-            raise ArgumentError, "types Array #{type.inspect} should include only a single symbol element."
+          unless type.is_a?(Array) && type.count == 1 && (type.first.is_a?(Symbol) || type.first.is_a?(Hash))
+            raise ArgumentError, "types Array #{type.inspect} should include only a single symbol or hash element."
           end
           type.first
         end

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

@@ -64,23 +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
 
         ##

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

@@ -793,6 +793,11 @@ module Google
         #   object without verifying that the resource exists on the BigQuery
         #   service. Calls made on this object will raise errors if the resource
         #   does not exist. Default is `false`. Optional.
+        # @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 [Google::Cloud::Bigquery::Table, nil] Returns `nil` if the
         #   table does not exist.
@@ -815,13 +820,22 @@ module Google
         #
         #   table = dataset.table "my_table", skip_lookup: true
         #
+        # @example Avoid retrieving transient stats of the table with `view`:
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #
+        #   dataset = bigquery.dataset "my_dataset"
+        #
+        #   table = dataset.table "my_table", view: "basic"
+        #
         # @!group Table
         #
-        def table table_id, skip_lookup: nil
+        def table table_id, skip_lookup: nil, view: nil
           ensure_service!
           return Table.new_reference project_id, dataset_id, table_id, service if skip_lookup
-          gapi = service.get_table dataset_id, table_id
-          Table.from_gapi gapi, service
+          gapi = service.get_table dataset_id, table_id, metadata_view: view
+          Table.from_gapi gapi, service, metadata_view: view
         rescue Google::Cloud::NotFoundError
           nil
         end
@@ -2658,6 +2672,11 @@ module Google
         #   messages before the batch is published. Default is 10.
         # @attr_reader [Numeric] threads The number of threads used to insert
         #   batches of rows. Default is 4.
+        # @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.
         # @yield [response] the callback for when a batch of rows is inserted
         # @yieldparam [Table::AsyncInserter::Result] result the result of the
         #   asynchronous insert
@@ -2686,13 +2705,35 @@ module Google
         #
         #   inserter.stop.wait!
         #
+        # @example Avoid retrieving transient stats of the table with while inserting :
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   inserter = dataset.insert_async("my_table", view: "basic") do |result|
+        #     if result.error?
+        #       log_error result.error
+        #     else
+        #       log_insert "inserted #{result.insert_count} rows " \
+        #         "with #{result.error_count} errors"
+        #     end
+        #   end
+        #
+        #   rows = [
+        #     { "first_name" => "Alice", "age" => 21 },
+        #     { "first_name" => "Bob", "age" => 22 }
+        #   ]
+        #   inserter.insert rows
+        #
+        #   inserter.stop.wait!
+        #
         def insert_async table_id, skip_invalid: nil, ignore_unknown: nil, max_bytes: 10_000_000, max_rows: 500,
-                         interval: 10, threads: 4, &block
+                         interval: 10, threads: 4, view: nil, &block
           ensure_service!
 
           # Get table, don't use Dataset#table which handles NotFoundError
-          gapi = service.get_table dataset_id, table_id
-          table = Table.from_gapi gapi, service
+          gapi = service.get_table dataset_id, table_id, metadata_view: view
+          table = Table.from_gapi gapi, service, metadata_view: view
           # Get the AsyncInserter from the table
           table.insert_async skip_invalid: skip_invalid,
                              ignore_unknown: ignore_unknown,
@@ -2944,8 +2985,6 @@ module Google
             @access
           end
 
-          # rubocop:disable Style/MethodDefParentheses
-
           ##
           # @raise [RuntimeError] not implemented
           def delete(*)
@@ -3049,8 +3088,6 @@ module Google
           end
           alias refresh! reload!
 
-          # rubocop:enable Style/MethodDefParentheses
-
           ##
           # @private Make sure any access changes are saved
           def check_for_mutated_access!

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

@@ -65,11 +65,17 @@ module Google
         ##
         # The table or model which is exported.
         #
+        # @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, Model, nil] A table or model instance, or `nil`.
         #
-        def source
+        def source view: nil
           if (table = @gapi.configuration.extract.source_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
           elsif (model = @gapi.configuration.extract.source_model)
             retrieve_model model.project_id, model.dataset_id, model.model_id
           end

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

@@ -710,9 +710,9 @@ module Google
           raise "Must have active connection" unless service
         end
 
-        def retrieve_table project_id, dataset_id, table_id
+        def retrieve_table project_id, dataset_id, table_id, metadata_view: nil
           ensure_service!
-          gapi = service.get_project_table project_id, dataset_id, table_id
+          gapi = service.get_project_table project_id, dataset_id, table_id, metadata_view: metadata_view
           Table.from_gapi gapi, service
         rescue Google::Cloud::NotFoundError
           nil

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

@@ -62,12 +62,18 @@ module Google
         # The table into which the operation loads data. This is the table on
         # which {Table#load_job} was invoked.
         #
+        # @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.load.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
 
         ##

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

@@ -437,14 +437,21 @@ module Google
         ##
         # The table in which the query results are stored.
         #
+        # @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.query.destination_table
           return nil unless table
           retrieve_table table.project_id,
                          table.dataset_id,
-                         table.table_id
+                         table.table_id,
+                         metadata_view: view
         end
 
         ##

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

@@ -144,10 +144,11 @@ module Google
 
         ##
         # Gets the specified table resource by full table reference.
-        def get_project_table project_id, dataset_id, table_id
+        def get_project_table project_id, dataset_id, table_id, metadata_view: nil
+          metadata_view = table_metadata_view_type_for metadata_view
           # The get operation is considered idempotent
           execute backoff: true do
-            service.get_table project_id, dataset_id, table_id
+            service.get_table project_id, dataset_id, table_id, view: metadata_view
           end
         end
 
@@ -156,8 +157,8 @@ module Google
         # This method does not return the data in the table,
         # it only returns the table resource,
         # which describes the structure of this table.
-        def get_table dataset_id, table_id
-          get_project_table @project, dataset_id, table_id
+        def get_table dataset_id, table_id, metadata_view: nil
+          get_project_table @project, dataset_id, table_id, metadata_view: metadata_view
         end
 
         ##
@@ -572,6 +573,14 @@ module Google
           raise Google::Cloud::Error.from_error e
         end
 
+        def table_metadata_view_type_for str
+          return nil if str.nil?
+          { "unspecified" => "TABLE_METADATA_VIEW_UNSPECIFIED",
+            "basic" => "BASIC",
+            "storage" => "STORAGE_STATS",
+            "full" => "FULL" }[str.to_s.downcase]
+        end
+
         class Backoff
           class << self
             attr_accessor :retries

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

@@ -108,6 +108,10 @@ module Google
         # @private A Google API Client Table Reference object.
         attr_reader :reference
 
+        ##
+        # @private The metadata view type string.
+        attr_accessor :metadata_view
+
         ##
         # @private Create an empty Table object.
         def initialize
@@ -2836,7 +2840,7 @@ module Google
         #
         def reload!
           ensure_service!
-          @gapi = service.get_table dataset_id, table_id
+          @gapi = service.get_table dataset_id, table_id, metadata_view: metadata_view
           @reference = nil
           @exists = nil
           self
@@ -2970,10 +2974,11 @@ module Google
 
         ##
         # @private New Table from a Google API Client object.
-        def self.from_gapi gapi, service
+        def self.from_gapi gapi, service, metadata_view: nil
           new.tap do |f|
             f.gapi = gapi
             f.service = service
+            f.metadata_view = metadata_view
           end
         end
 
@@ -3982,8 +3987,6 @@ module Google
             schema.record name, description: description, mode: mode, &block
           end
 
-          # rubocop:disable Style/MethodDefParentheses
-
           ##
           # @raise [RuntimeError] not implemented
           def data(*)
@@ -4069,8 +4072,6 @@ module Google
           end
           alias refresh! reload!
 
-          # rubocop:enable Style/MethodDefParentheses
-
           ##
           # @private Make sure any access changes are saved
           def check_for_mutated_schema!

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby