in paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/mysql/MySqlSyncDatabaseActionFactory.java [68:177]
public void printHelp() {
System.out.println(
"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. "
+ "Newly created MySQL tables after the job starts will not be included.");
System.out.println();
System.out.println("Syntax:");
System.out.println(
" 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();
System.out.println(
"--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, "
+ "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`");
System.out.println();
System.out.println(
"--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.");
System.out.println(
"--excluding_tables has higher priority than --including_tables if you specified both.");
System.out.println();
System.out.println(
"--mode is used to specify synchronization mode. You can specify two modes:");
System.out.println(
" 1. 'divided' (the default mode if you haven't specified one): "
+ "start a sink for each table, the synchronization of the new table requires restarting the job;");
System.out.println(
" 2. 'combined': start a single combined sink for all tables, the new table will be automatically synchronized.");
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.");
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.");
System.out.println();
System.out.println("MySQL CDC source conf syntax:");
System.out.println(" key=value");
System.out.println(
"'hostname', 'username', 'password' and 'database-name' "
+ "are required configurations, others are optional. "
+ "Note that 'database-name' should be the exact name "
+ "of the MySQL database you want to synchronize. "
+ "It can't be a regular expression.");
System.out.println(
"For a complete list of supported configurations, "
+ "see https://nightlies.apache.org/flink/flink-cdc-docs-release-3.1/docs/connectors/flink-sources/mysql-cdc/#connector-options");
System.out.println();
System.out.println("Paimon catalog and table sink conf syntax:");
System.out.println(" key=value");
System.out.println("All Paimon sink table will be applied the same set of configurations.");
System.out.println(
"For a complete list of supported configurations, "
+ "see https://paimon.apache.org/docs/master/maintenance/configurations/");
System.out.println();
System.out.println("Examples:");
System.out.println(
" 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");
}