prasad-anandappa opened a new pull request, #13148:
URL: https://github.com/apache/seatunnel/pull/13148

   ### Purpose of this pull request
   
   Yes — happy to contribute this to SeaTunnel.
   
   Related to #12809
   
   This pull request rewrites the RegexExtract transform documentation 
(`docs/en/transforms/regexextract.md` and `docs/zh/transforms/regexextract.md`) 
to the connector documentation standard defined in the umbrella issue #12809. 
It is a documentation-only change for one plugin, as requested by the tracker 
(claim: 
https://github.com/apache/seatunnel/issues/12809#issuecomment-6661943893).
   
   The rewrite adds, in both English and Chinese:
   
   - `Support Those Engines` (Spark / Flink / SeaTunnel Zeta), an expanded 
`Description`, and `Key Features`
   - A five-column `Options` table (`Name | Type | Required | Default | 
Description`) covering all plugin options plus the shared multi-table options 
`table_match_regex`, `table_transform`, `rule_match_mode` and the common 
options, which the old four-column placeholder table did not document
   - One section per option, with constraints and interactions verified against 
the code
   - A `Multi-Table Configuration` section (per-table entries take precedence 
over the transform level rule; every entry must be a complete single-table 
rule; when only `table_transform` is configured, tables without an entry stay 
unchanged) with a complete runnable job
   - Examples covering the three usages: transform level rule only / transform 
level rule plus per-table rules / per-table rules only
   
   Option names, types, required flags, defaults and constraints were verified 
against:
   
   - `RegexExtractTransformConfig` (`source_field` String, `regex_pattern` 
String, `output_fields` List<String>, `default_values` List<String>, all with 
no default value)
   - `RegexExtractTransformFactory#optionRule()` (`source_field`, 
`regex_pattern` and non-empty `output_fields` required in a single-table rule; 
`default_values` optional with a length-must-equal-`output_fields` validator; 
`table_transform` entries validated against the same single-table rule)
   - `RegexExtractTransform` (pattern compiled with `java.util.regex.Pattern` 
and applied with `Matcher#find`; capture group count must equal `output_fields` 
size; null source value or non-matching pattern falls back to `default_values`, 
otherwise null; output columns are nullable `STRING` columns of length 200 
appended after the input columns)
   - `RegexExtractMultiCatalogTransform` and `TransformCommonOptions` 
(`table_match_regex` default `.*`, `rule_match_mode` default `FIRST_MATCH`, 
duplicate `table_path` entries rejected when `rule_match_mode` is not set 
explicitly)
   
   ### Does this PR introduce _any_ user-facing change?
   
   Yes — documentation only. No code, configuration or behaviour changes. The 
previous RegexExtract pages were the early placeholder version (four-column 
options table, no engine list, no multi-table options); this PR brings them to 
the same standard as the already-rewritten transform documents (for example 
Split, #13118).
   
   ### How was this patch tested?
   
   Documentation-only change, so no code tests were run. The content was 
verified by reading the implementation and the existing tests:
   
   - `RegexExtractTransformFactoryTest` — required options, empty 
`output_fields` rejection, `default_values` length validation, 
`table_transform`-only configuration
   - `RegexExtractTransformTest` — produced catalog table (output columns are 
`STRING`, length 200)
   - Every HOCON example was checked against the option rule above (required 
options present in every rule, capture group counts equal to `output_fields` 
sizes, `table_transform` entries complete)
   
   ### Check list
   
   * [ ] If any new Jar binary package adding in your PR, please add License 
Notice according
     [New License 
Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/developer/new-license.md)
   * [x] If necessary, please update the documentation to describe the new 
feature. https://github.com/apache/seatunnel/tree/dev/docs
   * [ ] If necessary, please update `incompatible-changes.md` to describe the 
incompatibility caused by this PR.
   * [ ] If you are contributing the connector code, please check that the 
following files are updated:
     1. Update 
[plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties)
 and add new connector information in it
     2. Update the pom file of 
[seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml)
     3. Add ci label in 
[label-scope-conf](https://github.com/apache/seatunnel/blob/dev/.github/workflows/labeler/label-scope-conf.yml)
     4. Add e2e testcase in 
[seatunnel-e2e](https://github.com/apache/seatunnel/tree/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/)
     5. Update connector 
[plugin_config](https://github.com/apache/seatunnel/blob/dev/config/plugin_config)
   


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