google-cloud-bigquery 1.38.1 → 1.42.0

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
@@ -154,6 +158,45 @@ module Google
           @gapi.table_reference.project_id
         end
 
+        ##
+        # The type of the table like if its a TABLE, VIEW or SNAPSHOT etc.,
+        #
+        # @return [String, nil] Type of the table, or
+        #   `nil` if the object is a reference (see {#reference?}).
+        #
+        # @!group Attributes
+        #
+        def type
+          return nil if reference?
+          @gapi.type
+        end
+
+        ##
+        # The Information about base table and snapshot time of the table.
+        #
+        # @return [Google::Apis::BigqueryV2::SnapshotDefinition, nil] Snapshot definition of table snapshot, or
+        #   `nil` if not snapshot or the object is a reference (see {#reference?}).
+        #
+        # @!group Attributes
+        #
+        def snapshot_definition
+          return nil if reference?
+          @gapi.snapshot_definition
+        end
+
+        ##
+        # The Information about base table and clone time of the table.
+        #
+        # @return [Google::Apis::BigqueryV2::CloneDefinition, nil] Clone definition of table clone, or
+        #   `nil` if not clone or the object is a reference (see {#reference?}).
+        #
+        # @!group Attributes
+        #
+        def clone_definition
+          return nil if reference?
+          @gapi.clone_definition
+        end
+
         ##
         # @private The gapi fragment containing the Project ID, Dataset ID, and
         # Table ID.
@@ -820,6 +863,40 @@ module Google
           @gapi.type == "VIEW"
         end
 
+        ##
+        # Checks if the table's type is `SNAPSHOT`, indicating that the table
+        # represents a BigQuery table snapshot.
+        #
+        # @see https://cloud.google.com/bigquery/docs/table-snapshots-intro
+        #
+        # @return [Boolean, nil] `true` when the type is `SNAPSHOT`, `false`
+        #   otherwise, if the object is a resource (see {#resource?}); `nil` if
+        #   the object is a reference (see {#reference?}).
+        #
+        # @!group Attributes
+        #
+        def snapshot?
+          return nil if reference?
+          @gapi.type == "SNAPSHOT"
+        end
+
+        ##
+        # Checks if the table's type is `CLONE`, indicating that the table
+        # represents a BigQuery table clone.
+        #
+        # @see https://cloud.google.com/bigquery/docs/table-clones-intro
+        #
+        # @return [Boolean, nil] `true` when the type is `CLONE`, `false`
+        #   otherwise, if the object is a resource (see {#resource?}); `nil` if
+        #   the object is a reference (see {#reference?}).
+        #
+        # @!group Attributes
+        #
+        def clone?
+          return nil if reference?
+          !@gapi.clone_definition.nil?
+        end
+
         ##
         # Checks if the table's type is `MATERIALIZED_VIEW`, indicating that
         # the table represents a BigQuery materialized view.
@@ -1697,9 +1774,16 @@ module Google
         #
         # @!group Data
         #
-        def copy_job destination_table, create: nil, write: nil, job_id: nil, prefix: nil, labels: nil, dryrun: nil
+        def copy_job destination_table, create: nil, write: nil, job_id: nil, prefix: nil, labels: nil, dryrun: nil,
+                     operation_type: nil
           ensure_service!
