google-cloud-spanner 2.8.1 → 2.11.0

data/lib/google/cloud/spanner/client.rb

@@ -236,6 +236,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -403,6 +407,21 @@ module Google
         #     puts "User #{row[:id]} is #{row[:name]}"
         #   end
         #
+        # @example Query using tag for request query statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Read-Users" }
+        #   results = db.execute_query "SELECT * FROM users",
+        #                              request_options: request_options
+        #
+        #   results.rows.each do |row|
+        #     puts "User #{row[:id]} is #{row[:name]}"
+        #   end
+        #
         def execute_query sql, params: nil, types: nil, single_use: nil,
                           query_options: nil, request_options: nil,
                           call_options: nil
@@ -410,7 +429,8 @@ module Google
           ensure_service!
 
           params, types = Convert.to_input_params_and_types params, types
-
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
           single_use_tx = single_use_transaction single_use
           results = nil
           @pool.with_session do |session|
@@ -580,6 +600,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -657,12 +681,27 @@ module Google
         #    "UPDATE users SET friends = NULL WHERE active = @active",
         #    params: { active: false }, request_options: request_options
         #
+        # @example Query using tag for request query statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Update-Users" }
+        #   row_count = db.execute_partition_update \
+        #     "UPDATE users SET friends = NULL WHERE active = false",
+        #     request_options: request_options
+        #
         def execute_partition_update sql, params: nil, types: nil,
                                      query_options: nil, request_options: nil,
                                      call_options: nil
           ensure_service!
 
           params, types = Convert.to_input_params_and_types params, types
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
+
           results = nil
           @pool.with_session do |session|
             results = session.execute_query \
@@ -761,6 +800,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -840,6 +883,22 @@ module Google
         #     puts "User #{row[:id]} is #{row[:name]}"
         #   end
         #
+        # @example Read using tag for read statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Read-Users-All" }
+        #   results = db.read "users", [:id, :name],
+        #                     request_options: request_options
+        #
+        #   results.rows.each do |row|
+        #     puts "User #{row[:id]} is #{row[:name]}"
+        #   end
+        #
         def read table, columns, keys: nil, index: nil, limit: nil,
                  single_use: nil, request_options: nil, call_options: nil
           validate_single_use_args! single_use
@@ -847,8 +906,10 @@ module Google
 
           columns = Array(columns).map(&:to_s)
           keys = Convert.to_key_set keys
-
           single_use_tx = single_use_transaction single_use
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
+
           results = nil
           @pool.with_session do |session|
             results = session.read \
@@ -914,6 +975,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the format:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -954,7 +1018,23 @@ module Google
         #   db.upsert "users", [{ id: 1, name: "Charlie", active: false }],
         #                      request_options: request_options
         #
+        # @example Upsert using tag for transaction statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Bulk-Upsert" }
+        #   db.upsert "users", [{ id: 1, name: "Charlie", active: false },
+        #                       { id: 2, name: "Harvey",  active: true }],
+        #                       request_options: request_options
+        #
         def upsert table, rows, commit_options: nil, request_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.upsert table, rows, commit_options: commit_options,
                            request_options: request_options
@@ -999,7 +1079,6 @@ module Google
         #
         #   See [Data
         #   types](https://cloud.google.com/spanner/docs/data-definition-language#data_types).
-        #
         # @param [Hash] commit_options A hash of commit options.
         #   e.g., return_commit_stats. Commit options are optional.
         #   The following options can be provided:
@@ -1015,6 +1094,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1055,7 +1137,23 @@ module Google
         #   db.insert "users", [{ id: 1, name: "Charlie", active: false }],
         #                      request_options: request_options
         #
+        # @example Insert using tag for transaction statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkInsert-Users" }
+        #   db.insert "users", [{ id: 1, name: "Charlie", active: false },
+        #                       { id: 2, name: "Harvey",  active: true }],
+        #                       request_options: request_options
+        #
         def insert table, rows, commit_options: nil, request_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.insert table, rows, commit_options: commit_options,
                            request_options: request_options
