Skip to main content
Version: Stable-3.1

SHOW RESTORE

Description

Views the last RESTORE task in a specified database. For more information, see data backup and restoration.

NOTE

Only the information of the last RESTORE task is saved in StarRocks.

Syntax

SHOW RESTORE [FROM <db_name>]

Parameters

ParameterDescription
db_nameName of the database that the RESTORE task belongs to.

Return

ReturnDescription
JobIdUnique job ID.
LabelName of the data snapshot.
TimestampBackup timestamp.
DbNameName of the database that the RESTORE task belongs to.
StateCurrent state of the RESTORE task:
  • PENDING: Initial state after submitting a job.
  • SNAPSHOTING: Executing the local snapshot.
  • DOWNLOAD: Submitting snapshot download task.
  • DOWNLOADING: Downloading the snapshot.
  • COMMIT: To commit the downloaded snapshot.
  • COMMITTING: Committing the downloaded snapshot.
  • FINISHED: RESTORE task finished.
  • CANCELLED: RESTORE task failed or cancelled.
AllowLoadIf loading data is allowed during the RESTORE task.
ReplicationNumNumber of replicas to be restored.
RestoreObjsThe restored objects (tables and partitions).
CreateTimeTask submission time.
MetaPreparedTimeLocal metadata completion time.
SnapshotFinishedTimeSnapshot completion time.
DownloadFinishedTimeSnapshot download completion time.
FinishedTimeTask completion Time.
UnfinishedTasksUnfinished subtask IDs in the SNAPSHOTTING, DOWNLOADING, and COMMITTING phases.
ProgressThe progress of snapshot downloading tasks.
TaskErrMsgError messages.
StatusStatus information.
TimeoutTask timeout. Unit: second.

Examples

Example 1: Views the last RESTORE task in the database example_db.

SHOW RESTORE FROM example_db;