Skip to content

Commit 5cffa18

Browse files
committed
[hotfix] [DOC] Fix missing areas in the development documentation #7959
Additional notes on sink
1 parent 0838f96 commit 5cffa18

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

seatunnel-connectors-v2/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ own connectors, you need to follow the steps below.
5656

5757
5.add connector dependency to seatunnel-dist/pom.xml, so the connector jar can be find in binary package.
5858

59-
6.There are several classes that must be implemented on the source side, namely {connector name} Source, {connector name} SourceFactory, {connector name} SourceReader. Please refer to other connectors for details
59+
6.There are several classes that must be implemented on the source side, namely {ConnectorName}Source, {ConnectorName}SourceFactory, {ConnectorName}SourceReader; There are several classes that must be implemented on the sink side, namely {ConnectorName}Sink, {ConnectorName}SinkFactory, {ConnectorName}SinkWriter Please refer to other connectors for details
6060

61-
7.{Connector Name} SourceFactory needs to be annotated with the **@AutoService (Factory.class)** annotation on the class name, and in addition to the required methods, an additional 'creatSource' method needs to be rewritten
61+
7.{ConnectorName}SourceFactory and {ConnectorName}SinkFactory needs to be annotated with the **@AutoService (Factory.class)** annotation on the class name, and in addition to the required methods, source side an additional **creatSource** method needs to be rewritten and sink side an additional **creatSink** method needs to be rewritten
6262

63-
8.{Connector Name} Source needs to override the getProducedCatalogTables method
63+
8.{ConnectorName}Source needs to override the **getProducedCatalogTables** method; {ConnectorName}Sink needs to override the **getWriteCatalogTable** method
6464

6565
### **Startup Class**
6666

seatunnel-connectors-v2/README.zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ SeaTunnel为与计算引擎进行解耦,设计了新的连接器API,通过
4646

4747
5.将连接器添加到seatunnel-dist/pom.xml,这样连接器jar就可以在二进制包中找到.
4848

49-
6.source端有几个必须实现的类,分别是{连接器名}Source、{连接器名}SourceFactory、{连接器名}SourceReader,具体可以参考其他连接器
49+
6.source端有几个必须实现的类,分别是{连接器名}Source、{连接器名}SourceFactory、{连接器名}SourceReader;sink端有几个必须实现的类,分别是{连接器名}Sink、{连接器名}SinkFactory、{连接器名}SinkWriter,具体可以参考其他连接器
5050

51-
7.{连接器名}SourceFactory 里面需要在类名上标注 **@AutoService(Factory.class)** 注解,并且除了必须实现的方法外,需要额外再重写一个 createSource 方法
51+
7.{连接器名}SourceFactory 和 {连接器名}SinkFactory 里面需要在类名上标注 **@AutoService(Factory.class)** 注解,并且除了必须实现的方法外,source端需要额外再重写一个 **createSource** 方法,sink端需要额外再重写一个 **createSink** 方法
5252

53-
8.{连接器名}Source 需要重写 getProducedCatalogTables 方法
53+
8.{连接器名}Source 需要重写 **getProducedCatalogTables** 方法;{连接器名}Sink 需要重写 **getWriteCatalogTable** 方法
5454

5555
### 启动类
5656

0 commit comments

Comments
 (0)