Restore Dataproc Metastore from a backup

This page explains how to restore a Dataproc Metastore service from a backup.

A backup is a snapshot of the configuration settings and metadata stored in a Dataproc Metastore service. You can use the restore feature to quickly set up a new Dataproc Metastore service with the data previously saved in a backup.

Before you begin

Enable Dataproc Metastore in your project.
Create a Dataproc Metastore service.
Back up a Dataproc Metastore service.

Required roles

To get the permission that you need to Restore a Dataproc Metastore service from a backup, ask your administrator to grant you the following IAM roles on your project, based on the principle of least privilege:

Grant full access to all Dataproc Metastore resources, including IAM policy administration (roles/metastore.admin)
Grant full control of Dataproc Metastore resources (roles/metastore.editor)

For more information about granting roles, see Manage access.

This predefined role contains the metastore.services.restore, metastore.backups.use permission, which is required to Restore a Dataproc Metastore service from a backup.

You might also be able to get this permission with custom roles or other predefined roles.

For more information about specific Dataproc Metastore roles and permissions, see Dataproc Metastore IAM overview.

About restoring from a backup

When you restore a service from a backup, you can choose one of the following options:

Restore all metadata and the configuration settings saved in the backup.
Restore all metadata, but don't restore the configuration settings saved in the backup. Instead, your service retains your current configuration settings.

Configuration settings include Dataproc Metastore parameters such as service name, port number, and network settings. Metadata includes all the database and table information stored in a Dataproc Metastore service.

Considerations

While a restore operation is running, you can't update your service — for example changing configuration settings. However, you can still use it for normal operations, such as using it to access its metadata from attached Dataproc or self-managed clusters.
Dataproc Metastore labels aren't restored.
Data stored in the data warehouse directory isn't restored.
Restoring from a backup doesn't restore or replace fine-grained IAM policies.

Restore from a backup

To restore a Dataproc Metastore service from a backup, complete the following steps.

If you're using the Google Cloud console, you can only restore metadata from a backup that was created in the same project and region as your new service.
If you use the Google Cloud CLI or Dataproc Metastore APIs, you can restore metadata from a backup created in a different project and region (cross-service backup).

Console

In the Google Cloud console, open the Dataproc Metastore page:

Open Dataproc Metastore
On the Dataproc Metastore page, click the name of the service you want to restore from a backup.

The Service detail page opens.
To view your backups, click the Backup/Restore tab.
Select the backup you want to use. To do this,s click the menu icon , and select Restore.

The Restore page opens.

You can also restore your service on the Backup detail page. To do this, click the name of the backup and then click Restore.
Select the appropriate restore operation:
- Restore metastore data. Restores all metadata, but doesn't restore the configuration settings saved in the backup
- Restore metastore data and service configuration. Restores all metadata and the all configuration settings saved in the backup.
To update the service, click Restore.

Return to the Dataproc Metastore page, and verify that your service was successfully backed up.

When the restore completes, Dataproc Metastore automatically returns to the active state regardless of whether or not the restore succeeded.

gcloud CLI

To restore a Dataproc Metastore service, run the following gcloud metastore services restore command:
```
gcloud metastore services restore SERVICE  \
    --project=PROJECT_ID \
    --location=LOCATION \
    --backup=BACKUP \
    --restore-type=RESTORE_TYPE
```
Replace the following:
- SERVICE: the name of your Dataproc Metastore service.
- PROJECT_ID: the project ID of the Google Cloud project your Dataproc Metastore service resides in.
- LOCATION: the Google Cloud region that your Dataproc Metastore service resides.
- BACKUP: the identifier of the backup file you're restoring from. This value can be the backup ID, a fully qualified URL, or the relative name in the following format: projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
- RESTORE_TYPE: the type of restore operation to perform. Accepted values include metadata-only or full. The default value is metadata-only.
Verify that the restore operation was successful.

When the restore completes, Dataproc Metastore automatically returns to the active state regardless of whether or not the restore succeeded.

REST

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

When the restore completes, Dataproc Metastore automatically returns to the active state regardless of whether or not the restore succeeded.

View restore history

To view the restore history of a Dataproc Metastore service in the Google Cloud console, complete the following steps:

In the Google Cloud console console, open the Dataproc Metastore page.
In the navigation bar, click Backup/Restore.

Your restore history appears in a table under Restore.

The history displays up to the latest 25 restores you completed.

Deleting a Dataproc Metastore service also deletes all associated restore history.

Troubleshoot common issues

The service agent or user account doesn't have necessary permissions.
For more help solving common troubleshooting issues, see Backup and restore error scenarios.