[update] Add module description

wgzhao · Feb 6, 2025 · 2892565 · 2892565
1 parent de79f0e
commit 2892565
Show file tree

Hide file tree

Showing 74 changed files with 89 additions and 36 deletions.
diff --git a/common/pom.xml b/common/pom.xml
@@ -8,6 +8,7 @@
 
     <artifactId>addax-common</artifactId>
     <name>addax-common</name>
+    <description>Common library for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/core/pom.xml b/core/pom.xml
@@ -8,6 +8,7 @@
 
     <artifactId>addax-core</artifactId>
     <name>addax-core</name>
+    <description>The core library for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/lib/addax-rdbms/pom.xml b/lib/addax-rdbms/pom.xml
@@ -9,6 +9,7 @@
 
     <artifactId>addax-rdbms</artifactId>
     <name>addax-rdbms</name>
+    <description>RDBMS reader and writer library for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/lib/addax-storage/pom.xml b/lib/addax-storage/pom.xml
@@ -9,9 +9,7 @@
 
     <artifactId>addax-storage</artifactId>
     <name>addax-storage</name>
-    <description>addax-storage 通用的文件类型的读取写入方法，
-        供TxtFileReader/Writer, OSSReader/Writer ,FtpReader/Writer, HdfsReader/Writer使用。
-    </description>
+    <description>General file system reader and writer library for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/lib/addax-transformer/pom.xml b/lib/addax-transformer/pom.xml
@@ -9,7 +9,7 @@
 
     <artifactId>addax-transformer</artifactId>
     <name>addax-transformer</name>
-    <description>data transformer</description>
+    <description>Transformer library for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/accessreader/pom.xml b/plugin/reader/accessreader/pom.xml
@@ -10,6 +10,7 @@
 
     <artifactId>accessreader</artifactId>
     <name>access-reader</name>
+    <description>Access reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/cassandrareader/pom.xml b/plugin/reader/cassandrareader/pom.xml
@@ -10,6 +10,7 @@
 
     <artifactId>cassandrareader</artifactId>
     <name>cassandra-reader</name>
+    <description>Cassandra reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/clickhousereader/pom.xml b/plugin/reader/clickhousereader/pom.xml
@@ -9,6 +9,7 @@
     </parent>
     <artifactId>clickhousereader</artifactId>
     <name>clickhouse-reader</name>
+    <description>Clickhouse reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/databendreader/pom.xml b/plugin/reader/databendreader/pom.xml
@@ -9,6 +9,7 @@
     </parent>
     <artifactId>databendreader</artifactId>
     <name>databend-reader</name>
+    <description>Databend reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/datareader/pom.xml b/plugin/reader/datareader/pom.xml
@@ -11,7 +11,7 @@
 
     <artifactId>datareader</artifactId>
     <name>data-reader</name>
-    <description>Generates fake data for populating your database</description>
+    <description>Fake data generator for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/dbfreader/pom.xml b/plugin/reader/dbfreader/pom.xml
@@ -8,7 +8,7 @@
     </parent>
     <artifactId>dbfreader</artifactId>
     <name>dbf-reader</name>
-    <description>DBFReader提供了本地读取dbf功能，并可以根据用户配置的类型进行类型转换，建议开发、测试环境使用。</description>
+    <description>DBF file reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/elasticsearchreader/pom.xml b/plugin/reader/elasticsearchreader/pom.xml
@@ -9,7 +9,7 @@
     </parent>
     <artifactId>elasticsearchreader</artifactId>
     <name>elasticsearch-reader</name>
-    <description>Retrieve data from ElasticSearch</description>
+    <description>ElasticSearch reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/excelreader/pom.xml b/plugin/reader/excelreader/pom.xml
@@ -9,7 +9,7 @@
     </parent>
     <artifactId>excelreader</artifactId>
     <name>excel-reader</name>
-    <description>Retrieve data from Microsoft Excel</description>
+    <description>Microsoft Excel file reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/ftpreader/pom.xml b/plugin/reader/ftpreader/pom.xml
@@ -8,7 +8,7 @@
     </parent>
     <artifactId>ftpreader</artifactId>
     <name>ftp-reader</name>
-    <description>FtpReader提供了读取指定ftp服务器文件功能，并可以根据用户配置的类型进行类型转换，建议开发、测试环境使用。</description>
+    <description>FTP remote files reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hanareader/pom.xml b/plugin/reader/hanareader/pom.xml
@@ -10,7 +10,7 @@
 
     <artifactId>hanareader</artifactId>
     <name>hanareader-reader</name>
-    <description>SAP HANA Reader</description>
+    <description>SAP HANA reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hbase11xreader/pom.xml b/plugin/reader/hbase11xreader/pom.xml
@@ -8,6 +8,7 @@
     </parent>
     <artifactId>hbase11xreader</artifactId>
     <name>hbase11x-reader</name>
