PDGGK opened a new pull request, #119: URL: https://github.com/apache/iotdb-extras/pull/119
Adds the user and migration guides for the IoTDB Table Mode ThingsBoard backend, and corrects two descriptions that no longer match the code. ### Docs - **`docs/user-guide.md`** — activation selectors for each of the three storage paths, what each DAO implements, schema and bootstrap behaviour, retention/TTL, the configuration reference, and the known limitations. - **`docs/migration-guide.md`** — what a migration from an existing ThingsBoard backend carries over and what it does not, and the operational steps. ### Two corrections Writing the guides surfaced two places where the shipped description had fallen behind the implementation. **1. `IoTDBTableConfig.Ts#experimentalRawOnly` javadoc.** It still read "This backend currently implements write, raw read, and delete only; time-bucketed aggregation is outside the current scope." Time-bucketed aggregation has been implemented since the `date_bin` and calendar-bucket read paths landed in #115, so the javadoc now describes what the flag actually gates, notes that the property name predates the aggregation support and is kept for compatibility, and states the Phase-1 relaxation that is the real reason it stays experimental. **2. The unsupported-operations description.** The guide's first draft said the batch latest read throws `UnsupportedOperationException`. It does not — `findLatestByEntityIds` and `findLatestByEntityIdsAsync` return empty deliberately, because they back the `includeSamples` branch of `POST /api/entitiesQuery/find/keys`, where a synchronous throw would surface as an HTTP 500. That mirrors `CassandraBaseTimeseriesLatestDao`. `findNextBatch` is the only method in the module that throws, and that half of the statement was correct; the two are now stated separately. Also drops a comment reference in `IoTDBTableTimeseriesDao` pointing at a document outside this repository. ### Scope Documentation and comments only — no behaviour change, no new dependency. `mvn -P with-thingsboard -pl iotdb-thingsboard-table spotless:check test-compile` passes. The ingestion-throughput benchmark from the same work is held back as a separate change so this one stays cheap to review. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
