google-cloud-spanner 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e910df98ae5fce8c055a045ec853ff60dfa2d8d2de3d625cad423a17a48fbf
-  data.tar.gz: 8eb916b7a90df206630629a9b9be3e4f83a3f3dbc10df56e346647bd5008578a
+  metadata.gz: 31f7875bf6e782a6e02f78fc4c56059b6a7a33aad2aea8e5bb8ddb93932749e6
+  data.tar.gz: 2d0babe313899246327cdc92fe537a94e5b2a8d58d2e300913bc79bfac4ced84
 SHA512:
-  metadata.gz: 8d58bf9e158e9aabe3a05366e3a68be9d07d3f864a7a799f80127f2e72b78340db6fd984fe48eb2e64cb593825b70eef2da5753fae819b3108f42052e24eb315
-  data.tar.gz: 1e1e8d72cdb03be22f10a5ff47c4a268927033986e9b1f6cae41872c8a5482c8d3eb61f6bac8ecb034903beab0f725d5cd38951b23593b9c9fc9d6dbe993c528
+  metadata.gz: 73fd57fd66a11124e0e987f9dedde6bc1435a5ada931fab6eec310ecc219c977c977eef845eeb134f184dd41903a8f60a630573ba455f597ddbbcd768c00a593
+  data.tar.gz: 39c0e508c9f06534fa6ea0ba9ecf91fff841b6d4709ccdfd2cbcafefa879b47a2c96d9678a96de109098962f4a31b462eea1893f2a00d0025a76f1c6fb2cb1b0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 1.15.0 / 2020-03-15
+
+#### Features
+
+* Added support for query options ([#4907](https://www.github.com/googleapis/google-cloud-ruby/issues/4907))
+  * Added support for specifying the query optimizer version.
+* Support separate project setting for quota/billing
+
 ### 1.14.0 / 2020-02-18
 
 #### Features

data/lib/google-cloud-spanner.rb

@@ -144,6 +144,8 @@ module Google
   end
 end
 
+# rubocop:disable Metrics/BlockLength
+
 # Set the default spanner configuration
 Google::Cloud.configure.add_config! :spanner do |config|
   default_project = Google::Cloud::Config.deferred do
@@ -159,6 +161,14 @@ Google::Cloud.configure.add_config! :spanner do |config|
     ENV["SPANNER_EMULATOR_HOST"]
   end
 
+  default_query_options = Google::Cloud::Config.deferred do
+    query_options = {}
+    optimizer_version = ENV["SPANNER_OPTIMIZER_VERSION"]
+    query_options[:optimizer_version] = optimizer_version if optimizer_version
+    query_options = nil if query_options.empty?
+    query_options
+  end
+
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
   config.add_field! :credentials, default_creds,
@@ -172,4 +182,7 @@ Google::Cloud.configure.add_config! :spanner do |config|
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :lib_name, nil, match: String, allow_nil: true
   config.add_field! :lib_version, nil, match: String, allow_nil: true
+  config.add_field! :query_options, default_query_options, match: Hash, allow_nil: true
 end
+
+# rubocop:enable Metrics/BlockLength

data/lib/google/cloud/spanner.rb

@@ -124,7 +124,8 @@ module Google
             project_id, credentials,
             host: endpoint, timeout: timeout, client_config: client_config,
             lib_name: lib_name, lib_version: lib_version
-          )
+          ),
+          query_options: configure.query_options
         )
       end
 

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

@@ -23,7 +23,7 @@ module Google
         # rubocop:disable LineLength
 
         ##
-        # # Ruby Client for Cloud Spanner Database Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+        # # Ruby Client for Cloud Spanner Database Admin API
         #
         # [Cloud Spanner Database Admin API][Product Documentation]:
         #
@@ -93,7 +93,8 @@ module Google
           #
           # The Cloud Spanner Database Admin API can be used to create, drop, and
           # list databases. It also enables updating the schema of pre-existing
-          # databases.
+          # databases. It can be also used to create, delete and list backups for a
+          # database and to restore from an existing backup.
           #
           # @param version [Symbol, String]
           #   The major version of the service to be used. By default :v1

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

@@ -24,7 +24,7 @@ module Google
           # rubocop:disable LineLength
 
           ##
-          # # Ruby Client for Cloud Spanner Database Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+          # # Ruby Client for Cloud Spanner Database Admin API
           #
           # [Cloud Spanner Database Admin API][Product Documentation]:
           #