+    <description>HBase 11.x reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hbase11xsqlreader/pom.xml b/plugin/reader/hbase11xsqlreader/pom.xml
@@ -8,6 +8,7 @@
     </parent>
     <artifactId>hbase11xsqlreader</artifactId>
     <name>hbase11xsql-reader</name>
+    <description>HBase 11.x reader plugin with phoenix for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hbase20xreader/pom.xml b/plugin/reader/hbase20xreader/pom.xml
@@ -8,6 +8,7 @@
     </parent>
     <artifactId>hbase20xreader</artifactId>
     <name>hbase20x-reader</name>
+    <description>HBase 2.x reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hbase20xsqlreader/pom.xml b/plugin/reader/hbase20xsqlreader/pom.xml
@@ -12,6 +12,7 @@
 
     <artifactId>hbase20xsqlreader</artifactId>
     <name>hbase20xsql-reader</name>
+    <description>HBase 2.x reader plugin with phoenix for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hdfsreader/pom.xml b/plugin/reader/hdfsreader/pom.xml
@@ -12,6 +12,7 @@
 
     <artifactId>hdfsreader</artifactId>
     <name>hdfs-reader</name>
+    <description>Hadoop HDFS files reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/hivereader/pom.xml b/plugin/reader/hivereader/pom.xml
@@ -9,6 +9,7 @@
     </parent>
     <artifactId>hivereader</artifactId>
     <name>hive-reader</name>
+    <description>Apache Hive reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <properties>

diff --git a/plugin/reader/httpreader/pom.xml b/plugin/reader/httpreader/pom.xml
@@ -8,7 +8,7 @@
     </parent>
     <artifactId>httpreader</artifactId>
     <name>http-reader</name>
-    <description>HTTPReader提供了读取指定HTTP服务接口的功能，并对返回的JSON内容进行解析</description>
+    <description>HTTP JSON response content reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/influxdb2reader/pom.xml b/plugin/reader/influxdb2reader/pom.xml
@@ -25,8 +25,10 @@
         <version>4.2.4-SNAPSHOT</version>
         <relativePath>../../../pom.xml</relativePath>
     </parent>
+
     <artifactId>influxdb2reader</artifactId>
     <name>influxdb2-reader</name>
+    <description>InfluxDB 2.x reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/influxdbreader/pom.xml b/plugin/reader/influxdbreader/pom.xml
@@ -25,8 +25,10 @@
         <version>4.2.4-SNAPSHOT</version>
         <relativePath>../../../pom.xml</relativePath>
     </parent>
+
     <artifactId>influxdbreader</artifactId>
     <name>influxdb-reader</name>
+    <description>InfluxDB 1.x reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/jsonfilereader/pom.xml b/plugin/reader/jsonfilereader/pom.xml
@@ -8,7 +8,7 @@
     </parent>
     <artifactId>jsonfilereader</artifactId>
     <name>jsonfile-reader</name>
-    <description>json file reader 提供了本地读取JSON功能，并可以根据用户配置的类型进行类型转换，建议开发、测试环境使用。</description>
+    <description>JSON format files reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/kafkareader/pom.xml b/plugin/reader/kafkareader/pom.xml
@@ -7,8 +7,10 @@
         <version>4.2.4-SNAPSHOT</version>
         <relativePath>../../../pom.xml</relativePath>
     </parent>
+
     <artifactId>kafkareader</artifactId>
     <name>kafka-reader</name>
+    <description>Kafka reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/kudureader/pom.xml b/plugin/reader/kudureader/pom.xml
@@ -10,6 +10,7 @@
 
     <artifactId>kudureader</artifactId>
     <name>kudu-reader</name>
+    <description>Apache Kudu reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/mongodbreader/pom.xml b/plugin/reader/mongodbreader/pom.xml
@@ -11,6 +11,8 @@
 
     <artifactId>mongodbreader</artifactId>
     <name>mongodb-reader</name>
+    <description>MongoDB reader plugin for Addax</description>
+    <packaging>jar</packaging>
 
     <dependencies>
         <dependency>

diff --git a/plugin/reader/mysqlreader/pom.xml b/plugin/reader/mysqlreader/pom.xml
@@ -7,8 +7,10 @@
         <version>4.2.4-SNAPSHOT</version>
         <relativePath>../../../pom.xml</relativePath>
     </parent>
+
     <artifactId>mysqlreader</artifactId>
     <name>mysql-reader</name>
+    <description>MySQL reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/oraclereader/pom.xml b/plugin/reader/oraclereader/pom.xml
@@ -10,7 +10,7 @@
 
     <artifactId>oraclereader</artifactId>
     <name>oracle-reader</name>
