blob: da0cd0532a08ef500819dd873d7ebab16882de7d [file] [log] [blame] [view]
---
{
"title": "SHOW-BACKUP",
"language": "en"
}
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
## SHOW-BACKUP
### Name
SHOW BACKUP
### Description
This statement is used to view BACKUP tasks
grammar:
```sql
SHOW BACKUP [FROM db_name]
[WHERE SnapshotName ( LIKE | = ) 'snapshot name']
```
illustrate:
1. Only the most recent BACKUP task is saved in Doris.
2. The meaning of each column is as follows:
- `JobId`: Unique job id
- `SnapshotName`: The name of the backup
- `DbName`: belongs to the database
- `State`: current stage
- `PENDING`: The initial state after submitting the job
- `SNAPSHOTING`: Executing snapshot
- `UPLOAD_SNAPSHOT`: Snapshot completed, ready to upload
- `UPLOADING`: Snapshot uploading
- `SAVE_META`: Save job meta information to a local file
- `UPLOAD_INFO`: Upload job meta information
- `FINISHED`: The job was successful
- `CANCELLED`: Job failed
- `BackupObjs`: Backed up tables and partitions
- `CreateTime`: task submission time
- `SnapshotFinishedTime`: Snapshot completion time
- `UploadFinishedTime`: Snapshot upload completion time
- `FinishedTime`: Job finish time
- `UnfinishedTasks`: Displays unfinished subtask ids during SNAPSHOTING and UPLOADING stages
- `Status`: If the job fails, display the failure message
- `Timeout`: Job timeout, in seconds
### Example
1. View the last BACKUP task under example_db.
```sql
SHOW BACKUP FROM example_db;
```
### Keywords
SHOW, BACKUP
### Best Practice