Superset 项目技术文档

1. 安装指南

1.1 环境要求

• Python 3.7 或更高版本
• Node.js 14 或更高版本
• 支持的 SQL 数据库（如 PostgreSQL、MySQL 等）

1.2 安装步骤

1. 克隆项目仓库：

   git clone https://github.com/apache/superset.git
   cd superset
   

2. 创建虚拟环境：

   python3 -m venv venv
   source venv/bin/activate
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 安装 Superset：

   pip install apache-superset
   

5. 初始化数据库：

   superset db upgrade
   

6. 创建管理员用户：

   superset fab create-admin
   

7. 加载示例数据（可选）：

   superset load_examples
   

8. 启动 Superset：

   superset run -p 8088 --with-threads --reload --debugger
   

2. 项目的使用说明

2.1 登录与界面

• 打开浏览器，访问 http://localhost:8088。
• 使用管理员账户登录。

2.2 创建数据源

1. 点击“Sources”菜单，选择“Databases”。
2. 点击“+ Database”按钮，填写数据库连接信息。
3. 保存并测试连接。

2.3 创建数据表

1. 点击“Sources”菜单，选择“Tables”。
2. 点击“+ Table”按钮，选择数据库和表。
3. 配置表的列和指标。

2.4 创建图表

1. 点击“Charts”菜单，选择“+ Chart”。
2. 选择数据表和图表类型。
3. 配置图表的维度和指标。
4. 保存并查看图表。

2.5 创建仪表盘

1. 点击“Dashboards”菜单，选择“+ Dashboard”。
2. 添加已创建的图表。
3. 调整布局并保存仪表盘。

3. 项目 API 使用文档

3.1 获取所有数据库

GET /api/v1/database/

3.2 获取所有表

GET /api/v1/table/

3.3 创建图表

POST /api/v1/chart/
{
  "slice_name": "My Chart",
  "viz_type": "bar",
  "datasource": "1__table",
  "params": {
    "groupby": ["column1"],
    "metrics": ["sum__column2"]
  }
}

3.4 获取所有仪表盘

GET /api/v1/dashboard/

4. 项目安装方式

4.1 通过 Docker 安装

1. 拉取 Docker 镜像：

   docker pull apache/superset
   

2. 运行容器：

   docker run -d -p 8088:8088 apache/superset
   

4.2 通过 PyPI 安装

pip install apache-superset

4.3 通过源码安装

1. 克隆仓库：

   git clone https://github.com/apache/superset.git
   

2. 安装依赖：

   pip install -r requirements.txt
   

3. 安装 Superset：

   pip install .
   

通过以上步骤，您可以顺利安装并使用 Superset 项目。