[
https://issues.apache.org/jira/browse/HUDI-5703?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ethan Guo updated HUDI-5703:
----------------------------
Description:
* Adds {{subGroupName}} and {{areCommonConfigs}} in {{ConfigClassProperty}}
annotation.
* Restructures index, lock, and commit configs to subgroups{{{}{}}}
* Adds the ability to provide docs on the default value in
{{{}ConfigProperty{}}}: {{{}docOnDefaultValue{}}},
{{{}getDocOnDefaultValue(){}}}, so that the note on default can be shown on the
configuration page.
* Adds {{hasInferFunction()}} in {{ConfigProperty}}
* Removes {{ConfigClassProperty}} annotation for {{HoodieTableConfig}} so they
do not show up on the configuration page, as these are not meant to be changed
by the user.
* Adds description for {{META_SYNC}} and {{AWS}} config groups
was:
* Adds {{subGroupName}} and {{areCommonConfigs}} in {{ConfigClassProperty}}
annotation. Now we can structures the configs in three-level hierarchy
(previously, it's two-level): {{groupName}} -> {{subGroupName}} (optional) ->
config class. New {{SubGroupNames}} in {{ConfigGroups}} is added for the
sub-group name. {{areCommonConfigs}} indicates whether these are common
configs, showing as the first in the sub-group if true.
* Restructures index, lock, and commit configs:
** LOCK sub-group: {{{}HoodieLockConfig{}}}, {{DynamoDbBasedLockConfig}}
** INDEX sub-group: {{{}HoodieIndexConfig{}}}, {{HoodieHBaseIndexConfig}}
** COMMIT_CALLBACK sub-group: {{{}HoodieWriteCommitCallbackConfig{}}},
{{{}HoodieWriteCommitKafkaCallbackConfig{}}},
{{HoodieWriteCommitPulsarCallbackConfig}}
* Adds the ability to provide docs on the default value in
{{{}ConfigProperty{}}}: {{{}docOnDefaultValue{}}},
{{{}getDocOnDefaultValue(){}}}, so that the note on default can be shown on the
configuration page.
* Adds {{hasInferFunction()}} in {{ConfigProperty}}
* Removes {{ConfigClassProperty}} annotation for {{HoodieTableConfig}} so they
do not show up on the configuration page, as these are not meant to be changed
by the user.
* Adds description for {{META_SYNC}} and {{AWS}} config groups
> Improve ConfigProperty APIs for docs generation
> -----------------------------------------------
>
> Key: HUDI-5703
> URL: https://issues.apache.org/jira/browse/HUDI-5703
> Project: Apache Hudi
> Issue Type: New Feature
> Reporter: Ethan Guo
> Assignee: Ethan Guo
> Priority: Blocker
> Labels: pull-request-available
> Fix For: 0.13.0
>
>
> * Adds {{subGroupName}} and {{areCommonConfigs}} in {{ConfigClassProperty}}
> annotation.
> * Restructures index, lock, and commit configs to subgroups{{{}{}}}
> * Adds the ability to provide docs on the default value in
> {{{}ConfigProperty{}}}: {{{}docOnDefaultValue{}}},
> {{{}getDocOnDefaultValue(){}}}, so that the note on default can be shown on
> the configuration page.
> * Adds {{hasInferFunction()}} in {{ConfigProperty}}
> * Removes {{ConfigClassProperty}} annotation for {{HoodieTableConfig}} so
> they do not show up on the configuration page, as these are not meant to be
> changed by the user.
> * Adds description for {{META_SYNC}} and {{AWS}} config groups
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
