Skip to main content

SHOW RESTORE

Description​

This statement is used to view RESTORE tasks

Syntax​

SHOW [BRIEF] RESTORE [FROM <db_name>]

Parameters​

1.<db_name>

The name of the database to which the recovery task belongs.

Return Value​

  • brief: only show key information of RESTORE tasks, columns RestoreObjs, Progress, TaskErrMsg will not show
ColumnDescription
JobIdUnique job id
LabelThe name of the backup to restore
TimestampThe time version of the backup to restore
DbNamebelongs to the database
Statecurrent stage:
  • PENDING: The initial state after submitting the job.
  • SNAPSHOTING: Executing snapshot.
  • DOWNLOAD: The snapshot is complete, ready to download the snapshot in the repository.
  • DOWNLOADING: Snapshot downloading.
  • COMMIT: Snapshot download is complete, ready to take effect.
  • COMMITTING: in effect.
  • FINISHED: Job finish time.
  • CANCELLED: Job failed.
AllowLoadWhether to allow import when restoring (currently not supported)
ReplicationNumSpecifies the number of replicas to restore
ReserveReplicaWhether to keep a copy
ReplicaAllocationWhether to keep dynamic partitioning enabled
RestoreJobsTables and partitions to restore
CreateTimetask submission time
MetaPreparedTimeMetadata preparation completion time
SnapshotFinishedTimeSnapshot completion time
DownloadFinishedTimeSnapshot download completion time
FinishedTimeJob finish time
UnfinishedTasksDisplays unfinished subtask ids during SNAPSHOTING, DOWNLOADING and COMMITING stages
ProgressTask progress
TaskErrMsgDisplay task error messages
StatusIf the job fails, display the failure message
TimeoutJob timeout, in seconds

Example​

  1. View the latest RESTORE task under example_db.
SHOW RESTORE FROM example_db;