DanielCarter-stack commented on issue #10537: URL: https://github.com/apache/seatunnel/issues/10537#issuecomment-3976459477
<!-- code-pr-reviewer --> Verified this as a valid documentation request. The `MultiTableSinkWriter` class (seatunnel-api/src/main/java/org/apache/seatunnel/api/sink/multitablesink/MultiTableSinkWriter.java, lines 48-373) currently has no method-level Javadoc, which creates a significant barrier for connector developers implementing `SupportMultiTableSinkWriter`. The Issue accurately lists 9 methods needing documentation, and all line numbers match the source code: - Constructor (line 64): needs explanation for `queueSize * 2` thread pool sizing - `initResourceManager(int)` (line 112): resource initialization across writers - `subSinkErrorCheck()` (line 134): async error propagation mechanism - `write(SeaTunnelRow)` (line 179): hash-based routing logic - `snapshotState(long)` (line 222): checkpoint coordination - `prepareCommit(long)` (line 246): queue draining before commit - `abortPrepare()` (line 294): rollback semantics - `close()` (line 322): resource cleanup - `checkQueueRemain()` (line 361): busy-wait mechanism The existing architecture documentation (docs/en/architecture/features/multi-table.md, section 4.2) provides high-level pseudocode but doesn't explain critical implementation details like thread safety, error propagation, or the modulo-based distribution strategy. **Recommendation**: This is a good first issue for contributors familiar with SeaTunnel's sink API. The Issue author has already provided a solid template of what needs to be documented. -- 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]
