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.

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

auzre is not supported in 2.1 #1688

Merged
merged 9 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions docs/admin-manual/data-admin/backup-restore/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ under the License.

For concepts related to backup, please refer to [Backup and Restore](./overview.md). This guide provides the steps to create a Repository and back up data.

## 1. Create Repository
## Step 1. Create Repository

<!--
suites/backup_restore/test_create_and_drop_repository.groovy
Expand Down Expand Up @@ -56,7 +56,7 @@ PROPERTIES

### Option 2: Create Repository on Azure

**Azure is supported since 2.0.8 or 3.0.4.**
**Azure is supported since 3.0.4.**

To create a Repository on Azure storage, use the following SQL command:

Expand Down Expand Up @@ -160,7 +160,7 @@ PROPERTIES
- Replace `prefix_path` with the actual path.
- Provide your HDFS endpoint and username.

## 2. Backup
## Step 2. Backup

Refer to the following statements to back up databases, tables, or partitions. For detailed usage, please refer to [Backup](../../../sql-manual/sql-statements/Data-Definition-Statements/Backup-and-Restore/BACKUP.md).

Expand Down Expand Up @@ -222,7 +222,7 @@ EXCLUDE
);
```

## 3. View Recent Backup Job Execution Status
## Step 3. View Recent Backup Job Execution Status

The following SQL statement can be used to view the execution status of recent backup jobs.

Expand All @@ -246,7 +246,7 @@ mysql> show BACKUP\G;
1 row in set (0.01 sec)
```

## 4. View Existing Backups in Repository
## Step 4. View Existing Backups in Repository

The following SQL statement can be used to view existing backups in a Repository named `example_repo`, where the Snapshot column is the snapshot label, and the Timestamp is the timestamp.

Expand All @@ -260,6 +260,6 @@ mysql> SHOW SNAPSHOT ON example_repo;
1 row in set (0.15 sec)
```

## 5. Cancel Backup (if necessary)
## Step 5. Cancel Backup (if necessary)

You can use `CANCEL BACKUP FROM db_name;` to cancel a backup task in a database. For more specific usage, refer to [Cancel Backup](../../../sql-manual/sql-statements/Data-Definition-Statements/Backup-and-Restore/CANCEL-BACKUP.md).
You can use `CANCEL BACKUP FROM db_name;` to cancel a backup task in a database. For more specific usage, refer to [Cancel Backup](../../../sql-manual/sql-statements/Data-Definition-Statements/Backup-and-Restore/CANCEL-BACKUP.md).
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ under the License.

有关备份的概念,请参阅[备份与恢复](./overview.md)。本指南提供了创建 Repository 和备份数据的操作步骤。

## 1. 创建 Repository
## 第 1 步. 创建 Repository

<!--
suites/backup_restore/test_create_and_drop_repository.groovy
-->

根据您的存储选择适当的语句来创建 Repository。有关详细用法,请参阅[创建 Repository ](../../../sql-manual/sql-statements/Data-Definition-Statements/Backup-and-Restore/CREATE-REPOSITORY.md)。在不同集群使用相同路径的 Repository 进行备份时,请确保使用不同的 Label,以避免冲突造成数据错乱。

### Option 1: 在 S3 上创建 Repository
### 方法 1: 在 S3 上创建 Repository

要在 S3 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -54,9 +54,10 @@ PROPERTIES
- 将 bucket_name 替换为您的 S3 存储桶名称。
- 提供适当的 endpoint、access key、 secret key 和 region 以进行 S3 设置。

### Option 2: 在 Azure 上创建 Repository
### 方法 2: 在 Azure 上创建 Repository

**自 Doris 3.0.4 开始支持**

**2.1.8 以及 3.1.4 开始支持**
要在 Azure 存储上创建 Repository ,请使用以下 SQL 命令:

```sql
Expand All @@ -78,7 +79,7 @@ PROPERTIES
- `s3.region` 只是一个虚假的 region,任意指定一个即可,但是必须要指定。
- `provider` 必须为 `AZURE`。

### Option 3: 在 GCP 上创建 Repository
### 方法 3: 在 GCP 上创建 Repository

要在 Google Cloud Platform (GCP) 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -99,7 +100,7 @@ PROPERTIES
- 提供您的 GCP endpoint、access key 和 secret key。
- `s3.region` 只是一个虚假的 region,任意指定一个即可,但是必须要指定。

### Option 4: 在 OSS(阿里云对象存储服务)上创建 Repository
### 方法 4: 在 OSS(阿里云对象存储服务)上创建 Repository

要在 OSS 上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -118,7 +119,7 @@ PROPERTIES
- 将 bucket_name 替换为您的 OSS 存储桶名称。
- 提供您的 OSS endpoint、region、access key 和 secret key。

### Option 5: 在 MinIO 上创建 Repository
### 方法 5: 在 MinIO 上创建 Repository

要在 MinIO 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -141,7 +142,7 @@ PROPERTIES
- `s3.region` 只是一个虚假的 region,任意指定一个即可,但是必须要指定。
- 如果您不启用 Virtual Host-style,则 'use_path_style' 必须为 true。

