apache/seatunnel

[Docs][Core] Add Javadoc to MultiTableWriterRunnable

Open

#10538 opened on Feb 28, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (6,897 stars) (1,432 forks)batch import
help wanted

Description

Sub-issue of #10533

Scope

MultiTableWriterRunnable is the async worker that drains a BlockingQueue<SeaTunnelRow> and dispatches rows to per-table SinkWriter instances. It has no method-level Javadoc despite containing subtle concurrency and schema-evolution logic.

File

seatunnel-api/src/main/java/org/apache/seatunnel/api/sink/multitablesink/MultiTableWriterRunnable.java

Methods to document

Method Line What to explain
Constructor 37 tableWriterMap keyed by tableIdentifier string; queue ownership (each runnable owns exactly one BlockingQueue)
run() 45 Infinite loop draining the queue; row.getArity() == 0 as control signal for schema-evolution events; synchronized(this) block ensures snapshotState cannot run concurrently with an active write
getThrowable() 91 Returns first unhandled exception from the run loop; null means the worker is healthy; checked by MultiTableSinkWriter.subSinkErrorCheck()
getCurrentTableId() 95 Diagnostic field: the tableId of the row currently being written; may be null or stale between rows

How to contribute

  1. Fork the repo and create a branch
  2. Add Javadoc to the four methods above
  3. Run ./mvnw spotless:apply and ./mvnw -q -DskipTests verify
  4. Open a PR with title: [Docs][Core] Add Javadoc to MultiTableWriterRunnable

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaMavenGitJavadoc basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The main file is seatunnel api/src/main/java/org/apache/seatunnel/api/sink/multitablesink/MultiTableWriterRunnable.java. Methods to document are the constructor, run(), getThrowable(), and getCurrentTableId(). The issue provides specific explanations for each. Ensure Javadoc describes concurrency and schema evolution logic as noted. After adding Javadoc, run ./mvnw spotless:apply and verify tests pass.