This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch branch-2.1
in repository https://gitbox.apache.org/repos/asf/doris.git
commit 286685ff2fe85ba09e98691a7b198aa72b39a033
Author: Jiwen liu <61498169+liujiwen...@users.noreply.github.com>
AuthorDate: Thu Mar 7 12:11:56 2024 +0800
[doc](apache-superset)add doc for apache superset compatible (#31314)
---
.../ecosystem/bi-integration/apache-superset.md | 53 ++++++++++++++++++++
docs/sidebars.json | 1 +
.../ecosystem/bi-integration/apache-superset.md | 57 ++++++++++++++++++++++
3 files changed, 111 insertions(+)
diff --git a/docs/en/docs/ecosystem/bi-integration/apache-superset.md
b/docs/en/docs/ecosystem/bi-integration/apache-superset.md
new file mode 100644
index 00000000000..0ada613da75
--- /dev/null
+++ b/docs/en/docs/ecosystem/bi-integration/apache-superset.md
@@ -0,0 +1,53 @@
+---
+{
+"title": "Apache Superset Integrate",
+"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.
+-->
+
+
+## Introduction
+Apache Superset is an open-source data exploration platform. It supports a
rich variety of data source connections and numerous visualization methods. It
also enables fine-grained access control for users. The main features of this
tool include self-service analysis, customizable dashboards, visualization of
analytical results (with export functionality), and user/role permission
control. Moreover, it integrates an SQL editor for conducting SQL editing and
queries.
+
+In Apache Superset version 3.1 official support has been introduced for
querying and visualizing both internal and external data from Apache Doris.
+## Preconditions
+Ensure you have completed the following tool installations:
+1. Install the Python client for Apache Doris on the Apache Superset server.
+ pip install pydoris
+2. Install Apache Superset version 3.1 or above. For detailed instructions,
refer to [Installing Superset from
PyPI](https://superset.apache.org/docs/installation/installing-superset-from-pypi/)
or [Installing Superset Locally Using Docker
Compose](https://hub.docker.com/r/apache/superset).
+## Add data source
+When creating a data source in Apache Superset, please pay attention to the
following two points:
+- Choose Apache Doris as the data source in SUPPORTED DATABASES.
+- In the SQLALCHEMY URI, fill in the URI following the Doris SQLAlchemy URI
format as shown below.
+
+ ```doris://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>```
+- URI parameters are explained as follows:
+ - User: The username for logging into the Doris cluster, e.g., admin.
+ - Password: The password for logging into the Doris cluster.
+ - Host: The IP address of the FE (Frontend) host in the Doris cluster.
+ - Port: The query port of the FE in the Doris cluster, e.g. 9030.
+ - Catalog: The target Catalog in the Doris cluster. Both Internal Catalog
and External Catalog are supported.
+ - Database: The target database in the Doris cluster. Both internal and
external databases are supported.
+
+
+:::tip
+1. When deploying Superset using the latest Docker image, if you encounter the
issue of not finding the Apache Doris data source, it may be because the
default [Superset Docker image](https://hub.docker.com/r/apache/superset)
includes only basic data source builds. You need to manually install the
pydoris package. You can refer to the 'How to extend this image' section in the
Superset Docker tutorial for the deployment steps of Superset.
+2. It is recommended to use Apache Doris 2.0.4 and above.
+:::
diff --git a/docs/sidebars.json b/docs/sidebars.json
index 2e009562a82..eee48955dfa 100644
--- a/docs/sidebars.json
+++ b/docs/sidebars.json
@@ -287,6 +287,7 @@
"ecosystem/cloudcanal",
"ecosystem/hive-bitmap-udf",
"ecosystem/dbt-doris-adapter",
+ "ecosystem/bi-integration/apache-superset",
{
"type": "category",
"label": "UDF",
diff --git a/docs/zh-CN/docs/ecosystem/bi-integration/apache-superset.md
b/docs/zh-CN/docs/ecosystem/bi-integration/apache-superset.md
new file mode 100644
index 00000000000..cd974bfad14
--- /dev/null
+++ b/docs/zh-CN/docs/ecosystem/bi-integration/apache-superset.md
@@ -0,0 +1,57 @@
+{
+"title": "Apache Superset 集成",
+"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.
+-->
+
+
+## 介绍
+Apache Superset
是一个开源的数据挖掘平台，支持丰富的数据源连接，多种可视化方式，并能够对用户实现细粒度的权限控制。该工具主要特点是可自助分析、自定义仪表盘、分析结果可视化（导出）、用户/角色权限控制，还集成了一个
SQL 编辑器，可以进行 SQL 编辑查询等。
+
+在 Apache Superset 3.1 版本中正式支持了 Apache Doris 的内部数据和外部数据进行查询和可视化处理。
+## 前置条件
+确保您已完成如下工具安装：
+1. 在 Apache Superset 服务器上安装 Apache Doris 的 Python 客户端。
+ ```
+ pip install pydoris
+ ```
+2. 安装 Apache Superset 3.1 及其以上的版本。具体参见[安装 Superset 从 PyPI
库](https://superset.apache.org/docs/installation/installing-superset-from-pypi)或者[通过
Docker 容器的方式安装](https://hub.docker.com/r/apache/superset)
+
+## 添加数据源
+当你在 Apache Superset 中创建数据源时需要注意以下两点：
+- 在 SUPPORTED DATABASES 里选择 Apache Doris 作为数据源。
+- 在 SQLALCHEMY URI 里，按如下 Doris SQLAlchemy URI 格式填写 URI：
+
+ ```doris://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>```
+- URI 参数说明如下：
+ - User：用于登录 Doris 集群的用户名，如 admin。
+ - Password：用于登录 Doris 集群的用户密码。
+ - Host：Doris 集群的 FE 主机 IP 地址。
+ - Port：Doris 集群的 FE 查询端口，如 9030。
+ - Catalog：Doris 集群中的目标 Catalog。Internal Catalog 和 External Catalog 均支持。
+ - Database：Doris 集群中的目标数据库。内部数据库和外部数据库均支持。
+
+
+:::tip
+1. 当你使用最新的 Docker 镜像部署 Superset 时，如果发现找不到 Apache Doris 数据源，这个可能是因为 Superset
Docker Image默认只包含基本的数据源构建，需要手动将 pydoris 包安装进来，您可以参考 [superset docker教程]
(https://hub.docker.com/r/apache/superset)中的 How to extend this image 步骤进行
Apache Superset 的部署。
+2. 推荐使用 Apache Doris 2.0.4 及以上版本。
+:::
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