### Option 6: 在 HDFS 上创建 Repository
### 方法 6: 在 HDFS 上创建 Repository

要在 HDFS 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -159,13 +160,13 @@ PROPERTIES
- 将 prefix_path 替换为真实路径。
- 提供您的 hdfs endpoint 和用户名。

## 2. 备份
## 第 2 步. 备份

请参考以下语句以备份数据库、表或分区。有关详细用法,请参阅[备份](../../../sql-manual/sql-statements/Data-Definition-Statements/Backup-and-Restore/BACKUP.md)。

建议使用有意义的 Label 名称,例如包含备份中包含的数据库和表。

### Option 1: 备份当前数据库
### 方法 1: 备份当前数据库

以下 SQL 语句将当前数据库备份到名为 `example_repo` 的 Repository ,并使用快照 Label `exampledb_20241225`。

Expand All @@ -174,7 +175,7 @@ BACKUP SNAPSHOT exampledb_20241225
TO example_repo;
```

### Option 2: 备份指定数据库
### 方法 2: 备份指定数据库

以下 SQL 语句将名为 destdb 的数据库备份到名为 `example_repo` 的 Repository ,并使用快照 Label `destdb_20241225`。

Expand All @@ -183,7 +184,7 @@ BACKUP SNAPSHOT destdb.`destdb_20241225`
TO example_repo;
```

### Option 3: 备份指定表
### 方法 3: 备份指定表

以下 SQL 语句将两个表备份到名为 `example_repo` 的 Repository ,并使用快照 Label `exampledb_tbl_tbl1_20241225`。

Expand All @@ -193,7 +194,7 @@ TO example_repo
ON (example_tbl, example_tbl1);
```

### Option 4: 备份指定分区
### 方法 4: 备份指定分区

以下 SQL 语句将名为 `example_tbl2` 的表和名为 `p1` 和 `p2` 的两个分区备份到名为 `example_repo` 的 Repository ,并使用快照 Label `example_tbl_p1_p2_tbl1_20241225`。

Expand All @@ -207,7 +208,7 @@ ON
);
```

### Option 5: 备份当前数据库,排除某些表
### 方法 5: 备份当前数据库,排除某些表

以下 SQL 语句将当前数据库备份到名为 `example_repo` 的 Repository ,并使用快照 Label `exampledb_20241225`,排除两个名为 `example_tbl` 和 `example_tbl1` 的表。

Expand All @@ -221,7 +222,7 @@ EXCLUDE
);
```

## 3. 查看最近备份作业的执行情况
## 第 3 步. 查看最近备份作业的执行情况

以下 SQL 语句可用于查看最近备份作业的执行情况。

Expand All @@ -245,7 +246,7 @@ mysql> show BACKUP\G;
1 row in set (0.01 sec)
```

## 4. 查看 Repository 中的现有备份
## 第 4 步. 查看 Repository 中的现有备份

以下 SQL 语句可用于查看名为 `example_repo` 的 Repository 中的现有备份,其中 Snapshot 列是快照 Label,Timestamp 是时间戳。

