[cdc] Add line breaks to cdc action help message to improve readabili…

…ty (#5032)
apache · Feb 11, 2025 · 6f5c8fd · 6f5c8fd
1 parent 3781094
commit 6f5c8fd
Show file tree

Hide file tree

Showing 9 changed files with 93 additions and 76 deletions.
diff --git a/...rc/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncDatabaseActionFactory.java b/...rc/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncDatabaseActionFactory.java
@@ -54,14 +54,16 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  kafka_sync_database --warehouse <warehouse_path> --database <database_name> "
-                        + "[--table_prefix <paimon_table_prefix>] "
-                        + "[--table_suffix <paimon_table_suffix>] "
-                        + "[--including_tables <table_name|name_regular_expr>] "
-                        + "[--excluding_tables <table_name|name_regular_expr>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--kafka_conf <kafka_source_conf> [--kafka_conf <kafka_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  kafka_sync_database \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "[--table_prefix <paimon_table_prefix>] \\\n"
+                        + "[--table_suffix <paimon_table_suffix>] \\\n"
+                        + "[--including_tables <table_name|name_regular_expr>] \\\n"
+                        + "[--excluding_tables <table_name|name_regular_expr>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--kafka_conf <kafka_source_conf> [--kafka_conf <kafka_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...c/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncTableActionFactory.java b/...c/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncTableActionFactory.java
@@ -52,14 +52,16 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  kafka_sync_table --warehouse <warehouse_path> --database <database_name> "
-                        + "--table <table_name> "
-                        + "[--partition_keys <partition_keys>] "
-                        + "[--primary_keys <primary_keys>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] "
-                        + "[--kafka_conf <kafka_source_conf> [--kafka_conf <kafka_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  kafka_sync_table \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "--table <table_name> \\\n"
+                        + "[--partition_keys <partition_keys>] \\\n"
+                        + "[--primary_keys <primary_keys>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] \\\n"
+                        + "[--kafka_conf <kafka_source_conf> [--kafka_conf <kafka_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...ain/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncDatabaseActionFactory.java b/...ain/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncDatabaseActionFactory.java
@@ -55,13 +55,15 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  mongodb_sync_database --warehouse <warehouse_path> --database <database_name> "
-                        + "[--table_prefix <paimon_table_prefix>] "
-                        + "[--table_suffix <paimon_table_suffix>] "
-                        + "[--including_tables <mongodb_table_name|name_regular_expr>] "
-                        + "[--excluding_tables <mongodb_table_name|name_regular_expr>] "
-                        + "[--mongodb_conf <mongodb_cdc_source_conf> [--mongodb_conf <mongodb_cdc_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  mongodb_sync_database \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "[--table_prefix <paimon_table_prefix>] \\\n"
+                        + "[--table_suffix <paimon_table_suffix>] \\\n"
+                        + "[--including_tables <mongodb_table_name|name_regular_expr>] \\\n"
+                        + "[--excluding_tables <mongodb_table_name|name_regular_expr>] \\\n"
+                        + "[--mongodb_conf <mongodb_cdc_source_conf> [--mongodb_conf <mongodb_cdc_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...c/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncTableActionFactory.java b/...c/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncTableActionFactory.java
@@ -70,12 +70,14 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  mongodb_sync_table --warehouse <warehouse_path> --database <database_name> "
-                        + "--table <table_name> "
-                        + "[--partition_keys <partition_keys>] "
-                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] "
-                        + "[--mongodb_conf <mongodb_cdc_source_conf> [--mongodb_conf <mongodb_cdc_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  mongodb_sync_table \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "--table <table_name> \\\n"
+                        + "[--partition_keys <partition_keys>] \\\n"
+                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] \\\n"
+                        + "[--mongodb_conf <mongodb_cdc_source_conf> [--mongodb_conf <mongodb_cdc_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...rc/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java b/...rc/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java
@@ -76,18 +76,20 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  mysql_sync_database --warehouse <warehouse_path> --database <database_name> "
-                        + "[--ignore_incompatible <true/false>] "
-                        + "[--merge_shards <true/false>] "
-                        + "[--table_prefix <paimon_table_prefix>] "
-                        + "[--table_suffix <paimon_table_suffix>] "
-                        + "[--including_tables <mysql_table_name|name_regular_expr>] "
-                        + "[--excluding_tables <mysql_table_name|name_regular_expr>] "
-                        + "[--mode <sync_mode>] "
-                        + "[--metadata_column <metadata_column>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--mysql_conf <mysql_cdc_source_conf> [--mysql_conf <mysql_cdc_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  mysql_sync_database \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "[--ignore_incompatible <true/false>] \\\n"
+                        + "[--merge_shards <true/false>] \\\n"
+                        + "[--table_prefix <paimon_table_prefix>] \\\n"
+                        + "[--table_suffix <paimon_table_suffix>] \\\n"
+                        + "[--including_tables <mysql_table_name|name_regular_expr>] \\\n"
+                        + "[--excluding_tables <mysql_table_name|name_regular_expr>] \\\n"
+                        + "[--mode <sync_mode>] \\\n"
+                        + "[--metadata_column <metadata_column>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--mysql_conf <mysql_cdc_source_conf> [--mysql_conf <mysql_cdc_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...c/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncTableActionFactory.java b/...c/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncTableActionFactory.java
@@ -51,15 +51,17 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  mysql_sync_table --warehouse <warehouse_path> --database <database_name> "
-                        + "--table <table_name> "
-                        + "[--partition_keys <partition_keys>] "
-                        + "[--primary_keys <primary_keys>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] "
-                        + "[--metadata_column <metadata_column>] "
-                        + "[--mysql_conf <mysql_cdc_source_conf> [--mysql_conf <mysql_cdc_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  mysql_sync_table \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "--table <table_name> \\\n"
+                        + "[--partition_keys <partition_keys>] \\\n"
+                        + "[--primary_keys <primary_keys>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] \\\n"
+                        + "[--metadata_column <metadata_column>] \\\n"
+                        + "[--mysql_conf <mysql_cdc_source_conf> [--mysql_conf <mysql_cdc_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...main/java/org/apache/paimon/flink/action/cdc/postgres/PostgresSyncTableActionFactory.java b/...main/java/org/apache/paimon/flink/action/cdc/postgres/PostgresSyncTableActionFactory.java
@@ -52,16 +52,17 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  postgres_sync_table --warehouse <warehouse_path> --database <database_name> "
-                        + "--table <table_name> "
-                        + "--table <table_name> "
-                        + "[--partition_keys <partition_keys>] "
-                        + "[--primary_keys <primary_keys>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] "
-                        + "[--metadata_column <metadata_column>] "
-                        + "[--postgres_conf <postgres_cdc_source_conf> [--postgres_conf <postgres_cdc_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  postgres_sync_table \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "--table <table_name> \\\n"
+                        + "[--partition_keys <partition_keys>] \\\n"
+                        + "[--primary_keys <primary_keys>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] \\\n"
+                        + "[--metadata_column <metadata_column>] \\\n"
+                        + "[--postgres_conf <postgres_cdc_source_conf> [--postgres_conf <postgres_cdc_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/.../main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncDatabaseActionFactory.java b/.../main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncDatabaseActionFactory.java
@@ -54,14 +54,16 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  pulsar_sync_database --warehouse <warehouse_path> --database <database_name> "
-                        + "[--table_prefix <paimon_table_prefix>] "
-                        + "[--table_suffix <paimon_table_suffix>] "
-                        + "[--including_tables <table_name|name_regular_expr>] "
-                        + "[--excluding_tables <table_name|name_regular_expr>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--pulsar_conf <pulsar_source_conf> [--pulsar_conf <pulsar_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  pulsar_sync_database \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "[--table_prefix <paimon_table_prefix>] \\\n"
+                        + "[--table_suffix <paimon_table_suffix>] \\\n"
+                        + "[--including_tables <table_name|name_regular_expr>] \\\n"
+                        + "[--excluding_tables <table_name|name_regular_expr>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--pulsar_conf <pulsar_source_conf> [--pulsar_conf <pulsar_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();
 

