HBase backup commands

The following list details each hbase backup COMMAND [command-specific arguments]. Run the full command line as hbase superuser.

hbase backup create [ <type>​​<backup_path>​​[options]]

Creates a new backup image.

hbase​ ​backup​ ​delete​ [​<backup_id>]

Deletes the specified existing backup image from the system. The backup_id option is required.

hbase backup describe [​<backup_id>]

Shows the detailed information of a backup image. The backup_id option is required.

hbase backup history [options]

Options:​​​​​​​​​​​​​

​-n​ ​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​Number ​​of​ ​records​​ of​ ​backup​ ​history.​ ​Default is 10​.

​-p ​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​Backup​ ​destination ​​root​​ directory ​​path​​​​​​​​​​​​​​​.

-s ​​​​​​​​​​​​​​​​​​​​​​​​​​Backup ​​set​ ​name​​​​​​​​​​​​​​​

-t​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ Table ​​name. ​​If​ ​specified,​ ​only​ ​backup ​​images,​​​​ ​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​which​ ​contain ​​this ​​table​ ​will​​ be ​​listed.

Shows the history of all successful backups.

hbase backup progress [​<backup_id>]

Shows the progress of the latest backup request. Backup​ ​image​​id is ​​(optional). If no ID ia specified, the command will show the progress of the currently running backup session.

hbase backup set COMMAND [[name] [tables]]

Manages the backup sets. You can add, remove, delete, describe, and delete a backup set using this command.

hbase backup progress [​<backup_id>]

Shows the progress of the latest backup request. Backup​ ​image​​id is ​​(optional). If no ID ia specified, the command will show the progress of the currently running backup session.

hbase backup repair

It repairs the backup system table.

It repairs the backup system table. This command attempts to correct any inconsistencies in persisted backup metadata, which exists as a result of software errors or unhandled failure scenarios. While the backup implementation tries to correct all errors on its own, this tool may be necessary in the cases where the system cannot automatically recover on its own.

hbase backup merge [<backup_id>]

Merges the backup images. Run​ merge​ command ​to ​​merge ​incremental​ backup ​​images ​into​​ a​ ​single​ ​incremental ​​backup image.​​ The ​​most​ recent​ ​backup ​​image​ ​will​ be​ ​overwritten ​​by ​​resulting ​​merged​ ​image,​​ all​ ​other images​​ will​ ​be​ ​deleted.