You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@paimon.apache.org by lz...@apache.org on 2023/12/02 11:14:58 UTC
(incubator-paimon) 02/03: [flink] All help messages in action factory use underline argument key instead of hyphen (#2440)
This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch release-0.6
in repository https://gitbox.apache.org/repos/asf/incubator-paimon.git
commit 4f240e2d41af77b0ffd9ee2bed2ee9b3fa1692b9
Author: yuzelin <33...@users.noreply.github.com>
AuthorDate: Sat Dec 2 19:01:35 2023 +0800
[flink] All help messages in action factory use underline argument key instead of hyphen (#2440)
---
.../cdc/kafka/KafkaSyncDatabaseActionFactory.java | 56 +++++++-------
.../cdc/kafka/KafkaSyncTableActionFactory.java | 48 ++++++------
.../mongodb/MongoDBSyncDatabaseActionFactory.java | 52 ++++++-------
.../cdc/mongodb/MongoDBSyncTableActionFactory.java | 44 +++++------
.../cdc/mysql/MySqlSyncDatabaseActionFactory.java | 70 +++++++++---------
.../cdc/mysql/MySqlSyncTableActionFactory.java | 54 +++++++-------
.../pulsar/PulsarSyncDatabaseActionFactory.java | 58 +++++++--------
.../cdc/pulsar/PulsarSyncTableActionFactory.java | 50 ++++++-------
.../paimon/flink/action/CompactActionFactory.java | 32 ++++----
.../flink/action/CompactDatabaseActionFactory.java | 30 ++++----
.../flink/action/CreateTagActionFactory.java | 6 +-
.../paimon/flink/action/DeleteActionFactory.java | 8 +-
.../flink/action/DeleteTagActionFactory.java | 6 +-
.../flink/action/DropPartitionActionFactory.java | 12 +--
.../flink/action/MergeIntoActionFactory.java | 86 +++++++++++-----------
.../flink/action/MigrateTableActionFactory.java | 4 +-
.../action/RemoveOrphanFilesActionFactory.java | 8 +-
.../flink/action/ResetConsumerActionFactory.java | 8 +-
.../flink/action/RollbackToActionFactory.java | 8 +-
19 files changed, 320 insertions(+), 320 deletions(-)
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncDatabaseActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncDatabaseActionFactory.java
index 8c55c0bfe..700720ba1 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncDatabaseActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncDatabaseActionFactory.java
@@ -70,7 +70,7 @@ public class KafkaSyncDatabaseActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"kafka-sync-database\" creates a streaming job "
+ "Action \"kafka_sync_database\" creates a streaming job "
+ "with a Flink Kafka source and multiple Paimon table sinks "
+ "to synchronize multiple tables into one Paimon database.\n"
+ "Only tables with primary keys will be considered. ");
@@ -78,35 +78,35 @@ public class KafkaSyncDatabaseActionFactory implements ActionFactory {
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println(
- "--table-prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
- + "synchronized tables to have \"ods_\" as prefix, you can specify `--table-prefix ods_`.");
- System.out.println("The usage of --table-suffix is same as `--table-prefix`");
+ "--table_prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
+ + "synchronized tables to have \"ods_\" as prefix, you can specify `--table_prefix ods_`.");
+ System.out.println("The usage of --table_suffix is same as `--table_prefix`");
System.out.println();
System.out.println(
- "--including-tables is used to specify which source tables are to be synchronized. "
+ "--including_tables is used to specify which source tables are to be synchronized. "
+ "You must use '|' to separate multiple tables. Regular expression is supported.");
System.out.println(
- "--excluding-tables is used to specify which source tables are not to be synchronized. "
- + "The usage is same as --including-tables.");
+ "--excluding_tables is used to specify which source tables are not to be synchronized. "
+ + "The usage is same as --including_tables.");
System.out.println(
- "--excluding-tables has higher priority than --including-tables if you specified both.");
+ "--excluding_tables has higher priority than --including_tables if you specified both.");
System.out.println();
System.out.println(
- "--type-mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
+ "--type_mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
System.out.println();
System.out.println("kafka source conf syntax:");
@@ -130,17 +130,17 @@ public class KafkaSyncDatabaseActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " kafka-sync-database \\\n"
+ " kafka_sync_database \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
- + " --kafka-conf properties.bootstrap.servers=127.0.0.1:9020 \\\n"
- + " --kafka-conf topic=order\\;logistic\\;user \\\n"
- + " --kafka-conf properties.group.id=123456 \\\n"
- + " --kafka-conf value.format=canal-json \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --kafka_conf properties.bootstrap.servers=127.0.0.1:9020 \\\n"
+ + " --kafka_conf topic=order\\;logistic\\;user \\\n"
+ + " --kafka_conf properties.group.id=123456 \\\n"
+ + " --kafka_conf value.format=canal-json \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncTableActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncTableActionFactory.java
index 8a1efcd52..49c1ef76d 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncTableActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/kafka/KafkaSyncTableActionFactory.java
@@ -82,21 +82,21 @@ public class KafkaSyncTableActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"kafka-sync-table\" creates a streaming job "
+ "Action \"kafka_sync_table\" creates a streaming job "
+ "with a Flink Kafka Canal CDC source and a Paimon table sink to consume CDC events.");
System.out.println();
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println("Partition keys syntax:");
@@ -112,10 +112,10 @@ public class KafkaSyncTableActionFactory implements ActionFactory {
System.out.println();
System.out.println(
- "--type-mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
+ "--type_mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
System.out.println();
- System.out.println("Please see doc for usage of --computed-column.");
+ System.out.println("Please see doc for usage of --computed_column.");
System.out.println();
System.out.println("kafka source conf syntax:");
@@ -137,20 +137,20 @@ public class KafkaSyncTableActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " kafka-sync-table \\\n"
+ " kafka_sync_table \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
+ " --table test_table \\\n"
- + " --partition-keys pt \\\n"
- + " --primary-keys pt,uid \\\n"
- + " --kafka-conf properties.bootstrap.servers=127.0.0.1:9020 \\\n"
- + " --kafka-conf topic=order \\\n"
- + " --kafka-conf properties.group.id=123456 \\\n"
- + " --kafka-conf value.format=canal-json \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --partition_keys pt \\\n"
+ + " --primary_keys pt,uid \\\n"
+ + " --kafka_conf properties.bootstrap.servers=127.0.0.1:9020 \\\n"
+ + " --kafka_conf topic=order \\\n"
+ + " --kafka_conf properties.group.id=123456 \\\n"
+ + " --kafka_conf value.format=canal-json \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncDatabaseActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncDatabaseActionFactory.java
index b97a73552..e9c61582c 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncDatabaseActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncDatabaseActionFactory.java
@@ -62,7 +62,7 @@ public class MongoDBSyncDatabaseActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"mongodb-sync-database\" creates a streaming job "
+ "Action \"mongodb_sync_database\" creates a streaming job "
+ "with a Flink MongoDB CDC source and multiple Paimon table sinks "
+ "to synchronize a whole MongoDB database into one Paimon database.\n"
+ "Only MongoDB tables with a primary key that includes `_id` will be taken into consideration."
@@ -71,30 +71,30 @@ public class MongoDBSyncDatabaseActionFactory implements ActionFactory {
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println(
- "--table-prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
- + "synchronized tables to have \"ods_\" as prefix, you can specify `--table-prefix ods_`.");
- System.out.println("The usage of --table-suffix is same as `--table-prefix`");
+ "--table_prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
+ + "synchronized tables to have \"ods_\" as prefix, you can specify `--table_prefix ods_`.");
+ System.out.println("The usage of --table_suffix is same as `--table_prefix`");
System.out.println();
System.out.println(
- "--including-tables is used to specify which source tables are to be synchronized. "
+ "--including_tables is used to specify which source tables are to be synchronized. "
+ "You must use '|' to separate multiple tables. Regular expression is supported.");
System.out.println(
- "--excluding-tables is used to specify which source tables are not to be synchronized. "
- + "The usage is same as --including-tables.");
+ "--excluding_tables is used to specify which source tables are not to be synchronized. "
+ + "The usage is same as --including_tables.");
System.out.println(
- "--excluding-tables has higher priority than --including-tables if you specified both.");
+ "--excluding_tables has higher priority than --including_tables if you specified both.");
System.out.println();
System.out.println("MongoDB CDC source conf syntax:");
@@ -120,17 +120,17 @@ public class MongoDBSyncDatabaseActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " mongodb-sync-database \\\n"
+ " mongodb_sync_database \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
- + " --mongodb-conf hosts=127.0.0.1:27017 \\\n"
- + " --mongodb-conf username=root \\\n"
- + " --mongodb-conf password=123456 \\\n"
- + " --mongodb-conf database=source_db \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --mongodb_conf hosts=127.0.0.1:27017 \\\n"
+ + " --mongodb_conf username=root \\\n"
+ + " --mongodb_conf password=123456 \\\n"
+ + " --mongodb_conf database=source_db \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncTableActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncTableActionFactory.java
index 819bf7815..4cac49178 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncTableActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mongodb/MongoDBSyncTableActionFactory.java
@@ -71,19 +71,19 @@ public class MongoDBSyncTableActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"mongodb-sync-table\" creates a streaming job "
+ "Action \"mongodb_sync_table\" creates a streaming job "
+ "with a Flink mongodb CDC source and a Paimon table sink to consume CDC events.");
System.out.println();
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println("Partition keys syntax:");
@@ -93,7 +93,7 @@ public class MongoDBSyncTableActionFactory implements ActionFactory {
+ "this action will automatically create an unpartitioned Paimon table.");
System.out.println();
- System.out.println("Please see doc for usage of --computed-column.");
+ System.out.println("Please see doc for usage of --computed_column.");
System.out.println();
System.out.println("mongodb CDC source conf syntax:");
@@ -102,7 +102,7 @@ public class MongoDBSyncTableActionFactory implements ActionFactory {
"'hosts', 'username', 'password', 'database' and 'collection' "
+ "are required configurations, others are optional.");
System.out.println(
- "The 'mongodb-conf' introduces the 'schema.start.mode' parameter on top of the MongoDB CDC source configuration. 'schema.start.mode' provides two modes: 'dynamic' (default) and 'specified'."
+ "The 'mongodb_conf' introduces the 'schema.start.mode' parameter on top of the MongoDB CDC source configuration. 'schema.start.mode' provides two modes: 'dynamic' (default) and 'specified'."
+ "In 'dynamic' mode, MongoDB schema information is parsed at one level, which forms the basis for schema change evolution."
+ "In 'specified' mode, synchronization takes place according to specified criteria."
+ "This can be done by configuring 'field.name' to specify the synchronization fields and 'parser.path' to specify the JSON parsing path for those fields.");
@@ -120,20 +120,20 @@ public class MongoDBSyncTableActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " mongodb-sync-table \\\n"
+ " mongodb_sync_table \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
+ " --table test_table \\\n"
- + " --partition-keys pt \\\n"
- + " --mongodb-conf hosts=127.0.0.1:27017 \\\n"
- + " --mongodb-conf username=root \\\n"
- + " --mongodb-conf password=123456 \\\n"
- + " --mongodb-conf database=source_db \\\n"
- + " --mongodb-conf collection='source_table' \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --partition_keys pt \\\n"
+ + " --mongodb_conf hosts=127.0.0.1:27017 \\\n"
+ + " --mongodb_conf username=root \\\n"
+ + " --mongodb_conf password=123456 \\\n"
+ + " --mongodb_conf database=source_db \\\n"
+ + " --mongodb_conf collection='source_table' \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java
index 785083589..ef56f900e 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java
@@ -84,7 +84,7 @@ public class MySqlSyncDatabaseActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"mysql-sync-database\" creates a streaming job "
+ "Action \"mysql_sync_database\" creates a streaming job "
+ "with a Flink MySQL CDC source and multiple Paimon table sinks "
+ "to synchronize a whole MySQL database into one Paimon database.\n"
+ "Only MySQL tables with primary keys will be considered. "
@@ -93,48 +93,48 @@ public class MySqlSyncDatabaseActionFactory implements ActionFactory {
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println(
- "--ignore-incompatible is default false, in this case, if MySQL table name exists in Paimon "
+ "--ignore_incompatible is default false, in this case, if MySQL table name exists in Paimon "
+ "and their schema is incompatible, an exception will be thrown. "
+ "You can specify it to true explicitly to ignore the incompatible tables and exception.");
System.out.println();
System.out.println(
- "--merge-shards is default true, in this case, if some tables in different databases have the same name, "
+ "--merge_shards is default true, in this case, if some tables in different databases have the same name, "
+ "their schemas will be merged and their records will be synchronized into one Paimon table. "
+ "Otherwise, each table's records will be synchronized to a corresponding Paimon table, "
+ "and the Paimon table will be named to 'databaseName_tableName' to avoid potential name conflict.");
System.out.println();
System.out.println(
- "--table-prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
- + "synchronized tables to have \"ods_\" as prefix, you can specify `--table-prefix ods_`.");
- System.out.println("The usage of --table-suffix is same as `--table-prefix`");
+ "--table_prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
+ + "synchronized tables to have \"ods_\" as prefix, you can specify `--table_prefix ods_`.");
+ System.out.println("The usage of --table_suffix is same as `--table_prefix`");
System.out.println();
System.out.println(
- "--including-tables is used to specify which source tables are to be synchronized. "
+ "--including_tables is used to specify which source tables are to be synchronized. "
+ "You must use '|' to separate multiple tables. Regular expression is supported.");
System.out.println(
- "--excluding-tables is used to specify which source tables are not to be synchronized. "
- + "The usage is same as --including-tables.");
+ "--excluding_tables is used to specify which source tables are not to be synchronized. "
+ + "The usage is same as --including_tables.");
System.out.println(
- "--excluding-tables has higher priority than --including-tables if you specified both.");
+ "--excluding_tables has higher priority than --including_tables if you specified both.");
System.out.println();
System.out.println(
@@ -147,11 +147,11 @@ public class MySqlSyncDatabaseActionFactory implements ActionFactory {
System.out.println();
System.out.println(
- "--metadata-column is used to specify which metadata columns to include in the output schema of the connector. Please see the doc for usage.");
+ "--metadata_column is used to specify which metadata columns to include in the output schema of the connector. Please see the doc for usage.");
System.out.println();
System.out.println(
- "--type-mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
+ "--type_mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
System.out.println();
System.out.println("MySQL CDC source conf syntax:");
@@ -177,17 +177,17 @@ public class MySqlSyncDatabaseActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " mysql-sync-database \\\n"
+ " mysql_sync_database \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
- + " --mysql-conf hostname=127.0.0.1 \\\n"
- + " --mysql-conf username=root \\\n"
- + " --mysql-conf password=123456 \\\n"
- + " --mysql-conf database-name=source_db \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --mysql_conf hostname=127.0.0.1 \\\n"
+ + " --mysql_conf username=root \\\n"
+ + " --mysql_conf password=123456 \\\n"
+ + " --mysql_conf database-name=source_db \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncTableActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncTableActionFactory.java
index 293fdd6bb..7cd115c7f 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncTableActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncTableActionFactory.java
@@ -88,22 +88,22 @@ public class MySqlSyncTableActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"mysql-sync-table\" creates a streaming job "
+ "Action \"mysql_sync_table\" creates a streaming job "
+ "with a Flink MySQL CDC source and a Paimon table sink to consume CDC events.");
System.out.println();
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println("Partition keys syntax:");
@@ -119,14 +119,14 @@ public class MySqlSyncTableActionFactory implements ActionFactory {
System.out.println();
System.out.println(
- "--type-mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
+ "--type_mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
System.out.println();
- System.out.println("Please see doc for usage of --computed-column.");
+ System.out.println("Please see doc for usage of --computed_column.");
System.out.println();
System.out.println(
- "--metadata-column is used to specify which metadata columns to include in the output schema of the connector. Please see the doc for usage.");
+ "--metadata_column is used to specify which metadata columns to include in the output schema of the connector. Please see the doc for usage.");
System.out.println();
System.out.println("MySQL CDC source conf syntax:");
@@ -148,21 +148,21 @@ public class MySqlSyncTableActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " mysql-sync-table \\\n"
+ " mysql_sync_table \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
+ " --table test_table \\\n"
- + " --partition-keys pt \\\n"
- + " --primary-keys pt,uid \\\n"
- + " --mysql-conf hostname=127.0.0.1 \\\n"
- + " --mysql-conf username=root \\\n"
- + " --mysql-conf password=123456 \\\n"
- + " --mysql-conf database-name=source_db \\\n"
- + " --mysql-conf table-name='source_table' \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --partition_keys pt \\\n"
+ + " --primary_keys pt,uid \\\n"
+ + " --mysql_conf hostname=127.0.0.1 \\\n"
+ + " --mysql_conf username=root \\\n"
+ + " --mysql_conf password=123456 \\\n"
+ + " --mysql_conf database-name=source_db \\\n"
+ + " --mysql_conf table-name='source_table' \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncDatabaseActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncDatabaseActionFactory.java
index 023f139a8..f042798ff 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncDatabaseActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncDatabaseActionFactory.java
@@ -70,7 +70,7 @@ public class PulsarSyncDatabaseActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"pulsar-sync-database\" creates a streaming job "
+ "Action \"pulsar_sync_database\" creates a streaming job "
+ "with a Flink Pulsar source and multiple Paimon table sinks "
+ "to synchronize multiple tables into one Paimon database.\n"
+ "Only tables with primary keys will be considered. ");
@@ -78,35 +78,35 @@ public class PulsarSyncDatabaseActionFactory implements ActionFactory {
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println(
- "--table-prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
- + "synchronized tables to have \"ods_\" as prefix, you can specify `--table-prefix ods_`.");
- System.out.println("The usage of --table-suffix is same as `--table-prefix`");
+ "--table_prefix is the prefix of all Paimon tables to be synchronized. For example, if you want all "
+ + "synchronized tables to have \"ods_\" as prefix, you can specify `--table_prefix ods_`.");
+ System.out.println("The usage of --table_suffix is same as `--table_prefix`");
System.out.println();
System.out.println(
- "--including-tables is used to specify which source tables are to be synchronized. "
+ "--including_tables is used to specify which source tables are to be synchronized. "
+ "You must use '|' to separate multiple tables. Regular expression is supported.");
System.out.println(
- "--excluding-tables is used to specify which source tables are not to be synchronized. "
- + "The usage is same as --including-tables.");
+ "--excluding_tables is used to specify which source tables are not to be synchronized. "
+ + "The usage is same as --including_tables.");
System.out.println(
- "--excluding-tables has higher priority than --including-tables if you specified both.");
+ "--excluding_tables has higher priority than --including_tables if you specified both.");
System.out.println();
System.out.println(
- "--type-mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
+ "--type_mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
System.out.println();
System.out.println("pulsar source conf syntax:");
@@ -130,18 +130,18 @@ public class PulsarSyncDatabaseActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " pulsar-sync-database \\\n"
+ " pulsar_sync_database \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
- + " --pulsar-conf topic=order,logistic,user \\\n"
- + " --pulsar-conf value.format=canal-json \\\n"
- + " --pulsar-conf pulsar.client.serviceUrl=pulsar://127.0.0.1:6650 \\\n"
- + " --pulsar-conf pulsar.admin.adminUrl=http://127.0.0.1:8080 \\\n"
- + " --pulsar-conf pulsar.consumer.subscriptionName=paimon-tests \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --pulsar_conf topic=order,logistic,user \\\n"
+ + " --pulsar_conf value.format=canal-json \\\n"
+ + " --pulsar_conf pulsar.client.serviceUrl=pulsar://127.0.0.1:6650 \\\n"
+ + " --pulsar_conf pulsar.admin.adminUrl=http://127.0.0.1:8080 \\\n"
+ + " --pulsar_conf pulsar.consumer.subscriptionName=paimon-tests \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncTableActionFactory.java b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncTableActionFactory.java
index 6929687aa..a2df98d59 100644
--- a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncTableActionFactory.java
+++ b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/pulsar/PulsarSyncTableActionFactory.java
@@ -82,21 +82,21 @@ public class PulsarSyncTableActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"pulsar-sync-table\" creates a streaming job "
+ "Action \"pulsar_sync_table\" creates a streaming job "
+ "with a Flink Pulsar CDC source and a Paimon table sink to consume CDC events.");
System.out.println();
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> ...]] "
- + "[--table-conf <paimon-table-sink-conf> [--table-conf <paimon-table-sink-conf> ...]]");
+ " 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> ...]] "
+ + "[--table_conf <paimon_table_sink_conf> [--table_conf <paimon_table_sink_conf> ...]]");
System.out.println();
System.out.println("Partition keys syntax:");
@@ -112,10 +112,10 @@ public class PulsarSyncTableActionFactory implements ActionFactory {
System.out.println();
System.out.println(
- "--type-mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
+ "--type_mapping is used to specify how to map MySQL type to Paimon type. Please see the doc for usage.");
System.out.println();
- System.out.println("Please see doc for usage of --computed-column.");
+ System.out.println("Please see doc for usage of --computed_column.");
System.out.println();
System.out.println("pulsar source conf syntax:");
@@ -137,21 +137,21 @@ public class PulsarSyncTableActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " pulsar-sync-table \\\n"
+ " pulsar_sync_table \\\n"
+ " --warehouse hdfs:///path/to/warehouse \\\n"
+ " --database test_db \\\n"
+ " --table test_table \\\n"
- + " --partition-keys pt \\\n"
- + " --primary-keys pt,uid \\\n"
- + " --pulsar-conf topic=order \\\n"
- + " --pulsar-conf value.format=canal-json \\\n"
- + " --pulsar-conf pulsar.client.serviceUrl=pulsar://127.0.0.1:6650 \\\n"
- + " --pulsar-conf pulsar.admin.adminUrl=http://127.0.0.1:8080 \\\n"
- + " --pulsar-conf pulsar.consumer.subscriptionName=paimon-tests \\\n"
- + " --catalog-conf metastore=hive \\\n"
- + " --catalog-conf uri=thrift://hive-metastore:9083 \\\n"
- + " --table-conf bucket=4 \\\n"
- + " --table-conf changelog-producer=input \\\n"
- + " --table-conf sink.parallelism=4");
+ + " --partition_keys pt \\\n"
+ + " --primary_keys pt,uid \\\n"
+ + " --pulsar_conf topic=order \\\n"
+ + " --pulsar_conf value.format=canal-json \\\n"
+ + " --pulsar_conf pulsar.client.serviceUrl=pulsar://127.0.0.1:6650 \\\n"
+ + " --pulsar_conf pulsar.admin.adminUrl=http://127.0.0.1:8080 \\\n"
+ + " --pulsar_conf pulsar.consumer.subscriptionName=paimon-tests \\\n"
+ + " --catalog_conf metastore=hive \\\n"
+ + " --catalog_conf uri=thrift://hive-metastore:9083 \\\n"
+ + " --table_conf bucket=4 \\\n"
+ + " --table_conf changelog-producer=input \\\n"
+ + " --table_conf sink.parallelism=4");
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactActionFactory.java
index 08c1215df..22cb6cafa 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactActionFactory.java
@@ -80,15 +80,15 @@ public class CompactActionFactory implements ActionFactory {
System.out.println("Syntax:");
System.out.println(
- " compact --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> [--partition <partition-name>]"
- + "[--order-strategy <order-strategy>]"
- + "[--table-conf <key>=<value>]"
- + "[--order-by <order-columns>]");
+ " compact --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> [--partition <partition_name>]"
+ + "[--order_strategy <order_strategy>]"
+ + "[--table_conf <key>=<value>]"
+ + "[--order_by <order_columns>]");
System.out.println(
- " compact --warehouse s3://path/to/warehouse --database <database-name> "
- + "--table <table-name> [--catalog-conf <paimon-catalog-conf> [--catalog-conf <paimon-catalog-conf> ...]]");
- System.out.println(" compact --path <table-path> [--partition <partition-name>]");
+ " compact --warehouse s3://path/to/warehouse --database <database_name> "
+ + "--table <table_name> [--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]]");
+ System.out.println(" compact --path <table_path> [--partition <partition_name>]");
System.out.println();
System.out.println("Partition name syntax:");
@@ -97,8 +97,8 @@ public class CompactActionFactory implements ActionFactory {
System.out.println();
System.out.println("Note:");
System.out.println(
- " order compact now only support append-only table with bucket=-1, please don't specify --order-strategy parameter if your table does not meet the request");
- System.out.println(" order-strategy now only support zorder in batch mode");
+ " order compact now only support append-only table with bucket=-1, please don't specify --order_strategy parameter if your table does not meet the request");
+ System.out.println(" order_strategy now only support zorder in batch mode");
System.out.println();
System.out.println("Examples:");
@@ -113,11 +113,11 @@ public class CompactActionFactory implements ActionFactory {
" compact --warehouse s3:///path/to/warehouse "
+ "--database test_db "
+ "--table test_table "
- + "--order-strategy zorder "
- + "--order-by a,b,c "
- + "--table-conf sink.parallelism=9 "
- + "--catalog-conf s3.endpoint=https://****.com "
- + "--catalog-conf s3.access-key=***** "
- + "--catalog-conf s3.secret-key=***** ");
+ + "--order_strategy zorder "
+ + "--order_by a,b,c "
+ + "--table_conf sink.parallelism=9 "
+ + "--catalog_conf s3.endpoint=https://****.com "
+ + "--catalog_conf s3.access-key=***** "
+ + "--catalog_conf s3.secret-key=***** ");
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactDatabaseActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactDatabaseActionFactory.java
index 590f5283a..a7b761044 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactDatabaseActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CompactDatabaseActionFactory.java
@@ -54,37 +54,37 @@ public class CompactDatabaseActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"compact-database\" runs a dedicated job for compacting one or multiple database.");
+ "Action \"compact_database\" runs a dedicated job for compacting one or multiple database.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " compact-database --warehouse <warehouse-path> --database <database-name> "
- + "[--including-tables <paimon-table-name|name-regular-expr>] "
- + "[--excluding-tables <paimon-table-name|name-regular-expr>] ");
+ " compact_database --warehouse <warehouse_path> --database <database_name> "
+ + "[--including_tables <paimon_table_name|name_regular_expr>] "
+ + "[--excluding_tables <paimon_table_name|name_regular_expr>] ");
System.out.println(
- " compact-database --warehouse s3://path/to/warehouse --database <database-name> "
- + "[--catalog-conf <paimon-catalog-conf> [--catalog-conf <paimon-catalog-conf> ...]]");
+ " compact_database --warehouse s3://path/to/warehouse --database <database_name> "
+ + "[--catalog_conf <paimon_catalog_conf> [--catalog_conf <paimon_catalog_conf> ...]]");
System.out.println();
System.out.println(
- "--including-tables is used to specify which source tables are to be compacted. "
+ "--including_tables is used to specify which source tables are to be compacted. "
+ "You must use '|' to separate multiple tables, the format is `databaseName.tableName`, Regular expression is supported.");
System.out.println(
- "--excluding-tables is used to specify which source tables are not to be compacted. "
- + "The usage is same as --including-tables.");
+ "--excluding_tables is used to specify which source tables are not to be compacted. "
+ + "The usage is same as --including_tables.");
System.out.println(
- "--excluding-tables has higher priority than --including-tables if you specified both.");
+ "--excluding_tables has higher priority than --including_tables if you specified both.");
System.out.println();
System.out.println("Examples:");
System.out.println(
- " compact-database --warehouse hdfs:///path/to/warehouse --database test_db");
+ " compact_database --warehouse hdfs:///path/to/warehouse --database test_db");
System.out.println(
- " compact-database --warehouse s3:///path/to/warehouse "
+ " compact_database --warehouse s3:///path/to/warehouse "
+ "--database test_db "
- + "--catalog-conf s3.endpoint=https://****.com "
- + "--catalog-conf s3.access-key=***** "
- + "--catalog-conf s3.secret-key=***** ");
+ + "--catalog_conf s3.endpoint=https://****.com "
+ + "--catalog_conf s3.access-key=***** "
+ + "--catalog_conf s3.secret-key=***** ");
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CreateTagActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CreateTagActionFactory.java
index 45b9597df..bfc9510d7 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CreateTagActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/CreateTagActionFactory.java
@@ -54,13 +54,13 @@ public class CreateTagActionFactory implements ActionFactory {
@Override
public void printHelp() {
- System.out.println("Action \"create-tag\" creates a tag from given snapshot.");
+ System.out.println("Action \"create_tag\" creates a tag from given snapshot.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " create-tag --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> --tag-name <tag-name> --snapshot <snapshot-id>");
+ " create_tag --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> --tag_name <tag_name> --snapshot <snapshot_id>");
System.out.println();
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteActionFactory.java
index dee3a68de..7f8f63f7f 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteActionFactory.java
@@ -59,9 +59,9 @@ public class DeleteActionFactory implements ActionFactory {
System.out.println("Syntax:");
System.out.println(
- " delete --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> --where <filter_spec>");
- System.out.println(" delete --path <table-path> --where <filter_spec>");
+ " delete --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> --where <filter_spec>");
+ System.out.println(" delete --path <table_path> --where <filter_spec>");
System.out.println();
System.out.println(
@@ -70,7 +70,7 @@ public class DeleteActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " delete --path hdfs:///path/to/warehouse/test_db.db/test_table --where id > (SELECT count(*) FROM employee)");
+ " delete --path hdfs:///path/to/warehouse/test_db.db/test_table --where 'id > (SELECT count(*) FROM employee)'");
System.out.println(
" It's equal to 'DELETE FROM test_table WHERE id > (SELECT count(*) FROM employee)");
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteTagActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteTagActionFactory.java
index 8f0c51482..56b724c0e 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteTagActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DeleteTagActionFactory.java
@@ -51,13 +51,13 @@ public class DeleteTagActionFactory implements ActionFactory {
@Override
public void printHelp() {
- System.out.println("Action \"delete-tag\" deletes a tag by name.");
+ System.out.println("Action \"delete_tag\" deletes a tag by name.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " delete-tag --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> --tag-name <tag-name>");
+ " delete_tag --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> --tag_name <tag_name>");
System.out.println();
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DropPartitionActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DropPartitionActionFactory.java
index b177caadd..e4b29dde0 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DropPartitionActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/DropPartitionActionFactory.java
@@ -51,15 +51,15 @@ public class DropPartitionActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"drop-partition\" drops data of specified partitions for a table.");
+ "Action \"drop_partition\" drops data of specified partitions for a table.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " drop-partition --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> --partition <partition-name> [--partition <partition-name> ...]");
+ " drop_partition --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> --partition <partition_name> [--partition <partition_name> ...]");
System.out.println(
- " drop-partition --path <table-path> --partition <partition-name> [--partition <partition-name> ...]");
+ " drop_partition --path <table_path> --partition <partition_name> [--partition <partition_name> ...]");
System.out.println();
System.out.println("Partition name syntax:");
@@ -68,8 +68,8 @@ public class DropPartitionActionFactory implements ActionFactory {
System.out.println("Examples:");
System.out.println(
- " drop-partition --warehouse hdfs:///path/to/warehouse --database test_db --table test_table --partition dt=20221126,hh=08");
+ " drop_partition --warehouse hdfs:///path/to/warehouse --database test_db --table test_table --partition dt=20221126,hh=08");
System.out.println(
- " drop-partition --path hdfs:///path/to/warehouse/test_db.db/test_table --partition dt=20221126,hh=08 --partition dt=20221127,hh=09");
+ " drop_partition --path hdfs:///path/to/warehouse/test_db.db/test_table --partition dt=20221126,hh=08 --partition dt=20221127,hh=09");
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MergeIntoActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MergeIntoActionFactory.java
index 2b87b7293..3c07e3bd5 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MergeIntoActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MergeIntoActionFactory.java
@@ -119,50 +119,50 @@ public class MergeIntoActionFactory implements ActionFactory {
@Override
public void printHelp() {
- System.out.println("Action \"merge-into\" simulates the \"MERGE INTO\" syntax.");
+ System.out.println("Action \"merge_into\" simulates the \"MERGE INTO\" syntax.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " merge-into --warehouse <warehouse-path>\n"
- + " --database <database-name>\n"
- + " --table <target-table-name>\n"
- + " [--target-as <target-table-alias>]\n"
- + " [--source-sql <sql> ...]\n"
- + " --source-table <source-table-name>\n"
- + " --on <merge-condition>\n"
- + " --merge-actions <matched-upsert,matched-delete,not-matched-insert,not-matched-by-source-upsert,not-matched-by-source-delete>\n"
- + " --matched-upsert-condition <matched-condition>\n"
- + " --matched-upsert-set <upsert-changes>\n"
- + " --matched-delete-condition <matched-condition>\n"
- + " --not-matched-insert-condition <not-matched-condition>\n"
- + " --not-matched-insert-values <insert-values>\n"
- + " --not-matched-by-source-upsert-condition <not-matched-by-source-condition>\n"
- + " --not-matched-by-source-upsert-set <not-matched-upsert-changes>\n"
- + " --not-matched-by-source-delete-condition <not-matched-by-source-condition>");
-
- System.out.println(" matched-upsert-changes format:");
- System.out.println(
- " col=<source-table>.col | expression [, ...] (do not add '<target-table>.' before 'col')");
+ " merge_into --warehouse <warehouse_path>\n"
+ + " --database <database_name>\n"
+ + " --table <target_table_name>\n"
+ + " [--target_as <target_table_alias>]\n"
+ + " [--source_sql <sql> ...]\n"
+ + " --source_table <source_table_name>\n"
+ + " --on <merge_condition>\n"
+ + " --merge_actions <matched-upsert,matched-delete,not-matched-insert,not-matched-by-source-upsert,not-matched-by-source-delete>\n"
+ + " --matched_upsert_condition <matched_condition>\n"
+ + " --matched_upsert_set <upsert_changes>\n"
+ + " --matched_delete_condition <matched_condition>\n"
+ + " --not_matched_insert_condition <not_matched_condition>\n"
+ + " --not_matched_insert_values <insert_values>\n"
+ + " --not_matched_by_source_upsert_condition <not_matched_by_source_condition>\n"
+ + " --not_matched_by_source_upsert_set <not_matched_upsert_changes>\n"
+ + " --not_matched_by_source_delete_condition <not_matched_by_source_condition>");
+
+ System.out.println(" matched_upsert_set format:");
+ System.out.println(
+ " col=<source_table>.col | expression [, ...] (do not add '<target_table>.' before 'col')");
System.out.println(
" * (upsert with all source cols; require target table's schema is equal to source's)");
- System.out.println(" not-matched-upsert-changes format:");
+ System.out.println(" not_matched_upsert_set format:");
System.out.println(" col=expression (cannot use source table's col)");
- System.out.println(" insert-values format:");
+ System.out.println(" insert_values format:");
System.out.println(
- " col1,col2,...,col_end (must specify values of all columns; can use <source-table>.col or expression)");
+ " col1,col2,...,col_end (must specify values of all columns; can use <source_table>.col or expression)");
System.out.println(
" * (insert with all source cols; require target table's schema is equal to source's)");
System.out.println(
- " not-matched-condition: cannot use target table's columns to construct condition expression.");
+ " not_matched_condition: cannot use target table's columns to construct condition expression.");
System.out.println(
- " not-matched-by-source-condition: cannot use source table's columns to construct condition expression.");
+ " not_matched_by_source_condition: cannot use source table's columns to construct condition expression.");
System.out.println(" alternative arguments:");
- System.out.println(" --path <table-path> to represent the table path.");
+ System.out.println(" --path <table_path> to represent the table path.");
System.out.println();
System.out.println("Note: ");
@@ -170,35 +170,35 @@ public class MergeIntoActionFactory implements ActionFactory {
System.out.println(
" 2. All conditions, set changes and values should use Flink SQL syntax. Please quote them with \" to escape special characters.");
System.out.println(
- " 3. You can pass sqls by --source-sql to config environment and create source table at runtime");
+ " 3. You can pass sqls by --source_sql to config environment and create source table at runtime");
System.out.println(" 4. Target alias cannot be duplicated with existed table name.");
System.out.println(
" 5. If the source table is not in the current catalog and current database, "
- + "the source-table-name must be qualified (database.table or catalog.database.table if in different catalog).");
+ + "the source_table_name must be qualified (database.table or catalog.database.table if in different catalog).");
System.out.println(" 6. At least one merge action must be specified.");
System.out.println(" 7. How to determine the changed rows with different \"matched\":");
System.out.println(
" matched: changed rows are from target table and each can match a source table row "
- + "based on merge-condition and optional matched-condition.");
+ + "based on merge_condition and optional matched_condition.");
System.out.println(
- " not-matched: changed rows are from source table and all rows cannot match any target table row "
- + "based on merge-condition and optional not-matched-condition.");
+ " not_matched: changed rows are from source table and all rows cannot match any target table row "
+ + "based on merge_condition and optional not_matched_condition.");
System.out.println(
- " not-matched-by-source: changed rows are from target table and all row cannot match any source table row "
- + "based on merge-condition and optional not-matched-by-source-condition.");
+ " not_matched_by_source: changed rows are from target table and all row cannot match any source table row "
+ + "based on merge_condition and optional not_matched_by_source_condition.");
System.out.println(
- " 8. If both matched-upsert and matched-delete actions are present, their conditions must both be present too "
- + "(same to not-matched-by-source-upsert and not-matched-by-source-delete). Otherwise, all conditions are optional.");
+ " 8. If both matched_upsert and matched_delete actions are present, their conditions must both be present too "
+ + "(same to not_matched_by_source_upsert and not_matched_by_source_delete). Otherwise, all conditions are optional.");
System.out.println();
System.out.println("Examples:");
System.out.println(
- " merge-into --path hdfs:///path/to/T\n"
- + " --source-table S\n"
+ " merge_into --path hdfs:///path/to/T\n"
+ + " --source_table S\n"
+ " --on \"T.k = S.k\"\n"
- + " --merge-actions matched-upsert\n"
- + " --matched-upsert-condition \"T.v <> S.v\"\n"
- + " --matched-upsert-set \"v = S.v\"");
+ + " --merge_actions matched-upsert\n"
+ + " --matched_upsert_condition \"T.v <> S.v\"\n"
+ + " --matched_upsert_set \"v = S.v\"");
System.out.println(
" It will find matched rows of target table that meet condition (T.k = S.k), then update T.v with S.v where (T.v <> S.v).");
}
@@ -210,7 +210,7 @@ public class MergeIntoActionFactory implements ActionFactory {
&& !action.notMatchedDelete
&& !action.insert) {
throw new IllegalArgumentException(
- "Must specify at least one merge action. Run 'merge-into --help' for help.");
+ "Must specify at least one merge action. Run 'merge_into --help' for help.");
}
if ((action.matchedUpsert && action.matchedDelete)
@@ -231,7 +231,7 @@ public class MergeIntoActionFactory implements ActionFactory {
if (action.notMatchedBySourceUpsertSet != null
&& action.notMatchedBySourceUpsertSet.equals("*")) {
throw new IllegalArgumentException(
- "The '*' cannot be used in not-matched-by-source-upsert-set");
+ "The '*' cannot be used in not_matched_by_source_upsert_set");
}
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MigrateTableActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MigrateTableActionFactory.java
index 5ab1fb259..ffe2a9b99 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MigrateTableActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/MigrateTableActionFactory.java
@@ -55,9 +55,9 @@ public class MigrateTableActionFactory implements ActionFactory {
System.out.println("Syntax:");
System.out.println(
- " migrate_table --warehouse <warehouse-path> --source_type hive "
+ " migrate_table --warehouse <warehouse_path> --source_type hive "
+ "--table <database.table_name> "
- + "[--catalog-conf <key>=<value] "
+ + "[--catalog_conf <key>=<value] "
+ "[--options <key>=<value>,<key>=<value>,...]");
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RemoveOrphanFilesActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RemoveOrphanFilesActionFactory.java
index b5d1f290d..de5de23bd 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RemoveOrphanFilesActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RemoveOrphanFilesActionFactory.java
@@ -54,18 +54,18 @@ public class RemoveOrphanFilesActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"remove-orphan-files\" remove files which are not used by any snapshots or tags of a Paimon table.");
+ "Action \"remove_orphan_files\" remove files which are not used by any snapshots or tags of a Paimon table.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " remove-orphan-files --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> [--older-than <timestamp>]");
+ " remove_orphan_files --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> [--older_than <timestamp>]");
System.out.println();
System.out.println(
"To avoid deleting newly written files, this action only deletes orphan files older than 1 day by default. "
- + "The interval can be modified by '--older-than'. <timestamp> format: yyyy-MM-dd HH:mm:ss");
+ + "The interval can be modified by '--older_than'. <timestamp> format: yyyy-MM-dd HH:mm:ss");
System.out.println();
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/ResetConsumerActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/ResetConsumerActionFactory.java
index a6e16b7e8..acd85ae60 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/ResetConsumerActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/ResetConsumerActionFactory.java
@@ -58,18 +58,18 @@ public class ResetConsumerActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"reset-consumer\" reset a consumer with a given consumer ID and next snapshot ID and delete a consumer with a given consumer ID.");
+ "Action \"reset_consumer\" reset a consumer with a given consumer ID and next snapshot ID and delete a consumer with a given consumer ID.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " reset-consumer --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> --consumer-id <consumer-id> [--next-snapshot <next-snapshot-id>]");
+ " reset_consumer --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> --consumer_id <consumer_id> [--next_snapshot <next_snapshot_id>]");
System.out.println();
System.out.println("Note:");
System.out.println(
- " please don't specify --next-snapshot parameter if you want to delete the consumer.");
+ " please don't specify --next_snapshot parameter if you want to delete the consumer.");
System.out.println();
}
}
diff --git a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RollbackToActionFactory.java b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RollbackToActionFactory.java
index 222d7d569..077c608ac 100644
--- a/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RollbackToActionFactory.java
+++ b/paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/action/RollbackToActionFactory.java
@@ -54,15 +54,15 @@ public class RollbackToActionFactory implements ActionFactory {
@Override
public void printHelp() {
System.out.println(
- "Action \"rollback-to\" roll back a table to a specific snapshot ID or tag.");
+ "Action \"rollback_to\" roll back a table to a specific snapshot ID or tag.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
- " rollback-to --warehouse <warehouse-path> --database <database-name> "
- + "--table <table-name> --version <version-string>");
+ " rollback_to --warehouse <warehouse_path> --database <database_name> "
+ + "--table <table_name> --version <version_string>");
System.out.println(
- " 'version-string can be a long value representing a snapshot ID or a tag name.'");
+ " <version_string> can be a long value representing a snapshot ID or a tag name.");
System.out.println();
}
}