Skip to content

docs: add SeaTunnel Source and Sink quick start #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zhupitertop wants to merge 33 commits into
base: master
Choose a base branch
from
Open

docs: add SeaTunnel Source and Sink quick start #464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
62baf2a
chore: update release workflow and .gitignore entries
imbajin Nov 14, 2025
5bb8ee0
refactor: unify release validation script and add local path support
imbajin Nov 14, 2025
e4e9e08
refactor: revamp release validation script with enhanced checks V2
imbajin Nov 14, 2025
1ab58f1
refactor: enhance release validation for multi-arch and license check…
imbajin Nov 14, 2025
ba74766
refactor: improve validation script error context and reporting V4
imbajin Nov 14, 2025
af87f8a
fix: add JSON to CATEGORY_X license validation
imbajin Nov 14, 2025
512b51c
introduce new version of validation
Pengzna Nov 15, 2025
c4107b6
Update GPG username and regex in workflow
imbajin Nov 26, 2025
c773933
feat: add 1.7.0 release-notes (#429)
Pengzna Nov 16, 2025
dff6ba1
chore: add docker using / add load data methods (#423)
Ethereal-O Nov 17, 2025
ea90243
chore: minor test (#430)
Ethereal-O Nov 19, 2025
e4660a6
docs: delete licsence/add link of twitter (#431)
Ethereal-O Nov 19, 2025
34bfab5
chore: add deepwiki notes in docs (#432)
Ethereal-O Nov 20, 2025
13b6d1f
Merge pull request #24 from apache/master
imbajin Nov 26, 2025
5840b8b
feat: add graphspace related doc (#425)
Pengzna Nov 26, 2025
966a459
Merge branch 'apache:master' into master
imbajin Nov 27, 2025
b55fe2b
feat: 1.7.0 download-links (#434)
Pengzna Nov 28, 2025
d533820
docs: refactor docs of loader & client for new version(1.7.0) (#415)
sadwitdastreetz Dec 1, 2025
90f21e5
Merge pull request #29 from apache/master
imbajin Dec 3, 2025
51e334f
Merge pull request #30 from apache/master
imbajin Aug 6, 2026
4ae78ff
@
spr1lng Aug 6, 2026
68a004a
@
spr1lng Aug 7, 2026
7851a25
@
spr1lng Aug 7, 2026
c886b49
@
spr1lng Aug 10, 2026
d15c312
@
spr1lng Aug 10, 2026
08381d2
@
spr1lng Aug 10, 2026
a136574
docs: add SeaTunnel Source and Sink guide
imbajin Aug 11, 2026
7031a56
docs: restructure SeaTunnel connector doc per review feedback
spr1lng Aug 19, 2026
d64dedb
docs: restructure SeaTunnel connector doc per second review round
spr1lng Aug 19, 2026
b9c6d5c
docs: fix SeaTunnel doc to match released 2.3.13 API
spr1lng Aug 19, 2026
378b7dd
docs: remove confusing client version note from version matrix
spr1lng Aug 19, 2026
3c42928
docs(seatunnel): refine connector quick start
imbajin Aug 19, 2026
8956f3b
docs(seatunnel): align connector guide with upstream dev status (3.0.0)
spr1lng Aug 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions PR_DESCRIPTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Add SeaTunnel Connector Integration Guide (CN only)

@bitflicker64 bitflicker64 Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ important - This is a pull request description committed as a file in the site repository. The only Markdown files at the repository root on master are AGENTS.md, README.md and contribution.md; nothing references this file and .gitignore does not cover it, so it would ship as a permanent stray file. The same information already belongs in the PR description field. It also begins with a UTF-8 BOM: git show 8956f3b:PR_DESCRIPTION.md | head -c 6 | xxd returns efbb bf23 2041.

Please delete PR_DESCRIPTION.md from the branch.


## Purpose

- 新增 Apache SeaTunnel Connector 集成快速上手文档，作为 HugeGraph 工具链的生态入口之一
- 帮助新用户理解 SeaTunnel 与 Loader / Tools 的选型边界，并给出 JDBC / Kafka / graph2graph 三类常见用法

## Changes

- **New**: `content/cn/docs/quickstart/toolchain/hugegraph-seatunnel-connector.md` — CN 快速上手：
- 发布版（2.3.13，`schema_config`）与 dev（Source + `mappings`）分开讲解，示例按上游 commit 钉住核对
- sql2graph（JDBC 顶点/边写入）、kafka2graph（流式写入）、graph2graph（图迁移，dev）三个场景，含完整 HOCON 配置与验证命令
- dev 示例与上游最新状态对齐（2026-08）：HugeGraph Source 与 `mappings` 多映射已随 PR apache/seatunnel#11413 合入 dev（2026-08-05），将随 SeaTunnel **3.0.0** 发布；2.3.13 内置 Client 1.5.0，dev 已升 1.7.0
- 补充 dev Source 要点：省略 `label` 读全量（多表输出、不可配 `schema`/`filter`）、`parallelism > 1` 分片并行要求可扫描后端（RocksDB / HBase / Cassandra）且与 `filter` 互斥、`~id`/`~source_id`/`~target_id` 保留列克隆
- 常用配置表区分 `schema_config`（2.3.13）与 `mappings`（dev），并列出 dev 新增选项（`schema_save_mode`、`data_save_mode`、`check_vertex`、失败回退、重试、`updateStrategies`、`listFormat`、`unfold*` 等）
- 参考文档补齐官网版本化链接（2.3.13 Sink）与上游追踪链接（apache/seatunnel#10001 / #10002 / #11413 / #11329）
- **New images**: `content/cn/docs/images/seatunnel/*.png`（总览 / sql2graph / kafka2graph / graph2graph 示意图）
- **Modified**: `content/cn/docs/introduction/_index.md` — 工具链表新增 SeaTunnel-connector 条目（Sink 2.3.13+；Source 已合入 dev，随 3.0.0 发布）；新增全栈生态全景图

## Notes for reviewers

- 按 review 意见先出纯 CN 版本，EN 版本通过后再补
- dev 示例按上游 commit `f1a1a0a` 核对（含 #11413 合入后的 Source / Sink 文档），`dev` 会继续变化，文档已注明需重新核对
- Source 尚未随正式 Release 发布（已合入 dev，随 SeaTunnel 3.0.0 发布）；3.0.0 发版后可将 dev 示例链接切换为官网版本化地址

## Related

- 功能请求：apache/seatunnel#10001
- Sink Connector（已随 SeaTunnel 2.3.13 发布）：apache/seatunnel#10002
- Source Connector + 多映射重构（2026-08-05 合入 dev，随 3.0.0 发布）：apache/seatunnel#11413
- 文档改进：apache/seatunnel#11329
Binary file added content/cn/docs/images/seatunnel/seatunnel-graph2graph.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/cn/docs/images/seatunnel/seatunnel-kafka2graph.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/cn/docs/images/seatunnel/seatunnel-overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/cn/docs/images/seatunnel/seatunnel-sql2graph.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 4 additions & 12 deletions content/cn/docs/introduction/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,9 @@ HugeGraph 支持百亿以上的顶点和边的快速存储与查询，具备出

### 生态系统全景

```
┌──────────────────────────────────────────────────────────────┐
│ Apache HugeGraph - Full-Stack Graph System │
├──────────────────┬────────────────────┬──────────────────────┤
│ Graph DB (OLTP) │ Graph Compute │ Graph AI │
│ HugeGraph │ Vermeer (Memory) │ HugeGraph-AI │
│ Server │ Computer (Dist.) │ GraphRAG/GNN/Py │
├──────────────────┴────────────────────┴──────────────────────┤
│ HugeGraph Toolchain │
│ Hubble | Loader | Client(Java/Go/Py) | Spark | Tools │
└──────────────────────────────────────────────────────────────┘
```
![HugeGraph 生态与 SeaTunnel 数据流](/cn/docs/images/seatunnel/seatunnel-overview.png)

@bitflicker64 bitflicker64 Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ important - Removing the ASCII block is listed as intentional in the PR description, but the heading above is still ### 生态系统全景 and the figure that replaces it does not cover that subject. I opened seatunnel-overview.png at this head: it shows JDBC / Kafka / 文件 boxes, then SeaTunnel, then HugeGraph, with 读取 / 转换 / 写入 underneath. None of what the removed block listed survives: Graph DB (OLTP) HugeGraph Server, Graph Compute (Vermeer, Computer), Graph AI (HugeGraph-AI, GraphRAG/GNN/Py), and the Toolchain row (Hubble, Loader, Client, Spark, Tools). So this section loses content unrelated to SeaTunnel, and content/en/docs/introduction/_index.md still carries the block at lines 23-34, leaving the two language versions describing different things under the same heading.

Please keep an ecosystem figure here, replacing the ASCII block with a diagram of the same scope if the alignment problems are the reason for dropping it. The SeaTunnel figure already appears on the new connector page at line 12, which is the right place for it.


HugeGraph 负责图存储和查询，Toolchain 负责导入、管理和连接外部数据系统。需要把 JDBC、Kafka 等数据接入图数据库时，可以从 [SeaTunnel Connector 快速开始](/cn/docs/quickstart/toolchain/hugegraph-seatunnel-connector) 开始。

---

Expand Down Expand Up @@ -94,6 +85,7 @@ HugeGraph 独立的 AI 组件，连接图与大语言模型（LLM）：
| [Loader](/cn/docs/quickstart/toolchain/hugegraph-loader) | 数据导入工具：支持本地文件、HDFS、MySQL 等多数据源，TXT/CSV/JSON 等格式 |
| [Client](/cn/docs/quickstart/client/hugegraph-client) | 多语言 SDK：Java / Python / Go |
| [Spark-connector](/cn/docs/quickstart/toolchain/hugegraph-spark-connector) | Spark 集成：支持通过 Spark 批量读写图数据，适合大数据离线处理场景 |
| [SeaTunnel Connector](/cn/docs/quickstart/toolchain/hugegraph-seatunnel-connector) | 提供 HugeGraph Sink（2.3.13+）；Source 已合入 dev，随 SeaTunnel 3.0.0 发布 |
| [Tools](/cn/docs/quickstart/toolchain/hugegraph-tools) | 命令行运维工具：图管理、备份恢复、Gremlin 执行等 |

---
Expand Down
Loading
Loading