This is an automated email from the ASF dual-hosted git repository.
kirs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8b0256df4e8 Master new catalog (#2666)
8b0256df4e8 is described below
commit 8b0256df4e85bae598eb195456f14db826ea5f4f
Author: Calvin Kirs <[email protected]>
AuthorDate: Mon Aug 4 16:10:52 2025 +0800
Master new catalog (#2666)
## Versions
- [x] dev
- [ ] 3.0
- [ ] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [ ] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
.../current/lakehouse/metastores/aliyun-dlf.md | 69 ++++++--
.../current/lakehouse/metastores/aws-glue.md | 137 ++++++++++-----
.../current/lakehouse/metastores/hive-metastore.md | 187 ++++++++++++++-------
.../current/lakehouse/metastores/s3tables.md | 75 +++++++++
.../current/lakehouse/storages/aliyun-oss.md | 95 ++++++++---
.../current/lakehouse/storages/huawei-obs.md | 79 ++++++---
.../current/lakehouse/storages/s3.md | 137 ++++++++++-----
7 files changed, 581 insertions(+), 198 deletions(-)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aliyun-dlf.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aliyun-dlf.md
index 13af756e6e5..0acb51769c3 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aliyun-dlf.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aliyun-dlf.md
@@ -5,14 +5,63 @@
}
---
-本文档用于介绍通过 `CREATE CATALOG` 语句连接并访问阿里云 DLF 时所支持的参数。
-
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-| --------------- | -------------- |
--------------------------------------------------------------------------------------
| --- | ---- |
-| `dlf.endpoint` | | DLF
endpoint,参阅:https://www.alibabacloud.com/help/en/dlf/dlf-1-0/regions-and-endpoints
| | 是 |
-| `dlf.region` | | DLF
region,参阅:https://www.alibabacloud.com/help/en/dlf/dlf-1-0/regions-and-endpoints
| | 是 |
-| `dlf.uid` | | 阿里云账号。即阿里云控制台右上角个人信息的“云账号 ID”。
| | 是 |
-| `dlf.access_key` | | DLF access key。可以在
[阿里云控制台](https://ram.console.aliyun.com/manage/ak) 中创建和管理。 | | 是
|
-| `dlf.secret_key` | | DLF secret key。可以在
[阿里云控制台](https://ram.console.aliyun.com/manage/ak) 中创建和管理。 | | 是
|
-| `dlf.catalog_id` | dlf.catalog.id | Catalog Id。用于指定数据目录,如果不填,使用默认的 Catalog
ID。 | | 否 |
+# 阿里云 DLF Catalog 参数配置文档(Hive 表)
+
+本文档介绍如何使用 `CREATE CATALOG` 语句连接并访问 **阿里云 DLF** 中的 **Hive 表**,以及所需的参数说明。
+
+---
+
+## 一、支持类型
+
+目前 DLF Catalog 仅支持 Hive 表
+
+---
+
+## 二、Hive 表配置示例(DLF Catalog)
+
+以下为使用 DLF 作为 Hive Metastore 创建 Catalog 的示例:
+
+```sql
+CREATE CATALOG hive_dlf_catalog WITH (
+ 'type' = 'hms',
+ 'hive.metastore.type' = 'dlf',
+ 'dlf.endpoint' = '<DLF_ENDPOINT>',
+ 'dlf.region' = '<DLF_REGION>',
+ 'dlf.uid' = '<YOUR_ALICLOUD_UID>',
+ 'dlf.access_key' = '<YOUR_ACCESS_KEY>',
+ 'dlf.secret_key' = '<YOUR_SECRET_KEY>'
+);
+```
+
+---
+
+## 三、认证方式说明
+
+DLF Catalog 当前仅支持通过 **AccessKey/SecretKey** 的方式进行认证。必须提供以下参数:
+
+| 参数名称 | 描述
| 是否必须 |
+|--------------------|----------------------------------------------------------------------|----------|
+| `dlf.access_key` | 阿里云 AccessKey。可在 [RAM
控制台](https://ram.console.aliyun.com/manage/ak) 获取。 | 是 |
+| `dlf.secret_key` | 阿里云 SecretKey。与 AccessKey 配套使用。
| 是 |
+
+---
+
+## 四、参数总览(Hive)
+
+| 参数名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
+|---------------------|------------------|------------------------------------------------------------------------------------------|--------|----------|
+| `dlf.endpoint` | | DLF
endpoint,详见:[阿里云文档](https://www.alibabacloud.com/help/en/dlf/dlf-1-0/regions-and-endpoints)
| 无 | 是 |
+| `dlf.region` | | DLF
region,详见:[阿里云文档](https://www.alibabacloud.com/help/en/dlf/dlf-1-0/regions-and-endpoints)
| 无 | 是 |
+| `dlf.uid` | | 阿里云账号 ID。可在控制台右上角个人信息查看。
| 无 | 是 |
+| `dlf.access_key` | | 阿里云 AccessKey,用于访问 DLF 服务。
| 无 | 是 |
+| `dlf.secret_key` | | 阿里云 SecretKey,用于访问 DLF 服务。
| 无 | 是 |
+| `dlf.catalog_id` | `dlf.catalog.id` | Catalog ID。用于指定元数据目录,如果不设置则使用默认目录。
| 无 | 否 |
+
+---
+
+## 五、注意事项
+
+- 当前 DLF Catalog 仅支持 Hive 表。
+- 请确保您的 AccessKey/SecretKey 拥有访问 DLF 和 Hive 元数据服务的权限。
+- `dlf.catalog_id` 暂非必需,仅当使用多个 Catalog 时使用。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aws-glue.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aws-glue.md
index 5679d3a957d..c1fea3813e1 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aws-glue.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/aws-glue.md
@@ -5,25 +5,44 @@
}
---
+# Glue Catalog 参数文档
+
本文档介绍通过 `CREATE CATALOG` 使用 **AWS Glue Catalog** 访问 **Iceberg 表** 或 **Hive 表**
时的参数配置。
-## 通用连接参数(适用于 Hive & Iceberg)
+---
+
+## 一、Glue Catalog 支持的类型
+
+AWS Glue Catalog 当前支持两种类型的 Catalog:
+
+| Catalog 类型 | 类型标识 (`type`) | 描述 |
+|--------------|---------------|-------------------------------------|
+| Hive | glue | 对接 Hive Metastore 的 Catalog |
+| Iceberg | glue | 对接 Iceberg 表格式 |
-以下参数适用于 **Iceberg Glue Catalog** 和 **Hive Glue Catalog**:
-| 属性名称 | 描述
| 是否必须 | 默认值 |
-|--------------------|----------------------------------------------------------------------|----------|--------|
-| `glue.region` | AWS Glue 区域,例如:`us-east-1`
| 是 | 无 |
-| `glue.endpoint` | AWS Glue
endpoint,例如:`https://glue.us-east-1.amazonaws.com` | 是 | 无 |
-| `glue.access_key` | AWS Access Key ID
| 是 | 空 |
-| `glue.secret_key` | AWS Secret Access Key
| 是 | 空 |
-| `glue.catalog_id` | Glue Catalog ID(尚未支持)
| 否 | |
-| `glue.role_arn` | 用于访问 Glue 的 IAM Role ARN(尚未支持)
| 否 | |
-| `glue.external_id` | 与 IAM Role 配合使用的 External ID(尚未支持)
| 否 | |
+本说明文档分别对这两种类型的参数进行详细介绍,便于用户配置。
-## Iceberg 表配置(使用 Glue Catalog)
+---
+
+## 二、Iceberg Glue Catalog 参数总揽
+
+Iceberg Glue Catalog 用于访问 Iceberg 表,必须配置以下参数:
-配置示例:
+| 参数名称 | 描述
| 是否必须 | 默认值 |
+|---------------------------|-------------------------------------------------------------------------|----------|---------|
+| `type` | 固定为 `iceberg`
| 是 | 无 |
+| `iceberg.catalog.type` | 固定为 `glue`
| 是 | 无 |
+| `warehouse` | Iceberg
数据仓库路径,例如:`s3://my-bucket/iceberg-warehouse/` | 是 | s3://doris
|
+| `glue.region` | AWS Glue 所在区域,例如:`us-east-1`
| 是 | 无 |
+| `glue.endpoint` | AWS Glue
endpoint,例如:`https://glue.us-east-1.amazonaws.com` | 是 | 无 |
+| `glue.access_key` | AWS Access Key ID
| 是 | 空 |
+| `glue.secret_key` | AWS Secret Access Key
| 是 | 空 |
+| `glue.catalog_id` | Glue Catalog ID(暂未支持)
| 否 | 空 |
+| `glue.role_arn` | IAM Role ARN,用于访问 Glue(暂未支持)
| 否 | 空 |
+| `glue.external_id` | IAM External ID,用于访问 Glue(暂未支持)
| 否 | 空 |
+
+### Iceberg Glue Catalog 示例
```sql
CREATE CATALOG iceberg_glue_catalog WITH (
@@ -38,9 +57,43 @@ CREATE CATALOG iceberg_glue_catalog WITH (
---
-## 三、Hive 表配置(使用 Glue 作为 HMS)
+## 三、Hive Glue Catalog 参数总揽
+
+Hive Glue Catalog 用于访问 Hive 表,通过 AWS Glue 作为 Hive Metastore 服务,必须配置以下参数:
-配置示例:
+| 参数名称 | 描述
| 是否必须 | 默认值 |
+|-----------------------------------|--------------------------------------------------------------------------------------------------|----------|---------|
+| `type` | 固定为 `hms`
| 是 | 无 |
+| `hive.metastore.type` | 固定为 `glue`
| 是 | 无 |
+| `glue.region` | AWS Glue 所在区域,例如:`us-east-1`
| 是 | 无 |
+| `glue.endpoint` | AWS Glue
endpoint,例如:`https://glue.us-east-1.amazonaws.com`
| 是 | 无 |
+| `glue.access_key` | AWS Access Key ID
| 是 | 空 |
+| `glue.secret_key` | AWS Secret Access Key
| 是 | 空 |
+| `glue.catalog_id` | Glue Catalog ID(暂未支持)
| 否 | 空 |
+| `glue.role_arn` | IAM Role ARN,用于访问 Glue(暂未支持)
| 否 | 空 |
+| `glue.external_id` | IAM External ID,用于访问 Glue(暂未支持)
| 否 | 空 |
+
+### Hive Glue Catalog 缓存参数(仅 Hive Glue 有效,默认关闭)
+
+#### 表缓存
+
+| 参数名称 | 描述 | 默认值 |
+|----------------------------------|------------------------------|---------|
+| `aws.glue.cache.table.enable` | 是否启用表缓存 | `false` |
+| `aws.glue.cache.table.size` | 表缓存最大条目数 | `1000` |
+| `aws.glue.cache.table.ttl-mins` | 表缓存存活时间(分钟) | `30` |
+
+#### 数据库缓存
+
+| 参数名称 | 描述 | 默认值 |
+|-------------------------------|------------------------------|---------|
+| `aws.glue.cache.db.enable` | 是否启用数据库缓存 | `false` |
+| `aws.glue.cache.db.size` | 数据库缓存最大条目数 | `1000` |
+| `aws.glue.cache.db.ttl-mins` | 数据库缓存存活时间(分钟) | `30` |
+
+---
+
+### Hive Glue Catalog 示例
```sql
CREATE CATALOG hive_glue_catalog WITH (
@@ -55,38 +108,46 @@ CREATE CATALOG hive_glue_catalog WITH (
---
-## 四、Hive Glue Catalog 专属参数
+## 四、Glue Catalog 认证方式说明
-以下配置 **仅适用于 Hive Glue Catalog**,用于控制 Hive 使用 AWS Glue Metastore 客户端的行为。
+访问 AWS Glue Catalog 需要进行身份认证,目前支持的两种方式如下(**当前仅支持方式一**):
+### 方式一:使用 Access Key / Secret Key(已支持 ✅)
-### Glue 客户端缓存参数(**默认关闭**)
+通过设置 `glue.access_key` 和 `glue.secret_key` 来进行静态身份认证。
-Glue 客户端提供元数据缓存(**仅支持 Hive Glue**):
+| 参数名称 | 描述 | 是否必须 | 示例
|
+|--------------------|--------------------------------------|----------|--------------------------------|
+| `glue.access_key` | AWS Access Key ID,用于身份验证 | 是 |
`AKIA***************` |
+| `glue.secret_key` | AWS Secret Access Key | 是 |
`wJalrXUtnFEMI/K7MDENG/bPxRfi` |
-#### - 表缓存(Table Metadata Cache)
+#### 适用场景:
+- 本地测试、开发环境
+- 运行环境中没有统一的 IAM Role 授权管理
+- 快速集成使用
-| 参数名称 | 描述 | 默认值 |
-|----------------------------------|-------------------------------------|---------|
-| `aws.glue.cache.table.enable` | 是否启用表缓存 | `false` |
-| `aws.glue.cache.table.size` | 表缓存的最大条目数 | `1000` |
-| `aws.glue.cache.table.ttl-mins` | 表缓存的存活时间(分钟) | `30` |
+#### 注意事项:
+- AK/SK 具有权限管理风险,建议避免硬编码到代码或配置文件中。
+- 在生产环境中推荐使用 IAM Role 的方式替代。
+
+---
-#### - 数据库缓存(Database Metadata Cache)
+### 方式二:使用 IAM Role(暂未支持 ❌)
-| 参数名称 | 描述 | 默认值 |
-|-------------------------------|---------------------------------------|---------|
-| `aws.glue.cache.db.enable` | 是否启用数据库缓存 | `false` |
-| `aws.glue.cache.db.size` | 数据库缓存的最大条目数 | `1000` |
-| `aws.glue.cache.db.ttl-mins` | 数据库缓存的存活时间(分钟) | `30` |
+通过配置 `glue.role_arn` 和 `glue.external_id`,授权当前程序以某个角色的身份访问 Glue。
-参考:
-- [GetTable
API](https://docs.aws.amazon.com/glue/latest/webapi/API_GetTable.html)
-- [GetDatabase
API](https://docs.aws.amazon.com/glue/latest/webapi/API_GetDatabase.html)
+| 参数名称 | 描述 | 是否必须
| 示例 |
+|--------------------|--------------------------------------------------------|----------|----------------------------------------------------------------------|
+| `glue.role_arn` | 目标 IAM Role 的 ARN(Amazon Resource Name) |
是(若启用此方式) | `arn:aws:iam::123456789012:role/MyGlueAccessRole` |
+| `glue.external_id` | 外部 ID,通常用于跨账号访问 Glue,防止角色被滥用 | 否 |
`external-glue-id-abc123` |
+#### 适用场景:
+- 生产环境中使用 **IAM Role 访问策略**进行权限管理
+- 支持 **跨 AWS 账号** 的 Glue Catalog 访问
+- 避免将 AK/SK 暴露在配置中,更加安全可靠
-## 注意事项
+#### 注意事项:
+- 当前此方式尚未在系统中实现,仅作参数预留。
+- 启用此方式后,将忽略 `glue.access_key` 和 `glue.secret_key` 配置。
+- 未来支持后可作为企业级 Glue 接入的推荐方式。
-- 如果你使用的是 **Iceberg 表**,只需关注 **通用连接参数**。
-- 如果你使用的是 **Hive 表** 并将 Glue 作为 Hive Metastore,需额外配置 Hive Glue 专属参数。
-- **缓存机制目前仅在 Hive Glue 场景下有效**,Iceberg Glue Catalog 不使用这些参数。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/hive-metastore.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/hive-metastore.md
index 072a2499403..7bb58e050cb 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/hive-metastore.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/hive-metastore.md
@@ -4,87 +4,154 @@
"language": "zh-CN"
}
---
+# 使用 `CREATE CATALOG` 连接外部元数据服务的参数说明
-本文档用于介绍通过 `CREATE CATALOG` 语句连接并访问 Hive Metastore 时所支持的参数。
-## 参数总览
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-|--------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------|
-| `hive.metastore.uris` | | Hive Metastore 的 URI 地址。支持指定多个
URI,使用逗号分隔。默认使用第一个 URI,当第一个 URI 不可用时,会尝试使用其他的。如:`thrift://172.0.0.1:9083` 或
`thrift://172.0.0.1:9083,thrift://172.0.0.2:9083`
| 无 | 是 |
-| `hive.conf.resources` | | hive-site.xml 文件位置,用于从
hive-site.xml 文件中加载连接 HMS 所需参数,若 hive-site.xml 文件包含完整的链接参数信息,则可仅填写此参数。配置文件必须放在
FE 部署目录,默认目录为部署目录下的 `/plugins/hadoop_conf/`(可修改 fe.conf 中的 `hadoop_config_dir`
来更改默认路径),文件位置需要为相对路径,如 hms-1/hive-site.xml。且所有 FE 节点都必须含有此文件。 | 空 | 否 |
-| `hive.metastore.authentication.type` | | Hive Metastore 的认证方式。支持 `simple` 和
`kerberos` 两种。在 2.1 及之前版本中,认证方式由`hadoop.security.authentication`属性决定。3.0
版本开始,可以单独指定 Hive Metastore 的认证方式。
| simple | 否 |
-| `hive.metastore.service.principal` | | 当认证方式为 kerberos 时,用于指定 Hive
Metastore 服务端的 principal。
| 空 | 否 |
-| `hive.metastore.client.principal` | | 当认证方式为 kerberos 时,用于指定 Hive
Metastore 客户端的 principal。在 2.1 及之前版本中,该参数由`hadoop.kerberos.principal`属性决定。
| 空 | 否 |
-| `hive.metastore.client.keytab` | | 当认证方式为 kerberos 时,用于指定 Hive
Metastore 客户端的 keytab。keytab 文件必须要放置到所有 FE 节点的相同目录下。
| 空 | 否 |
+本文档用于介绍通过 `CREATE CATALOG` 语句连接并访问外部元数据服务时支持的所有参数,当前支持 Hive、Iceberg 和 Paimon
三种 Catalog 类型。
-## 认证参数
-在 Hive Metastore 中,有两种认证方式:simple 和 kerberos。
+## ✅ 当前支持的 Catalog 类型
+
+| Catalog 类型 | 类型标识 (`type`) | 描述 |
+|--------------|---------------------|-------------------------------------|
+| Hive | `hms` | 对接 Hive Metastore 的 Catalog |
+| Iceberg | `iceberg_hms` / `iceberg_rest` | 对接 Iceberg 表格式
|
+| Paimon | `paimon` | 对接 Apache Paimon 表格式 |
+
+---
+
+# 一、Hive Catalog
+
+Hive Catalog 用于连接 Hive Metastore,并读取 Hive 表信息。支持 Kerberos 认证。
+
+## 📋 参数总揽
+
+| 参数名称 | 是否必须 | 默认值 | 简要描述
|
+|--------------------------------------|----------|----------|--------------------------------------------------------------|
+| `type` | ✅ 是 | 无 | Catalog 类型,Hive
固定为 `hms` |
+| `hive.metastore.uris` | ✅ 是 | 无 | Hive Metastore 的
URI 地址 |
+| `hive.conf.resources` | 否 | 空 | hive-site.xml
配置文件相对路径 |
+| `hive.metastore.authentication.type` | 否 | simple | Metastore
认证方式,支持 `simple` 或 `kerberos` |
+| `hive.metastore.service.principal` | 否 | 空 | Kerberos 服务端
principal |
+| `hive.metastore.client.principal` | 否 | 空 | Kerberos 客户端
principal |
+| `hive.metastore.client.keytab` | 否 | 空 | Kerberos 客户端
keytab 文件路径 |
+
+## 📖 参数详细说明
+
+### `type`
+Catalog 类型,Hive 固定为 `hms`
+示例:`"type" = "hms"`
+
+### `hive.metastore.uris`
+Hive Metastore 的 URI 地址,支持多个逗号分隔
+示例:`"hive.metastore.uris" = "thrift://127.0.0.1:9083"`
+
+### `hive.conf.resources`
+hive-site.xml 配置文件路径,默认目录为 `/plugins/hadoop_conf/`
+示例:`"hive.conf.resources" = "hms-1/hive-site.xml"`
### `hive.metastore.authentication.type`
+认证方式:`simple`(默认)或 `kerberos`,在 3.0
及之前版本中,认证方式由`hadoop.security.authentication`属性决定。3.1 版本开始,可以单独指定 Hive Metastore
的认证方式。
+示例:`"hive.metastore.authentication.type" = "kerberos"`
-- 描述
- 指定 Hive Metastore 的认证方式。
+### `hive.metastore.service.principal`
+Hive 服务端 principal,支持 `_HOST` 占位符
+示例:`"hive.metastore.service.principal" = "hive/[email protected]"`
-- 可选值
- - `simple`(默认): 即不使用任何认证。
- - `kerberos`: 启用 Kerberos 认证
+### `hive.metastore.client.principal`
+客户端 principal(Kerberos 模式)
+示例:`"hive.metastore.client.principal" = "doris/[email protected]"`
-- 版本差异
- - 2.1 及之前版本:依赖全局参数 `hadoop.security.authentication`
- - 3.1+ 版本:可独立配置
+### `hive.metastore.client.keytab`
+keytab 文件路径,所有 FE 节点均需存在
+示例:`"hive.metastore.client.keytab" = "conf/doris.keytab"`
-### 启用 Simple 认证相关参数
-直接指定 `hive.metastore.authentication.type = simple` 即可。**生产环境不建议使用此方式**
+## ✅ 示例:Hive Catalog(Kerberos)
-#### 完整示例
-```plaintext
-"hive.metastore.authentication.type" = "simple"
```
+CREATE CATALOG hive_catalog WITH (
+ "type" = "hms",
+ "hive.metastore.uris" = "thrift://127.0.0.1:9083",
+ "hive.metastore.authentication.type" = "kerberos",
+ "hive.metastore.service.principal" = "hive/[email protected]",
+ "hive.metastore.client.principal" = "doris/[email protected]",
+ "hive.metastore.client.keytab" = "conf/doris.keytab"
+);
+```
+
+---
-### 启用 Kerberos 认证相关参数
+# 二、Iceberg Catalog
-#### `hive.metastore.service.principal`
-- 描述
- Hive Metastore 服务的 Kerberos 主体,用于 Doris 验证 Metastore 身份。
+支持使用 Hive Metastore。
-- 占位符支持
- `_HOST` 会自动替换为实际连接的 Metastore 主机名(适用于多节点 Metastore 集群)。
+## 📋 参数总揽
-- 示例
- ```plaintext
- hive/[email protected]
- hive/[email protected] # 动态解析实际主机名
- ```
+| 参数名称 | 是否必须 | 默认值 | 简要描述
|
+|--------------------------------------|----------|----------------|-----------------------------------------|
+| `type` | ✅ 是 | 无 | Catalog
类型:固定为 `iceberg` |
+| `iceberg.catalog.type` | ✅ 是 | 无 | Mestadata
Catalog 类型,固定为 `hms` |
+| `warehouse` | ✅ 是 | 无 | Iceberg 仓库路径
|
+| `hive.metastore.uris` | ✅ 是 | 无 | Hive Metastore 的
URI 地址 |
+| `hive.conf.resources` | 否 | 空 | hive-site.xml
配置文件相对路径 |
+| `hive.metastore.authentication.type` | 否 | simple | Metastore
认证方式,支持 `simple` 或 `kerberos` |
+| `hive.metastore.service.principal` | 否 | 空 | Kerberos 服务端
principal |
+| `hive.metastore.client.principal` | 否 | 空 | Kerberos 客户端
principal |
+| `hive.metastore.client.keytab` | 否 | 空 | Kerberos 客户端
keytab 文件路径 |
-#### `hive.metastore.client.principal`
-- 描述
- 连接到 Hive MeteStore 服务时使用的 Kerberos 主体。例如:`doris/[email protected]` 或
`doris/[email protected]`。
-- 占位符支持
- `_HOST` 会自动替换为实际连接的 Metastore 主机名(适用于多节点 Metastore 集群)。
+### `type`
+Catalog 类型,Hive 固定为 `hms`
+示例:`"type" = "hms"`
-- 示例
- ```plaintext
- doris/[email protected]
- doris/[email protected] # 动态解析实际主机名
- ```
+### `hive.metastore.uris`
+Hive Metastore 的 URI 地址,支持多个逗号分隔
+示例:`"hive.metastore.uris" = "thrift://127.0.0.1:9083"`
-#### `hive.metastore.client.keytab`
-- 描述
- 包含指定的 principal 的密钥的密钥表文件的路径。运行所有 FE 的操作系统用户必须有权限读取此文件。
+### `hive.conf.resources`
+hive-site.xml 配置文件路径,默认目录为 `/plugins/hadoop_conf/`
+示例:`"hive.conf.resources" = "hms-1/hive-site.xml"`
-- 示例
- ```plaintext
- "hive.metastore.client.keytab" = "conf/doris.keytab"
- ```
+### `hive.metastore.authentication.type`
+认证方式:`simple`(默认)或 `kerberos`,在 3.0
及之前版本中,认证方式由`hadoop.security.authentication`属性决定。3.1 版本开始,可以单独指定 Hive Metastore
的认证方式。
+示例:`"hive.metastore.authentication.type" = "kerberos"`
+
+### `hive.metastore.service.principal`
+Hive 服务端 principal,支持 `_HOST` 占位符
+示例:`"hive.metastore.service.principal" = "hive/[email protected]"`
-#### 完整示例
+### `hive.metastore.client.principal`
+客户端 principal(Kerberos 模式)
+示例:`"hive.metastore.client.principal" = "doris/[email protected]"`
-启用 Kerberos 认证
+### `hive.metastore.client.keytab`
+keytab 文件路径,所有 FE 节点均需存在
+示例:`"hive.metastore.client.keytab" = "conf/doris.keytab"`
-```plaintext
-"hive.metastore.authentication.type" = "kerberos",
-"hive.metastore.service.principal" = "hive/[email protected]",
-"hive.metastore.client.principal" = "doris/[email protected]",
-"hive.metastore.client.keytab" = "etc/doris/conf/doris.keytab"
+## ✅ 示例
+
+```
+CREATE CATALOG iceberg_catalog WITH (
+ "type" = "iceberg_hms",
+ "iceberg.hive.metastore.uris" = "thrift://127.0.0.1:9083",
+ "warehouse" = "hdfs:///user/hive/warehouse"
+ ----
+ Standard Hive Metastore parameters
+);
```
+
+---
+
+# 三、Paimon Catalog
+
+补充中
+
+
+---
+
+# 四、常见问题 FAQ
+
+**Q1:** hive-site.xml 是必须的吗?
+不是,仅当需要从中读取链接配置时使用。
+
+**Q2:** keytab 文件是否必须每个节点都存在?
+是的,所有 FE 节点必须可访问指定路径。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/s3tables.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/s3tables.md
new file mode 100644
index 00000000000..1c8dd149443
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/metastores/s3tables.md
@@ -0,0 +1,75 @@
+---
+{
+ "title": "S3 Tables",
+ "language": "zh-CN"
+}
+---
+
+# S3tables Catalog (Iceberg)
+
+本文档介绍如何通过 `CREATE CATALOG` 使用 Iceberg 的 `S3tables` Catalog,使用 S3 作为元数据存储。
+
+## 支持的表类型
+
+该 Catalog 类型支持 [Apache Iceberg](https://iceberg.apache.org/) 表。
+
+## 参数总览
+
+| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
+|-------------------------------------|--------|------------------------------------------------------------|------------|----------|
+| `s3.region` | | S3
所在的区域,例如:`us-east-1`。强烈建议配置 | 无 | 否 |
+| `s3.endpoint` | | S3
服务访问地址,例如:`s3.us-east-1.amazonaws.com` | 无 | ✅ 是 |
+| `s3.access_key` | | AWS Access Key。用于基础身份验证
| 无 | ✅ 是* |
+| `s3.secret_key` | | AWS Secret Key。用于基础身份验证
| 无 | ✅ 是* |
+| `s3.role_arn` | | 使用 Assume Role 模式时指定的角色 ARN
| 无 | 否 |
+| `s3.external_id` | | 配合 `s3.role_arn` 使用的 external
ID,用于增强安全性 | 无 | 否 |
+| `s3.use_path_style` | | 是否使用 path-style(路径风格)访问。默认是
virtual-host 风格 | `false` | 否 |
+| `s3.connection.maximum` | | 最大连接数,适用于高并发场景
| `50` | 否 |
+| `s3.connection.request.timeout` | | 请求超时时间(毫秒),控制连接池中获取连接的等待超时
| `3000` | 否 |
+| `s3.connection.timeout` | | 建立连接的超时时间(毫秒)
| `1000` | 否 |
+> ✅ *说明:若使用 Assume Role 模式,则可省略 `s3.access_key` 和 `s3.secret_key`。
+
+## 认证方式
+
+S3tables Catalog 支持两种认证方式:
+
+### 1. Access Key 模式(推荐测试环境使用)
+
+通过配置 `s3.access_key` 和 `s3.secret_key` 实现基础认证,适用于本地或开发环境快速接入。
+
+### 2. Assume Role 模式(推荐生产环境)
+
+通过配置 `s3.role_arn` 和 `s3.external_id`,使用 IAM 角色授权方式访问
S3。适用于生产场景下的跨账户授权、安全性要求更高的环境。
+
+- `s3.role_arn`:要 Assume 的目标 IAM Role ARN。
+- `s3.external_id`:与 Role 配合的 external ID,用于增强安全性。
+
+
+## 示例
+
+```sql
+CREATE CATALOG s3_iceberg_catalog WITH (
+ 'type' = 'iceberg',
+ 'type' = 'iceberg',
+ 'iceberg.catalog.type' = 's3tables',
+ 'warehouse' = 's3://my-bucket/warehouse',
+ 's3.endpoint' = 's3.us-east-1.amazonaws.com',
+ 's3.region' = 'us-east-1',
+ 's3.access_key' = 'YOUR_ACCESS_KEY',
+ 's3.secret_key' = 'YOUR_SECRET_KEY'
+);
+```
+
+或使用 IAM Role:
+
+```sql
+CREATE CATALOG s3_iceberg_catalog WITH (
+ 'type' = 'iceberg',
+ 'iceberg.catalog.type' = 's3tables',
+ 'warehouse' = 's3://my-bucket/warehouse',
+ 's3.endpoint' = 's3.us-east-1.amazonaws.com',
+ 's3.region' = 'us-east-1',
+ 's3.role_arn' = 'arn:aws:iam::123456789012:role/my-role',
+ 's3.external_id' = 'my-external-id'
+);
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/aliyun-oss.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/aliyun-oss.md
index 49f4ed3be95..b67f837c245 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/aliyun-oss.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/aliyun-oss.md
@@ -14,35 +14,76 @@
- Outfile 属性
**Doris 使用 S3 Client,通过 S3 兼容协议访问阿里云 OSS。**
-
## 参数总览
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-|---------------------------------|------------------|----------------------------------------------------------------|--------|------|
-| `s3.endpoint` | `oss.endpoint` | OSS endpoint,指定阿里云 OSS
的访问端点。注意,OSS 和 OSS HDFS 的 endpoint 不相同。 | | 是 |
-| `s3.region` | `oss.region` | OSS region,指定阿里云 OSS
的区域 | | 否 |
-| `s3.access_key` | `oss.access_key` | OSS access key,用于身份验证的
OSS 访问密钥 | | 是 |
-| `s3.secret_key` | `oss.secret_key` | OSS secret key,与 access
key 配合使用的访问密钥 | | 是 |
-| `s3.connection.maximum` | | S3 最大连接数,指定与 OSS
服务建立的最大连接数 | `50` | 否 |
-| `s3.connection.request.timeout` | | S3 请求超时时间,单位为毫秒,指定连接
OSS 服务时的请求超时时间 | `3000` | 否 |
-| `s3.connection.timeout` | | S3 连接超时时间,单位为毫秒,指定与 OSS
服务建立连接时的超时时间 | `1000` | 否 |
-| `s3.sts_endpoint` | | 尚未支持
| | 否 |
-| `s3.sts_region` | | 尚未支持
| | 否 |
-| `s3.iam_role` | | 尚未支持
| | 否 |
-| `s3.external_id` | | 尚未支持
| | 否 |
-
-### 认证配置
-访问阿里云 OSS 时,需要提供阿里云的 Access Key 和 Secret Key,即下列参数:
-
-- `s3.access_key` (或 `oss.access_key`)
-- `s3.secret_key` (或 `oss.secret_key`)
-
-### 示例配置
-
-```plaintext
-"oss.access_key" = "ak",
-"oss.secret_key" = "sk",
-"oss.endpoint" = "oss-cn-beijing.aliyuncs.com",
+| 属性名称 | 曾用名 | 描述
| 默认值 |
是否必须 |
+|----------------------------------|---------------------|-------------------------------------------------------------------------------------------|----------|----------|
+| `oss.endpoint` | `s3.endpoint` | OSS endpoint,指定阿里云
OSS 的访问端点。注意,OSS 和 OSS HDFS 的 endpoint 不相同。 | 无 | ✅ 是
|
+| `oss.region` | `s3.region` | OSS region,指定阿里云
OSS 的区域 | 无 | 否
|
+| `oss.access_key` | `s3.access_key` | OSS Access
Key,用于身份验证 | 无
| ✅ 是 |
+| `oss.secret_key` | `s3.secret_key` | OSS Secret Key,与
Access Key 配合使用 | 无 |
✅ 是 |
+| `oss.use_path_style` | `s3.use_path_style` | 是否使用
path-style(路径风格)访问。兼容 MinIO/Ceph 等非 AWS S3 服务建议设置为 true | `false` | 否 |
+| `oss.connection.maximum` | | 最大连接数,指定与 OSS
服务建立的最大连接数 | `50` | 否
|
+| `oss.connection.request.timeout` | | 请求超时时间(毫秒),指定连接 OSS
服务时的请求超时时间 | `3000` | 否 |
+| `oss.connection.timeout` | | 连接超时时间(毫秒),指定与 OSS
服务建立连接时的超时时间 | `1000` | 否 |
+
+---
+
+## 1. 认证配置(必填)
+
+访问阿里云 OSS 需要提供以下参数:
+
+- `oss.access_key` (兼容曾用名 `s3.access_key`)
+- `oss.secret_key` (兼容曾用名 `s3.secret_key`)
+
+---
+
+## 2. 示例配置
+
+```properties
+"oss.access_key" = "your-access-key"
+"oss.secret_key" = "your-secret-key"
+"oss.endpoint" = "oss-cn-beijing.aliyuncs.com"
"oss.region" = "cn-beijing"
```
+> ⚠️ 曾用名示例(兼容历史配置):
+> ```properties
+> "s3.access_key" = "your-access-key"
+> "s3.secret_key" = "your-secret-key"
+> "s3.endpoint" = "oss-cn-beijing.aliyuncs.com"
+> "s3.region" = "cn-beijing"
+> ```
+
+---
+
+## 3. 连接及超时参数(可选)
+
+| 参数 | 说明 | 默认值 |
+|-------------------------------|------------------------------------|----------|
+| `oss.connection.maximum` | 最大连接数 | `50` |
+| `oss.connection.request.timeout` | 请求超时时间,单位毫秒 | `3000` |
+| `oss.connection.timeout` | 连接超时时间,单位毫秒 | `1000` |
+
+---
+
+## 4. 其他参数说明
+
+目前 Doris 对以下参数暂未支持:
+
+- `oss.sts_endpoint`
+- `oss.sts_region`
+- `oss.iam_role`
+- `oss.external_id`
+
+---
+
+## 5. 使用建议
+
+- **推荐使用 `oss.` 前缀配置参数**,保证与阿里云 OSS 的一致性和清晰度。
+- 曾用名 `s3.` 仍然兼容,方便历史配置平滑迁移。
+- 配置 `oss.region` 能提升访问的准确性和性能,建议设置。
+- 连接池参数可根据并发需求调整,避免连接阻塞。
+
+---
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/huawei-obs.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/huawei-obs.md
index 39eb62bfcee..c1eabc41157 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/huawei-obs.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/huawei-obs.md
@@ -14,33 +14,72 @@
- Outfile 属性
**Doris 使用 S3 Client,通过 S3 兼容协议访问华为云 OBS。**
-
## 参数总览
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-|---------------------------------|------------------|---------------------------------------|--------|------|
-| `s3.endpoint` | `obs.endpoint` | OBS endpoint,指定华为云 OBS
的访问端点 | | 是 |
-| `s3.region` | `obs.region` | OBS region,指定华为云 OBS
的区域 | | 否 |
-| `s3.access_key` | `obs.access_key` | OBS access key,用于身份验证的
OBS 访问密钥 | | 是 |
-| `s3.secret_key` | `obs.secret_key` | OBS secret key,与 access
key 配合使用的访问密钥 | | 是 |
-| `s3.connection.maximum` | | S3 最大连接数,指定与 OBS
服务建立的最大连接数 | `50` | 否 |
-| `s3.connection.request.timeout` | | S3 请求超时时间,单位为毫秒,指定连接
OBS 服务时的请求超时时间 | `3000` | 否 |
-| `s3.connection.timeout` | | S3 连接超时时间,单位为毫秒,指定与 OBS
服务建立连接时的超 | `1000` | 否 |
+| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
+|----------------------------------|----------------|----------------------------------------------|-------|----------|
+| `obs.endpoint` | `s3.endpoint` | OBS endpoint,指定华为云 OBS
的访问端点 | | 是 |
+| `obs.region` | `s3.region` | OBS region,指定华为云 OBS 的区域
| | 否 |
+| `obs.access_key` | `s3.access_key`| OBS access key,用于身份验证的
OBS 访问密钥 | | 是 |
+| `obs.secret_key` | `s3.secret_key`| OBS secret key,与 access
key 配合使用的访问密钥 | | 是 |
+| `obs.use_path_style` | `s3.use_path_style` | 是否使用
path-style(路径风格)访问。兼容 MinIO/Ceph 等非 AWS S3 服务建议设置为 true | `false` | 否 |
+| `obs.connection.maximum` | | 最大连接数,指定与 OBS 服务建立的最大连接数
| `50` | 否 |
+| `obs.connection.request.timeout` | | 请求超时时间,单位为毫秒,指定连接 OBS
服务时的请求超时时间 | `3000`| 否 |
+| `obs.connection.timeout` | | 连接超时时间,单位为毫秒,指定与 OBS
服务建立连接时的超时时间 | `1000`| 否 |
+---
+
+## 认证配置
-### 认证配置
+访问华为云 OBS 时,需要提供华为云的 Access Key 和 Secret Key 进行身份验证。
+除了传统的 Access Key/Secret Key 外,Doris 也支持通过 Assume Role 的方式访问 OBS,方便临时授权和跨账号访问。
-访问华为云 OBS 时,需要提供华为云的 Access Key 和 Secret Key,即下列参数:
+### Access Key / Secret Key 认证
-- `s3.access_key` (或 `obs.access_key`)
-- `s3.secret_key` (或 `obs.secret_key`)
+必须提供以下参数:
+
+- `obs.access_key` (曾用名:`s3.access_key`)
+- `obs.secret_key` (曾用名:`s3.secret_key`)
这两个参数用于身份验证,确保访问华为云 OBS 的权限。
-### 配置示例
-```plaintext:
-"s3.access_key" = "ak",
-"s3.secret_key" = "sk",
-"s3.endpoint" = "obs.cn-north-4.myhuaweicloud.com"
-"s3.region" = "cn-north-4"
+
+## 配置示例
+
+```properties
+# 传统 Access Key / Secret Key 模式
+"obs.access_key" = "your-access-key"
+"obs.secret_key" = "your-secret-key"
+"obs.endpoint" = "obs.cn-north-4.myhuaweicloud.com"
+"obs.region" = "cn-north-4"
+"obs.connection.maximum" = "50"
+"obs.connection.request.timeout" = "3000"
+"obs.connection.timeout" = "1000"
```
+
+---
+
+## 参数说明细节
+
+- `obs.endpoint`
+ 指定 OBS 服务的访问地址,不同区域和环境的 endpoint 不同。
+
+- `obs.region`
+ 华为云区域标识,比如 `cn-north-4`,可选参数。
+
+- `obs.access_key` / `obs.secret_key`
+ 传统的访问凭证,必填。
+
+- `obs.connection.maximum`
+ 最大连接数,默认 50。
+
+- `obs.connection.request.timeout`
+ 请求超时时间,单位毫秒,默认 3000。
+
+- `obs.connection.timeout`
+ 连接超时时间,单位毫秒,默认 1000。
+
+- `obs.role_arn` / `obs.external_id`
+ Assume Role 相关参数,非必填。
+
+---
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/s3.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/s3.md
index 531bcb4d874..2fef0bab162 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/s3.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/storages/s3.md
@@ -1,11 +1,12 @@
---
{
- "title": "S3",
- "language": "zh-CN"
+ "title": "S3",
+ "language": "zh-CN"
}
---
本文档用于介绍访问 AWS S3 时所需的参数。这些参数适用于:
+
- Catalog 属性。
- Table Valued Function 属性。
- Broker Load 属性。
@@ -14,65 +15,115 @@
## 参数总览
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-|------------------------------|----------------|------------------------------------------------|--------------|----------|
-| `s3.endpoint` | S3 endpoint | S3 endpoint
| | 是 |
-| `s3.region` | S3 region | S3 region
| | 否 |
-| `s3.access_key` | S3 access key | S3 access key
| | 是 |
-| `s3.secret_key` | S3 secret key | S3 secret key
| | 是 |
-| `s3.use_path_style` | use_path_style | 是否使用 path-style 访问
S3。在访问某些不支持 host-style 的 S3 兼容对象存储时使用 | `false` | 否 |
-| `s3.connection.maximum` | | S3 最大连接数
| `50` | 否 |
-| `s3.connection.request.timeout` | | S3 请求超时时间,单位毫秒
| `3000` | 否 |
-| `s3.connection.timeout` | | S3 连接超时时间,单位毫秒
| `1000` | 否 |
-| `s3.role_arn` | | assume role 方式会用到
| | 否 |
-| `s3.external_id` | | assume role 方式会用到
| | 否 |
+| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
+|---------------------------------|-----|------------------------------------------|---------|------|
+| `s3.endpoint` | | S3 服务访问地址,如
`s3.us-east-1.amazonaws.com` | 无 | ✅ 是 |
+| `s3.access_key` | | AWS Access Key。用于身份验证
| 无 | ✅ 是 |
+| `s3.secret_key` | | AWS Secret Key。用于身份验证
| 无 | ✅ 是 |
+| `s3.region` | | S3 所在的区域,例如:`us-east-1`。强烈建议配置
| 无 | 否 |
+| `s3.use_path_style` | | 是否使用 path-style(路径风格)访问。
| `false` | 否 |
+| `s3.connection.maximum` | | 最大连接数,适用于高并发场景
| `50` | 否 |
+| `s3.connection.request.timeout` | | 请求超时时间(毫秒),控制连接获取超时
| `3000` | 否 |
+| `s3.connection.timeout` | | 建立连接的超时时间(毫秒)
| `1000` | 否 |
+| `s3.role_arn` | | 使用 Assume Role 模式时指定的角色 ARN
| 无 | 否 |
+| `s3.external_id` | | 配合 `s3.role_arn` 使用的 external ID
| 无 | 否 |
+
+---
-### 认证配置
+## 1. 认证配置(必填)
-访问 AWS S3 时,需要提供 AWS Access Key 和 AWS Secret Key,即下列参数:
-- s3.access_key
-- s3.secret_key
+Doris 支持以下两种方式访问 S3:
-访问 AWS S3 时,Doris 也支持 Assumed Role 的方式,请参考如下文档进行配置
-[AWS
intergration](../../admin-manual/auth/integrations/aws-authentication-and-authorization.md#assumed-role-authentication).
+---
+### 1.1 方式一:Access Key + Secret Key(推荐)
-### 配置示例
+适用于 AWS S3 或兼容对象存储(如 MinIO、Ceph 等):
```properties
-"s3.access_key" = "ak"
-"s3.secret_key" = "sk"
-"s3.endpoint" = "s3.us-east-1.amazonaws.com"
-"s3.region" = "us-east-1"
+"s3.access_key"="your-access-key"
+"s3.secret_key"="your-secret-key"
+"s3.endpoint"="s3.us-east-1.amazonaws.com"
+"s3.region"="us-east-1"
```
-## Directory Bucket
+> 如使用 MinIO 等兼容服务,建议加上:
+> ```properties
+> "s3.use_path_style" = "true"
+> ```
-> 该功能自 3.1.0 版本支持。
+---
+
+### 1.2 方式二:Assume Role 模式(可选)
-Directory Bucket 是 Amazon S3 Express One Zone 存储类的高性能存储选项。使用 Directory Bucket
时,主要区别在于 `s3.endpoint` 的配置格式不同,其他配置参数保持不变。
+适用于跨账号、临时授权访问。通过角色授权自动获取临时凭证。
-### Endpoint 配置区别
+#### 参数说明:
-- General S3 Bucket
+| 参数 | 说明
|
+|------------------|----------------------------------------------------------------------|
+| `s3.role_arn` | 指定可扮演的 AWS IAM 角色的
ARN,例如:`arn:aws:iam::123456789012:role/demo-role` |
+| `s3.external_id` | 可选的外部 ID,用于第三方访问安全控制
|
- ```
- "s3.endpoint" = "s3.us-east-1.amazonaws.com"
- ```
+#### 示例:
-- Directory Bucket
+```properties
+"s3.role_arn"="arn:aws:iam::123456789012:role/demo-role"
+"s3.external_id"="external-identifier"
+"s3.endpoint"="s3.us-east-1.amazonaws.com"
+"s3.region"="us-east-1"
+```
- ```
- "s3.endpoint" = "s3express-{zone-id}.{region}.amazonaws.com"
- ```
+> 如果同时设置了 Access Key 和 Role ARN,则优先使用 Access Key 模式。
-### Directory Bucket 配置示例
+
+---
+
+## 2. 网络连接参数(可选)
+
+用于提升并发性能、避免连接阻塞。
+
+| 参数 | 说明 | 默认值 |
+|---------------------------------|----------------|--------|
+| `s3.connection.maximum` | 最大连接数 | `50` |
+| `s3.connection.request.timeout` | 请求等待连接超时时间(毫秒) | `3000` |
+| `s3.connection.timeout` | 建立连接的超时时间(毫秒) | `1000` |
+
+---
+
+## 3. 使用 Path-style 访问(兼容性选项)
+
+部分兼容 S3 的对象存储(如 MinIO)不支持默认的 host-style 访问方式,需启用:
```properties
-"s3.access_key" = "ak"
-"s3.secret_key" = "sk"
-"s3.endpoint" = "s3express-usw2-az1.us-west-2.amazonaws.com"
-"s3.region" = "us-west-2"
+"s3.use_path_style"="true"
```
-其中 `s3express-usw2-az1.us-west-2.amazonaws.com` 是 Directory Bucket 专用的
endpoint 格式,更多 endpoint 地址请参考 [AWS
官方文档](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html)。
+- **Host-style 访问**(默认): `https://bucket.s3.amazonaws.com`
+- **Path-style 访问**(开启后): `https://s3.amazonaws.com/bucket`
+
+---
+
+## 4. Directory Bucket 配置(S3 Express One Zone)
+
+> 📌 该功能自 **3.1.0** 起支持。
+
+Amazon S3 Express One Zone(又名 Directory Bucket)提供更高性能,但 endpoint 格式不同。
+
+### 4.1 endpoint 区别
+
+| 类型 | 示例 endpoint |
+|------------------|----------------------------------------------|
+| 普通 bucket | `s3.us-east-1.amazonaws.com` |
+| Directory Bucket | `s3express-usw2-az1.us-west-2.amazonaws.com` |
+
+更多可用区域参考:[AWS
官方文档](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html)
+
+### 4.2 示例配置
+
+```properties
+"s3.access_key"="ak"
+"s3.secret_key"="sk"
+"s3.endpoint"="s3express-usw2-az1.us-west-2.amazonaws.com"
+"s3.region"="us-west-2"
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]