github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-26 16:46:28 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Clean up command line option handling and help output

Browse Source 
- properly distinguish between the command line option -? and getopt's
  unknown option marker '?'
- remove deprecated command line options --initdb-no-pwprompt and
  -l/--local-port
- add witness command summary in help output
This commit is contained in:
Ian Barwick
2016-08-02 14:23:33 +09:00
parent 050f007cc2
commit d0c05e6f46
3 changed files with 52 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
HISTORY
View File

@@ -1,6 +1,8 @@
3.2 2016- 3.2 2016-
repmgr: suppress connection error display in `repmgr cluster show` repmgr: suppress connection error display in `repmgr cluster show`
unless `--verbose` supplied (Ian) unless `--verbose` supplied (Ian)
repmgr: remove deprecated command line options --initdb-no-pwprompt and
-l/--local-port (Ian)
3.1.4 2016-07-12 3.1.4 2016-07-12
repmgr: new configuration option for setting "restore_command" repmgr: new configuration option for setting "restore_command"

83
repmgr.c
View File

@@ -178,8 +178,6 @@ main(int argc, char **argv)
{"data-dir", required_argument, NULL, 'D'}, {"data-dir", required_argument, NULL, 'D'},
/* alias for -D/--data-dir, following pg_ctl usage */ /* alias for -D/--data-dir, following pg_ctl usage */
{"pgdata", required_argument, NULL, 'D'}, {"pgdata", required_argument, NULL, 'D'},
/* -l/--local-port is deprecated */
{"local-port", required_argument, NULL, 'l'},
{"config-file", required_argument, NULL, 'f'}, {"config-file", required_argument, NULL, 'f'},
{"remote-user", required_argument, NULL, 'R'}, {"remote-user", required_argument, NULL, 'R'},
{"wal-keep-segments", required_argument, NULL, 'w'}, {"wal-keep-segments", required_argument, NULL, 'w'},
@@ -194,16 +192,14 @@ main(int argc, char **argv)
{"terse", required_argument, NULL, 't'}, {"terse", required_argument, NULL, 't'},
{"mode", required_argument, NULL, 'm'}, {"mode", required_argument, NULL, 'm'},
{"remote-config-file", required_argument, NULL, 'C'}, {"remote-config-file", required_argument, NULL, 'C'},
/* deprecated from 3.2; replaced with -P/--pwprompt */ {"help", no_argument, NULL, OPT_HELP},
{"initdb-no-pwprompt", no_argument, NULL, 1}, {"check-upstream-config", no_argument, NULL, OPT_CHECK_UPSTREAM_CONFIG},
{"check-upstream-config", no_argument, NULL, 2}, {"recovery-min-apply-delay", required_argument, NULL, OPT_RECOVERY_MIN_APPLY_DELAY},
{"recovery-min-apply-delay", required_argument, NULL, 3}, {"ignore-external-config-files", no_argument, NULL, OPT_IGNORE_EXTERNAL_CONFIG_FILES},
{"ignore-external-config-files", no_argument, NULL, 4}, {"config-archive-dir", required_argument, NULL, OPT_CONFIG_ARCHIVE_DIR},
{"config-archive-dir", required_argument, NULL, 5}, {"pg_rewind", optional_argument, NULL, OPT_PG_REWIND},
{"pg_rewind", optional_argument, NULL, 6}, {"pwprompt", optional_argument, NULL, OPT_PWPROMPT},
{"pwprompt", optional_argument, NULL, 7}, {"csv", no_argument, NULL, OPT_CSV},
{"csv", no_argument, NULL, 8},
{"help", no_argument, NULL, '?'},
{"version", no_argument, NULL, 'V'}, {"version", no_argument, NULL, 'V'},
{NULL, 0, NULL, 0} {NULL, 0, NULL, 0}
}; };
@@ -318,7 +314,7 @@ main(int argc, char **argv)
/* Prevent getopt_long() from printing an error message */ /* Prevent getopt_long() from printing an error message */
opterr = 0; opterr = 0;
while ((c = getopt_long(argc, argv, "?Vd:h:p:U:S:D:l:f:R:w:k:FWIvb:rcL:tm:C:", long_options, while ((c = getopt_long(argc, argv, "?Vd:h:p:U:S:D:f:R:w:k:FWIvb:rcL:tm:C:", long_options,
&optindex)) != -1) &optindex)) != -1)
{ {
/* /*
@@ -330,6 +326,17 @@ main(int argc, char **argv)
switch (c) switch (c)
{ {
case '?': case '?':
/* Actual help option given */
if (strcmp(argv[optind - 1], "-?") == 0)
{
do_help();
exit(SUCCESS);
}
/* unknown option reported by getopt */
else
goto unknown_option;
break;
case OPT_HELP:
do_help(); do_help();
exit(SUCCESS); exit(SUCCESS);
case 'V': case 'V':
@@ -365,13 +372,6 @@ main(int argc, char **argv)
case 'D': case 'D':
strncpy(runtime_options.dest_dir, optarg, MAXPGPATH); strncpy(runtime_options.dest_dir, optarg, MAXPGPATH);
break; break;
case 'l':
/* -l/--local-port is deprecated */
repmgr_atoi(optarg, "-l/--local-port", &cli_errors, false);
strncpy(runtime_options.localport,
optarg,
MAXLEN);
break;
case 'f': case 'f':
strncpy(runtime_options.config_file, optarg, MAXLEN); strncpy(runtime_options.config_file, optarg, MAXLEN);
break; break;
@@ -451,18 +451,15 @@ main(int argc, char **argv)
case 'C': case 'C':
strncpy(runtime_options.remote_config_file, optarg, MAXLEN); strncpy(runtime_options.remote_config_file, optarg, MAXLEN);
break; break;
case 1: case OPT_CHECK_UPSTREAM_CONFIG:
runtime_options.initdb_no_pwprompt = true;
break;
case 2:
check_upstream_config = true; check_upstream_config = true;
break; break;
case 3: case OPT_RECOVERY_MIN_APPLY_DELAY:
targ = strtol(optarg, &ptr, 10); targ = strtol(optarg, &ptr, 10);
if (targ < 1) if (targ < 1)
{ {
item_list_append(&cli_errors, _("Invalid value provided for '-r/--recovery-min-apply-delay'")); item_list_append(&cli_errors, _("Invalid value provided for '--recovery-min-apply-delay'"));
break; break;
} }
if (ptr && *ptr) if (ptr && *ptr)
@@ -471,34 +468,34 @@ main(int argc, char **argv)
strcmp(ptr, "min") != 0 && strcmp(ptr, "h") != 0 && strcmp(ptr, "min") != 0 && strcmp(ptr, "h") != 0 &&
strcmp(ptr, "d") != 0) strcmp(ptr, "d") != 0)
{ {
item_list_append(&cli_errors, _("Value provided for '-r/--recovery-min-apply-delay' must be one of ms/s/min/h/d")); item_list_append(&cli_errors, _("Value provided for '--recovery-min-apply-delay' must be one of ms/s/min/h/d"));
break; break;
} }
} }
strncpy(runtime_options.recovery_min_apply_delay, optarg, MAXLEN); strncpy(runtime_options.recovery_min_apply_delay, optarg, MAXLEN);
break; break;
case 4: case OPT_IGNORE_EXTERNAL_CONFIG_FILES:
runtime_options.ignore_external_config_files = true; runtime_options.ignore_external_config_files = true;
break; break;
case 5: case OPT_CONFIG_ARCHIVE_DIR:
strncpy(runtime_options.config_archive_dir, optarg, MAXLEN); strncpy(runtime_options.config_archive_dir, optarg, MAXLEN);
break; break;
case 6: case OPT_PG_REWIND:
if (optarg != NULL) if (optarg != NULL)
{ {
strncpy(runtime_options.pg_rewind, optarg, MAXPGPATH); strncpy(runtime_options.pg_rewind, optarg, MAXPGPATH);
} }
pg_rewind_supplied = true; pg_rewind_supplied = true;
break; break;
case 7: case OPT_PWPROMPT:
runtime_options.witness_pwprompt = true; runtime_options.witness_pwprompt = true;
break; break;
case 8: case OPT_CSV:
runtime_options.csv_mode = true; runtime_options.csv_mode = true;
break; break;
default: default:
unknown_option:
{ {
PQExpBufferData unknown_option; PQExpBufferData unknown_option;
initPQExpBuffer(&unknown_option); initPQExpBuffer(&unknown_option);
@@ -3838,6 +3835,8 @@ do_witness_create(void)
char master_hba_file[MAXLEN]; char master_hba_file[MAXLEN];
bool success; bool success;
bool record_created; bool record_created;
char witness_port[MAXLEN];
char repmgr_user[MAXLEN]; char repmgr_user[MAXLEN];
char repmgr_db[MAXLEN]; char repmgr_db[MAXLEN];
@@ -3986,12 +3985,9 @@ do_witness_create(void)
/* /*
* Attempt to extract a port number from the provided conninfo string. * Attempt to extract a port number from the provided conninfo string.
* This will override any value provided with '-l/--local-port', as it's
* what we'll later try and connect to anyway. '-l/--local-port' should
* be deprecated.
*/ */
get_conninfo_value(options.conninfo, "port", runtime_options.localport); get_conninfo_value(options.conninfo, "port", witness_port);
/* /*
* If not specified by the user, the default port for the witness server * If not specified by the user, the default port for the witness server
@@ -3999,10 +3995,10 @@ do_witness_create(void)
* a separate instance on a normal node server, rather than on its own * a separate instance on a normal node server, rather than on its own
* dedicated server. * dedicated server.
*/ */
if (!runtime_options.localport[0]) if (!witness_port[0])
strncpy(runtime_options.localport, WITNESS_DEFAULT_PORT, MAXLEN); strncpy(witness_port, WITNESS_DEFAULT_PORT, MAXLEN);
xsnprintf(buf, sizeof(buf), "port = %s\n", runtime_options.localport); xsnprintf(buf, sizeof(buf), "port = %s\n", witness_port);
fputs(buf, pg_conf); fputs(buf, pg_conf);
xsnprintf(buf, sizeof(buf), "shared_preload_libraries = 'repmgr_funcs'\n"); xsnprintf(buf, sizeof(buf), "shared_preload_libraries = 'repmgr_funcs'\n");
@@ -4051,7 +4047,7 @@ do_witness_create(void)
* language function in C */ * language function in C */
maxlen_snprintf(script, "%s -p %s --superuser --login %s-U %s %s", maxlen_snprintf(script, "%s -p %s --superuser --login %s-U %s %s",
make_pg_path("createuser"), make_pg_path("createuser"),
runtime_options.localport, witness_port,
runtime_options.witness_pwprompt ? "-P " : "", runtime_options.witness_pwprompt ? "-P " : "",
runtime_options.superuser, runtime_options.superuser,
repmgr_user); repmgr_user);
@@ -4075,12 +4071,12 @@ do_witness_create(void)
} }
/* check if we need to create a database */ /* check if we need to create a database */
if (runtime_options.dbname[0] && strcmp(runtime_options.dbname,"postgres") != 0 && runtime_options.localport[0]) if (runtime_options.dbname[0] && strcmp(runtime_options.dbname,"postgres") != 0 && witness_port[0])
{ {
/* create required db */ /* create required db */
maxlen_snprintf(script, "%s -p %s -U %s --owner=%s %s", maxlen_snprintf(script, "%s -p %s -U %s --owner=%s %s",
make_pg_path("createdb"), make_pg_path("createdb"),
runtime_options.localport, witness_port,
runtime_options.superuser, runtime_options.superuser,
repmgr_user, repmgr_user,
repmgr_db); repmgr_db);
@@ -4389,6 +4385,7 @@ do_help(void)
printf(_(" %s [OPTIONS] master register\n"), progname()); printf(_(" %s [OPTIONS] master register\n"), progname());
printf(_(" %s [OPTIONS] standby {register|unregister|clone|promote|follow|switchover}\n"), printf(_(" %s [OPTIONS] standby {register|unregister|clone|promote|follow|switchover}\n"),
progname()); progname());
printf(_(" %s [OPTIONS] witness {create|unregister}\n"), progname());
printf(_(" %s [OPTIONS] cluster {show|cleanup}\n"), progname()); printf(_(" %s [OPTIONS] cluster {show|cleanup}\n"), progname());
printf(_("\n")); printf(_("\n"));
printf(_("General options:\n")); printf(_("General options:\n"));

15
repmgr.h
View File

@@ -47,6 +47,15 @@
#define NO_UPSTREAM_NODE -1 #define NO_UPSTREAM_NODE -1
#define UNKNOWN_NODE_ID -1 #define UNKNOWN_NODE_ID -1
#define OPT_HELP 1
#define OPT_CHECK_UPSTREAM_CONFIG 2
#define OPT_RECOVERY_MIN_APPLY_DELAY 3
#define OPT_IGNORE_EXTERNAL_CONFIG_FILES 4
#define OPT_CONFIG_ARCHIVE_DIR 5
#define OPT_PG_REWIND 6
#define OPT_PWPROMPT 7
#define OPT_CSV 8
/* Run time options type */ /* Run time options type */
@@ -89,13 +98,9 @@ typedef struct
char pg_bindir[MAXLEN]; char pg_bindir[MAXLEN];
char recovery_min_apply_delay[MAXLEN]; char recovery_min_apply_delay[MAXLEN];
/* deprecated command line options */
char localport[MAXLEN];
bool initdb_no_pwprompt;
} t_runtime_options; } t_runtime_options;
#define T_RUNTIME_OPTIONS_INITIALIZER { "", "", "", "", "", "", "", DEFAULT_WAL_KEEP_SEGMENTS, false, false, false, false, false, false, false, false, false, false, "", "", "", "", "fast", "", 0, "", "", "", false } #define T_RUNTIME_OPTIONS_INITIALIZER { "", "", "", "", "", "", "", DEFAULT_WAL_KEEP_SEGMENTS, false, false, false, false, false, false, false, false, false, false, "", "", "", "", "fast", "", 0, "", ""}
struct BackupLabel struct BackupLabel
{ {