Skip to main content

SHOW RESTORE

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

Parameter

Description

db_name

Name of the database that the RESTORE task belongs to.

Return

Return

Description

JobId

Unique job ID.

Label

Name of the data snapshot.

Timestamp

Backup timestamp.

DbName

Name of the database that the RESTORE task belongs to.

State

Current 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.

AllowLoad

If loading data is allowed during the RESTORE task.

ReplicationNum

Number of replicas to be restored.

RestoreObjs

The restored objects (tables and partitions).

CreateTime

Task submission time.

MetaPreparedTime

Local metadata completion time.

SnapshotFinishedTime

Snapshot completion time.

DownloadFinishedTime

Snapshot download completion time.

FinishedTime

Task completion Time.

UnfinishedTasks

Unfinished subtask IDs in the SNAPSHOTTING, DOWNLOADING, and COMMITTING phases.

Progress

The progress of snapshot downloading tasks.

TaskErrMsg

Error messages.

Status

Status information.

Timeout

Task timeout. Unit: second.

Examples

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

SHOW RESTORE FROM example_db;