Repository navigation
Conversation
PDGGK
force-pushed
the
docs-thingsboard-table-model
branch
2 times, most recently
from
August 21, 2026 09:37
56a80ea to
e44cfd4
Compare
Contributor
|
@PDGGK add some's screenshots |
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
force-pushed
the
docs-thingsboard-table-model
branch
from
September 23, 2026 07:51
9d334cc to
3bac99e
Compare
The module is now released in Apache IoTDB Extras 2.0.11, with its jar attached to the GitHub release. Download it and its nine IoTDB client dependencies instead of building from a commit, and update the tested IoTDB version to 2.0.11. The jar list changes for the 2.0.11 client: pipe-api is no longer needed, libthrift is 0.23.0 and tsfile/common are 2.4.0. All ten jars are required even with no selector set, because ThingsBoard does not start with the module jar alone. Signed-off-by: Zihan Dai <1436286758@qq.com>
Author
|
@CritasWang The screenshots you asked for are in section 4 (the device's latest telemetry and client attributes pages), added in 3bac99e. I have also updated the page for the 2.0.11 release: it now downloads iotdb-thingsboard-table-2.0.11.jar from the release and the nine IoTDB client jars from Maven Central, instead of building from a commit. I followed the updated steps on ThingsBoard 4.3.1.2 with IoTDB 2.0.11: the commands give the ten jars with a good signature, ThingsBoard starts, and telemetry and a client attribute sent through ThingsBoard read back from IoTDB with the same timestamps. |
- Say where the settings go: a Docker Compose snippet and the Linux package's /etc/thingsboard/conf/thingsboard.conf, both passing them as SPRING_APPLICATION_JSON, and note that the .deb does not create /usr/share/thingsboard/extensions. - Explain each setting for operators: what iotdb.ts.experimental-raw-only actually switches on, how the three kinds of data depend on each other, and what cluster_mode requires with one or several ThingsBoard nodes. - List the jars once, keep other extension jars, and drop design terms the reader does not need. - Compare IoTDB rows against the device's own ID, keys and times. - Rewrite the Chinese page in plain Chinese rather than as a translation. Signed-off-by: Zihan Dai <1436286758@qq.com>
Give the configuration section one subsection each for Docker, the Linux package, choosing what IoTDB stores, and one or several ThingsBoard nodes, so the JSON appears only where it is used. Clarify that a node here is a ThingsBoard node, that sticky-routing does not set up routing and that disabled does not turn storage off, and that an existing SPRING_APPLICATION_JSON or extensions mount should be merged rather than duplicated. Install the jars on the .deb with install -m 0644. Signed-off-by: Zihan Dai <1436286758@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a user-guide page for the
iotdb-thingsboard-tablemodule inapache/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)
Thingsboard.mdinlatest-TableandMaster/Table, EN + ZHen-Table.ts/zh-Table.tssidebars — new "IoT Platform" / "物联网对接" groupEcosystem-Overview_apache.mdindex row in all four treesNotes for reviewers
latest-Tablethe tree-model page is at../../latest/, fromMaster/Tableit is at../../Tree/. There is noMaster/latestand no top-levelTree, so exactly one of these resolves per copy.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 tolatestandMaster/Tree(4 files) rather than all eight:V1.3.xanddev-1.3document 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.