Method: googleapis.spanner.v1.projects.instances.databases.restore

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 has a name of the format projects//instances//databases//operations/, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is 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.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters

Parameters
`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//instances/`.
`body`	`object (RestoreDatabaseRequest)` Required.

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//instances/.

body

object (RestoreDatabaseRequest)

Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
`OperationError`	If the long-running operation finished unsuccessfully.
`ResponseTypeError`	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- restore:
    call: googleapis.spanner.v1.projects.instances.databases.restore
    args:
        parent: ...
        body:
            backup: ...
            databaseId: ...
            encryptionConfig:
                encryptionType: ...
                kmsKeyName: ...
    result: restoreResult

JSON

[
  {
    "restore": {
      "call": "googleapis.spanner.v1.projects.instances.databases.restore",
      "args": {
        "parent": "...",
        "body": {
          "backup": "...",
          "databaseId": "...",
          "encryptionConfig": {
            "encryptionType": "...",
            "kmsKeyName": "..."
          }
        }
      },
      "result": "restoreResult"
    }
  }
]