Skip to content

docs: add the ThingsBoard table-model integration page - #1199

Open
PDGGK wants to merge 1 commit into
apache:mainfrom
PDGGK:docs-thingsboard-table-model
Open

docs: add the ThingsBoard table-model integration page#1199
PDGGK wants to merge 1 commit into
apache:mainfrom
PDGGK:docs-thingsboard-table-model

Conversation

@PDGGK

@PDGGKPDGGK commented Aug 20, 2026

Copy link
Copy Markdown

What

Adds a user-guide page for the iotdb-thingsboard-table module in apache/iotdb-extras, which lets a stock ThingsBoard instance store telemetry and attributes in IoTDB 2.x table model by putting the module and its runtime dependencies on its classpath and setting a few properties. (The page lists the exact jar set; it is not a single jar.)

The page is modelled on the existing Spark-IoTDB page — overview first, then requirements and deployment — and adds Configuration and Known Limitations sections that this integration needs.

Why a second ThingsBoard page

The site already has a ThingsBoard page under the tree model, but it documents a different deployment — an IoTDB-adapted ThingsBoard package writing to root.thingsboard. This one is stock ThingsBoard plus the module and its runtime dependencies, against table model.

Rather than replace or merge them, the new page opens with a paragraph distinguishing the two and links across to the tree-model page, so a reader who has landed on the wrong one can get to the right one.

That link is currently one-directional — the tree-model page does not point back here. Making it symmetric is a follow-up I have deliberately left out of this PR; see the last note below.

Files (10)

newThingsboard.md in latest-Table and Master/Table, EN + ZH
modifieden-Table.ts / zh-Table.ts sidebars — new "IoT Platform" / "物联网对接" group
modifiedEcosystem-Overview_apache.md index row in all four trees

Notes for reviewers

  • No screenshots. In this directory the screenshot-heavy pages are the GUI clients — DBeaver has 11, DataGrip 13. The code-integration pages carry few or none: SeaTunnel, Mybatis-Generator and Spring-Boot-Starter have zero, MyBatisPlus-Generator has one, Spark-IoTDB two. This page is a code integration, so I left them out rather than manufacture images. I have since run the deployment end to end (ThingsBoard 4.3.1.2 against IoTDB 2.0.8), so real screenshots are now possible — say the word and I will add them.
  • Cross-tree links differ by tree because the layout requires it: from latest-Table the tree-model page is at ../../latest/, from Master/Table it is at ../../Tree/. There is no Master/latest and no top-level Tree, so exactly one of these resolves per copy.
  • The back-link is not in this PR. The tree-model ThingsBoard page exists in four version trees (V1.3.x, dev-1.3, latest, Master/Tree) in both languages, so a blanket back-link is 8 files. I would suggest scoping it to latest and Master/Tree (4 files) rather than all eight: V1.3.x and dev-1.3 document IoTDB versions that have no table model, so pointing them at a table-model integration would advertise something those versions cannot run. Happy to do that as a follow-up, or fold it in here if you would rather it land together.

The module is the deliverable of GSoC 2026 project GSOC-304, mentored by @CritasWang, who asked for this page.

@PDGGK
PDGGKforce-pushed the docs-thingsboard-table-model branch from 72d2929 to df82defCompareAugust 20, 2026 03:45
Adds a user-guide page for the iotdb-thingsboard-table module in
apache/iotdb-extras: stock ThingsBoard storing telemetry and attributes in
IoTDB 2.x table model, by placing the module and its runtime dependencies on
ThingsBoard's classpath and setting a few properties. The page lists the exact
jar set, including the ones that must NOT be copied because ThingsBoard bundles
newer copies of them.
Four new pages -- Thingsboard.md in latest-Table and Master/Table, English and
Chinese -- plus the two sidebar groups and the four Ecosystem-Overview index
rows. Structure follows the existing Spark-IoTDB page.
The attributes selector is documented as not yet usable on a stock ThingsBoard:
ThingsBoard registers its JPA attributes bean unconditionally and exposes no
switch for it, so setting the selector currently fails startup. The fix is
apache/iotdb-extras#125; the page says so and will be updated when a build
containing it is released.
@PDGGK
PDGGKforce-pushed the docs-thingsboard-table-model branch from 56a80ea to e44cfd4CompareAugust 21, 2026 09:37
@PDGGKPDGGK changed the title docs: add ThingsBoard table-model integration pagedocs: add the ThingsBoard table-model integration pageAug 21, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@PDGGK