@@ -86,7 +86,8 @@ module Google
             #
             # The Cloud Spanner Database Admin API can be used to create, drop, and
             # list databases. It also enables updating the schema of pre-existing
-            # databases.
+            # databases. It can be also used to create, delete and list backups for a
+            # database and to restore from an existing backup.
             #
             # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
             #   Provides the means for authenticating requests made by the client. This parameter can

data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb

@@ -41,7 +41,8 @@ module Google
             #
             # The Cloud Spanner Database Admin API can be used to create, drop, and
             # list databases. It also enables updating the schema of pre-existing
-            # databases.
+            # databases. It can be also used to create, delete and list backups for a
+            # database and to restore from an existing backup.
             #
             # @!attribute [r] database_admin_stub
             #   @return [Google::Spanner::Admin::Database::V1::DatabaseAdmin::Stub]
@@ -64,7 +65,19 @@ module Google
                 "list_databases" => Google::Gax::PageDescriptor.new(
                   "page_token",
                   "next_page_token",
-                  "databases")
+                  "databases"),
+                "list_backups" => Google::Gax::PageDescriptor.new(
+                  "page_token",
+                  "next_page_token",
+                  "backups"),
+                "list_database_operations" => Google::Gax::PageDescriptor.new(
+                  "page_token",
+                  "next_page_token",
+                  "operations"),
+                "list_backup_operations" => Google::Gax::PageDescriptor.new(
+                  "page_token",
+                  "next_page_token",
+                  "operations")
               }.freeze
 
               private_constant :PAGE_DESCRIPTORS
@@ -82,6 +95,12 @@ module Google
                 self::GRPC_INTERCEPTORS = DatabaseAdminClient::GRPC_INTERCEPTORS
               end
 
+              BACKUP_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+                "projects/{project}/instances/{instance}/backups/{backup}"
+              )
+
+              private_constant :BACKUP_PATH_TEMPLATE
+
               DATABASE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
                 "projects/{project}/instances/{instance}/databases/{database}"
               )
@@ -94,6 +113,19 @@ module Google
 
               private_constant :INSTANCE_PATH_TEMPLATE
 
+              # Returns a fully-qualified backup resource name string.
+              # @param project [String]
+              # @param instance [String]
+              # @param backup [String]
+              # @return [String]
+              def self.backup_path project, instance, backup
+                BACKUP_PATH_TEMPLATE.render(
+                  :"project" => project,
+                  :"instance" => instance,
+                  :"backup" => backup
+                )
+              end
+
               # Returns a fully-qualified database resource name string.
               # @param project [String]
               # @param instance [String]
@@ -207,6 +239,9 @@ module Google
                 google_api_client.freeze
 
                 headers = { :"x-goog-api-client" => google_api_client }
+                if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
+                  headers[:"x-goog-user-project"] = credentials.quota_project_id
+                end
                 headers.merge!(metadata) unless metadata.nil?
                 client_config_file = Pathname.new(__dir__).join(
                   "database_admin_client_config.json"
@@ -311,6 +346,70 @@ module Google
                     {'resource' => request.resource}
                   end
                 )
+                @create_backup = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:create_backup),
+                  defaults["create_backup"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'parent' => request.parent}
+                  end
+                )
+                @get_backup = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:get_backup),
+                  defaults["get_backup"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'name' => request.name}
+                  end
+                )
+                @update_backup = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:update_backup),
+                  defaults["update_backup"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'backup.name' => request.backup.name}
+                  end
+                )
+                @delete_backup = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:delete_backup),
+                  defaults["delete_backup"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'name' => request.name}
+                  end
+                )
+                @list_backups = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:list_backups),
+                  defaults["list_backups"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'parent' => request.parent}
+                  end
+                )
+                @restore_database = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:restore_database),
+                  defaults["restore_database"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'parent' => request.parent}
+                  end
+                )
+                @list_database_operations = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:list_database_operations),
+                  defaults["list_database_operations"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'parent' => request.parent}
+                  end
+                )
+                @list_backup_operations = Google::Gax.create_api_call(
+                  @database_admin_stub.method(:list_backup_operations),
+                  defaults["list_backup_operations"],
+                  exception_transformer: exception_transformer,
+                  params_extractor: proc do |request|
+                    {'parent' => request.parent}
+                  end
+                )
               end
 
               # Service calls
@@ -375,8 +474,8 @@ module Google
               # have a name of the format `<database_name>/operations/<operation_id>` and
               # can be used to track preparation of the database. The
               # {Google::Longrunning::Operation#metadata metadata} field type is
