davidzollo opened a new issue, #10535:
URL: https://github.com/apache/seatunnel/issues/10535

   Sub-issue of #10533
   
   ## Scope
   
   Two small SPI interfaces (~60 lines combined) that are the extension points 
for sharing connections across multi-table sink writers. Without Javadoc, 
connector authors do not know when or whether to override them.
   
   ## Files
   
   - 
`seatunnel-api/src/main/java/org/apache/seatunnel/api/sink/SupportResourceShare.java`
   - 
`seatunnel-api/src/main/java/org/apache/seatunnel/api/sink/MultiTableResourceManager.java`
   
   ## Methods to document
   
   | Method | File | Line | What to explain |
   |--------|------|------|-----------------|
   | `initMultiTableResourceManager(int tableSize, int queueSize)` | 
`SupportResourceShare` | 22 | When to override; what `tableSize` (number of 
target tables) and `queueSize` (parallel write queues) mean; called once per 
job by `MultiTableSinkWriter` constructor |
   | `setMultiTableResourceManager(MultiTableResourceManager<T>, int 
queueIndex)` | `SupportResourceShare` | 27 | Called after 
`initMultiTableResourceManager`; `queueIndex` identifies which write queue this 
writer belongs to; use it to retrieve the shared resource |
   | `getSharedResource()` | `MultiTableResourceManager` | 25 | Thread-safety 
contract; when `Optional.empty()` is acceptable vs when to return a real shared 
object (e.g., connection pool) |
   | `close()` | `MultiTableResourceManager` | 29 | Called by 
`MultiTableSinkWriter.close()` after all per-table writers are closed; 
implementation should release pooled connections |
   
   ## 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 SupportResourceShare 
and MultiTableResourceManager`


-- 
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]

Reply via email to