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/24 10:25:43 UTC
[GitHub] [incubator-seatunnel] EricJoy2048 commented on a diff in pull request #2800: [Improve][DOC] Perfect the connector v2 doc
EricJoy2048 commented on code in PR #2800:
URL: https://github.com/apache/incubator-seatunnel/pull/2800#discussion_r979212603
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
+development of new Connector.
## **Code Structure**
-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. All the relevant code at this stage is kept on the ``api-draft`` branch.
+
+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.
### **Example**
-We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example`` in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector. The corresponding configuration files are saved in the same module ``resources/examples`` folder as before.
+We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be
+directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example``
+in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector.
Review Comment:
> This is also the debugging method that is often used in the local development of Connector.
This is also the debugging method that is often used in the local development of Connector. You can debug these examples, which will help you better understand the running logic of the program.
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
+development of new Connector.
## **Code Structure**
-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. All the relevant code at this stage is kept on the ``api-draft`` branch.
+
+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.
### **Example**
-We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example`` in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector. The corresponding configuration files are saved in the same module ``resources/examples`` folder as before.
+We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be
+directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example``
Review Comment:
> which can be
directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example``
in ``SeaTunnelApiExample``
One is `seatunnel-examples/seatunnel-flink-connector-v2-example/src/main/java/org/apache/seatunnel/example/flink/v2/SeaTunnelApiExample.java`, it runs in the Flink engine. Another one is `seatunnel-examples/seatunnel-spark-connector-v2-example/src/main/java/org/apache/seatunnel/example/spark/v2/SeaTunnelApiExample.java`, it runs in the Spark engine.
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
Review Comment:
Can you link the proposal https://github.com/apache/incubator-seatunnel/issues/1608
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
Review Comment:
`This helps developers quickly understand API and transformation layer improvements. On the other hand, it can guide contributors how to use the new API to develop new connectors.` is better.
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
+development of new Connector.
## **Code Structure**
-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. All the relevant code at this stage is kept on the ``api-draft`` branch.
+
+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.
### **Example**
-We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example`` in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector. The corresponding configuration files are saved in the same module ``resources/examples`` folder as before.
+We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be
Review Comment:
> We have prepared a new version of the locally executable example program in ``seatunnel-examples``
We have prepared two new version of the locally executable example program in `seatunnel-examples`.
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
+development of new Connector.
## **Code Structure**
-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. All the relevant code at this stage is kept on the ``api-draft`` branch.
+
+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.
### **Example**
-We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example`` in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector. The corresponding configuration files are saved in the same module ``resources/examples`` folder as before.
+We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be
+directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example``
+in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector.
+The corresponding configuration files are saved in the same module ``resources/examples`` folder as before. Currently,
Review Comment:
> The corresponding configuration files are saved in the same module ``resources/examples`` folder as before
The configuration files used in example are saved in the "resources/examples" folder..
I think it is enough to clarify the location of the example configuration file. It is unnecessary to guide the user to understand the previous configuration.
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
+development of new Connector.
## **Code Structure**
-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. All the relevant code at this stage is kept on the ``api-draft`` branch.
+
+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.
### **Example**
-We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example`` in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector. The corresponding configuration files are saved in the same module ``resources/examples`` folder as before.
+We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be
+directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example``
+in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector.
+The corresponding configuration files are saved in the same module ``resources/examples`` folder as before. Currently,
+you need to add the dependencies of the corresponding connectors to the pom file for testing under the
+seatunnel-examples module, if there are some three-party dependencies, please add them to the module classpath by
+yourself, if the scope of some dependencies of the connectors is provided, you also need to set Include dependencies
+with Provided Scope in Intellij IDEA. .
### **Startup Class**
-Aside from the old startup class, we have created two new startup class projects, namely ``seatunnel-core/seatunnel-flink-starter`` and ``seatunnel-core/seatunnel-spark-starter``. You can find out how to parse the configuration file into an executable Flink/Spark process here.
Review Comment:
> Aside from the old startup class, we have created two new startup class projects
Aside from the old startup module, we have created two new startup modules.
##########
seatunnel-connectors-v2/README.md:
##########
@@ -1,48 +1,101 @@
# Purpose
-This article introduces the new interface and the new code structure on account of the newly designed API for Connectors in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and development of new Connector.
+
+This article introduces the new interface and the new code structure on account of the newly designed API for Connectors
+in Apache SeaTunnel. This helps developers with quick overview regarding API, translation layer improvement, and
+development of new Connector.
## **Code Structure**
-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. All the relevant code at this stage is kept on the ``api-draft`` branch.
+
+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.
### **Example**
-We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example`` in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector. The corresponding configuration files are saved in the same module ``resources/examples`` folder as before.
+We have prepared a new version of the locally executable example program in ``seatunnel-examples``, which can be
+directly called using ``seatunnel-flink-connector-v2-example`` or ``seatunnel-spark-connector-v2-example``
+in ``SeaTunnelApiExample``. This is also the debugging method that is often used in the local development of Connector.
+The corresponding configuration files are saved in the same module ``resources/examples`` folder as before. Currently,
+you need to add the dependencies of the corresponding connectors to the pom file for testing under the
Review Comment:
> you need to add the dependencies of the corresponding connectors to the pom file for testing under the
seatunnel-examples module, if there are some three-party dependencies, please add them to the module classpath by
yourself, if the scope of some dependencies of the connectors is provided, you also need to set Include dependencies
with Provided Scope in Intellij IDEA.
I think these are guidelines for contributors on how to add examples to their connectors. This requires clearer steps.
**If you want to add examples for your own connectors, you need to follow the steps below.**
1. Add the dependencies 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).
2. Fink 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.
--
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