Skip to main content
Version: Stable-3.1

SHOW BACKUP

Description

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

NOTE

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

Syntax

SHOW BACKUP [FROM <db_name>]

Parameters

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

Return

ReturnDescription
JobIdUnique job ID.
SnapshotNameName of the data snapshot.
DbNameName of the database that the BACKUP task belongs to.
StateCurrent state of the BACKUP task:
  • PENDING: Initial state after submitting a job.
  • SNAPSHOTING: Creating snapshot.
  • UPLOAD_SNAPSHOT: Snapshot complete, ready for upload.
  • UPLOADING: Uploading snapshot.
  • SAVE_META: Creating local metadata files.
  • UPLOAD_INFO: Uploading metadata files and information of the BACKUP task.
  • FINISHED: BACKUP task finished.
  • CANCELLED: BACKUP task failed or cancelled.
BackupObjsBacked up objects.
CreateTimeTask submission time.
SnapshotFinishedTimeSnapshot completion time.
UploadFinishedTimeSnapshot upload completion time.
FinishedTimeTask completion Time.
UnfinishedTasksUnfinished subtask IDs in the SNAPSHOTING and UPLOADING phases.
ProgressThe progress of snapshot uploading tasks.
TaskErrMsgError messages.
StatusStatus information.
TimeoutTask timeout. Unit: second.

Examples

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

SHOW BACKUP FROM example_db;