@@ -1099,7 +1197,6 @@ module Google
         #
         #   See [Data
         #   types](https://cloud.google.com/spanner/docs/data-definition-language#data_types).
-        #
         # @param [Hash] commit_options A hash of commit options.
         #   e.g., return_commit_stats. Commit options are optional.
         #   The following options can be provided:
@@ -1115,6 +1212,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1155,7 +1255,22 @@ module Google
         #   db.update "users", [{ id: 1, name: "Charlie", active: false }],
         #                      request_options: request_options
         #
+        # @example Updte using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkUpdate-Users" }
+        #   db.update "users", [{ id: 1, name: "Charlie", active: false },
+        #                       { id: 2, name: "Harvey",  active: true }],
+        #                      request_options: request_options
+        #
         def update table, rows, commit_options: nil, request_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.update table, rows, commit_options: commit_options,
                            request_options: request_options
@@ -1201,7 +1316,6 @@ module Google
         #
         #   See [Data
         #   types](https://cloud.google.com/spanner/docs/data-definition-language#data_types).
-        #
         # @param [Hash] commit_options A hash of commit options.
         #   e.g., return_commit_stats. Commit options are optional.
         #   The following options can be provided:
@@ -1217,6 +1331,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1257,6 +1374,18 @@ module Google
         #   db.replace "users", [{ id: 1, name: "Charlie", active: false }],
         #                       request_options: request_options
         #
+        # @example Replace using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkReplace-Users" }
+        #   db.replace "users", [{ id: 1, name: "Charlie", active: false },
+        #                        { id: 2, name: "Harvey",  active: true }],
+        #                       request_options: request_options
+        #
         def replace table, rows, commit_options: nil, request_options: nil
           @pool.with_session do |session|
             session.replace table, rows, commit_options: commit_options,
@@ -1299,6 +1428,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -1348,8 +1480,21 @@ module Google
         #   request_options = { priority: :PRIORITY_MEDIUM }
         #   db.delete "users", [1, 2, 3], request_options: request_options
         #
+        # @example Delete using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkDelete-Users" }
+        #   db.delete "users", [1, 2, 3], request_options: request_options
+        #
         def delete table, keys = [], commit_options: nil, request_options: nil,
                    call_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.delete table, keys, commit_options: commit_options,
                            request_options: request_options,
@@ -1387,6 +1532,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -1447,10 +1595,26 @@ module Google
         #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
         #   end
         #
+        # @example Commit using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkManipulate-Users" }
+        #   db.commit request_options: request_options do |c|
+        #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
+        #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+        #   end
+        #
         def commit commit_options: nil, request_options: nil,
                    call_options: nil, &block
           raise ArgumentError, "Must provide a block" unless block_given?
 
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.commit(
               commit_options: commit_options, request_options: request_options,
@@ -1494,6 +1658,11 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String)A tag used for statistics collection
+        #     about transaction. The value of a transaction tag should be the
+        #     same for all requests belonging to the same transaction. A tag must
+        #     be a valid identifier of the format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`
+        #
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -1585,6 +1754,30 @@ module Google
         #                               request_options: request_options
         #   end
         #
+        # @example Tags for request and transaction statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   # Transaction tag will be set to "Users-Txn"
+        #   db.transaction request_options: { tag: "Users-Txn" } do |tx|
+        #     # The transaction tag set as "Users-Txn"
+        #     # The request tag set as "Users-Txn-1"
+        #     request_options = { tag: "Users-Txn-1" }
+        #     results = tx.execute_query "SELECT * FROM users",
+        #                                request_options: request_options
+        #
+        #     results.rows.each do |row|
+        #       puts "User #{row[:id]} is #{row[:name]}"
+        #     end
+        #
+        #     # The transaction tag set as "Users-Txn"
+        #     tx.update "users", [{ id: 1, name: "Charlie", active: false }]
+        #     tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+        #   end
+        #
         def transaction deadline: 120, commit_options: nil,
                         request_options: nil, call_options: nil
           ensure_service!
