This is an automated email from the ASF dual-hosted git repository.
morningman 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 5bfaa840900 [opt](paimon) add paimon dlf rest catalog doc (#2726)
5bfaa840900 is described below
commit 5bfaa8409008c24f9c79d25738e0fa03a0e70355
Author: Mingyu Chen (Rayner) <[email protected]>
AuthorDate: Sun Aug 10 11:14:00 2025 -0700
[opt](paimon) add paimon dlf rest catalog doc (#2726)
## Versions
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
docs/lakehouse/catalogs/paimon-catalog.md | 18 +++-
docs/lakehouse/metastores/aws-glue.md | 104 ++++++++++++++++++++-
.../current/lakehouse/catalogs/paimon-catalog.md | 18 +++-
.../current/lakehouse/metastores/aliyun-dlf.md | 94 +++++++++++--------
.../lakehouse/catalogs/paimon-catalog.md | 18 +++-
.../version-2.1/lakehouse/metastores/aliyun-dlf.md | 87 +++++++++++++++--
.../lakehouse/catalogs/paimon-catalog.md | 18 +++-
.../version-3.0/lakehouse/metastores/aliyun-dlf.md | 87 +++++++++++++++--
.../lakehouse/catalogs/paimon-catalog.md | 18 +++-
.../lakehouse/catalogs/paimon-catalog.md | 19 +++-
10 files changed, 418 insertions(+), 63 deletions(-)
diff --git a/docs/lakehouse/catalogs/paimon-catalog.md
b/docs/lakehouse/catalogs/paimon-catalog.md
index b141840ec49..ce9253d81f7 100644
--- a/docs/lakehouse/catalogs/paimon-catalog.md
+++ b/docs/lakehouse/catalogs/paimon-catalog.md
@@ -158,7 +158,7 @@ CREATE CATALOG paimon_hms PROPERTIES (
);
```
-### Paimon on DLF
+### Paimon on DLF 1.0
```sql
CREATE CATALOG paimon_dlf PROPERTIES (
@@ -173,6 +173,22 @@ CREATE CATALOG paimon_dlf PROPERTIES (
);
```
+### Paimon on DLF Rest Catalog
+
+> Since 3.1.0
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'new_dfl_paimon_catalog',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = 'ak',
+ 'paimon.rest.dlf.access-key-secret' = 'sk'
+);
+```
+
### Paimon on Google Dataproc Metastore
```sql
diff --git a/docs/lakehouse/metastores/aws-glue.md
b/docs/lakehouse/metastores/aws-glue.md
index eb87200896f..220ef6548c3 100644
--- a/docs/lakehouse/metastores/aws-glue.md
+++ b/docs/lakehouse/metastores/aws-glue.md
@@ -5,5 +5,107 @@
}
---
-The document is under development, please refer to versioned doc 2.1 or 3.0
+This document describes the parameter configuration when using **AWS Glue
Catalog** to access **Iceberg tables** or **Hive tables** through `CREATE
CATALOG`.
+## Supported Glue Catalog Types
+
+AWS Glue Catalog currently supports two types of Catalogs:
+
+| Catalog Type | Type Identifier (`type`) | Description
|
+|--------------|-------------------------|----------------------------------------------------|
+| Hive | glue | Catalog for connecting to Hive
Metastore |
+| Iceberg | glue | Catalog for connecting to Iceberg
table format |
+| Iceberg | rest | Catalog for connecting to Iceberg
via Glue Rest |
+
+This document provides detailed descriptions of the parameters for each type
to help users with configuration.
+
+## Hive Glue Catalog
+
+Hive Glue Catalog is used to access Hive tables through AWS Glue's Hive
Metastore compatible interface. Configuration parameters are as follows:
+
+| Parameter Name | Description
| Required | Default Value |
+|---------------------------|----------------------------------------------------------------------|----------|---------------|
+| `type` | Fixed value `hms`
| Yes | None |
+| `hive.metastore.type` | Fixed value `glue`
| Yes | None |
+| `glue.region` | AWS Glue region, e.g., `us-east-1`
| Yes | None |
+| `glue.endpoint` | AWS Glue endpoint, e.g.,
`https://glue.us-east-1.amazonaws.com` | Yes | None |
+| `glue.access_key` | AWS Access Key ID
| Yes | Empty |
+| `glue.secret_key` | AWS Secret Access Key
| Yes | Empty |
+| `glue.catalog_id` | Glue Catalog ID (not yet supported)
| No | Empty |
+| `glue.role_arn` | IAM Role ARN for accessing Glue (not yet
supported) | No | Empty |
+| `glue.external_id` | IAM External ID for accessing Glue (not yet
supported) | No | Empty |
+
+### Example
+
+```sql
+CREATE CATALOG hive_glue_catalog WITH (
+ 'type' = 'hms',
+ 'hive.metastore.type' = 'glue',
+ 'glue.region' = 'us-east-1',
+ 'glue.endpoint' = 'https://glue.us-east-1.amazonaws.com',
+ 'glue.access_key' = 'YOUR_ACCESS_KEY',
+ 'glue.secret_key' = 'YOUR_SECRET_KEY'
+);
+```
+
+## Iceberg Glue Catalog
+
+Iceberg Glue Catalog accesses Glue through the Glue Client. Configuration
parameters are as follows:
+
+| Parameter Name | Description
| Required | Default Value |
+|-------------------------|-----------------------------------------------------------------------------|----------|---------------|
+| `type` | Fixed value `iceberg`
| Yes | None |
+| `iceberg.catalog.type` | Fixed value `glue`
| Yes | None |
+| `warehouse` | Iceberg warehouse path, e.g.,
`s3://my-bucket/iceberg-warehouse/` | Yes | s3://doris |
+| `glue.region` | AWS Glue region, e.g., `us-east-1`
| Yes | None |
+| `glue.endpoint` | AWS Glue endpoint, e.g.,
`https://glue.us-east-1.amazonaws.com` | Yes | None |
+| `glue.access_key` | AWS Access Key ID
| Yes | Empty |
+| `glue.secret_key` | AWS Secret Access Key
| Yes | Empty |
+| `glue.catalog_id` | Glue Catalog ID (not yet supported)
| No | Empty |
+| `glue.role_arn` | IAM Role ARN for accessing Glue (not yet
supported) | No | Empty |
+| `glue.external_id` | IAM External ID for accessing Glue (not yet
supported) | No | Empty |
+
+### Example
+
+```sql
+CREATE CATALOG iceberg_glue_catalog WITH (
+ 'type' = 'iceberg',
+ 'iceberg.catalog.type' = 'glue',
+ 'glue.region' = 'us-east-1',
+ 'glue.endpoint' = 'https://glue.us-east-1.amazonaws.com',
+ 'glue.access_key' = '<YOUR_ACCESS_KEY>',
+ 'glue.secret_key' = '<YOUR_SECRET_KEY>'
+);
+```
+
+## Iceberg Glue Rest Catalog
+
+Iceberg Glue Rest Catalog accesses Glue through the Glue Rest Catalog
interface. Currently only supports Iceberg tables stored in AWS S3 Table
Bucket. Configuration parameters are as follows:
+
+| Parameter Name | Description
| Required | Default Value |
+|----------------------------------|---------------------------------------------------------------------------------|----------|---------------|
+| `type` | Fixed value `iceberg`
| Yes | None |
+| `iceberg.catalog.type` | Fixed value `rest`
| Yes | None |
+| `iceberg.rest.uri` | Glue Rest service endpoint, e.g.,
`https://glue.ap-east-1.amazonaws.com/iceberg` | Yes | None |
+| `warehouse` | Iceberg warehouse path, e.g.,
`<account_id>:s3tablescatalog/<bucket_name>` | Yes | None |
+| `iceberg.rest.sigv4-enabled` | Enable V4 signature format, fixed value
`true` | Yes | None |
+| `iceberg.rest.signing-name` | Signature type, fixed value `glue`
| Yes | Empty |
+| `iceberg.rest.access-key-id` | Access Key for accessing Glue (also used
for S3 Bucket access) | Yes | Empty |
+| `iceberg.rest.secret-access-key` | Secret Key for accessing Glue (also used
for S3 Bucket access) | Yes | Empty |
+| `iceberg.rest.signing-region` | AWS Glue region, e.g., `us-east-1`
| Yes | Empty |
+
+### Example
+
+```sql
+CREATE CATALOG glue_s3 PROPERTIES (
+ 'type' = 'iceberg',
+ 'iceberg.catalog.type' = 'rest',
+ 'iceberg.rest.uri' = 'https://glue.<region>.amazonaws.com/iceberg',
+ 'iceberg.rest.warehouse' =
'<acount_id>:s3tablescatalog/<s3_table_bucket_name>',
+ 'iceberg.rest.sigv4-enabled' = 'true',
+ 'iceberg.rest.signing-name' = 'glue',
+ 'iceberg.rest.access-key-id' = '<ak>',
+ 'iceberg.rest.secret-access-key' = '<sk>',
+ 'iceberg.rest.signing-region' = '<region>'
+);
+```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/catalogs/paimon-catalog.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/catalogs/paimon-catalog.md
index d1120499bcd..cc6f194e6e3 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/catalogs/paimon-catalog.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/catalogs/paimon-catalog.md
@@ -158,7 +158,7 @@ CREATE CATALOG paimon_hms PROPERTIES (
);
```
-### Paimon on DLF
+### Paimon on DLF 1.0
```sql
CREATE CATALOG paimon_dlf PROPERTIES (
@@ -173,6 +173,22 @@ CREATE CATALOG paimon_dlf PROPERTIES (
);
```
+### Paimon on DLF Rest Catalog
+
+> 该功能自 3.1.0 版本支持
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'new_dfl_paimon_catalog',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = 'ak',
+ 'paimon.rest.dlf.access-key-secret' = 'sk'
+);
+```
+
### Paimon on Google Dataproc Metastore
```sql
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 0acb51769c3..93f0f31984e 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,21 +5,44 @@
}
---
-# 阿里云 DLF Catalog 参数配置文档(Hive 表)
+本文档介绍如何使用 `CREATE CATALOG` 语句连接并访问阿里云 [Dake Lake
Formation(DLF)](https://www.alibabacloud.com/zh/product/datalake-formation)
元数据服务。
-本文档介绍如何使用 `CREATE CATALOG` 语句连接并访问 **阿里云 DLF** 中的 **Hive 表**,以及所需的参数说明。
+## DLF 版本说明
----
+- 对于 DLF 1.0 版本,Doris 通过 DLF 的 Hive Metastore 兼容接口访问 DLF。支持 Paimon Catalog 和
Hive Catalog。
+- 对于 DLF 2.5 之后的版本,Doris 通过 DLF 的 Rest 接口访问 DLF。仅支持 Paimon Catalog。
-## 一、支持类型
+### DLF 1.0
-目前 DLF Catalog 仅支持 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。用于指定元数据目录,如果不设置则使用默认目录。 | 无
| 否 |
+| `warehouse` | - | Warehouse 的存储路径,仅在 Paimon Catalog 中需要填写 | 无 | 否 |
----
+### DLF Rest Catalog
+
+> 自 3.1.0 版本支持
+
+| 参数名称 | 曾用名 | 描述 | 默认值 | 是否必须 |
+|----------|--------|------|--------|----------|
+| `uri` | - | DLF REST URI。示例:http://cn-beijing-vpc.dlf.aliyuncs.com | 无 | 是 |
+| `warehouse` | - | Warehouse 名称。注意这里直接填写需要连接的 Catalog 的名称,而非 Paimon 表存储路径 | 无
| 是 |
+| `paimon.rest.token.provider` | - | token 提供方,固定填写 `dlf` | 无 | 是 |
+| `paimon.rest.dlf.access-key-id` | - | 阿里云 AccessKey,用于访问 DLF 服务。 | 无 | 是 |
+| `paimon.rest.dlf.access-key-secret` | - | 阿里云 SecretKey,用于访问 DLF 服务。 | 无 | 是
|
+
+DLF Rest Catalog 无需提供存储服务(OSS)的 Endpoint 和 Region 等信息。Doris 会利用 DLF Rest
Catalog 的 Vended Credential 获取用于访问 OSS 的临时凭证信息。
+
+## 示例
-## 二、Hive 表配置示例(DLF Catalog)
+### DLF 1.0
-以下为使用 DLF 作为 Hive Metastore 创建 Catalog 的示例:
+创建 Hive Catalog,以 DLF 作为元数据服务:
```sql
CREATE CATALOG hive_dlf_catalog WITH (
@@ -33,35 +56,32 @@ CREATE CATALOG hive_dlf_catalog WITH (
);
```
----
-
-## 三、认证方式说明
-
-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。用于指定元数据目录,如果不设置则使用默认目录。
| 无 | 否 |
+创建 Paimon Catalog,以 DLF 作为元数据服务:
----
-
-## 五、注意事项
+```sql
+CREATE CATALOG paimon_dlf PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'dlf',
+ 'warehouse' = 'oss://xx/yy/',
+ 'dlf.proxy.mode' = 'DLF_ONLY',
+ '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 仅支持 Hive 表。
-- 请确保您的 AccessKey/SecretKey 拥有访问 DLF 和 Hive 元数据服务的权限。
-- `dlf.catalog_id` 暂非必需,仅当使用多个 Catalog 时使用。
+### DLF Rest Catalog
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'my_catalog_name',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = '<YOUR_ACCESS_KEY>',
+ 'paimon.rest.dlf.access-key-secret' = '<YOUR_SECRET_KEY>'
+);
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
index d1120499bcd..cc6f194e6e3 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
@@ -158,7 +158,7 @@ CREATE CATALOG paimon_hms PROPERTIES (
);
```
-### Paimon on DLF
+### Paimon on DLF 1.0
```sql
CREATE CATALOG paimon_dlf PROPERTIES (
@@ -173,6 +173,22 @@ CREATE CATALOG paimon_dlf PROPERTIES (
);
```
+### Paimon on DLF Rest Catalog
+
+> 该功能自 3.1.0 版本支持
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'new_dfl_paimon_catalog',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = 'ak',
+ 'paimon.rest.dlf.access-key-secret' = 'sk'
+);
+```
+
### Paimon on Google Dataproc Metastore
```sql
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metastores/aliyun-dlf.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metastores/aliyun-dlf.md
index 13af756e6e5..93f0f31984e 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metastores/aliyun-dlf.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/lakehouse/metastores/aliyun-dlf.md
@@ -5,14 +5,83 @@
}
---
-本文档用于介绍通过 `CREATE CATALOG` 语句连接并访问阿里云 DLF 时所支持的参数。
+本文档介绍如何使用 `CREATE CATALOG` 语句连接并访问阿里云 [Dake Lake
Formation(DLF)](https://www.alibabacloud.com/zh/product/datalake-formation)
元数据服务。
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-| --------------- | -------------- |
--------------------------------------------------------------------------------------
| --- | ---- |
-| `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 版本说明
+- 对于 DLF 1.0 版本,Doris 通过 DLF 的 Hive Metastore 兼容接口访问 DLF。支持 Paimon Catalog 和
Hive Catalog。
+- 对于 DLF 2.5 之后的版本,Doris 通过 DLF 的 Rest 接口访问 DLF。仅支持 Paimon Catalog。
+
+### DLF 1.0
+
+| 参数名称 | 曾用名 | 描述 | 默认值 | 是否必须 |
+|----------|--------|------|--------|----------|
+| `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。用于指定元数据目录,如果不设置则使用默认目录。 | 无
| 否 |
+| `warehouse` | - | Warehouse 的存储路径,仅在 Paimon Catalog 中需要填写 | 无 | 否 |
+
+### DLF Rest Catalog
+
+> 自 3.1.0 版本支持
+
+| 参数名称 | 曾用名 | 描述 | 默认值 | 是否必须 |
+|----------|--------|------|--------|----------|
+| `uri` | - | DLF REST URI。示例:http://cn-beijing-vpc.dlf.aliyuncs.com | 无 | 是 |
+| `warehouse` | - | Warehouse 名称。注意这里直接填写需要连接的 Catalog 的名称,而非 Paimon 表存储路径 | 无
| 是 |
+| `paimon.rest.token.provider` | - | token 提供方,固定填写 `dlf` | 无 | 是 |
+| `paimon.rest.dlf.access-key-id` | - | 阿里云 AccessKey,用于访问 DLF 服务。 | 无 | 是 |
+| `paimon.rest.dlf.access-key-secret` | - | 阿里云 SecretKey,用于访问 DLF 服务。 | 无 | 是
|
+
+DLF Rest Catalog 无需提供存储服务(OSS)的 Endpoint 和 Region 等信息。Doris 会利用 DLF Rest
Catalog 的 Vended Credential 获取用于访问 OSS 的临时凭证信息。
+
+## 示例
+
+### DLF 1.0
+
+创建 Hive Catalog,以 DLF 作为元数据服务:
+
+```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>'
+);
+```
+
+创建 Paimon Catalog,以 DLF 作为元数据服务:
+
+```sql
+CREATE CATALOG paimon_dlf PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'dlf',
+ 'warehouse' = 'oss://xx/yy/',
+ 'dlf.proxy.mode' = 'DLF_ONLY',
+ '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 Rest Catalog
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'my_catalog_name',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = '<YOUR_ACCESS_KEY>',
+ 'paimon.rest.dlf.access-key-secret' = '<YOUR_SECRET_KEY>'
+);
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
index d1120499bcd..cc6f194e6e3 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
@@ -158,7 +158,7 @@ CREATE CATALOG paimon_hms PROPERTIES (
);
```
-### Paimon on DLF
+### Paimon on DLF 1.0
```sql
CREATE CATALOG paimon_dlf PROPERTIES (
@@ -173,6 +173,22 @@ CREATE CATALOG paimon_dlf PROPERTIES (
);
```
+### Paimon on DLF Rest Catalog
+
+> 该功能自 3.1.0 版本支持
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'new_dfl_paimon_catalog',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = 'ak',
+ 'paimon.rest.dlf.access-key-secret' = 'sk'
+);
+```
+
### Paimon on Google Dataproc Metastore
```sql
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metastores/aliyun-dlf.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metastores/aliyun-dlf.md
index 13af756e6e5..93f0f31984e 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metastores/aliyun-dlf.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/lakehouse/metastores/aliyun-dlf.md
@@ -5,14 +5,83 @@
}
---
-本文档用于介绍通过 `CREATE CATALOG` 语句连接并访问阿里云 DLF 时所支持的参数。
+本文档介绍如何使用 `CREATE CATALOG` 语句连接并访问阿里云 [Dake Lake
Formation(DLF)](https://www.alibabacloud.com/zh/product/datalake-formation)
元数据服务。
-| 属性名称 | 曾用名 | 描述
| 默认值 | 是否必须 |
-| --------------- | -------------- |
--------------------------------------------------------------------------------------
| --- | ---- |
-| `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 版本说明
+- 对于 DLF 1.0 版本,Doris 通过 DLF 的 Hive Metastore 兼容接口访问 DLF。支持 Paimon Catalog 和
Hive Catalog。
+- 对于 DLF 2.5 之后的版本,Doris 通过 DLF 的 Rest 接口访问 DLF。仅支持 Paimon Catalog。
+
+### DLF 1.0
+
+| 参数名称 | 曾用名 | 描述 | 默认值 | 是否必须 |
+|----------|--------|------|--------|----------|
+| `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。用于指定元数据目录,如果不设置则使用默认目录。 | 无
| 否 |
+| `warehouse` | - | Warehouse 的存储路径,仅在 Paimon Catalog 中需要填写 | 无 | 否 |
+
+### DLF Rest Catalog
+
+> 自 3.1.0 版本支持
+
+| 参数名称 | 曾用名 | 描述 | 默认值 | 是否必须 |
+|----------|--------|------|--------|----------|
+| `uri` | - | DLF REST URI。示例:http://cn-beijing-vpc.dlf.aliyuncs.com | 无 | 是 |
+| `warehouse` | - | Warehouse 名称。注意这里直接填写需要连接的 Catalog 的名称,而非 Paimon 表存储路径 | 无
| 是 |
+| `paimon.rest.token.provider` | - | token 提供方,固定填写 `dlf` | 无 | 是 |
+| `paimon.rest.dlf.access-key-id` | - | 阿里云 AccessKey,用于访问 DLF 服务。 | 无 | 是 |
+| `paimon.rest.dlf.access-key-secret` | - | 阿里云 SecretKey,用于访问 DLF 服务。 | 无 | 是
|
+
+DLF Rest Catalog 无需提供存储服务(OSS)的 Endpoint 和 Region 等信息。Doris 会利用 DLF Rest
Catalog 的 Vended Credential 获取用于访问 OSS 的临时凭证信息。
+
+## 示例
+
+### DLF 1.0
+
+创建 Hive Catalog,以 DLF 作为元数据服务:
+
+```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>'
+);
+```
+
+创建 Paimon Catalog,以 DLF 作为元数据服务:
+
+```sql
+CREATE CATALOG paimon_dlf PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'dlf',
+ 'warehouse' = 'oss://xx/yy/',
+ 'dlf.proxy.mode' = 'DLF_ONLY',
+ '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 Rest Catalog
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'my_catalog_name',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = '<YOUR_ACCESS_KEY>',
+ 'paimon.rest.dlf.access-key-secret' = '<YOUR_SECRET_KEY>'
+);
+```
diff --git a/versioned_docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
b/versioned_docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
index b141840ec49..ce9253d81f7 100644
--- a/versioned_docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
+++ b/versioned_docs/version-2.1/lakehouse/catalogs/paimon-catalog.md
@@ -158,7 +158,7 @@ CREATE CATALOG paimon_hms PROPERTIES (
);
```
-### Paimon on DLF
+### Paimon on DLF 1.0
```sql
CREATE CATALOG paimon_dlf PROPERTIES (
@@ -173,6 +173,22 @@ CREATE CATALOG paimon_dlf PROPERTIES (
);
```
+### Paimon on DLF Rest Catalog
+
+> Since 3.1.0
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'new_dfl_paimon_catalog',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = 'ak',
+ 'paimon.rest.dlf.access-key-secret' = 'sk'
+);
+```
+
### Paimon on Google Dataproc Metastore
```sql
diff --git a/versioned_docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
b/versioned_docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
index 485e4061483..ce9253d81f7 100644
--- a/versioned_docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
+++ b/versioned_docs/version-3.0/lakehouse/catalogs/paimon-catalog.md
@@ -158,7 +158,7 @@ CREATE CATALOG paimon_hms PROPERTIES (
);
```
-### Paimon on DLF
+### Paimon on DLF 1.0
```sql
CREATE CATALOG paimon_dlf PROPERTIES (
@@ -173,6 +173,22 @@ CREATE CATALOG paimon_dlf PROPERTIES (
);
```
+### Paimon on DLF Rest Catalog
+
+> Since 3.1.0
+
+```sql
+CREATE CATALOG paimon_dlf_test PROPERTIES (
+ 'type' = 'paimon',
+ 'paimon.catalog.type' = 'rest',
+ 'uri' = 'http://cn-beijing-vpc.dlf.aliyuncs.com',
+ 'warehouse' = 'new_dfl_paimon_catalog',
+ 'paimon.rest.token.provider' = 'dlf',
+ 'paimon.rest.dlf.access-key-id' = 'ak',
+ 'paimon.rest.dlf.access-key-secret' = 'sk'
+);
+```
+
### Paimon on Google Dataproc Metastore
```sql
@@ -279,7 +295,6 @@ To access metadata of a Paimon table, add a `$` symbol
after the table name, fol
SELECT * FROM my_table$system_table_name;
```
-
> Note: Doris does not support reading Paimon global system tables, which are
> only supported in Flink.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]