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 49861978714 [doc] Add LakeSoul Catalog docs (#785)
49861978714 is described below
commit 49861978714f8dc83a43b054cd0d8f754ed964ad
Author: Xu Chen <xuchen-p...@users.noreply.github.com>
AuthorDate: Wed Jun 26 14:21:36 2024 +0800
[doc] Add LakeSoul Catalog docs (#785)
Co-authored-by: maosen <738159...@qq.com>
Co-authored-by: Luzhijing <82810928+luzhij...@users.noreply.github.com>
---
docs/lakehouse/datalake-analytics/lakesoul.md | 65 ++++++++++++++++++++++
docs/lakehouse/lakehouse-overview.md | 4 +-
.../lakehouse/datalake-analytics/lakesoul.md | 65 ++++++++++++++++++++++
.../current/lakehouse/lakehouse-overview.md | 6 +-
sidebars.json | 1 +
5 files changed, 137 insertions(+), 4 deletions(-)
diff --git a/docs/lakehouse/datalake-analytics/lakesoul.md
b/docs/lakehouse/datalake-analytics/lakesoul.md
new file mode 100644
index 00000000000..8f661658353
--- /dev/null
+++ b/docs/lakehouse/datalake-analytics/lakesoul.md
@@ -0,0 +1,65 @@
+---
+{
+ "title": "LakeSoul",
+ "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.
+-->
+
+## Instructions for use
+
+1. Currently, LakeSoul is supported as a source for read operations.
LakeSoul's primary key table, non-primary key table, and MOR reading are all
supported.
+2. When LakeSoul's data is stored on HDFS, core-site.xml, hdfs-site.xml, and
hive-site.xml need to be placed in the conf directory of FE and BE. The hadoop
configuration file in the conf directory is read first, and then the relevant
configuration files of the environment variable `HADOOP_CONF_DIR` are read.
+
+## Create Catalog
+
+When creating a LakeSoul Catalog, you need to specify the connection
information of the LakeSoul's metadata DB. For more information about setting
up the LakeSoul environment, please refer to the [LakeSoul
Documentation](https://lakesoul-io.github.io/docs/Getting%20Started/setup-local-env).
+
+### Example of Creating LakeSoul Catalog
+
+```sql
+create catalog lakesoul properties (
+'type'='lakesoul',
+'lakesoul.pg.username'='lakesoul_test',
+'lakesoul.pg.password'='lakesoul_test',
+'lakesoul.pg.url'='jdbc:postgresql://127.0.0.1:5432/lakesoul_test?stringtype=unspecified'
+);
+```
+
+## Supported Data Types
+| Doris Data Type | Comment |
+| ------------------------- | --------------------- |
+| Boolean | Supported |
+| TinyInt | Supported |
+| SmallInt | Supported |
+| Int | Supported |
+| Float | Supported |
+| BigInt | Supported |
+| Double | Supported |
+| VarChar | Supported |
+| Char | Supported |
+| String | Supported |
+| Decimal(precision, scale) | Supported |
+| DateTime | Supported |
+| Date | Supported |
+| Array | Support Nested Array |
+| Map | Support Nested Map |
+| Struct | Support Nested Struct |
\ No newline at end of file
diff --git a/docs/lakehouse/lakehouse-overview.md
b/docs/lakehouse/lakehouse-overview.md
index 5644bd65960..96fdcc3d9b4 100644
--- a/docs/lakehouse/lakehouse-overview.md
+++ b/docs/lakehouse/lakehouse-overview.md
@@ -49,7 +49,7 @@ We design the Doris lakehouse solution for the following four
applicable scenari
## Doris-based data lakehouse architecture
-Apache Doris can work as a data lakehouse with its [Multi
Catalog](../lakehouse/lakehouse-overview#multi-catalog) feature. It can access
databases and data lakes including Apache Hive, Apache Iceberg, Apache Hudi,
Apache Paimon (incubating), Elasticsearch, MySQL, Oracle, and SQLServer. It
also supports Apache Ranger for privilege management.
+Apache Doris can work as a data lakehouse with its [Multi
Catalog](../lakehouse/lakehouse-overview#multi-catalog) feature. It can access
databases and data lakes including Apache Hive, Apache Iceberg, Apache Hudi,
Apache Paimon, LakeSoul, Elasticsearch, MySQL, Oracle, and SQLServer. It also
supports Apache Ranger for privilege management.
@@ -157,7 +157,7 @@ With Multi-Catalog, Doris now has a new three-tiered
metadata hierarchy (catalog
- JDBC
-- Apache Paimon(Incubating)
+- Apache Paimon
Multi-Catalog works as an additional and enhanced external table connection
method. It helps users conduct multi-catalog federated queries quickly.
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-analytics/lakesoul.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-analytics/lakesoul.md
new file mode 100644
index 00000000000..6e72ad2e640
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/datalake-analytics/lakesoul.md
@@ -0,0 +1,65 @@
+---
+{
+ "title": "LakeSoul",
+ "language": "zh-CN"
+}
+---
+
+<!--
+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.
+-->
+
+## 使用须知
+
+1. 目前支持 LakeSoul 作为 Source 的读操作，支持 LakeSoul 的主键表、无主键表，支持 MOR 读取。
+2. LakeSoul 的数据存储在 HDFS 上时，需要将 core-site.xml，hdfs-site.xml 和 hive-site.xml 放到
FE 和 BE 的 conf 目录下。优先读取 conf 目录下的 hadoop 配置文件，再读取环境变量 `HADOOP_CONF_DIR` 的相关配置文件。
+
+## Doris 中创建 Catalog
+
+LakeSoul Catalog 创建时需要指定 LakeSoul 元数据的连接信息。关于 LakeSoul 的环境搭建，请参考 [LakeSoul
文档](https://lakesoul-io.github.io/zh-Hans/docs/Getting%20Started/setup-local-env)。
+
+### 创建 Catalog 示例
+
+```sql
+create catalog lakesoul properties (
+'type'='lakesoul',
+'lakesoul.pg.username'='lakesoul_test',
+'lakesoul.pg.password'='lakesoul_test',
+'lakesoul.pg.url'='jdbc:postgresql://127.0.0.1:5432/lakesoul_test?stringtype=unspecified'
+);
+```
+
+## 支持的类型
+| Doris Data Type | Comment |
+| ------------------------- | -------------- |
+| Boolean | 支持 |
+| TinyInt | 支持 |
+| SmallInt | 支持 |
+| Int | 支持 |
+| Float | 支持 |
+| BigInt | 支持 |
+| Double | 支持 |
+| VarChar | 支持 |
+| Char | 支持 |
+| String | 支持 |
+| Decimal(precision, scale) | 支持 |
+| DateTime | 支持 |
+| Date | 支持 |
+| Array | 支持Array嵌套 |
+| Map | 支持Map嵌套 |
+| Struct | 支持Struct嵌套 |
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/lakehouse-overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/lakehouse-overview.md
index 876fa398e2f..627e0966679 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/lakehouse-overview.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/lakehouse-overview.md
@@ -49,7 +49,7 @@ Doris 在设计湖仓一体时，主要考虑如下四个应用场景：
## 基于 Doris 的湖仓一体架构
-Doris 通过多源数据目录（Multi-Catalog）功能，支持了包括 Apache Hive、Apache Iceberg、Apache
Hudi、Apache Paimon(Incubating)、Elasticsearch、MySQL、Oracle、SQLSserver
等主流数据湖、数据库的连接访问。以及可以通过 Apache Ranger 等进行统一的权限管理，具体架构如下：
+Doris 通过多源数据目录（Multi-Catalog）功能，支持了包括 Apache Hive、Apache Iceberg、Apache
Hudi、Apache Paimon、LakeSoul、Elasticsearch、MySQL、Oracle、SQLSserver
等主流数据湖、数据库的连接访问。以及可以通过 Apache Ranger 等进行统一的权限管理，具体架构如下：
@@ -160,7 +160,9 @@ Doris 通过收集统计信息有助于优化器了解数据分布特性，在
- JDBC: 对接数据库访问的标准接口 (JDBC) 来访问各式数据库的数据。
-- Apache Paimon(Incubating)
+- Apache Paimon
+
+- LakeSoul
该功能将作为之前外表连接方式（External Table）的补充和增强，帮助用户进行快速的多数据目录联邦查询。
diff --git a/sidebars.json b/sidebars.json
index 70fbe322059..48eb81ae28c 100644
--- a/sidebars.json
+++ b/sidebars.json
@@ -265,6 +265,7 @@
"lakehouse/datalake-analytics/hudi",
"lakehouse/datalake-analytics/iceberg",
"lakehouse/datalake-analytics/paimon",
+ "lakehouse/datalake-analytics/lakesoul",
"lakehouse/datalake-analytics/dlf",
"lakehouse/datalake-analytics/tpch",
"lakehouse/datalake-analytics/tpcds"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