Expand All @@ -259,7 +260,7 @@ mysql> SHOW SNAPSHOT ON example_repo;
1 row in set (0.15 sec)
```

## 5. 取消备份(如有需要)
## 第 5 步. 取消备份(如有需要)

可以使用 `CANCEL BACKUP FROM db_name;` 取消一个数据库中的备份任务。更具体的用法可以参考[取消备份](../../../sql-manual/sql-statements/Data-Definition-Statements/Backup-and-Restore/CANCEL-BACKUP.md)。

Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ under the License.

有关备份的概念,请参阅[备份与恢复](./overview.md)。本指南提供了创建 Repository 和备份数据的操作步骤。

## 1. 创建 Repository
## 第 1 步. 创建 Repository

<!--
suites/backup_restore/test_create_and_drop_repository.groovy
-->

根据您的存储选择适当的语句来创建 Repository。有关详细用法,请参阅[创建 Repository ](../../../sql-manual/sql-statements/data-modification/backup-and-restore/CREATE-REPOSITORY.md)。在不同集群使用相同路径的 Repository 进行备份时,请确保使用不同的 Label,以避免冲突造成数据错乱。

### Option 1: 在 S3 上创建 Repository
### 方法 1: 在 S3 上创建 Repository

要在 S3 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -54,31 +54,11 @@ PROPERTIES
- 将 bucket_name 替换为您的 S3 存储桶名称。
- 提供适当的 endpoint、access key、 secret key 和 region 以进行 S3 设置。

### Option 2: 在 Azure 上创建 Repository
### 方法 2: 在 Azure 上创建 Repository

**2.1.8 以及 3.1.4 开始支持**
要在 Azure 存储上创建 Repository ,请使用以下 SQL 命令:
**Doris 2.1 版本不支持在 Azure 上创建**

```sql
CREATE REPOSITORY `azure_repo`
WITH S3
ON LOCATION "s3://bucket_name/azure_repo"
PROPERTIES
(
"s3.endpoint" = "selectdbcloudtestwestus3.blob.core.windows.net",
"s3.region" = "dummy_region",
"s3.access_key" = "ak",
"s3.secret_key" = "sk",
"provider" = "AZURE"
);
```

- 将 bucket_name 替换为您的 Azure 容器名称。
- 提供您的 Azure 存储帐户和密钥以进行身份验证。
- `s3.region` 只是一个虚假的 region,任意指定一个即可,但是必须要指定。
- `provider` 必须为 `AZURE`。

### Option 3: 在 GCP 上创建 Repository
### 方法 3: 在 GCP 上创建 Repository

要在 Google Cloud Platform (GCP) 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -99,7 +79,7 @@ PROPERTIES
- 提供您的 GCP endpoint、access key 和 secret key。
- `s3.region` 只是一个虚假的 region,任意指定一个即可,但是必须要指定。

### Option 4: 在 OSS(阿里云对象存储服务)上创建 Repository
### 方法 4: 在 OSS(阿里云对象存储服务)上创建 Repository

要在 OSS 上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -118,7 +98,7 @@ PROPERTIES
- 将 bucket_name 替换为您的 OSS 存储桶名称。
- 提供您的 OSS endpoint、region、access key 和 secret key。

### Option 5: 在 MinIO 上创建 Repository
### 方法 5: 在 MinIO 上创建 Repository

要在 MinIO 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -141,7 +121,7 @@ PROPERTIES
- `s3.region` 只是一个虚假的 region,任意指定一个即可,但是必须要指定。
- 如果您不启用 Virtual Host-style,则 'use_path_style' 必须为 true。

### Option 6: 在 HDFS 上创建 Repository
### 方法 6: 在 HDFS 上创建 Repository

要在 HDFS 存储上创建 Repository ,请使用以下 SQL 命令:

Expand All @@ -159,13 +139,13 @@ PROPERTIES
- 将 prefix_path 替换为真实路径。
- 提供您的 hdfs endpoint 和用户名。

## 2. 备份
## 第 2 步. 备份

请参考以下语句以备份数据库、表或分区。有关详细用法,请参阅[备份](../../../sql-manual/sql-statements/data-modification/backup-and-restore/BACKUP.md)。

建议使用有意义的 Label 名称,例如包含备份中包含的数据库和表。

### Option 1: 备份当前数据库
### 方法 1: 备份当前数据库

以下 SQL 语句将当前数据库备份到名为 `example_repo` 的 Repository ,并使用快照 Label `exampledb_20241225`。

Expand All @@ -174,7 +154,7 @@ BACKUP SNAPSHOT exampledb_20241225
TO example_repo;
```

### Option 2: 备份指定数据库
### 方法 2: 备份指定数据库

以下 SQL 语句将名为 destdb 的数据库备份到名为 `example_repo` 的 Repository ,并使用快照 Label `destdb_20241225`。

Expand All @@ -183,7 +163,7 @@ BACKUP SNAPSHOT destdb.`destdb_20241225`
TO example_repo;
```

### Option 3: 备份指定表
### 方法 3: 备份指定表

以下 SQL 语句将两个表备份到名为 `example_repo` 的 Repository ,并使用快照 Label `exampledb_tbl_tbl1_20241225`。

Expand All @@ -193,7 +173,7 @@ TO example_repo
ON (example_tbl, example_tbl1);
```

### Option 4: 备份指定分区
### 方法 4: 备份指定分区

以下 SQL 语句将名为 `example_tbl2` 的表和名为 `p1` 和 `p2` 的两个分区备份到名为 `example_repo` 的 Repository ,并使用快照 Label `example_tbl_p1_p2_tbl1_20241225`。

Expand All @@ -207,7 +187,7 @@ ON
);
```

### Option 5: 备份当前数据库,排除某些表
### 方法 5: 备份当前数据库,排除某些表

以下 SQL 语句将当前数据库备份到名为 `example_repo` 的 Repository ,并使用快照 Label `exampledb_20241225`,排除两个名为 `example_tbl` 和 `example_tbl1` 的表。

Expand All @@ -221,7 +201,7 @@ EXCLUDE
);
```

## 3. 查看最近备份作业的执行情况
## 第 3 步. 查看最近备份作业的执行情况

以下 SQL 语句可用于查看最近备份作业的执行情况。

Expand All @@ -245,7 +225,7 @@ mysql> show BACKUP\G;
1 row in set (0.01 sec)
```

## 4. 查看 Repository 中的现有备份
## 第 4 步. 查看 Repository 中的现有备份

以下 SQL 语句可用于查看名为 `example_repo` 的 Repository 中的现有备份,其中 Snapshot 列是快照 Label,Timestamp 是时间戳。

Expand All @@ -259,7 +239,7 @@ mysql> SHOW SNAPSHOT ON example_repo;
1 row in set (0.15 sec)
```

## 5. 取消备份(如有需要)
## 第 5 步. 取消备份(如有需要)

可以使用 `CANCEL BACKUP FROM db_name;` 取消一个数据库中的备份任务。更具体的用法可以参考[取消备份](../../../sql-manual/sql-statements/data-modification/backup-and-restore/CANCEL-BACKUP.md)。

Loading
Loading