@@ -1596,39 +1789,48 @@ module Google
           backoff = 1.0
           start_time = current_time
 
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_transaction do |tx|
-            Thread.current[:transaction_id] = tx.transaction_id
-            yield tx
-            commit_resp = @project.service.commit \
-              tx.session.path, tx.mutations,
-              transaction_id: tx.transaction_id,
-              commit_options: commit_options,
-              request_options: request_options,
-              call_options: call_options
-            resp = CommitResponse.from_grpc commit_resp
-            commit_options ? resp : resp.timestamp
-          rescue GRPC::Aborted, Google::Cloud::AbortedError => e
-            # Re-raise if deadline has passed
-            if current_time - start_time > deadline
-              if e.is_a? GRPC::BadStatus
-                e = Google::Cloud::Error.from_error e
+            if request_options
+              tx.transaction_tag = request_options[:transaction_tag]
+            end
+
+            begin
+              Thread.current[:transaction_id] = tx.transaction_id
+              yield tx
+              commit_resp = @project.service.commit \
+                tx.session.path, tx.mutations,
+                transaction_id: tx.transaction_id,
+                commit_options: commit_options,
+                request_options: request_options,
+                call_options: call_options
+              resp = CommitResponse.from_grpc commit_resp
+              commit_options ? resp : resp.timestamp
+            rescue GRPC::Aborted, Google::Cloud::AbortedError => e
+              # Re-raise if deadline has passed
+              if current_time - start_time > deadline
+                if e.is_a? GRPC::BadStatus
+                  e = Google::Cloud::Error.from_error e
+                end
+                raise e
               end
+              # Sleep the amount from RetryDelay, or incremental backoff
+              sleep(delay_from_aborted(e) || backoff *= 1.3)
+              # Create new transaction on the session and retry the block
+              tx = tx.session.create_transaction
+              retry
+            rescue StandardError => e
+              # Rollback transaction when handling unexpected error
+              tx.session.rollback tx.transaction_id
+              # Return nil if raised with rollback.
+              return nil if e.is_a? Rollback
+              # Re-raise error.
               raise e
+            ensure
+              Thread.current[:transaction_id] = nil
             end
-            # Sleep the amount from RetryDelay, or incremental backoff
-            sleep(delay_from_aborted(e) || backoff *= 1.3)
-            # Create new transaction on the session and retry the block
-            tx = tx.session.create_transaction
-            retry
-          rescue StandardError => e
-            # Rollback transaction when handling unexpected error
-            tx.session.rollback tx.transaction_id
-            # Return nil if raised with rollback.
-            return nil if e.is_a? Rollback
-            # Re-raise error.
-            raise e
-          ensure
-            Thread.current[:transaction_id] = nil
           end
         end
 

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

@@ -99,8 +99,7 @@ module Google
               if field.is_a? Fields
                 field.struct(obj).to_grpc_value
               else
-                raise ArgumentError,
-                      "A hash value cannot be set to type #{field}."
+                Google::Protobuf::Value.new string_value: obj.to_json
               end
             else
               if obj.respond_to?(:read) && obj.respond_to?(:rewind)
@@ -223,6 +222,8 @@ module Google
               Data.from_grpc value.list_value.values, type.struct_type.fields
             when :NUMERIC
               BigDecimal value.string_value
+            when :JSON
+              JSON.parse value.string_value
             end
           end
 
@@ -324,6 +325,25 @@ module Google
 
             [input_params, input_param_types]
           end
+
+          ##
+          # Build request options by replacing tag to respecitve statistics
+          # collection tag type.
+          #
+          # @param [Hash] options Common request options.
+          #   * `:tag` (String) A tag used for statistics collection.
+          #
+          # @param [Symbol] tag_type Request tag type.
+          #   Possible values are `request_tag`, `transaction_tag`
+          # @return [Hash, nil]
+          #
+          def to_request_options options, tag_type: nil
+            return unless options
+
+            return options unless options.key? :tag
+
+            options.transform_keys { |k| k == :tag ? tag_type : k }
+          end
         end
 
         # rubocop:enable all

