[HUDI-1186][DOC] Add description of write commit callback by kafka to document#1974
[HUDI-1186][DOC] Add description of write commit callback by kafka to document#1974yanghua merged 3 commits intoapache:asf-sitefrom
Conversation
yanghua
left a comment
There was a problem hiding this comment.
@wangxianghu Thanks for your contribution. Left some comments.
docs/_docs/2_4_configurations.cn.md
Outdated
|
|
||
| ### 写提交回调配置 | ||
| 控制写提交的回调。 如果用户启用了回调并且回调过程发生了错误,则会抛出异常。 当前只支持Http回调方式,Kafka不久后会支持。 | ||
| 控制写提交的回调。 如果用户启用了回调并且回调过程发生了错误,则会抛出异常。 当前只支持 Http, Kafka 两种回调方式。 |
There was a problem hiding this comment.
Can we remove 只? And Http -> HTTP?
There was a problem hiding this comment.
Can we remove
只? AndHttp->HTTP?
done
docs/_docs/2_4_configurations.cn.md
Outdated
| ##### withCallbackClass(callbackClass) {#withCallbackClass} | ||
| Property: `hoodie.write.commit.callback.class` <br/> | ||
| <span style="color:grey">用户自定义回调的类全路径名,回调类必须为HoodieWriteCommitCallback的子类。默认 org.apache.hudi.callback.impl.HoodieWriteCommitHttpCallback</span> | ||
| <span style="color:grey">回调类全路径名,回调类必须为HoodieWriteCommitCallback的子类。默认 org.apache.hudi.callback.impl.HoodieWriteCommitHttpCallback</span> |
There was a problem hiding this comment.
回调类全路径名 -> 回调类的完全限定名 and 必须为HoodieWriteCommitCallback的子类 -> 必须实现HoodieWriteCommitCallback接口
There was a problem hiding this comment.
回调类全路径名->回调类的完全限定名and必须为HoodieWriteCommitCallback的子类->必须实现HoodieWriteCommitCallback接口
done
docs/_docs/2_4_configurations.cn.md
Outdated
|
|
||
| ##### CALLBACK_KAFKA_TOPIC | ||
| Property: `hoodie.write.commit.callback.kafka.topic` <br/> | ||
| <span style="color:grey">发送回调信息的主题</span> |
There was a problem hiding this comment.
主题-> topic
done
docs/_docs/2_4_configurations.md
Outdated
|
|
||
| ### Write commit callback configs | ||
| Controls callback behavior on write commit. Exception will be thrown if user enabled the callback service and errors occurred during the process of callback. Currently support http callback only, kafka implementation will be supported in the near future. | ||
| Controls callback behavior on write commit. Exception will be thrown if user enabled the callback service and errors occurred during the process of callback. Currently support http, kafka type only. |
There was a problem hiding this comment.
Remove
only.
done
docs/_docs/2_4_configurations.md
Outdated
|
|
||
| #### HoodieWriteCommitHttpCallback | ||
| #### HTTP CALLBACK | ||
| Callback via http, User does not need to specify this way explicitly, it is the default type. |
There was a problem hiding this comment.
http->HTTP
done
yanghua
left a comment
There was a problem hiding this comment.
@wangxianghu Thanks for addressing my concern. LGTM now.
Tips
What is the purpose of the pull request
Add description of write commit callback by kafka to document
Brief change log
(for example:)
Verify this pull request
(Please pick either of the following options)
This pull request is a trivial rework / code cleanup without any test coverage.
(or)
This pull request is already covered by existing tests, such as (please describe tests).
(or)
This change added tests and can be verified as follows:
(example:)
Committer checklist
Has a corresponding JIRA in PR title & commit
Commit message is descriptive of the change
CI is green
Necessary doc changes done or have another open PR
For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.