Restoring a service from a backup

Restore allows you to recover your Dataproc Metastore service's stored metadata and configuration from a backup.

This page explains how to restore a Dataproc Metastore service's metadata using the Google Cloud Console opened in a local browser or by using the Dataproc Metastore API method services.restore.

Access control

  • To restore metadata, you must be granted an IAM role containing the and metastore.backups.use IAM permissions. The Dataproc Metastore specific roles roles/metastore.admin and roles/metastore.editor can be used to grant restore permission.

  • You can also give restore permission to users or groups by using the roles/owner and roles/editor legacy roles.

For more information, see Dataproc Metastore IAM and access control.

Restoring a service from a backup

You can restore a service from a backup by choosing a backup on the Service detail page opened in a local browser or by issuing a Dataproc Metastore API method services.restore.

You have the option to restore metadata with the current service configuration or restore metadata with the backup service configuration. You can restore the metadata and backup service configuration at the same time. The configuration includes settings such as network, port, and service tier, which are the same configurations that you can change using the API method service.update.

While a restore is pending, no updates can be made to the service. You can still use the service while it's undergoing a restore.

You can restore a Dataproc Metastore service from a backup using the Google Cloud Console or the Dataproc Metastore API:


  1. In the Cloud Console, open the Dataproc Metastore page:

    Open Dataproc Metastore in the Cloud Console

  2. On the Dataproc Metastore page, click the name of the service you'd like to restore metadata into. The Service detail page opens.

    Service detail page
  3. Click the Backup/Restore tab to view your backups for the service.

  4. On the right of the backup you'd like to use, click and select Restore. The restore page opens.

    You can also restore your service on the Backup detail page by clicking the name of the backup that you'd like to use, and then clicking Restore.

  5. Select a restore option:

    • Restore metastore data

      Only restores the data content stored in the backup.

    • Restore metastore data and service configuration

      Restores the data content stored in the backup, and applies the service configuration stored in the backup to the current service.

  6. Click Restore to update the service.

  7. Verify that you have returned to the Service detail page, and that your restore appears under the Restore history on the Backup/Restore tab.


Follow the API instructions to restore metadata into a service by using the APIs Explorer.

When the restore succeeds, the service automatically enters active state. If it fails, then the service is rolled back to its previous healthy state.

To view a service's restore history, refer to the Backup/Restore tab on the Service detail page in the Cloud Console.

Restore caveats

  • Dataproc Metastore service labels and actual data in the datawarehouse directory are not restored.

  • You can only restore metadata from backups created from the same Dataproc Metastore service.

  • A history of past restores is available on the UI. Deleting the service itself will delete all restore history under that service.

Common failures

  • The user restoring the Dataproc Metastore service from a backup doesn't have and metastore.backups.use permissions.

What's next?