diff --git a/...src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncTableActionFactory.java b/...src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncTableActionFactory.java
@@ -51,14 +51,16 @@ public void printHelp() {
 
         System.out.println("Syntax:");
         System.out.println(
-                "  pulsar_sync_table --warehouse <warehouse_path> --database <database_name> "
-                        + "--table <table_name> "
-                        + "[--partition_keys <partition_keys>] "
-                        + "[--primary_keys <primary_keys>] "
-                        + "[--type_mapping <option1,option2...>] "
-                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] "
-                        + "[--pulsar_conf <pulsar_source_conf> [--pulsar_conf <pulsar_source_conf> ...]] "
-                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] "
+                "  pulsar_sync_table \\\n"
+                        + "--warehouse <warehouse_path> \\\n"
+                        + "--database <database_name> \\\n"
+                        + "--table <table_name> \\\n"
+                        + "[--partition_keys <partition_keys>] \\\n"
+                        + "[--primary_keys <primary_keys>] \\\n"
+                        + "[--type_mapping <option1,option2...>] \\\n"
+                        + "[--computed_column <'column_name=expr_name(args[, ...])'> [--computed_column ...]] \\\n"
+                        + "[--pulsar_conf <pulsar_source_conf> [--pulsar_conf <pulsar_source_conf> ...]] \\\n"
+                        + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]] \\\n"
                         + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
         System.out.println();