data/lib/google/cloud/spanner/database/backup_info.rb

@@ -12,11 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 module Google
   module Cloud
     module Spanner
       class Database
+        # @deprecated Use
+        # {Google::Cloud::Spanner::Admin::Database::V1::BackupInfo} instead.
         class BackupInfo
           ##
           # @private Creates a new Database::BackupInfo instance.

data/lib/google/cloud/spanner/database/job/list.rb

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 require "delegate"
 
@@ -26,6 +29,10 @@ module Google
           # List is a special case Array with additional values for database
           # operations.
           #
+          # @deprecated Use the result of
+          # {Google::Cloud::Spanner::Admin::Database#database_admin Client#list_database_operations}
+          # instead.
+          #
           class List < DelegateClass(::Array)
             # @private
             # The gRPC Service object.

data/lib/google/cloud/spanner/database/job.rb

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 require "google/cloud/spanner/status"
 require "google/cloud/spanner/database/job/list"
@@ -32,6 +35,10 @@ module Google
         # @see https://cloud.google.com/spanner/reference/rpc/google.longrunning#google.longrunning.Operation
         #   Long-running Operation
         #
+        # @deprecated Use the long-running operation returned by
+        # {Google::Cloud::Spanner::Admin::Database#database_admin Client#create_database}
+        # instead.
+        #
         # @example
         #   require "google/cloud/spanner"
         #

data/lib/google/cloud/spanner/database/list.rb

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 require "delegate"
 
@@ -22,6 +25,10 @@ module Google
         ##
         # Database::List is a special case Array with additional
         # values.
+        #
+        # @deprecated Use the result of
+        # {Google::Cloud::Spanner::Admin::Database#database_admin Client#list_databases}
+        # instead.
         class List < DelegateClass(::Array)
           ##
           # If not empty, indicates that there are more records that match

data/lib/google/cloud/spanner/database/restore_info.rb

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 require "google/cloud/spanner/database/backup_info"
 
@@ -19,6 +22,8 @@ module Google
   module Cloud
     module Spanner
       class Database
+        # @deprecated Use
+        # {Google::Cloud::Spanner::Admin::Database::V1::RestoreInfo} instead.
         class RestoreInfo
           ##
           # @private Creates a new Database::RestoreInfo instance.

data/lib/google/cloud/spanner/database.rb

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 require "google/cloud/spanner/database/job"
 require "google/cloud/spanner/database/list"
@@ -25,6 +28,13 @@ module Google
       ##
       # # Database
       #
+      # NOTE: From `google-cloud-spanner/v2.11.0` onwards, new features for
+      # mananging databases will only be available through the
+      # [google-cloud-spanner-admin-database-v1](https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-spanner-admin-database-v1)
+      # client. See the
+      # [README](https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-spanner#google-cloud-spanner)
+      # for further details.
+      #
       # Represents a Cloud Spanner database. To use Cloud Spanner's read and
       # write operations, you must first create a database. A database belongs
       # to a {Instance} and contains tables and indexes. You may create multiple
@@ -38,6 +48,9 @@ module Google
       # of {Google::Cloud::Spanner::Client}. See
       # {Google::Cloud::Spanner::Project#client}.
       #
+      # @deprecated Use
+      # {Google::Cloud::Spanner::Admin::Database#database_admin} instead.
+      #
       # @example
       #   require "google/cloud"
       #

data/lib/google/cloud/spanner/instance/config/list.rb

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# DO NOT EDIT: Unless you're fixing a P0/P1 and/or a security issue. This class
+# is frozen to all new features from `google-cloud-spanner/v2.11.0` onwards.
+
 
 require "delegate"
 
@@ -23,6 +26,10 @@ module Google
           ##
           # Instance::Config::List is a special case Array with additional
           # values.
+          #
+          # @deprecated Use the result of
+          # {Google::Cloud::Spanner::Admin::Instance#instance_admin Client#list_instance_configs}
+          # instead.
           class List < DelegateClass(::Array)
             ##
             # If not empty, indicates that there are more records that match