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/10/28 09:34:55 UTC
[GitHub] [incubator-seatunnel] Hisoka-X commented on a diff in pull request #3218: [Feature][Doc] Improved connectors v2 contribution guide
Hisoka-X commented on code in PR #3218:
URL: https://github.com/apache/incubator-seatunnel/pull/3218#discussion_r1007849754
##########
seatunnel-connectors-v2/README.md:
##########
@@ -10,6 +10,15 @@ this [issue](https://github.com/apache/incubator-seatunnel/issues/1608) for deta
In order to separate from the old code, we have defined new modules for execution flow. This facilitates parallel
development at the current stage, and reduces the difficulty of merging.
+### engineering structure
+
+- ../`seatunnel-connectors-v2` connector code implementation
+- ../`seatunnel-translation` translation layer for the new connector
Review Comment:
```suggestion
- ../`seatunnel-translation` translation layer for the connector-v2
```
##########
seatunnel-connectors-v2/README.md:
##########
@@ -10,6 +10,15 @@ this [issue](https://github.com/apache/incubator-seatunnel/issues/1608) for deta
In order to separate from the old code, we have defined new modules for execution flow. This facilitates parallel
development at the current stage, and reduces the difficulty of merging.
+### engineering structure
+
+- ../`seatunnel-connectors-v2` connector code implementation
+- ../`seatunnel-translation` translation layer for the new connector
+- ../seatunnel-e2e/`seatunnel-flink-connector-v2-e2e` testcase running on flink
+- ../seatunnel-e2e/`seatunnel-spark-connector-v2-e2e` testcase running on spark
+- ../seatunnel-examples/`seatunnel-flink-connector-v2-example` flink local running instance
+- ../seatunnel-examples/`seatunnel-spark-connector-v2-example` spark local running instance
Review Comment:
```suggestion
- ../seatunnel-examples/`seatunnel-spark-connector-v2-example` seatunnel connector-v2 example use spark local running instance
```
##########
seatunnel-connectors-v2/README.md:
##########
@@ -22,13 +31,27 @@ configuration files used in example are saved in the "resources/examples" folder
own connectors, you need to follow the steps below.
1. Add the groupId, artifactId and version of the connector to be tested to
- seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
- seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml when you want to runs it in Spark engine) as a
+ `seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml`(or add it to
+ `seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml` when you want to runs it in Spark engine) as a
dependency.
2. Find the dependency in your connector pom file which scope is test or provided and then add them to
seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml) file and modify the scope to compile.
-3. Refer to the SeaTunnelApiExample class to develop your sample code.
+3. Add the task configuration file under resources/examples.
+4. Configure the file in the `SeaTunnelApiExample` main method.
+5. Just run the main method.
+
+### **Create the format of the connector**
Review Comment:
```suggestion
### **Create new seatunnel v2 connector**
```
##########
seatunnel-connectors-v2/README.md:
##########
@@ -22,13 +31,27 @@ configuration files used in example are saved in the "resources/examples" folder
own connectors, you need to follow the steps below.
1. Add the groupId, artifactId and version of the connector to be tested to
- seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
- seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml when you want to runs it in Spark engine) as a
+ `seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml`(or add it to
+ `seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml` when you want to runs it in Spark engine) as a
dependency.
2. Find the dependency in your connector pom file which scope is test or provided and then add them to
seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml) file and modify the scope to compile.
-3. Refer to the SeaTunnelApiExample class to develop your sample code.
+3. Add the task configuration file under resources/examples.
+4. Configure the file in the `SeaTunnelApiExample` main method.
+5. Just run the main method.
+
+### **Create the format of the connector**
+
+1.Create a new module under the `seatunnel-connectors-v2` directory and name it connector - {connector name}.
+
+2.The pom file can refer to the pom file of the existing connector, and add the current sub model to the pom file of the parent model
+
+3.Create two packages corresponding to source and sink
+
+ package org.apache.seatunnel.connectors.seatunnel.{connector name}}.source
+
+ package org.apache.seatunnel.connectors.seatunnel.{connector name}}.sink
Review Comment:
Not only this, also should add doc about:
1. add connector to plugin-mapping file
2. add connector to `seatunnel-dist/pom.xml`
##########
seatunnel-connectors-v2/README.md:
##########
@@ -10,6 +10,15 @@ this [issue](https://github.com/apache/incubator-seatunnel/issues/1608) for deta
In order to separate from the old code, we have defined new modules for execution flow. This facilitates parallel
development at the current stage, and reduces the difficulty of merging.
+### engineering structure
+
+- ../`seatunnel-connectors-v2` connector code implementation
+- ../`seatunnel-translation` translation layer for the new connector
+- ../seatunnel-e2e/`seatunnel-flink-connector-v2-e2e` testcase running on flink
Review Comment:
```suggestion
- ../seatunnel-e2e/`seatunnel-flink-connector-v2-e2e` end to end testcase running on flink
```
##########
seatunnel-connectors-v2/README.md:
##########
@@ -10,6 +10,15 @@ this [issue](https://github.com/apache/incubator-seatunnel/issues/1608) for deta
In order to separate from the old code, we have defined new modules for execution flow. This facilitates parallel
development at the current stage, and reduces the difficulty of merging.
+### engineering structure
+
+- ../`seatunnel-connectors-v2` connector code implementation
+- ../`seatunnel-translation` translation layer for the new connector
+- ../seatunnel-e2e/`seatunnel-flink-connector-v2-e2e` testcase running on flink
+- ../seatunnel-e2e/`seatunnel-spark-connector-v2-e2e` testcase running on spark
Review Comment:
```suggestion
- ../seatunnel-e2e/`seatunnel-spark-connector-v2-e2e` end to end testcase running on spark
```
##########
seatunnel-connectors-v2/README.md:
##########
@@ -10,6 +10,15 @@ this [issue](https://github.com/apache/incubator-seatunnel/issues/1608) for deta
In order to separate from the old code, we have defined new modules for execution flow. This facilitates parallel
development at the current stage, and reduces the difficulty of merging.
+### engineering structure
+
+- ../`seatunnel-connectors-v2` connector code implementation
+- ../`seatunnel-translation` translation layer for the new connector
+- ../seatunnel-e2e/`seatunnel-flink-connector-v2-e2e` testcase running on flink
+- ../seatunnel-e2e/`seatunnel-spark-connector-v2-e2e` testcase running on spark
+- ../seatunnel-examples/`seatunnel-flink-connector-v2-example` flink local running instance
Review Comment:
```suggestion
- ../seatunnel-examples/`seatunnel-flink-connector-v2-example` seatunnel connector-v2 example use flink local running instance
```
##########
seatunnel-connectors-v2/README.md:
##########
@@ -10,6 +10,15 @@ this [issue](https://github.com/apache/incubator-seatunnel/issues/1608) for deta
In order to separate from the old code, we have defined new modules for execution flow. This facilitates parallel
development at the current stage, and reduces the difficulty of merging.
+### engineering structure
+
+- ../`seatunnel-connectors-v2` connector code implementation
Review Comment:
```suggestion
- ../`seatunnel-connectors-v2` connector-v2 code implementation
```
--
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