DanielCarter-stack opened a new pull request, #11719:
URL: https://github.com/apache/seatunnel/pull/11719
## What Problem Does This PR Solve?
Five connector doc pages were thin or inconsistent relative to the rest of
the repo's doc template:
- **Hive source / sink** (`docs/en/connectors/source/Hive.md`,
`docs/en/connectors/sink/Hive.md`):
- Both files were missing the standard `## Support Those Engines` block.
- The options tables had no `description` column, so readers had to read
the per-option prose to understand what each key did.
- The source doc's example blocks used ```bash``` fences instead of
```hocon```, even though the content was HOCON job config.
- **Elasticsearch sink** (`docs/en/connectors/sink/Elasticsearch.md`):
- Missing `## Support Those Engines` block.
- The options table had no `description` column.
- The top-level `## Description` was a single sentence that did not
explain the Bulk API buffering or the supported Elasticsearch version range.
- **Mysql sink** (`docs/en/connectors/sink/Mysql.md`):
- Example code blocks were bare ``` fences, so the renderer could not
syntax-highlight them as HOCON.
- **SqlServer source** (`docs/en/connectors/source/SqlServer.md`):
- The `## Description` section was a single generic sentence that did not
reflect what the connector actually does (single/multi-table reads, partition
splits).
## Fix approach
Pure documentation work — no source, config, SPI, or test files were touched.
- Add the missing `## Support Those Engines` blocks where the repo template
expects them.
- Add a `description` column to the Hive source, Hive sink, and
Elasticsearch sink options tables and populate each row with the actual
behavior of the option (verified against the connector source for `table_list`
/ `tables_configs` / `use_regex` / `metastore_uri` HA failover /
`vectorization_fields` / `auth.api_key_encoded` / etc.).
- Tighten the Elasticsearch sink top-level `## Description` paragraph to
describe the Bulk API batching, the CDC-friendly primary-key based document
IDs, and the supported Elasticsearch version range.
- Tighten the SqlServer source `## Description` to cover single-table,
multi-table, and partitioned reads.
- Convert bare ``` fences to ```hocon``` in the Mysql sink example section
so the rendered output highlights as HOCON.
## What changed (5 files)
- `docs/en/connectors/source/Hive.md`: added Support Those Engines block,
expanded the Description, added a description column to the options table, and
converted 8 bash code blocks to hocon.
- `docs/en/connectors/sink/Hive.md`: added Support Those Engines block,
expanded the Description, added a description column to the options table.
- `docs/en/connectors/sink/Elasticsearch.md`: added Support Those Engines
block, expanded the Description, added a description column to the options
table.
- `docs/en/connectors/sink/Mysql.md`: converted 12 bare code fences to hocon.
- `docs/en/connectors/source/SqlServer.md`: expanded the `## Description`
paragraph to describe single/multi-table and partition reads.
## What did NOT change
- No source, config, SPI, or test files touched.
- No Chinese (`docs/zh`) mirrors updated in this PR; `docs/zh` parity can be
addressed in a follow-up if reviewers want it included here.
- No support-version numbers added or modified.
## Verification
All option-name / default / required claims in the new description cells
were cross-checked against the connector source at upstream/dev (`75e19dadd`):
- Hive source — `HiveSourceOptions.java`, `HiveSourceFactory.optionRule()`,
`HiveConfUtils.java`.
- Hive sink — `HiveSinkOptions.java`, `HiveSinkFactory.optionRule()`.
- Elasticsearch sink — `ElasticsearchSinkOptions.java`,
`ElasticsearchSinkFactory.optionRule()`, `ElasticsearchClient.java` (Bulk API
usage).
- SqlServer source — `MssqlSourceFactory.optionRule()`,
`JdbcSourceFactory.java`, `partition_column` semantics.
## CI
`Build`, `Notify test workflow`, and `labeler` will run automatically once
the PR is opened.
--
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]