-              # {Google::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}.
-              # The {Google::Longrunning::Operation#response response} field type is
+              # {Google::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}. The
+              # {Google::Longrunning::Operation#response response} field type is
               # {Google::Spanner::Admin::Database::V1::Database Database}, if successful.
               #
               # @param parent [String]
@@ -389,7 +488,7 @@ module Google
               #   If the database ID is a reserved word or if it contains a hyphen, the
               #   database ID must be enclosed in backticks (`` ` ``).
               # @param extra_statements [Array<String>]
-              #   An optional list of DDL statements to run inside the newly created
+              #   Optional. A list of DDL statements to run inside the newly created
               #   database. Statements can create tables, indexes, etc. These
               #   statements execute atomically with the creation of the database:
               #   if there is an error in any statement, the database is not created.
@@ -493,8 +592,7 @@ module Google
               # the format `<database_name>/operations/<operation_id>` and can be used to
               # track execution of the schema change(s). The
               # {Google::Longrunning::Operation#metadata metadata} field type is
-              # {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}.
-              # The operation has no response.
+              # {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}.  The operation has no response.
               #
               # @param database [String]
               #   Required. The database to update.
@@ -508,20 +606,18 @@ module Google
               #
               #   Specifying an explicit operation ID simplifies determining
               #   whether the statements were executed in the event that the
-              #   {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl}
-              #   call is replayed, or the return value is otherwise lost: the
-              #   {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
-              #   and `operation_id` fields can be combined to form the
+              #   {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl} call is replayed,
+              #   or the return value is otherwise lost: the {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
+              #   `operation_id` fields can be combined to form the
               #   {Google::Longrunning::Operation#name name} of the resulting
-              #   {Google::Longrunning::Operation longrunning::Operation}:
-              #   `<database>/operations/<operation_id>`.
+              #   {Google::Longrunning::Operation longrunning::Operation}: `<database>/operations/<operation_id>`.
               #
               #   `operation_id` should be unique within the database, and must be
               #   a valid identifier: `[a-z][a-z0-9_]*`. Note that
               #   automatically-generated operation IDs always begin with an
               #   underscore. If the named operation already exists,
-              #   {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl}
-              #   returns `ALREADY_EXISTS`.
+              #   {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl} returns
+              #   `ALREADY_EXISTS`.
               # @param options [Google::Gax::CallOptions]
               #   Overrides the default settings for this call, e.g, timeout,
               #   retries, etc.
@@ -586,6 +682,8 @@ module Google
               end
 
               # Drops (aka deletes) a Cloud Spanner database.
+              # Completed backups for the database will be retained according to their
+              # `expire_time`.
               #
               # @param database [String]
               #   Required. The database to be dropped.
@@ -647,11 +745,13 @@ module Google
                 @get_database_ddl.call(req, options, &block)
               end
 
-              # Sets the access control policy on a database resource.
+              # Sets the access control policy on a database or backup resource.
               # Replaces any existing policy.
               #
               # Authorization requires `spanner.databases.setIamPolicy`
               # permission on {Google::Iam::V1::SetIamPolicyRequest#resource resource}.
+              # For backups, authorization requires `spanner.backups.setIamPolicy`
+              # permission on {Google::Iam::V1::SetIamPolicyRequest#resource resource}.
               #
               # @param resource [String]
               #   REQUIRED: The resource for which the policy is being specified.
@@ -694,12 +794,14 @@ module Google
                 @set_iam_policy.call(req, options, &block)
               end
 
-              # Gets the access control policy for a database resource.
-              # Returns an empty policy if a database exists but does
-              # not have a policy set.
+              # Gets the access control policy for a database or backup resource.
+              # Returns an empty policy if a database or backup exists but does not have a
+              # policy set.
               #
               # Authorization requires `spanner.databases.getIamPolicy` permission on
               # {Google::Iam::V1::GetIamPolicyRequest#resource resource}.
+              # For backups, authorization requires `spanner.backups.getIamPolicy`
+              # permission on {Google::Iam::V1::GetIamPolicyRequest#resource resource}.
               #
               # @param resource [String]
               #   REQUIRED: The resource for which the policy is being requested.
@@ -737,12 +839,16 @@ module Google
                 @get_iam_policy.call(req, options, &block)
               end
 
-              # Returns permissions that the caller has on the specified database resource.
+              # Returns permissions that the caller has on the specified database or backup
+              # resource.
               #
               # Attempting this RPC on a non-existent Cloud Spanner database will
               # result in a NOT_FOUND error if the user has
               # `spanner.databases.list` permission on the containing Cloud
               # Spanner instance. Otherwise returns an empty set of permissions.
