WL#14194 step 3.3: Aliases for command line options

WL#14194: Replace old terms in replication system variables, options,
and strings

For all renamed command-line options, we re-introduce the old name as
a deprecated alias.  This includes command-line options in mysqladmin,
mysqlbinlog, mysqldump, and the server.  For the server, it only
includes command-line options that are not defined through a system
variable.

RB:25845

Author: Sven Sandberg

client/client_priv.h

@@ -60,7 +60,7 @@ enum options_client {
   OPT_O_ENC,
   OPT_ESC,
   OPT_TABLES,
-  OPT_MASTER_DATA,
+  OPT_SOURCE_DATA,
   OPT_AUTOCOMMIT,
   OPT_AUTO_REHASH,
   OPT_LINE_NUMBERS,
@@ -78,7 +78,7 @@ enum options_client {
   OPT_SSL_CIPHER,
   OPT_SHUTDOWN_TIMEOUT,
   OPT_LOCAL_INFILE,
-  OPT_DELETE_MASTER_LOGS,
+  OPT_DELETE_SOURCE_LOGS,
   OPT_COMPACT,
   OPT_PROMPT,
   OPT_IGN_LINES,
@@ -112,9 +112,9 @@ enum options_client {
   OPT_DROP_DATABASE,
   OPT_TZ_UTC,
   OPT_CREATE_SLAP_SCHEMA,
-  OPT_MYSQLDUMP_SLAVE_APPLY,
-  OPT_MYSQLDUMP_SLAVE_DATA,
-  OPT_MYSQLDUMP_INCLUDE_MASTER_HOST_PORT,
+  OPT_MYSQLDUMP_REPLICA_APPLY,
+  OPT_MYSQLDUMP_REPLICA_DATA,
+  OPT_MYSQLDUMP_INCLUDE_SOURCE_HOST_PORT,
   OPT_MYSQLDUMP_IGNORE_ERROR,
   OPT_SLAP_CSV,
   OPT_SLAP_CREATE_STRING,
@@ -174,6 +174,12 @@ enum options_client {
   OPT_TLS_CIPHERSUITES,
   OPT_MYSQL_BINARY_AS_HEX,
   OPT_LOAD_DATA_LOCAL_DIR,
+  OPT_READ_FROM_REMOTE_MASTER_DEPRECATED,
+  OPT_MASTER_DATA_DEPRECATED,
+  OPT_MYSQLDUMP_SLAVE_APPLY_DEPRECATED,
+  OPT_DELETE_MASTER_LOGS_DEPRECATED,
+  OPT_MYSQLDUMP_SLAVE_DATA_DEPRECATED,
+  OPT_MYSQLDUMP_INCLUDE_MASTER_HOST_PORT_DEPRECATED,
   /* Add new option above this */
   OPT_MAX_CLIENT_OPTION
 };

client/mysqladmin.cc

@@ -147,7 +147,9 @@ enum commands {
   ADMIN_FLUSH_PRIVILEGES,
   ADMIN_START_REPLICA,
   ADMIN_STOP_REPLICA,
-  ADMIN_FLUSH_THREADS
+  ADMIN_FLUSH_THREADS,
+  ADMIN_START_SLAVE,
+  ADMIN_STOP_SLAVE
 };
 static const char *command_names[] = {"create",
                                       "drop",
@@ -171,6 +173,8 @@ static const char *command_names[] = {"create",
                                       "start-replica",
                                       "stop-replica",
                                       "flush-threads",
+                                      "start-slave",
+                                      "stop-slave",
                                       NullS};
 
 static TYPELIB command_typelib = {array_elements(command_names) - 1, "commands",
@@ -1112,6 +1116,9 @@ static int execute_commands(MYSQL *mysql, int argc, char **argv) {
         break;
       }
 
+      case ADMIN_START_SLAVE:
+        CLIENT_WARN_DEPRECATED("start-slave", "start-replica");
+        // FALLTHROUGH
       case ADMIN_START_REPLICA:
         if (mysql_query(mysql, "START REPLICA")) {
           my_printf_error(0, "Error starting replication: %s", error_flags,
@@ -1120,6 +1127,10 @@ static int execute_commands(MYSQL *mysql, int argc, char **argv) {
         } else
           puts("Replication started");
         break;
+
+      case ADMIN_STOP_SLAVE:
+        CLIENT_WARN_DEPRECATED("stop-slave", "stop-replica");
+        // FALLTHROUGH
       case ADMIN_STOP_REPLICA:
         if (mysql_query(mysql, "STOP REPLICA")) {
           my_printf_error(0, "Error stopping replication: %s", error_flags,
@@ -1228,7 +1239,9 @@ static void usage(void) {
   shutdown		Take server down\n\
   status		Gives a short status message from the server\n\
   start-replica		Start replication\n\
+  start-slave		Deprecated: use start-replica instead\n\
   stop-replica		Stop replication\n\
+  stop-slave		Deprecated: use stop-replica instead\n\
   variables             Prints variables available\n\
   version		Get version info from server");
 }

client/mysqlbinlog.cc

@@ -1892,6 +1892,11 @@ static struct my_option my_long_options[] = {
      "This is an alias for read-from-remote-source=BINLOG-DUMP-NON-GTIDS.",
      &opt_remote_alias, &opt_remote_alias, nullptr, GET_BOOL, NO_ARG, 0, 0, 0,
      nullptr, 0, nullptr},
+    {"read-from-remote-master", OPT_READ_FROM_REMOTE_MASTER_DEPRECATED,
+     "This option is deprecated and will be removed in a future version. "
+     "Use read-from-remote-source instead.",
+     &opt_remote_proto_str, &opt_remote_proto_str, nullptr, GET_STR,
+     REQUIRED_ARG, 0, 0, 0, nullptr, 0, nullptr},
     {"read-from-remote-source", OPT_REMOTE_PROTO,
      "Read binary logs from a MySQL server through the COM_BINLOG_DUMP or "
      "COM_BINLOG_DUMP_GTID commands by setting the option to either "
@@ -2233,6 +2238,10 @@ extern "C" bool get_one_option(int optid, const struct my_option *opt,
       opt_remote_alias = true;
       opt_remote_proto = BINLOG_DUMP_NON_GTID;
       break;
+    case OPT_READ_FROM_REMOTE_MASTER_DEPRECATED:
+      warning(CLIENT_WARN_DEPRECATED_MSG("--read-from-remote-master",
+                                         "--read-from-remote-source"));
+      /* FALLTHROUGH */
     case OPT_REMOTE_PROTO:
       opt_remote_proto = (enum_remote_proto)(
           find_type_or_exit(argument, &remote_proto_typelib, opt->name) - 1);

client/mysqldump.cc

@@ -147,8 +147,8 @@ static bool ansi_quotes_mode = false;
 static uint opt_zstd_compress_level = default_zstd_compression_level;
 static char *opt_compress_algorithm = nullptr;
 
-#define MYSQL_OPT_MASTER_DATA_EFFECTIVE_SQL 1
-#define MYSQL_OPT_MASTER_DATA_COMMENTED_SQL 2
+#define MYSQL_OPT_SOURCE_DATA_EFFECTIVE_SQL 1
+#define MYSQL_OPT_SOURCE_DATA_COMMENTED_SQL 2
 #define MYSQL_OPT_SLAVE_DATA_EFFECTIVE_SQL 1
 #define MYSQL_OPT_SLAVE_DATA_COMMENTED_SQL 2
 static uint opt_enable_cleartext_plugin = 0;
@@ -240,11 +240,16 @@ static struct my_option my_long_options[] = {
     {"allow-keywords", OPT_KEYWORDS,
      "Allow creation of column names that are keywords.", &opt_keywords,
      &opt_keywords, nullptr, GET_BOOL, NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
-    {"apply-replica-statements", OPT_MYSQLDUMP_SLAVE_APPLY,
+    {"apply-replica-statements", OPT_MYSQLDUMP_REPLICA_APPLY,
      "Adds 'STOP SLAVE' prior to 'CHANGE MASTER' and 'START SLAVE' to bottom "
      "of dump.",
      &opt_slave_apply, &opt_slave_apply, nullptr, GET_BOOL, NO_ARG, 0, 0, 0,
      nullptr, 0, nullptr},
+    {"apply-slave-statements", OPT_MYSQLDUMP_SLAVE_APPLY_DEPRECATED,
+     "This option is deprecated and will be removed in a future version. "
+     "Use apply-replica-statements instead.",
+     &opt_slave_apply, &opt_slave_apply, nullptr, GET_BOOL, NO_ARG, 0, 0, 0,
+     nullptr, 0, nullptr},
     {"bind-address", 0, "IP address to bind to.", (uchar **)&opt_bind_addr,
      (uchar **)&opt_bind_addr, nullptr, GET_STR, REQUIRED_ARG, 0, 0, 0, nullptr,
      0, nullptr},
@@ -311,18 +316,23 @@ static struct my_option my_long_options[] = {
     {"default-character-set", OPT_DEFAULT_CHARSET,
      "Set the default character set.", &default_charset, &default_charset,
      nullptr, GET_STR, REQUIRED_ARG, 0, 0, 0, nullptr, 0, nullptr},
-    {"delete-source-logs", OPT_DELETE_MASTER_LOGS,
+    {"delete-source-logs", OPT_DELETE_SOURCE_LOGS,
      "Rotate logs before the backup, equivalent to FLUSH LOGS, and purge "
      "all old binary logs after the backup, equivalent to PURGE LOGS. This "
      "automatically enables --source-data.",
      &opt_delete_master_logs, &opt_delete_master_logs, nullptr, GET_BOOL,
      NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
+    {"delete-master-logs", OPT_DELETE_MASTER_LOGS_DEPRECATED,
+     "This option is deprecated and will be removed in a future version. "
+     "Use delete-source-logs instead.",
+     &opt_delete_master_logs, &opt_delete_master_logs, nullptr, GET_BOOL,
+     NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
     {"disable-keys", 'K',
      "'/*!40000 ALTER TABLE tb_name DISABLE KEYS */; and '/*!40000 ALTER "
      "TABLE tb_name ENABLE KEYS */; will be put in the output.",
      &opt_disable_keys, &opt_disable_keys, nullptr, GET_BOOL, NO_ARG, 1, 0, 0,
      nullptr, 0, nullptr},
-    {"dump-replica", OPT_MYSQLDUMP_SLAVE_DATA,
+    {"dump-replica", OPT_MYSQLDUMP_REPLICA_DATA,
      "This causes the binary log position and filename of the source to be "
      "appended to the dumped data output. Setting the value to 1, will print"
      "it as a CHANGE MASTER command in the dumped data output; if equal"
@@ -335,6 +345,11 @@ static struct my_option my_long_options[] = {
      "Option automatically turns --lock-tables off.",
      &opt_slave_data, &opt_slave_data, nullptr, GET_UINT, OPT_ARG, 0, 0,
      MYSQL_OPT_SLAVE_DATA_COMMENTED_SQL, nullptr, 0, nullptr},
+    {"dump-slave", OPT_MYSQLDUMP_SLAVE_DATA_DEPRECATED,
+     "This option is deprecated and will be removed in a future version. "
+     "Use dump-replica instead.",
+     &opt_slave_data, &opt_slave_data, nullptr, GET_UINT, OPT_ARG, 0, 0,
+     MYSQL_OPT_SLAVE_DATA_COMMENTED_SQL, nullptr, 0, nullptr},
     {"events", 'E', "Dump events.", &opt_events, &opt_events, nullptr, GET_BOOL,
      NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
     {"extended-insert", 'e',
@@ -400,11 +415,17 @@ static struct my_option my_long_options[] = {
      "--ignore-table=database.table.",
      nullptr, nullptr, nullptr, GET_STR, REQUIRED_ARG, 0, 0, 0, nullptr, 0,
      nullptr},
-    {"include-source-host-port", OPT_MYSQLDUMP_INCLUDE_MASTER_HOST_PORT,
+    {"include-source-host-port", OPT_MYSQLDUMP_INCLUDE_SOURCE_HOST_PORT,
      "Adds 'MASTER_HOST=<host>, MASTER_PORT=<port>' to 'CHANGE MASTER TO..' "
      "in dump produced with --dump-replica.",
      &opt_include_master_host_port, &opt_include_master_host_port, nullptr,
      GET_BOOL, NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
+    {"include-master-host-port",
+     OPT_MYSQLDUMP_INCLUDE_MASTER_HOST_PORT_DEPRECATED,
+     "This option is deprecated and will be removed in a future version. "
+     "Use include-source-host-port instead.",
+     &opt_include_master_host_port, &opt_include_master_host_port, nullptr,
+     GET_BOOL, NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
     {"insert-ignore", OPT_INSERT_IGNORE, "Insert rows with INSERT IGNORE.",
      &opt_ignore, &opt_ignore, nullptr, GET_BOOL, NO_ARG, 0, 0, 0, nullptr, 0,
      nullptr},
@@ -424,7 +445,7 @@ static struct my_option my_long_options[] = {
      "Append warnings and errors to given file.", &log_error_file,
      &log_error_file, nullptr, GET_STR, REQUIRED_ARG, 0, 0, 0, nullptr, 0,
      nullptr},
-    {"source-data", OPT_MASTER_DATA,
+    {"source-data", OPT_SOURCE_DATA,
      "This causes the binary log position and filename to be appended to the "
      "output. If equal to 1, will print it as a CHANGE MASTER command; if equal"
      " to 2, that command will be prefixed with a comment symbol. "
@@ -436,7 +457,12 @@ static struct my_option my_long_options[] = {
      "any action on logs will happen at the exact moment of the dump. "
      "Option automatically turns --lock-tables off.",
      &opt_master_data, &opt_master_data, nullptr, GET_UINT, OPT_ARG, 0, 0,
-     MYSQL_OPT_MASTER_DATA_COMMENTED_SQL, nullptr, 0, nullptr},
+     MYSQL_OPT_SOURCE_DATA_COMMENTED_SQL, nullptr, 0, nullptr},
+    {"master-data", OPT_MASTER_DATA_DEPRECATED,
+     "This option is deprecated and will be removed in a future version. "
+     "Use source-data instead.",
+     &opt_master_data, &opt_master_data, nullptr, GET_UINT, OPT_ARG, 0, 0,
+     MYSQL_OPT_SOURCE_DATA_COMMENTED_SQL, nullptr, 0, nullptr},
     {"max_allowed_packet", OPT_MAX_ALLOWED_PACKET,
      "The maximum packet length to send to or receive from server.",
      &opt_max_allowed_packet, &opt_max_allowed_packet, nullptr, GET_ULONG,
@@ -890,14 +916,31 @@ static bool get_one_option(int optid, const struct my_option *opt,
     case '?':
       usage();
       exit(0);
-    case (int)OPT_MASTER_DATA:
+    case (int)OPT_MASTER_DATA_DEPRECATED:
+      CLIENT_WARN_DEPRECATED("--master-data", "--source-data");
+      // FALLTHROUGH
+    case (int)OPT_SOURCE_DATA:
       if (!argument) /* work like in old versions */
-        opt_master_data = MYSQL_OPT_MASTER_DATA_EFFECTIVE_SQL;
+        opt_master_data = MYSQL_OPT_SOURCE_DATA_EFFECTIVE_SQL;
       break;
-    case (int)OPT_MYSQLDUMP_SLAVE_DATA:
+    case (int)OPT_MYSQLDUMP_SLAVE_APPLY_DEPRECATED:
+      CLIENT_WARN_DEPRECATED("--apply-slave-statements",
+                             "--apply-replica-statements");
+      break;
+    case (int)OPT_DELETE_MASTER_LOGS_DEPRECATED:
+      CLIENT_WARN_DEPRECATED("--delete-master-logs", "--delete-source-logs");
+      break;
+    case (int)OPT_MYSQLDUMP_SLAVE_DATA_DEPRECATED:
+      CLIENT_WARN_DEPRECATED("--dump-slave", "--dump-replica");
+      // FALLTHROUGH
+    case (int)OPT_MYSQLDUMP_REPLICA_DATA:
       if (!argument) /* work like in old versions */
         opt_slave_data = MYSQL_OPT_SLAVE_DATA_EFFECTIVE_SQL;
       break;
+    case (int)OPT_MYSQLDUMP_INCLUDE_MASTER_HOST_PORT_DEPRECATED:
+      CLIENT_WARN_DEPRECATED("--include-master-host-port",
+                             "--include-source-host-port");
+      break;
     case (int)OPT_OPTIMIZE:
       extended_insert = opt_drop = opt_lock = quick = create_options =
           opt_disable_keys = lock_tables = opt_set_charset = true;
@@ -1018,7 +1061,7 @@ static int get_options(int *argc, char ***argv) {
 
   /* Ensure consistency of the set of binlog & locking options */
   if (opt_delete_master_logs && !opt_master_data)
-    opt_master_data = MYSQL_OPT_MASTER_DATA_COMMENTED_SQL;
+    opt_master_data = MYSQL_OPT_SOURCE_DATA_COMMENTED_SQL;
   if (opt_single_transaction && opt_lock_all_tables) {
     fprintf(stderr,
             "%s: You can't use --single-transaction and "
@@ -4935,7 +4978,7 @@ static int do_show_master_status(MYSQL *mysql_con) {
   MYSQL_ROW row;
   MYSQL_RES *master;
   const char *comment_prefix =
-      (opt_master_data == MYSQL_OPT_MASTER_DATA_COMMENTED_SQL) ? "-- " : "";
+      (opt_master_data == MYSQL_OPT_SOURCE_DATA_COMMENTED_SQL) ? "-- " : "";
   if (mysql_query_with_error_report(mysql_con, &master, "SHOW MASTER STATUS")) {
     return 1;
   } else {

mysql-test/r/client_command_line_aliases.result

@@ -0,0 +1,25 @@
+include/save_binlog_position.inc
+mysqlbinlog --read-from-remote-source: expect no warning
+mysqlbinlog --read-from-remote-master: expect warning
+WARNING: --read-from-remote-master is deprecated and will be removed in a future version. Use --read-from-remote-source instead.
+mysqldump --apply-replica-statements: expect no warning
+mysqldump --apply-slave-statements: expect warning
+WARNING: --apply-slave-statements is deprecated and will be removed in a future version. Use --apply-replica-statements instead.
+mysqldump --delete-source-logs: expect no warning
+mysqldump --delete-master-logs: expect warning
+WARNING: --delete-master-logs is deprecated and will be removed in a future version. Use --delete-source-logs instead.
+mysqldump --dump-replica: expect no warning
+mysqldump --dump-slave: expect warning
+WARNING: --dump-slave is deprecated and will be removed in a future version. Use --dump-replica instead.
+mysqldump --include-source-host-port: expect no warning
+mysqldump --include-master-host-port: expect warning
+WARNING: --include-master-host-port is deprecated and will be removed in a future version. Use --include-source-host-port instead.
+mysqldump --source-data: expect no warning
+mysqldump --master-data: expect warning
+WARNING: --master-data is deprecated and will be removed in a future version. Use --source-data instead.
+mysqladmin start-replica: expect no warning
+mysqladmin start-slave: expect warning
+WARNING: start-slave is deprecated and will be removed in a future version. Use start-replica instead.
+mysqladmin stop-replica: expect no warning
+mysqladmin stop-slave: expect warning
+WARNING: stop-slave is deprecated and will be removed in a future version. Use stop-replica instead.

mysql-test/suite/rpl/r/rpl_show_replica_auth_info.result

@@ -0,0 +1,61 @@
+include/master-slave.inc
+Warnings:
+Note	####	Sending passwords in plain text without SSL/TLS is extremely insecure.
+Note	####	Storing MySQL user name or password information in the master info repository is not secure and is therefore not recommended. Please consider using the USER and PASSWORD connection options for START SLAVE; see the 'START SLAVE Syntax' in the MySQL Manual for more information.
+[connection master]
+==== Init ====
+include/suppress_messages.inc
+# Connection 1 un-suppresses message <The syntax.*show-.*-auth-info.*is deprecated>.
+# Connection 2 un-suppresses message <The syntax.*show-.*-auth-info.*is deprecated>.
+include/save_error_log_position.inc
+==== R2: show-replica-auth-info ====
+include/rpl_restart_server.inc [server_number=1 parameters: --show-replica-auth-info]
+[connection slave]
+include/wait_for_slave_to_start.inc
+[connection master]
+* R2.1: No deprecation warning
+include/assert_error_log.inc [server: 1, pattern: NONE]
+* R2.1, R2.2: Have columns
+SHOW REPLICAS;
+Server_Id	Host	User	Password	Port	Source_Id	Replica_UUID
+2	127.0.0.1	USER	PASS	REPLICA_PORT	1	REPLICA_UUID
+SHOW SLAVE HOSTS;
+Server_id	Host	User	Password	Port	Master_id	Slave_UUID
+2	127.0.0.1	USER	PASS	REPLICA_PORT	1	REPLICA_UUID
+Warnings:
+Warning	1287	'SHOW SLAVE HOSTS' is deprecated and will be removed in a future release. Please use SHOW REPLICAS instead
+==== R3: show-slave-auth-info ====
+include/assert_error_log.inc [server: 1, pattern: NONE]
+include/rpl_restart_server.inc [server_number=1 parameters: --show-slave-auth-info]
+[connection slave]
+include/wait_for_slave_to_start.inc
+[connection master]
+* R3.1: Deprecation warning
+include/assert_error_log.inc [server: 1, pattern: The syntax 'show-slave-auth-info' is deprecated and will be removed in a future release. Please use show-replica-auth-info instead.]
+* R3.2, R3.3: Have columns
+SHOW REPLICAS;
+Server_Id	Host	User	Password	Port	Source_Id	Replica_UUID
+2	127.0.0.1	USER	PASS	REPLICA_PORT	1	REPLICA_UUID
+SHOW SLAVE HOSTS;
+Server_id	Host	User	Password	Port	Master_id	Slave_UUID
+2	127.0.0.1	USER	PASS	REPLICA_PORT	1	REPLICA_UUID
+Warnings:
+Warning	1287	'SHOW SLAVE HOSTS' is deprecated and will be removed in a future release. Please use SHOW REPLICAS instead
+==== R1: no command-line options ====
+include/rpl_restart_server.inc [server_number=1]
+[connection slave]
+include/wait_for_slave_to_start.inc
+[connection master]
+* R1.1: No deprecation warning
+include/assert_error_log.inc [server: 1, pattern: NONE]
+* R1.2, R1.3: No columns
+SHOW REPLICAS;
+Server_Id	Host	Port	Source_Id	Replica_UUID
+2	127.0.0.1	REPLICA_PORT	1	REPLICA_UUID
+SHOW SLAVE HOSTS;
+Server_id	Host	Port	Master_id	Slave_UUID
+2	127.0.0.1	REPLICA_PORT	1	REPLICA_UUID
+Warnings:
+Warning	1287	'SHOW SLAVE HOSTS' is deprecated and will be removed in a future release. Please use SHOW REPLICAS instead
+==== Clean up ====
+include/rpl_end.inc

mysql-test/suite/rpl/rpl_1slave_base.cnf

@@ -33,8 +33,8 @@ loose-innodb_read_io_threads=     2
 
 master-retry-count=         10
 
-# Values reported by slave when it connect to master
-# and shows up in SHOW SLAVE STATUS;
+# Values reported by source when a replica has connected and shows up
+# in SHOW REPLICAS.
 report-host=                127.0.0.1
 report-port=                @mysqld.2.port
 report-user=                root

mysql-test/suite/rpl/t/rpl_show_replica_auth_info-slave.opt

@@ -0,0 +1,2 @@
+--report-user=USER
+--report-password=PASS