You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by GitBox <gi...@apache.org> on 2022/09/27 07:30:39 UTC
[GitHub] [incubator-seatunnel] TaoZex opened a new pull request, #2913: update connector V2 common-options doc
TaoZex opened a new pull request, #2913:
URL: https://github.com/apache/incubator-seatunnel/pull/2913
<!--
Thank you for contributing to SeaTunnel! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
## Contribution Checklist
- Make sure that the pull request corresponds to a [GITHUB issue](https://github.com/apache/incubator-seatunnel/issues).
- Name the pull request in the form "[Feature] [component] Title of the pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
- Minor fixes should be named following this pattern: `[hotfix] [docs] Fix typo in README.md doc`.
-->
## Purpose of this pull request
The main purpose is update connector V2 common-options doc.
## Check list
* [ ] Code changed are covered with tests, or it does not need tests for reason:
* [ ] If any new Jar binary package adding in your PR, please add License Notice according
[New License Guide](https://github.com/apache/incubator-seatunnel/blob/dev/docs/en/contribution/new-license.md)
* [X] If necessary, please update the documentation to describe the new feature. https://github.com/apache/incubator-seatunnel/tree/dev/docs
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] TaoZex commented on pull request #2913: update connector V2 common-options doc
Posted by GitBox <gi...@apache.org>.
TaoZex commented on PR #2913:
URL: https://github.com/apache/incubator-seatunnel/pull/2913#issuecomment-1259243597
> Please remove `fields` from https://github.com/apache/incubator-seatunnel/blob/dev/docs/en/connector-v2/source/common-options.md, because not all source connector can set `fields`.
>
> And, find the source connector can config `fields` params and then add `fields` to the connector document.
Thanks, I will fix it.
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] TaoZex commented on a diff in pull request #2913: update connector V2 common-options doc
Posted by GitBox <gi...@apache.org>.
TaoZex commented on code in PR #2913:
URL: https://github.com/apache/incubator-seatunnel/pull/2913#discussion_r981061675
##########
docs/en/connector-v2/sink/Assert.md:
##########
@@ -21,7 +21,7 @@ A flink sink plugin which can assert illegal data by user defined rules
|rules.field_value | ConfigList | no | - |
|rules.field_value.rule_type | string | no | - |
|rules.field_value.rule_value | double | no | - |
-
+| common-options | string | no | - |
Review Comment:
The common-options used by the connector V1 version is string, do we need to change it to no?
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] EricJoy2048 commented on pull request #2913: update connector V2 common-options doc
Posted by GitBox <gi...@apache.org>.
EricJoy2048 commented on PR #2913:
URL: https://github.com/apache/incubator-seatunnel/pull/2913#issuecomment-1259214794
Please remove `fields` from https://github.com/apache/incubator-seatunnel/blob/dev/docs/en/connector-v2/source/common-options.md, because not all source connector can set `fields`.
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] EricJoy2048 commented on a diff in pull request #2913: update connector V2 common-options doc
Posted by GitBox <gi...@apache.org>.
EricJoy2048 commented on code in PR #2913:
URL: https://github.com/apache/incubator-seatunnel/pull/2913#discussion_r980977908
##########
docs/en/connector-v2/sink/Assert.md:
##########
@@ -21,7 +21,7 @@ A flink sink plugin which can assert illegal data by user defined rules
|rules.field_value | ConfigList | no | - |
|rules.field_value.rule_type | string | no | - |
|rules.field_value.rule_value | double | no | - |
-
+| common-options | string | no | - |
Review Comment:
Type of `common-options` maybe not `string`, I think common-options have no type.
##########
docs/en/connector-v2/sink/Assert.md:
##########
@@ -52,6 +52,10 @@ The following rules are supported for now
the value related to rule type
+### common options [string]
Review Comment:
remove `[string]`
##########
docs/en/connector-v2/source/Clickhouse.md:
##########
@@ -26,14 +26,14 @@ Reading data from Clickhouse can also be done using JDBC
## Options
-| name | type | required | default value |
-|----------------|--------|----------|---------------|
-| host | string | yes | - |
-| database | string | yes | - |
-| sql | string | yes | - |
-| username | string | yes | - |
-| password | string | yes | - |
-| common-options | string | yes | - |
+| name | type | required | default value |
+| ----------------- | ------ | -------- | ------------- |
+| host | string | yes | - |
+| database | string | yes | - |
+| sql | string | yes | - |
+| username | string | yes | - |
+| password | string | yes | - |
+| result_table_name | string | no | - |
Review Comment:
replace `result_table_name` to `common-options` and this param have no type.
##########
docs/en/connector-v2/sink/Console.md:
##########
@@ -16,6 +16,12 @@ Used to send data to Console. Both support streaming and batch mode.
| name | type | required | default value |
| --- |--------|----------|---------------|
+| common-options| string| no | - |
+
+
+### common options [string]
Review Comment:
same as above.
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] hailin0 commented on a diff in pull request #2913: update connector V2 common-options doc
Posted by GitBox <gi...@apache.org>.
hailin0 commented on code in PR #2913:
URL: https://github.com/apache/incubator-seatunnel/pull/2913#discussion_r981896487
##########
docs/en/connector-v2/sink/Neo4j.md:
##########
@@ -64,7 +65,9 @@ maximum transaction retry time(seconds). transaction fail if exceeded
### max_connection_timeout [long]
The maximum amount of time to wait for a TCP connection to be established (seconds)
+### common options [string]
+Sink plugin common parameters, please refer to [Sink Common Options](common-options.md) for details
Review Comment:
add empty line after
##########
docs/en/connector-v2/sink/HdfsFile.md:
##########
@@ -122,6 +123,9 @@ Storage mode, currently supports `overwrite`. This means we will delete the old
If `is_enable_transaction` is `true`, Basically, we won't encounter the same file name. Because we will add the transaction id to file name.
For the specific meaning of each mode, see [save-modes](https://spark.apache.org/docs/latest/sql-programming-guide.html#save-modes)
+### common options [string]
Review Comment:
add empty line before
##########
docs/en/connector-v2/source/FakeSource.md:
##########
@@ -23,6 +23,7 @@ just for testing, such as type conversion and feature testing
| result_table_name | string | yes | - |
| schema | config | yes | - |
| row.num | long | no | 10 |
+| result_table_name | string | no | - |
Review Comment:
as above
##########
docs/en/connector-v2/sink/Enterprise-WeChat.md:
##########
@@ -37,6 +38,9 @@ A list of userids to remind the specified members in the group (@ a member), @ a
### mentioned_mobile_list [array]
Mobile phone number list, remind the group member corresponding to the mobile phone number (@ a member), @ all means remind everyone
+### common options [string]
Review Comment:
add empty line before
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-seatunnel] TaoZex closed pull request #2913: update connector V2 common-options doc
Posted by GitBox <gi...@apache.org>.
TaoZex closed pull request #2913: update connector V2 common-options doc
URL: https://github.com/apache/incubator-seatunnel/pull/2913
--
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: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org