google-cloud-bigquery 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 316b03a95fd406a6382fb89e031e8cfe3388d7b244e53d0f3cc6749037437387
-  data.tar.gz: 00f3a68186e380fe588c7effb03e2f4ff9d4ca830d96f136df83d6df014abdc4
+  metadata.gz: 413b609d23c55aea401129708c06ef5d61a1f9df5227331b2a903eb0c7ec8443
+  data.tar.gz: a7bdf477a21c41e62cbe55f9ff105313b2ae2efee5c7e8798a66becbfd5a7e36
 SHA512:
-  metadata.gz: 7015cbe609aabf7f2bd57ee97f292c430733de8349b8349f97205de4a4192a3fc9b39d0163c626f393d1256a3354786b72e7f9f1dd94e2b262432c33c8287ad5
-  data.tar.gz: 843994c37a342681c9e53f3bde97dabcec668b313c73b3caf054ccf7ed6f422c8c48a6f2d947d097a6dfaf9803d96f110969096e22f47737b1a6fef8b8b494b2
+  metadata.gz: 52fe14d19dd4c3694776c63535faf63939eeb38a5416da85bf2a3355702354d7c1e9be18c88d951423cd57e319e454a65fec3a6cd81cca0e846e649a8c06a3e6
+  data.tar.gz: cc147d654b6339846b1e00c365c39e6010d1c8ff0fbe39d0dafb3dbc4c9aa4b2442c979fadc69e4ac68b67d56f8b53f85033412d1094f089598c7e4d8b79c2e7

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+### 1.31.0 / 2021-04-28
+
+#### Features
+
+* Add support for mutable clustering configuration
+  * Add Table#clustering_fields=
+
 ### 1.30.0 / 2021-04-20
 
 #### Features

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

@@ -484,7 +484,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
@@ -560,10 +560,15 @@ module Google
         ###
         # Checks if the destination table will be clustered.
         #
+        # See {LoadJob::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
@@ -578,14 +583,16 @@ module Google
         # be first partitioned and subsequently clustered. The order of the
         # returned fields determines the sort order of the data.
         #
-        # See {LoadJob::Updater#clustering_fields=}.
+        # BigQuery supports clustering for both partitioned and non-partitioned
+        # tables.
+        #
+        # See {LoadJob::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.
@@ -1819,23 +1826,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 {LoadJob#clustering_fields}.
+          # BigQuery supports clustering for both partitioned and non-partitioned
+          # tables.
+          #
+          # See {LoadJob#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.

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.
@@ -1445,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.

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

@@ -471,8 +471,13 @@ module Google
         ###
         # Checks if the table is clustered.
         #
+        # See {Table::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 is clustered, or
         #   `false` otherwise, if the object is a resource (see {#resource?});
@@ -491,14 +496,16 @@ module Google
         # first partitioned and subsequently clustered. The order of the
         # returned fields determines the sort order of the data.
         #
-        # See {Table::Updater#clustering_fields=}.
+        # BigQuery supports clustering for both partitioned and non-partitioned
+        # tables.
+        #
+        # See {Table::Updater#clustering_fields=}, {Table#clustering_fields=} and
+        # {Table#clustering?}.
         #
-        # @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
         #   table is not clustered or if the table is a reference (see
@@ -512,6 +519,53 @@ module Google
           @gapi.clustering.fields if clustering?
         end
 
+        ##
+        # Updates 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.
+        #
+        # BigQuery supports clustering for both partitioned and non-partitioned
+        # tables.
+        #
+        # See {Table::Updater#clustering_fields=}, {Table#clustering_fields} and
+        # {Table#clustering?}.
+        #
+        # @see https://cloud.google.com/bigquery/docs/clustered-tables
+        #   Introduction to clustered tables
+        # @see https://cloud.google.com/bigquery/docs/creating-clustered-tables
+        #   Creating and using clustered tables
+        # @see https://cloud.google.com/bigquery/docs/creating-clustered-tables#modifying-cluster-spec
+        #   Modifying clustering specification
+        #
+        # @param [Array<String>, nil] fields The clustering fields, or `nil` to
+        #   remove the clustering configuration. Only top-level, non-repeated,
+        #   simple-type fields are supported.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   table.clustering_fields = ["last_name", "first_name"]
+        #
+        # @!group Attributes
+        #
+        def clustering_fields= fields
+          reload! unless resource_full?
+          if fields
+            @gapi.clustering ||= Google::Apis::BigqueryV2::Clustering.new
+            @gapi.clustering.fields = fields
+          else
+            @gapi.clustering = nil
+          end
+          patch_gapi! :clustering
+        end
+
         ##
         # The combined Project ID, Dataset ID, and Table ID for this table, in
         # the format specified by the [Legacy SQL Query
@@ -3062,27 +3116,22 @@ module Google
           end
 
           ##
-          # Sets one or more fields on which data 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.
           #
-          # You can only set the clustering fields while creating a table as in
-          # the example below. BigQuery does not allow you to change clustering
-          # on an existing table.
+          # BigQuery supports clustering for both partitioned and non-partitioned
+          # tables.
           #
-          # See {Table#clustering_fields}.
+          # See {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.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigquery
-      VERSION = "1.30.0".freeze
+      VERSION = "1.31.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.30.0
+  version: 1.31.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -291,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: API Client library for Google BigQuery