EricJoy2048 commented on code in PR #4405:
URL: https://github.com/apache/seatunnel/pull/4405#discussion_r1666597978
##########
docs/en/connector-v2/sink/Hudi.md:
##########
@@ -0,0 +1,98 @@
+# Hudi
+
+> Hudi sink connector
+
+## Description
+
+Used to write data to Hudi.
+
+## Key features
+
+- [x] [exactly-once](../../concept/connector-v2-features.md)
+- [x] [cdc](../../concept/connector-v2-features.md)
+
+## Options
+
+| name | type | required | default value |
+|----------------------------|--------|----------|---------------|
+| table_name | string | yes | - |
+| table_dfs_path | string | yes | - |
+| conf_files_path | string | no | - |
+| record_key_fields | string | no | - |
+| partition_fields | string | no | - |
+| table_type | string | no | copy_on_write |
+| op_type | string | no | insert |
+| batch_interval_ms | Int | no | 1000 |
+| insert_shuffle_parallelism | Int | no | 2 |
+| upsert_shuffle_parallelism | Int | no | 2 |
+| min_commits_to_keep | Int | no | 20 |
+| max_commits_to_keep | Int | no | 30 |
+| common-options | config | no | - |
+
+### table_name [string]
+
+`table_name` The name of hudi table.
+
+### table_dfs_path [string]
+
+`table_dfs_path` The dfs root path of hudi table,such as
'hdfs://nameserivce/data/hudi/hudi_table/'.
+
+### table_type [string]
+
+`table_type` The type of hudi table.
+
+### conf_files_path [string]
+
+`conf_files_path` The environment conf file path list(local path), which used
to init hdfs client to read hudi table file. The example is
'/home/test/hdfs-site.xml;/home/test/core-site.xml;/home/test/yarn-site.xml'.
+
+### op_type [enum]
+
+`op_type` The operation type of hudi table. The value is 'insert' or 'upsert'
or 'bulk_insert'.
+
+### batch_interval_ms [Int]
+
+`batch_interval_ms` The interval time of batch write to hudi table.
+
+### insert_shuffle_parallelism [Int]
+
+`insert_shuffle_parallelism` The parallelism of insert data to hudi table.
+
+### upsert_shuffle_parallelism [Int]
+
+`upsert_shuffle_parallelism` The parallelism of upsert data to hudi table.
+
+### min_commits_to_keep [Int]
+
+`min_commits_to_keep` The min commits to keep of hudi table.
+
+### max_commits_to_keep [Int]
+
+`max_commits_to_keep` The max commits to keep of hudi table.
+
+### common options
+
+Source plugin common parameters, please refer to [Source Common
Options](common-options.md) for details.
+
+## Examples
+
+```hocon
+source {
+
+ Hudi {
+ table.path = "hdfs://nameserivce/data/hudi/hudi_table/"
+ table.type = "cow"
Review Comment:
```suggestion
table_type = "cow"
```
##########
docs/en/connector-v2/sink/Hudi.md:
##########
@@ -0,0 +1,98 @@
+# Hudi
+
+> Hudi sink connector
+
+## Description
+
+Used to write data to Hudi.
+
+## Key features
+
+- [x] [exactly-once](../../concept/connector-v2-features.md)
+- [x] [cdc](../../concept/connector-v2-features.md)
+
+## Options
+
+| name | type | required | default value |
+|----------------------------|--------|----------|---------------|
+| table_name | string | yes | - |
+| table_dfs_path | string | yes | - |
+| conf_files_path | string | no | - |
+| record_key_fields | string | no | - |
+| partition_fields | string | no | - |
+| table_type | string | no | copy_on_write |
+| op_type | string | no | insert |
+| batch_interval_ms | Int | no | 1000 |
+| insert_shuffle_parallelism | Int | no | 2 |
+| upsert_shuffle_parallelism | Int | no | 2 |
+| min_commits_to_keep | Int | no | 20 |
+| max_commits_to_keep | Int | no | 30 |
+| common-options | config | no | - |
+
+### table_name [string]
+
+`table_name` The name of hudi table.
+
+### table_dfs_path [string]
+
+`table_dfs_path` The dfs root path of hudi table,such as
'hdfs://nameserivce/data/hudi/hudi_table/'.
+
+### table_type [string]
+
+`table_type` The type of hudi table.
Review Comment:
Does this option‘s type is `enum` ?
##########
docs/en/connector-v2/sink/Hudi.md:
##########
@@ -0,0 +1,98 @@
+# Hudi
+
+> Hudi sink connector
+
+## Description
+
+Used to write data to Hudi.
+
+## Key features
+
+- [x] [exactly-once](../../concept/connector-v2-features.md)
+- [x] [cdc](../../concept/connector-v2-features.md)
+
+## Options
+
+| name | type | required | default value |
+|----------------------------|--------|----------|---------------|
+| table_name | string | yes | - |
+| table_dfs_path | string | yes | - |
+| conf_files_path | string | no | - |
+| record_key_fields | string | no | - |
+| partition_fields | string | no | - |
+| table_type | string | no | copy_on_write |
+| op_type | string | no | insert |
+| batch_interval_ms | Int | no | 1000 |
+| insert_shuffle_parallelism | Int | no | 2 |
+| upsert_shuffle_parallelism | Int | no | 2 |
+| min_commits_to_keep | Int | no | 20 |
+| max_commits_to_keep | Int | no | 30 |
+| common-options | config | no | - |
+
+### table_name [string]
+
+`table_name` The name of hudi table.
+
+### table_dfs_path [string]
+
+`table_dfs_path` The dfs root path of hudi table,such as
'hdfs://nameserivce/data/hudi/hudi_table/'.
+
+### table_type [string]
+
+`table_type` The type of hudi table.
+
+### conf_files_path [string]
+
+`conf_files_path` The environment conf file path list(local path), which used
to init hdfs client to read hudi table file. The example is
'/home/test/hdfs-site.xml;/home/test/core-site.xml;/home/test/yarn-site.xml'.
+
+### op_type [enum]
+
+`op_type` The operation type of hudi table. The value is 'insert' or 'upsert'
or 'bulk_insert'.
+
+### batch_interval_ms [Int]
+
+`batch_interval_ms` The interval time of batch write to hudi table.
+
+### insert_shuffle_parallelism [Int]
+
+`insert_shuffle_parallelism` The parallelism of insert data to hudi table.
+
+### upsert_shuffle_parallelism [Int]
+
+`upsert_shuffle_parallelism` The parallelism of upsert data to hudi table.
+
+### min_commits_to_keep [Int]
+
+`min_commits_to_keep` The min commits to keep of hudi table.
+
+### max_commits_to_keep [Int]
+
+`max_commits_to_keep` The max commits to keep of hudi table.
+
+### common options
+
+Source plugin common parameters, please refer to [Source Common
Options](common-options.md) for details.
+
+## Examples
+
+```hocon
+source {
+
+ Hudi {
+ table.path = "hdfs://nameserivce/data/hudi/hudi_table/"
Review Comment:
```suggestion
table_dfs_path = "hdfs://nameserivce/data/hudi/hudi_table/"
```
##########
docs/en/connector-v2/sink/Hudi.md:
##########
@@ -0,0 +1,98 @@
+# Hudi
+
+> Hudi sink connector
+
+## Description
+
+Used to write data to Hudi.
+
+## Key features
+
+- [x] [exactly-once](../../concept/connector-v2-features.md)
+- [x] [cdc](../../concept/connector-v2-features.md)
+
+## Options
+
+| name | type | required | default value |
+|----------------------------|--------|----------|---------------|
+| table_name | string | yes | - |
+| table_dfs_path | string | yes | - |
+| conf_files_path | string | no | - |
+| record_key_fields | string | no | - |
+| partition_fields | string | no | - |
+| table_type | string | no | copy_on_write |
+| op_type | string | no | insert |
+| batch_interval_ms | Int | no | 1000 |
+| insert_shuffle_parallelism | Int | no | 2 |
+| upsert_shuffle_parallelism | Int | no | 2 |
+| min_commits_to_keep | Int | no | 20 |
+| max_commits_to_keep | Int | no | 30 |
+| common-options | config | no | - |
+
+### table_name [string]
+
+`table_name` The name of hudi table.
+
+### table_dfs_path [string]
+
+`table_dfs_path` The dfs root path of hudi table,such as
'hdfs://nameserivce/data/hudi/hudi_table/'.
+
+### table_type [string]
+
+`table_type` The type of hudi table.
+
+### conf_files_path [string]
+
+`conf_files_path` The environment conf file path list(local path), which used
to init hdfs client to read hudi table file. The example is
'/home/test/hdfs-site.xml;/home/test/core-site.xml;/home/test/yarn-site.xml'.
+
+### op_type [enum]
+
+`op_type` The operation type of hudi table. The value is 'insert' or 'upsert'
or 'bulk_insert'.
+
+### batch_interval_ms [Int]
+
+`batch_interval_ms` The interval time of batch write to hudi table.
+
+### insert_shuffle_parallelism [Int]
+
+`insert_shuffle_parallelism` The parallelism of insert data to hudi table.
+
+### upsert_shuffle_parallelism [Int]
+
+`upsert_shuffle_parallelism` The parallelism of upsert data to hudi table.
+
+### min_commits_to_keep [Int]
+
+`min_commits_to_keep` The min commits to keep of hudi table.
+
+### max_commits_to_keep [Int]
+
+`max_commits_to_keep` The max commits to keep of hudi table.
+
+### common options
+
+Source plugin common parameters, please refer to [Source Common
Options](common-options.md) for details.
+
+## Examples
+
+```hocon
+source {
+
+ Hudi {
+ table.path = "hdfs://nameserivce/data/hudi/hudi_table/"
+ table.type = "cow"
+ conf.files =
"/home/test/hdfs-site.xml;/home/test/core-site.xml;/home/test/yarn-site.xml"
Review Comment:
Please check the option keys in this example.
--
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]
