Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] fix descriptions, add guide link #54620

Merged
merged 1 commit into from
Jan 2, 2025
Merged

[Doc] fix descriptions, add guide link #54620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ displayed_sidebar: docs

# BACKUP

## Description

Backs up data in a specified database, table, or partition. Currently, StarRocks only supports backing up data in OLAP tables.

:::tip
For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md).
:::

BACKUP is an asynchronous operation. You can check the status of a BACKUP job status using [SHOW BACKUP](./SHOW_BACKUP.md), or cancel a BACKUP job using [CANCEL BACKUP](./CANCEL_BACKUP.md). You can view the snapshot information using [SHOW SNAPSHOT](./SHOW_SNAPSHOT.md).

> **CAUTION**
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# CANCEL BACKUP

## Description

Cancels an ongoing BACKUP task in a specified database.

## Syntax
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# CANCEL RESTORE

## Description

Cancels an ongoing RESTORE task in a specified database.

> **CAUTION**
Expand Down
6 changes: 4 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ displayed_sidebar: docs

# CREATE REPOSITORY

## Description

Creates a repository in a remote storage system that is used to store data snapshots for backing up and restoring data.

:::tip
For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md).
:::

> **CAUTION**
>
> Only users with the ADMIN privilege can create a repository.
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# DROP REPOSITORY

## Description

Deletes a repository. Repositories are used to store data snapshots for data backup and restoration.

> **CAUTION**
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# RECOVER

## Description

Recovers a database, table, or partition that was dropped by using the DROP command. The dropped database, table, or partition can be recovered within the period specified by the FE parameter `catalog_trash_expire_second` (1 day by default).

Data deleted by using [TRUNCATE TABLE](../table_bucket_part_index/TRUNCATE_TABLE.md) cannot be recovered.
Expand Down
6 changes: 4 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ displayed_sidebar: docs

# RESTORE

## Description

Restores data to a specified database, table, or partition. Currently, StarRocks only supports restoring data to OLAP tables.

:::tip
For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md).
:::

RESTORE is an asynchronous operation. You can check the status of a RESTORE job using [SHOW RESTORE](./SHOW_RESTORE.md), or cancel a RESTORE job using [CANCEL RESTORE](./CANCEL_RESTORE.md).

> **CAUTION**
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW BACKUP

## Description

Views the last BACKUP task in a specified database.

> **NOTE**
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW REPOSITORIES

## Description

Views the repositories created in StarRocks.

## Syntax
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW RESTORE

## Description

Views the last RESTORE task in a specified database.

> **NOTE**
Expand Down
2 changes: 0 additions & 2 deletions docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW SNAPSHOT

## Description

Views data snapshots in a specified repository. For more information, see [data backup and restoration](../../../administration/management/Backup_and_restore.md).

## Syntax
Expand Down
8 changes: 0 additions & 8 deletions docs/en/sql-reference/sql-statements/backup_restore/backup_restore.mdx
View file
Open in desktop

This file was deleted.

6 changes: 4 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ keywords: ['beifen']

# BACKUP

## 功能

备份指定数据库、表或分区的数据。当前 StarRocks 仅支持备份 OLAP 类型表。更多信息，请见 备份和恢复。

:::tip
有关备份和恢复的概述，请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。
:::

数据备份为异步操作。您可以通过 [SHOW BACKUP](./SHOW_BACKUP.md) 语句查看备份作业状态，或通过 [CANCEL BACKUP](./CANCEL_BACKUP.md) 语句取消备份作业。作业成功后，您可以通过 [SHOW SNAPSHOT](./SHOW_SNAPSHOT.md) 查看特定仓库对应的数据快照信息。

> **注意**
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ keywords: ['beifen']

# CANCEL BACKUP

## 功能

取消指定数据库中一个正在进行的备份任务。更多信息，请见 备份和恢复。

## 语法
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ keywords: ['beifen']

# CANCEL RESTORE

## 功能

取消指定数据库中一个正在进行的恢复任务。更多信息，请见 备份和恢复。

> **注意**
Expand Down
6 changes: 4 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ keywords: ['beifen']

# CREATE REPOSITORY

## 功能

基于远端存储系统创建用于存储数据快照的仓库。仓库用于 备份和恢复 数据库数据。

:::tip
有关备份和恢复的概述，请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。
:::

> **注意**
>
> 只有拥有 System 级 REPOSITORY 权限的用户才可以创建仓库。
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ keywords: ['beifen']

# DROP REPOSITORY

## 功能

删除一个仓库。仓库用于 备份和恢复 数据库数据。

> **注意**
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ keywords: ['beifen']

# RECOVER

## 功能

恢复之前通过 DROP 操作删除的 database、table 或者 partition。DROP 操作后只有在指定的时间内才能通过 RECOVER 恢复数据，超过这个时间无法恢复。该时间由 FE 动态参数 `catalog_trash_expire_second` 控制，默认 1 天。

通过 [TRUNCATE TABLE](../table_bucket_part_index/TRUNCATE_TABLE.md) 命令删除的数据无法恢复。
Expand Down
6 changes: 4 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ keywords: ['beifen']

# RESTORE

## 功能

恢复指定数据库、表或分区的数据。当前 StarRocks 仅支持恢复 OLAP 类型表。更多信息，请见 备份和恢复。

:::tip
有关备份和恢复的概述，请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。
:::

数据恢复为异步操作。您可以通过 [SHOW RESTORE](./SHOW_RESTORE.md) 语句查看恢复作业状态，或通过 [CANCEL RESTORE](./CANCEL_RESTORE.md) 语句取消恢复作业。

> **注意**
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW BACKUP

## 功能

查看指定数据库中的备份任务。更多信息，请见 备份和恢复。

> **说明**
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW REPOSITORIES

## 功能

查看当前已创建的仓库。

## 语法
Expand Down
2 changes: 0 additions & 2 deletions docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ displayed_sidebar: docs

# SHOW RESTORE

## 功能

查看指定数据库中的恢复任务。更多信息，请见 备份和恢复。

> **说明**
Expand Down
9 changes: 0 additions & 9 deletions docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx
View file
Open in desktop

This file was deleted.

Loading