+              # Calling this method on a backup that does not exist will
+              # result in a NOT_FOUND error if the user has
+              # `spanner.backups.list` permission on the containing instance.
               #
               # @param resource [String]
               #   REQUIRED: The resource for which the policy detail is being requested.
@@ -782,6 +888,622 @@ module Google
                 req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
                 @test_iam_permissions.call(req, options, &block)
               end
+
+              # Starts creating a new Cloud Spanner Backup.
+              # The returned backup {Google::Longrunning::Operation long-running operation}
+              # will have a name of the format
+              # `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
+              # and can be used to track creation of the backup. The
+              # {Google::Longrunning::Operation#metadata metadata} field type is
+              # {Google::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}. The
+              # {Google::Longrunning::Operation#response response} field type is
+              # {Google::Spanner::Admin::Database::V1::Backup Backup}, if successful. Cancelling the returned operation will stop the
+              # creation and delete the backup.
+              # There can be only one pending backup creation per database. Backup creation
+              # of different databases can run concurrently.
+              #
+              # @param parent [String]
+              #   Required. The name of the instance in which the backup will be
+              #   created. This must be the same instance that contains the database the
+              #   backup will be created from. The backup will be stored in the
+              #   location(s) specified in the instance configuration of this
+              #   instance. Values are of the form
+              #   `projects/<project>/instances/<instance>`.
+              # @param backup_id [String]
+              #   Required. The id of the backup to be created. The `backup_id` appended to
+              #   `parent` forms the full backup name of the form
+              #   `projects/<project>/instances/<instance>/backups/<backup_id>`.
+              # @param backup [Google::Spanner::Admin::Database::V1::Backup | Hash]
+              #   Required. The backup to create.
+              #   A hash of the same form as `Google::Spanner::Admin::Database::V1::Backup`
+              #   can also be provided.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @return [Google::Gax::Operation]
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_parent = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
+              #
+              #   # TODO: Initialize `backup_id`:
+              #   backup_id = ''
+              #
+              #   # TODO: Initialize `backup`:
+              #   backup = {}
+              #
+              #   # Register a callback during the method call.
+              #   operation = database_admin_client.create_backup(formatted_parent, backup_id, backup) do |op|
+              #     raise op.results.message if op.error?
+              #     op_results = op.results
+              #     # Process the results.
+              #
+              #     metadata = op.metadata
+              #     # Process the metadata.
+              #   end
+              #
+              #   # Or use the return value to register a callback.
+              #   operation.on_done do |op|
+              #     raise op.results.message if op.error?
+              #     op_results = op.results
+              #     # Process the results.
+              #
+              #     metadata = op.metadata
+              #     # Process the metadata.
+              #   end
+              #
+              #   # Manually reload the operation.
+              #   operation.reload!
+              #
+              #   # Or block until the operation completes, triggering callbacks on
+              #   # completion.
+              #   operation.wait_until_done!
+
+              def create_backup \
+                  parent,
+                  backup_id,
+                  backup,
+                  options: nil
+                req = {
+                  parent: parent,
+                  backup_id: backup_id,
+                  backup: backup
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::CreateBackupRequest)
+                operation = Google::Gax::Operation.new(
+                  @create_backup.call(req, options),
+                  @operations_client,
+                  Google::Spanner::Admin::Database::V1::Backup,
+                  Google::Spanner::Admin::Database::V1::CreateBackupMetadata,
+                  call_options: options
+                )
+                operation.on_done { |operation| yield(operation) } if block_given?
+                operation
+              end
+
+              # Gets metadata on a pending or completed {Google::Spanner::Admin::Database::V1::Backup Backup}.
+              #
+              # @param name [String]
+              #   Required. Name of the backup.
+              #   Values are of the form
+              #   `projects/<project>/instances/<instance>/backups/<backup>`.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @yield [result, operation] Access the result along with the RPC operation
+              # @yieldparam result [Google::Spanner::Admin::Database::V1::Backup]
+              # @yieldparam operation [GRPC::ActiveCall::Operation]
+              # @return [Google::Spanner::Admin::Database::V1::Backup]
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_name = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.backup_path("[PROJECT]", "[INSTANCE]", "[BACKUP]")
+              #   response = database_admin_client.get_backup(formatted_name)
+
+              def get_backup \
+                  name,
+                  options: nil,
+                  &block
+                req = {
+                  name: name
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::GetBackupRequest)
+                @get_backup.call(req, options, &block)
+              end
+
+              # Updates a pending or completed {Google::Spanner::Admin::Database::V1::Backup Backup}.
+              #
+              # @param backup [Google::Spanner::Admin::Database::V1::Backup | Hash]
+              #   Required. The backup to update. `backup.name`, and the fields to be updated
+              #   as specified by `update_mask` are required. Other fields are ignored.
+              #   Update is only supported for the following fields:
+              #   * `backup.expire_time`.
+              #   A hash of the same form as `Google::Spanner::Admin::Database::V1::Backup`
+              #   can also be provided.
+              # @param update_mask [Google::Protobuf::FieldMask | Hash]
+              #   Required. A mask specifying which fields (e.g. `expire_time`) in the
+              #   Backup resource should be updated. This mask is relative to the Backup
+              #   resource, not to the request message. The field mask must always be
+              #   specified; this prevents any future fields from being erased accidentally
+              #   by clients that do not know about them.
+              #   A hash of the same form as `Google::Protobuf::FieldMask`
+              #   can also be provided.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @yield [result, operation] Access the result along with the RPC operation
+              # @yieldparam result [Google::Spanner::Admin::Database::V1::Backup]
+              # @yieldparam operation [GRPC::ActiveCall::Operation]
+              # @return [Google::Spanner::Admin::Database::V1::Backup]
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #
+              #   # TODO: Initialize `backup`:
+              #   backup = {}
+              #
+              #   # TODO: Initialize `update_mask`:
+              #   update_mask = {}
+              #   response = database_admin_client.update_backup(backup, update_mask)
+
+              def update_backup \
+                  backup,
+                  update_mask,
+                  options: nil,
+                  &block
+                req = {
+                  backup: backup,
+                  update_mask: update_mask
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::UpdateBackupRequest)
+                @update_backup.call(req, options, &block)
+              end
+
+              # Deletes a pending or completed {Google::Spanner::Admin::Database::V1::Backup Backup}.
+              #
+              # @param name [String]
+              #   Required. Name of the backup to delete.
+              #   Values are of the form
+              #   `projects/<project>/instances/<instance>/backups/<backup>`.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @yield [result, operation] Access the result along with the RPC operation
+              # @yieldparam result []
+              # @yieldparam operation [GRPC::ActiveCall::Operation]
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_name = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.backup_path("[PROJECT]", "[INSTANCE]", "[BACKUP]")
+              #   database_admin_client.delete_backup(formatted_name)
+
+              def delete_backup \
+                  name,
+                  options: nil,
+                  &block
+                req = {
+                  name: name
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::DeleteBackupRequest)
+                @delete_backup.call(req, options, &block)
+                nil
+              end
+
+              # Lists completed and pending backups.
+              # Backups returned are ordered by `create_time` in descending order,
+              # starting from the most recent `create_time`.
+              #
+              # @param parent [String]
+              #   Required. The instance to list backups from.  Values are of the
+              #   form `projects/<project>/instances/<instance>`.
+              # @param filter [String]
+              #   An expression that filters the list of returned backups.
+              #
+              #   A filter expression consists of a field name, a comparison operator, and a
+              #   value for filtering.
+              #   The value must be a string, a number, or a boolean. The comparison operator
+              #   must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
+              #   Colon `:` is the contains operator. Filter rules are not case sensitive.
+              #
+              #   The following fields in the {Google::Spanner::Admin::Database::V1::Backup Backup} are eligible for filtering:
+              #
+              #   * `name`
+              #     * `database`
+              #     * `state`
+              #     * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
+              #     * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
+              #     * `size_bytes`
+              #
+              #     You can combine multiple expressions by enclosing each expression in
+              #     parentheses. By default, expressions are combined with AND logic, but
+              #     you can specify AND, OR, and NOT logic explicitly.
+              #
+              #   Here are a few examples:
+              #
+              #   * `name:Howl` - The backup's name contains the string "howl".
+              #     * `database:prod`
+              #       * The database's name contains the string "prod".
+              #     * `state:CREATING` - The backup is pending creation.
+              #     * `state:READY` - The backup is fully created and ready for use.
+              #     * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
+              #       * The backup name contains the string "howl" and `create_time`
+              #         of the backup is before 2018-03-28T14:50:00Z.
+              #       * `expire_time < \"2018-03-28T14:50:00Z\"`
+              #         * The backup `expire_time` is before 2018-03-28T14:50:00Z.
+              #       * `size_bytes > 10000000000` - The backup's size is greater than 10GB
+              # @param page_size [Integer]
+              #   The maximum number of resources contained in the underlying API
+              #   response. If page streaming is performed per-resource, this
+              #   parameter does not affect the return value. If page streaming is
+              #   performed per-page, this determines the maximum number of
+              #   resources in a page.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @yield [result, operation] Access the result along with the RPC operation
+              # @yieldparam result [Google::Gax::PagedEnumerable<Google::Spanner::Admin::Database::V1::Backup>]
+              # @yieldparam operation [GRPC::ActiveCall::Operation]
+              # @return [Google::Gax::PagedEnumerable<Google::Spanner::Admin::Database::V1::Backup>]
+              #   An enumerable of Google::Spanner::Admin::Database::V1::Backup instances.
+              #   See Google::Gax::PagedEnumerable documentation for other
+              #   operations such as per-page iteration or access to the response
+              #   object.
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_parent = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
+              #
+              #   # TODO: Initialize `filter`:
+              #   filter = ''
+              #
+              #   # Iterate over all results.
+              #   database_admin_client.list_backups(formatted_parent, filter).each do |element|
+              #     # Process element.
+              #   end
+              #
+              #   # Or iterate over results one page at a time.
+              #   database_admin_client.list_backups(formatted_parent, filter).each_page do |page|
+              #     # Process each page at a time.
+              #     page.each do |element|
+              #       # Process element.
+              #     end
+              #   end
+
+              def list_backups \
+                  parent,
+                  filter,
+                  page_size: nil,
+                  options: nil,
+                  &block
+                req = {
+                  parent: parent,
+                  filter: filter,
+                  page_size: page_size
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::ListBackupsRequest)
+                @list_backups.call(req, options, &block)
+              end
+
+              # Create a new database by restoring from a completed backup. The new
+              # database must be in the same project and in an instance with the same
+              # instance configuration as the instance containing
+              # the backup. The returned database [long-running
+              # operation][google.longrunning.Operation] has a name of the format
+              # `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`,
+              # and can be used to track the progress of the operation, and to cancel it.
+              # The {Google::Longrunning::Operation#metadata metadata} field type is
+              # {Google::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
+              # The {Google::Longrunning::Operation#response response} type
+              # is {Google::Spanner::Admin::Database::V1::Database Database}, if
+              # successful. Cancelling the returned operation will stop the restore and
+              # delete the database.
+              # There can be only one database being restored into an instance at a time.
+              # Once the restore operation completes, a new restore operation can be
+              # initiated, without waiting for the optimize operation associated with the
+              # first restore to complete.
+              #
+              # @param parent [String]
+              #   Required. The name of the instance in which to create the
+              #   restored database. This instance must be in the same project and
+              #   have the same instance configuration as the instance containing
+              #   the source backup. Values are of the form
+              #   `projects/<project>/instances/<instance>`.
+              # @param database_id [String]
+              #   Required. The id of the database to create and restore to. This
+              #   database must not already exist. The `database_id` appended to
+              #   `parent` forms the full database name of the form
+              #   `projects/<project>/instances/<instance>/databases/<database_id>`.
+              # @param backup [String]
+              #   Name of the backup from which to restore.  Values are of the form
+              #   `projects/<project>/instances/<instance>/backups/<backup>`.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @return [Google::Gax::Operation]
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_parent = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
+              #
+              #   # TODO: Initialize `database_id`:
+              #   database_id = ''
+              #
+              #   # Register a callback during the method call.
+              #   operation = database_admin_client.restore_database(formatted_parent, database_id) do |op|
+              #     raise op.results.message if op.error?
+              #     op_results = op.results
+              #     # Process the results.
+              #
+              #     metadata = op.metadata
+              #     # Process the metadata.
+              #   end
+              #
+              #   # Or use the return value to register a callback.
+              #   operation.on_done do |op|
+              #     raise op.results.message if op.error?
+              #     op_results = op.results
+              #     # Process the results.
+              #
+              #     metadata = op.metadata
+              #     # Process the metadata.
+              #   end
+              #
+              #   # Manually reload the operation.
+              #   operation.reload!
+              #
+              #   # Or block until the operation completes, triggering callbacks on
+              #   # completion.
+              #   operation.wait_until_done!
+
+              def restore_database \
+                  parent,
+                  database_id,
+                  backup: nil,
+                  options: nil
+                req = {
+                  parent: parent,
+                  database_id: database_id,
+                  backup: backup
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::RestoreDatabaseRequest)
+                operation = Google::Gax::Operation.new(
+                  @restore_database.call(req, options),
+                  @operations_client,
+                  Google::Spanner::Admin::Database::V1::Database,
+                  Google::Spanner::Admin::Database::V1::RestoreDatabaseMetadata,
+                  call_options: options
+                )
+                operation.on_done { |operation| yield(operation) } if block_given?
+                operation
+              end
+
+              # Lists database {Google::Longrunning::Operation longrunning-operations}.
+              # A database operation has a name of the form
+              # `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.
+              # The long-running operation
+              # {Google::Longrunning::Operation#metadata metadata} field type
+              # `metadata.type_url` describes the type of the metadata. Operations returned
+              # include those that have completed/failed/canceled within the last 7 days,
+              # and pending operations.
+              #
+              # @param parent [String]
+              #   Required. The instance of the database operations.
+              #   Values are of the form `projects/<project>/instances/<instance>`.
+              # @param filter [String]
+              #   An expression that filters the list of returned operations.
+              #
+              #   A filter expression consists of a field name, a
+              #   comparison operator, and a value for filtering.
+              #   The value must be a string, a number, or a boolean. The comparison operator
+              #   must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
+              #   Colon `:` is the contains operator. Filter rules are not case sensitive.
+              #
+              #   The following fields in the {Google::Longrunning::Operation Operation}
+              #   are eligible for filtering:
+              #
+              #   * `name` - The name of the long-running operation
+              #     * `done` - False if the operation is in progress, else true.
+              #     * `metadata.@type` - the type of metadata. For example, the type string
+              #       for {Google::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata} is
+              #       `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
+              #     * `metadata.<field_name>` - any field in metadata.value.
+              #     * `error` - Error associated with the long-running operation.
+              #     * `response.@type` - the type of response.
+              #     * `response.<field_name>` - any field in response.value.
+              #
+              #     You can combine multiple expressions by enclosing each expression in
+              #     parentheses. By default, expressions are combined with AND logic. However,
+              #     you can specify AND, OR, and NOT logic explicitly.
+              #
+              #   Here are a few examples:
+              #
+              #   * `done:true` - The operation is complete.
+              #     * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
+              #       `(metadata.source_type:BACKUP) AND` <br/>
+              #       `(metadata.backup_info.backup:backup_howl) AND` <br/>
+              #       `(metadata.name:restored_howl) AND` <br/>
+              #       `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+              #       `(error:*)` - Return operations where:
+              #       * The operation's metadata type is {Google::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
+              #       * The database is restored from a backup.
+              #       * The backup name contains "backup_howl".
+              #       * The restored database's name contains "restored_howl".
+              #       * The operation started before 2018-03-28T14:50:00Z.
+              #       * The operation resulted in an error.
+              # @param page_size [Integer]
+              #   The maximum number of resources contained in the underlying API
+              #   response. If page streaming is performed per-resource, this
+              #   parameter does not affect the return value. If page streaming is
+              #   performed per-page, this determines the maximum number of
+              #   resources in a page.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @yield [result, operation] Access the result along with the RPC operation
+              # @yieldparam result [Google::Gax::PagedEnumerable<Google::Longrunning::Operation>]
+              # @yieldparam operation [GRPC::ActiveCall::Operation]
+              # @return [Google::Gax::PagedEnumerable<Google::Longrunning::Operation>]
+              #   An enumerable of Google::Longrunning::Operation instances.
+              #   See Google::Gax::PagedEnumerable documentation for other
+              #   operations such as per-page iteration or access to the response
+              #   object.
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_parent = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
+              #
+              #   # TODO: Initialize `filter`:
+              #   filter = ''
+              #
+              #   # Iterate over all results.
+              #   database_admin_client.list_database_operations(formatted_parent, filter).each do |element|
+              #     # Process element.
+              #   end
+              #
+              #   # Or iterate over results one page at a time.
+              #   database_admin_client.list_database_operations(formatted_parent, filter).each_page do |page|
+              #     # Process each page at a time.
+              #     page.each do |element|
+              #       # Process element.
+              #     end
+              #   end
+
+              def list_database_operations \
+                  parent,
+                  filter,
+                  page_size: nil,
+                  options: nil,
+                  &block
+                req = {
+                  parent: parent,
+                  filter: filter,
+                  page_size: page_size
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::ListDatabaseOperationsRequest)
+                @list_database_operations.call(req, options, &block)
+              end
+
+              # Lists the backup {Google::Longrunning::Operation long-running operations} in
+              # the given instance. A backup operation has a name of the form
+              # `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`.
+              # The long-running operation
+              # {Google::Longrunning::Operation#metadata metadata} field type
+              # `metadata.type_url` describes the type of the metadata. Operations returned
+              # include those that have completed/failed/canceled within the last 7 days,
+              # and pending operations. Operations returned are ordered by
+              # `operation.metadata.value.progress.start_time` in descending order starting
+              # from the most recently started operation.
+              #
+              # @param parent [String]
+              #   Required. The instance of the backup operations. Values are of
+              #   the form `projects/<project>/instances/<instance>`.
+              # @param filter [String]
+              #   An expression that filters the list of returned backup operations.
+              #
+              #   A filter expression consists of a field name, a
+              #   comparison operator, and a value for filtering.
+              #   The value must be a string, a number, or a boolean. The comparison operator
+              #   must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
+              #   Colon `:` is the contains operator. Filter rules are not case sensitive.
+              #
+              #   The following fields in the {Google::Longrunning::Operation operation}
+              #   are eligible for filtering:
+              #
+              #   * `name` - The name of the long-running operation
+              #     * `done` - False if the operation is in progress, else true.
+              #     * `metadata.@type` - the type of metadata. For example, the type string
+              #       for {Google::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata} is
+              #       `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
+              #     * `metadata.<field_name>` - any field in metadata.value.
+              #     * `error` - Error associated with the long-running operation.
+              #     * `response.@type` - the type of response.
+              #     * `response.<field_name>` - any field in response.value.
+              #
+              #     You can combine multiple expressions by enclosing each expression in
+              #     parentheses. By default, expressions are combined with AND logic, but
+              #     you can specify AND, OR, and NOT logic explicitly.
+              #
+              #   Here are a few examples:
+              #
+              #   * `done:true` - The operation is complete.
+              #     * `metadata.database:prod` - The database the backup was taken from has
+              #       a name containing the string "prod".
+              #     * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
+              #       `(metadata.name:howl) AND` <br/>
+              #       `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+              #       `(error:*)` - Returns operations where:
+              #       * The operation's metadata type is {Google::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
+              #       * The backup name contains the string "howl".
+              #       * The operation started before 2018-03-28T14:50:00Z.
+              #       * The operation resulted in an error.
+              # @param page_size [Integer]
+              #   The maximum number of resources contained in the underlying API
+              #   response. If page streaming is performed per-resource, this
+              #   parameter does not affect the return value. If page streaming is
+              #   performed per-page, this determines the maximum number of
+              #   resources in a page.
+              # @param options [Google::Gax::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout,
+              #   retries, etc.
+              # @yield [result, operation] Access the result along with the RPC operation
+              # @yieldparam result [Google::Gax::PagedEnumerable<Google::Longrunning::Operation>]
+              # @yieldparam operation [GRPC::ActiveCall::Operation]
+              # @return [Google::Gax::PagedEnumerable<Google::Longrunning::Operation>]
+              #   An enumerable of Google::Longrunning::Operation instances.
+              #   See Google::Gax::PagedEnumerable documentation for other
+              #   operations such as per-page iteration or access to the response
+              #   object.
+              # @raise [Google::Gax::GaxError] if the RPC is aborted.
+              # @example
+              #   require "google/cloud/spanner/admin/database"
+              #
+              #   database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
+              #   formatted_parent = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
+              #
+              #   # TODO: Initialize `filter`:
+              #   filter = ''
+              #
+              #   # Iterate over all results.
+              #   database_admin_client.list_backup_operations(formatted_parent, filter).each do |element|
+              #     # Process element.
+              #   end
+              #
+              #   # Or iterate over results one page at a time.
+              #   database_admin_client.list_backup_operations(formatted_parent, filter).each_page do |page|
+              #     # Process each page at a time.
+              #     page.each do |element|
+              #       # Process element.
+              #     end
+              #   end
+
+              def list_backup_operations \
+                  parent,
+                  filter,
+                  page_size: nil,
+                  options: nil,
+                  &block
+                req = {
+                  parent: parent,
+                  filter: filter,
+                  page_size: page_size
+                }.delete_if { |_, v| v.nil? }
+                req = Google::Gax::to_proto(req, Google::Spanner::Admin::Database::V1::ListBackupOperationsRequest)
+                @list_backup_operations.call(req, options, &block)
+              end
             end
           end
         end