-          options = { create: create, write: write, dryrun: dryrun, labels: labels, job_id: job_id, prefix: prefix }
+          options = { create: create,
+                      write: write,
+                      dryrun: dryrun,
+                      labels: labels,
+                      job_id: job_id,
+                      prefix: prefix,
+                      operation_type: operation_type }
           updater = CopyJob::Updater.from_options(
             service,
             table_ref,
@@ -1780,10 +1864,195 @@ module Google
         # @!group Data
         #
         def copy destination_table, create: nil, write: nil, &block
-          job = copy_job destination_table, create: create, write: write, &block
-          job.wait_until_done!
-          ensure_job_succeeded! job
-          true
+          copy_job_with_operation_type destination_table,
+                                       create: create,
+                                       write: write,
+                                       operation_type: OperationType::COPY,
+                                       &block
+        end
+
+        ##
+        # Clones the data from the table to another table using a synchronous
+        # method that blocks for a response.
+        # The source and destination table have the same table type, but only bill for
+        # unique data.
+        # Timeouts and transient errors are generally handled as needed to complete the job.
+        # See also {#copy_job}.
+        #
+        # The geographic location for the job ("US", "EU", etc.) can be set via
+        # {CopyJob::Updater#location=} in a block passed to this method. If the
+        # table is a full resource representation (see {#resource_full?}), the
+        # location of the job will be automatically set to the location of the
+        # table.
+        #
+        # @param [Table, String] destination_table The destination for the
+        #   copied data. This can also be a string identifier as specified by
+        #   the [Standard SQL Query
+        #   Reference](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#from-clause)
+        #   (`project-name.dataset_id.table_id`) or the [Legacy SQL Query
+        #   Reference](https://cloud.google.com/bigquery/query-reference#from)
+        #   (`project-name:dataset_id.table_id`). This is useful for referencing
+        #   tables in other projects and datasets.
+        #
+        # @yield [job] a job configuration object
+        # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
+        #   configuration object for setting additional options.
+        #
+        # @return [Boolean] Returns `true` if the copy operation succeeded.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #   destination_table = dataset.table "my_destination_table"
+        #
+        #   table.clone destination_table
+        #
+        # @example Passing a string identifier for the destination table:
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   table.clone "other-project:other_dataset.other_table"
+        #
+        # @!group Data
+        #
+        def clone destination_table, &block
+          copy_job_with_operation_type destination_table,
+                                       operation_type: OperationType::CLONE,
+                                       &block
+        end
+
+        ##
+        # Takes snapshot of the data from the table to another table using a synchronous
+        # method that blocks for a response.
+        # The source table type is TABLE and the destination table type is SNAPSHOT.
+        # Timeouts and transient errors are generally handled as needed to complete the job.
+        # See also {#copy_job}.
+        #
+        # The geographic location for the job ("US", "EU", etc.) can be set via
+        # {CopyJob::Updater#location=} in a block passed to this method. If the
+        # table is a full resource representation (see {#resource_full?}), the
+        # location of the job will be automatically set to the location of the
+        # table.
+        #
+        # @param [Table, String] destination_table The destination for the
+        #   copied data. This can also be a string identifier as specified by
+        #   the [Standard SQL Query
+        #   Reference](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#from-clause)
+        #   (`project-name.dataset_id.table_id`) or the [Legacy SQL Query
+        #   Reference](https://cloud.google.com/bigquery/query-reference#from)
+        #   (`project-name:dataset_id.table_id`). This is useful for referencing
+        #   tables in other projects and datasets.
+        #
+        # @yield [job] a job configuration object
+        # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
+        #   configuration object for setting additional options.
+        #
+        # @return [Boolean] Returns `true` if the copy operation succeeded.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #   destination_table = dataset.table "my_destination_table"
+        #
+        #   table.snapshot destination_table
+        #
+        # @example Passing a string identifier for the destination table:
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   table.snapshot "other-project:other_dataset.other_table"
+        #
+        # @!group Data
+        #
+        def snapshot destination_table, &block
+          copy_job_with_operation_type destination_table,
+                                       operation_type: OperationType::SNAPSHOT,
+                                       &block
+        end
+
+        ##
+        # Restore the data from the table to another table using a synchronous
+        # method that blocks for a response.
+        # The source table type is SNAPSHOT and the destination table type is TABLE.
+        # Timeouts and transient errors are generally handled as needed to complete the job.
+        # See also {#copy_job}.
+        #
+        # The geographic location for the job ("US", "EU", etc.) can be set via
+        # {CopyJob::Updater#location=} in a block passed to this method. If the
+        # table is a full resource representation (see {#resource_full?}), the
+        # location of the job will be automatically set to the location of the
+        # table.
+        #
+        # @param [Table, String] destination_table The destination for the
+        #   copied data. This can also be a string identifier as specified by
+        #   the [Standard SQL Query
+        #   Reference](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#from-clause)
+        #   (`project-name.dataset_id.table_id`) or the [Legacy SQL Query
+        #   Reference](https://cloud.google.com/bigquery/query-reference#from)
+        #   (`project-name:dataset_id.table_id`). This is useful for referencing
+        #   tables in other projects and datasets.
+        # @param [String] create Specifies whether the job is allowed to create
+        #   new tables. The default value is `needed`.
+        #
+        #   The following values are supported:
+        #
+        #   * `needed` - Create the table if it does not exist.
+        #   * `never` - The table must already exist. A 'notFound' error is
+        #     raised if the table does not exist.
+        # @param [String] write Specifies how to handle data already present in
+        #   the destination table. The default value is `empty`.
+        #
+        #   The following values are supported:
+        #
+        #   * `truncate` - BigQuery overwrites the table data.
+        #   * `append` - BigQuery appends the data to the table.
+        #   * `empty` - An error will be returned if the destination table
+        #     already contains data.
+        # @yield [job] a job configuration object
+        # @yieldparam [Google::Cloud::Bigquery::CopyJob::Updater] job a job
+        #   configuration object for setting additional options.
+        #
+        # @return [Boolean] Returns `true` if the copy operation succeeded.
+        #
+        # @example
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #   destination_table = dataset.table "my_destination_table"
+        #
+        #   table.restore destination_table
+        #
+        # @example Passing a string identifier for the destination table:
+        #   require "google/cloud/bigquery"
+        #
+        #   bigquery = Google::Cloud::Bigquery.new
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.table "my_table"
+        #
+        #   table.restore "other-project:other_dataset.other_table"
+        #
+        # @!group Data
+        #
+        def restore destination_table, create: nil, write: nil, &block
+          copy_job_with_operation_type destination_table,
+                                       create: create,
+                                       write: write,
+                                       operation_type: OperationType::RESTORE,
+                                       &block
         end
 
         ##
@@ -1812,7 +2081,7 @@ module Google
         #   The following values are supported:
         #
         #   * `csv` - CSV
-        #   * `json` - [Newline-delimited JSON](http://jsonlines.org/)
+        #   * `json` - [Newline-delimited JSON](https://jsonlines.org/)
         #   * `avro` - [Avro](http://avro.apache.org/)
         # @param [String] compression The compression type to use for exported
         #   files. Possible values include `GZIP` and `NONE`. The default value
@@ -1915,7 +2184,7 @@ module Google
         #   The following values are supported:
         #
         #   * `csv` - CSV
-        #   * `json` - [Newline-delimited JSON](http://jsonlines.org/)
+        #   * `json` - [Newline-delimited JSON](https://jsonlines.org/)
         #   * `avro` - [Avro](http://avro.apache.org/)
         # @param [String] compression The compression type to use for exported
         #   files. Possible values include `GZIP` and `NONE`. The default value
@@ -1986,7 +2255,7 @@ module Google
         #   The following values are supported:
         #
         #   * `csv` - CSV
-        #   * `json` - [Newline-delimited JSON](http://jsonlines.org/)
+        #   * `json` - [Newline-delimited JSON](https://jsonlines.org/)
         #   * `avro` - [Avro](http://avro.apache.org/)
         #   * `orc` - [ORC](https://cloud.google.com/bigquery/docs/loading-data-cloud-storage-orc)
         #   * `parquet` - [Parquet](https://parquet.apache.org/)
@@ -2199,7 +2468,7 @@ module Google
         #   The following values are supported:
         #
         #   * `csv` - CSV
-        #   * `json` - [Newline-delimited JSON](http://jsonlines.org/)
+        #   * `json` - [Newline-delimited JSON](https://jsonlines.org/)
         #   * `avro` - [Avro](http://avro.apache.org/)
         #   * `orc` - [ORC](https://cloud.google.com/bigquery/docs/loading-data-cloud-storage-orc)
         #   * `parquet` - [Parquet](https://parquet.apache.org/)
@@ -2571,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
@@ -2705,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
 
@@ -2739,6 +3009,17 @@ module Google
 
         protected
 
+        def copy_job_with_operation_type destination_table, create: nil, write: nil, operation_type: nil, &block
+          job = copy_job destination_table,
+                         create: create,
+                         write: write,
+                         operation_type: operation_type,
+                         &block
+          job.wait_until_done!
+          ensure_job_succeeded! job
+          true
+        end
+
         ##
         # Raise an error unless an active service is available.
         def ensure_service!
@@ -2766,7 +3047,7 @@ module Google
         def patch_gapi! *attributes
           return if attributes.empty?
           ensure_service!
-          patch_args = Hash[attributes.map { |attr| [attr, @gapi.send(attr)] }]
+          patch_args = attributes.to_h { |attr| [attr, @gapi.send(attr)] }
           patch_gapi = Google::Apis::BigqueryV2::Table.new(**patch_args)
           patch_gapi.etag = etag if etag
           @gapi = service.patch_table dataset_id, table_id, patch_gapi
@@ -3706,8 +3987,6 @@ module Google
             schema.record name, description: description, mode: mode, &block
           end
 
-          # rubocop:disable Style/MethodDefParentheses
-
           ##
           # @raise [RuntimeError] not implemented
           def data(*)
@@ -3793,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.38.1".freeze
+      VERSION = "1.42.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.38.1
+  version: 1.42.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -121,28 +121,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +268,7 @@ files:
 - lib/google/cloud/bigquery/dataset.rb
 - lib/google/cloud/bigquery/dataset/access.rb
 - lib/google/cloud/bigquery/dataset/list.rb
+- lib/google/cloud/bigquery/dataset/tag.rb
 - lib/google/cloud/bigquery/encryption_configuration.rb
 - lib/google/cloud/bigquery/external.rb
 - lib/google/cloud/bigquery/external/avro_source.rb
@@ -313,14 +314,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Google BigQuery