-    <description>read data from Oracle Database</description>
+    <description>Oracle Database reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <repositories>

diff --git a/plugin/reader/postgresqlreader/pom.xml b/plugin/reader/postgresqlreader/pom.xml
@@ -12,6 +12,7 @@
 
     <artifactId>postgresqlreader</artifactId>
     <name>postgresql-reader</name>
+    <description>PostgreSQL reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/rdbmsreader/pom.xml b/plugin/reader/rdbmsreader/pom.xml
@@ -10,7 +10,7 @@
 
     <artifactId>rdbmsreader</artifactId>
     <name>rdbms-reader</name>
-    <description>RDBMS Reader</description>
+    <description>Any RDBMS reader plugin with jdbc for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/redisreader/pom.xml b/plugin/reader/redisreader/pom.xml
@@ -11,7 +11,7 @@
 
     <artifactId>redisreader</artifactId>
     <name>redis-reader</name>
-    <description>Redis Reader</description>
+    <description>Redis reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/s3reader/pom.xml b/plugin/reader/s3reader/pom.xml
@@ -11,7 +11,7 @@
 
     <artifactId>s3reader</artifactId>
     <name>s3-reader</name>
-    <description>read from amazon aws s3 service</description>
+    <description>Amazon AWS s3 or variant reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencyManagement>

diff --git a/plugin/reader/sqlitereader/pom.xml b/plugin/reader/sqlitereader/pom.xml
@@ -9,6 +9,7 @@
     </parent>
     <artifactId>sqlitereader</artifactId>
     <name>sqlite-reader</name>
+    <description>SQLite reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/sqlserverreader/pom.xml b/plugin/reader/sqlserverreader/pom.xml
@@ -9,7 +9,7 @@
 
     <artifactId>sqlserverreader</artifactId>
     <name>sqlserver-reader</name>
-    <description>SQLServer reader plugin</description>
+    <description>Microsoft SQLServer reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/streamreader/pom.xml b/plugin/reader/streamreader/pom.xml
@@ -11,6 +11,7 @@
 
     <artifactId>streamreader</artifactId>
     <name>stream-reader</name>
+    <description>stream reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/sybasereader/pom.xml b/plugin/reader/sybasereader/pom.xml
@@ -11,6 +11,8 @@
 
     <artifactId>sybasereader</artifactId>
     <name>sybase-reader</name>
+    <description>Sybase database reader plugin for Addax</description>
+    <packaging>jar</packaging>
 
      <repositories>
         <repository>

diff --git a/plugin/reader/tdenginereader/pom.xml b/plugin/reader/tdenginereader/pom.xml
@@ -9,6 +9,7 @@
     </parent>
     <artifactId>tdenginereader</artifactId>
     <name>tdengine-reader</name>
+    <description>TDengine Time-Series Database reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/reader/txtfilereader/pom.xml b/plugin/reader/txtfilereader/pom.xml
@@ -10,7 +10,7 @@
 
     <artifactId>txtfilereader</artifactId>
     <name>txtfile-reader</name>
-    <description>TxtFileReader提供了本地读取TEXT功能，并可以根据用户配置的类型进行类型转换，建议开发、测试环境使用。</description>
+    <description>local text files reader plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/writer/accesswriter/pom.xml b/plugin/writer/accesswriter/pom.xml
@@ -6,8 +6,11 @@
         <version>4.2.4-SNAPSHOT</version>
         <relativePath>../../../pom.xml</relativePath>
     </parent>
+
     <artifactId>accesswriter</artifactId>
     <name>access-writer</name>
+    <description>Access writer plugin for Addax</description>
+    <packaging>jar</packaging>
 
     <dependencies>
         <dependency>

diff --git a/plugin/writer/cassandrawriter/pom.xml b/plugin/writer/cassandrawriter/pom.xml
@@ -10,11 +10,9 @@
 
     <artifactId>cassandrawriter</artifactId>
     <name>cassandra-writer</name>
+    <description>Cassandra writer plugin for Addax</description>
     <packaging>jar</packaging>
 
-    <properties>
-    </properties>
-
     <dependencies>
 
         <dependency>

diff --git a/plugin/writer/clickhousewriter/pom.xml b/plugin/writer/clickhousewriter/pom.xml
@@ -10,6 +10,7 @@
 
     <artifactId>clickhousewriter</artifactId>
     <name>clickhouse-writer</name>
+    <description>ClickHouse writer plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>

diff --git a/plugin/writer/databendwriter/pom.xml b/plugin/writer/databendwriter/pom.xml
@@ -9,6 +9,7 @@
 
     <artifactId>databendwriter</artifactId>
     <name>databend-writer</name>
+    <description>Databend writer plugin for Addax</description>
     <packaging>jar</packaging>
 
     <dependencies>