PGPRO-533: Allow to show backup list in json format

Author: za-arthur

src/backup.c

@@ -633,7 +633,7 @@ do_backup_instance(void)
 						* For backup from master wait for previous segment.
 						* For backup from replica wait for current segment.
 						*/
-					   !from_replica, backup_files_list);
+					   !current.from_replica, backup_files_list);
 	}
 
 	if (current.backup_mode == BACKUP_MODE_DIFF_PTRACK)
@@ -815,11 +815,15 @@ do_backup(time_t start_time)
 	pgut_atexit_push(backup_disconnect, NULL);
 
 	current.primary_conninfo = pgut_get_conninfo_string(backup_conn);
+
+	current.compress_alg = compress_alg;
+	current.compress_level = compress_level;
+
 	/* Confirm data block size and xlog block size are compatible */
 	confirm_block_size("block_size", BLCKSZ);
 	confirm_block_size("wal_block_size", XLOG_BLCKSZ);
 
-	from_replica = pg_is_in_recovery();
+	current.from_replica = pg_is_in_recovery();
 
 	/* Confirm that this server version is supported */
 	check_server_version();
@@ -859,7 +863,7 @@ do_backup(time_t start_time)
 		}
 	}
 
-	if (from_replica)
+	if (current.from_replica)
 	{
 		/* Check master connection options */
 		if (master_host == NULL)
@@ -956,7 +960,7 @@ check_server_version(void)
 			 "server version is %s, must be %s or higher",
 			 server_version_str, "9.5");
 
-	if (from_replica && server_version < 90600)
+	if (current.from_replica && server_version < 90600)
 		elog(ERROR,
 			 "server version is %s, must be %s or higher for backup from replica",
 			 server_version_str, "9.6");
@@ -1061,7 +1065,7 @@ pg_start_backup(const char *label, bool smooth, pgBackup *backup)
 	params[0] = label;
 
 	/* For replica we call pg_start_backup() on master */
-	conn = (from_replica) ? master_conn : backup_conn;
+	conn = (backup->from_replica) ? master_conn : backup_conn;
 
 	/* 2nd argument is 'fast'*/
 	params[1] = smooth ? "false" : "true";
@@ -1106,7 +1110,7 @@ pg_start_backup(const char *label, bool smooth, pgBackup *backup)
 	}
 
 	/* Wait for start_lsn to be replayed by replica */
-	if (from_replica)
+	if (backup->from_replica)
 		wait_replica_wal_lsn(backup->start_lsn, true);
 
 	/*
@@ -1554,8 +1558,6 @@ wait_replica_wal_lsn(XLogRecPtr lsn, bool is_start_backup)
 {
 	uint32		try_count = 0;
 
-	Assert(from_replica);
-
 	while (true)
 	{
 		PGresult   *res;
@@ -1650,7 +1652,7 @@ pg_stop_backup(pgBackup *backup)
 		elog(FATAL, "backup is not in progress");
 
 	/* For replica we call pg_stop_backup() on master */
-	conn = (from_replica) ? master_conn : backup_conn;
+	conn = (current.from_replica) ? master_conn : backup_conn;
 
 	/* Remove annoying NOTICE messages generated by backend */
 	res = pgut_execute(conn, "SET client_min_messages = warning;",
@@ -1663,7 +1665,7 @@ pg_stop_backup(pgBackup *backup)
 		const char *params[1];
 		char		name[1024];
 
-		if (!from_replica)
+		if (!current.from_replica)
 			snprintf(name, lengthof(name), "pg_probackup, backup_id %s",
 					 base36enc(backup->start_time));
 		else
@@ -1891,7 +1893,7 @@ pg_stop_backup(pgBackup *backup)
 					stream_xlog_path[MAXPGPATH];
 
 		/* Wait for stop_lsn to be received by replica */
-		if (from_replica)
+		if (backup->from_replica)
 			wait_replica_wal_lsn(stop_backup_lsn, false);
 		/*
 		 * Wait for stop_lsn to be archived or streamed.

src/catalog.c

@@ -385,10 +385,11 @@ pgBackupWriteControl(FILE *out, pgBackup *backup)
 
 	fprintf(out, "#Configuration\n");
 	fprintf(out, "backup-mode = %s\n", pgBackupGetBackupMode(backup));
-	fprintf(out, "stream = %s\n", backup->stream?"true":"false");
-	fprintf(out, "compress-alg = %s\n", deparse_compress_alg(compress_alg));
-	fprintf(out, "compress-level = %d\n", compress_level);
-	fprintf(out, "from-replica = %s\n", from_replica?"true":"false");
+	fprintf(out, "stream = %s\n", backup->stream ? "true" : "false");
+	fprintf(out, "compress-alg = %s\n",
+			deparse_compress_alg(backup->compress_alg));
+	fprintf(out, "compress-level = %d\n", backup->compress_level);
+	fprintf(out, "from-replica = %s\n", backup->from_replica ? "true" : "false");
 
 	fprintf(out, "\n#Compatibility\n");
 	fprintf(out, "block-size = %u\n", backup->block_size);
@@ -429,7 +430,7 @@ pgBackupWriteControl(FILE *out, pgBackup *backup)
 	if (backup->data_bytes != BYTES_INVALID)
 		fprintf(out, "data-bytes = " INT64_FORMAT "\n", backup->data_bytes);
 
-	if (backup->data_bytes != BYTES_INVALID)
+	if (backup->wal_bytes != BYTES_INVALID)
 		fprintf(out, "wal-bytes = " INT64_FORMAT "\n", backup->wal_bytes);
 
 	fprintf(out, "status = %s\n", status2str(backup->status));
@@ -475,10 +476,8 @@ readBackupControlFile(const char *path)
 	char	   *stop_lsn = NULL;
 	char	   *status = NULL;
 	char	   *parent_backup = NULL;
-	char	   *compress_alg = NULL;
 	char	   *server_version = NULL;
-	int		   *compress_level;
-	bool	   *from_replica;
+	char	   *compress_alg = NULL;
 
 	pgut_option options[] =
 	{
@@ -500,8 +499,8 @@ readBackupControlFile(const char *path)
 		{'s', 0, "status",				&status, SOURCE_FILE_STRICT},
 		{'s', 0, "parent-backup-id",	&parent_backup, SOURCE_FILE_STRICT},
 		{'s', 0, "compress-alg",		&compress_alg, SOURCE_FILE_STRICT},
-		{'u', 0, "compress-level",		&compress_level, SOURCE_FILE_STRICT},
-		{'b', 0, "from-replica",		&from_replica, SOURCE_FILE_STRICT},
+		{'u', 0, "compress-level",		&backup->compress_level, SOURCE_FILE_STRICT},
+		{'b', 0, "from-replica",		&backup->from_replica, SOURCE_FILE_STRICT},
 		{'s', 0, "primary-conninfo",	&backup->primary_conninfo, SOURCE_FILE_STRICT},
 		{0}
 	};
@@ -578,6 +577,9 @@ readBackupControlFile(const char *path)
 		pfree(server_version);
 	}
 
+	if (compress_alg)
+		backup->compress_alg = parse_compress_alg(compress_alg);
+
 	return backup;
 }
 
@@ -626,6 +628,48 @@ deparse_backup_mode(BackupMode mode)
 	return NULL;
 }
 
+CompressAlg
+parse_compress_alg(const char *arg)
+{
+	size_t		len;
+
+	/* Skip all spaces detected */
+	while (isspace((unsigned char)*arg))
+		arg++;
+	len = strlen(arg);
+
+	if (len == 0)
+		elog(ERROR, "compress algrorithm is empty");
+
+	if (pg_strncasecmp("zlib", arg, len) == 0)
+		return ZLIB_COMPRESS;
+	else if (pg_strncasecmp("pglz", arg, len) == 0)
+		return PGLZ_COMPRESS;
+	else if (pg_strncasecmp("none", arg, len) == 0)
+		return NONE_COMPRESS;
+	else
+		elog(ERROR, "invalid compress algorithm value \"%s\"", arg);
+
+	return NOT_DEFINED_COMPRESS;
+}
+
+const char*
+deparse_compress_alg(int alg)
+{
+	switch (alg)
+	{
+		case NONE_COMPRESS:
+		case NOT_DEFINED_COMPRESS:
+			return "none";
+		case ZLIB_COMPRESS:
+			return "zlib";
+		case PGLZ_COMPRESS:
+			return "pglz";
+	}
+
+	return NULL;
+}
+
 /* free pgBackup object */
 void
 pgBackupFree(void *backup)

src/help.c

@@ -128,6 +128,7 @@ help_pg_probackup(void)
 
 	printf(_("\n  %s show -B backup-dir\n"), PROGRAM_NAME);
 	printf(_("                 [--instance=instance_name [-i backup-id]]\n"));
+	printf(_("                 [--format=format]\n"));
 
 	printf(_("\n  %s delete -B backup-dir --instance=instance_name\n"), PROGRAM_NAME);
 	printf(_("                 [--wal] [-i backup-id | --expired]\n"));
@@ -362,6 +363,7 @@ help_show(void)
 	printf(_("  -B, --backup-path=backup-path    location of the backup storage area\n"));
 	printf(_("      --instance=instance_name     show info about specific intstance\n"));
 	printf(_("  -i, --backup-id=backup-id        show info about specific backups\n"));
+	printf(_("      --format=format              show format=PLAIN|JSON\n"));
 }
 
 static void

src/pg_probackup.c

@@ -47,7 +47,6 @@ char	   *replication_slot = NULL;
 /* backup options */
 bool		backup_logs = false;
 bool		smooth_checkpoint;
-bool		from_replica = false;
 bool		is_remote_backup = false;
 /* Wait timeout for WAL segment archiving */
 uint32		archive_timeout = 300;		/* default is 300 seconds */
@@ -83,7 +82,7 @@ uint32		retention_window = 0;
 /* compression options */
 CompressAlg compress_alg = NOT_DEFINED_COMPRESS;
 int			compress_level = DEFAULT_COMPRESS_LEVEL;
-bool 		compress_shortcut = false;
+bool		compress_shortcut = false;
 
 /* other options */
 char	   *instance_name;
@@ -94,6 +93,9 @@ static char *wal_file_path;
 static char *wal_file_name;
 static bool	file_overwrite = false;
 
+/* show options */
+ShowFormat show_format = SHOW_PLAIN;
+
 /* current settings */
 pgBackup	current;
 ProbackupSubcmd backup_subcmd;
@@ -104,6 +106,7 @@ static void opt_backup_mode(pgut_option *opt, const char *arg);
 static void opt_log_level_console(pgut_option *opt, const char *arg);
 static void opt_log_level_file(pgut_option *opt, const char *arg);
 static void opt_compress_alg(pgut_option *opt, const char *arg);
+static void opt_show_format(pgut_option *opt, const char *arg);
 
 static void compress_init(void);
 
@@ -178,6 +181,8 @@ static pgut_option options[] =
 	{ 's', 160, "wal-file-path",		&wal_file_path,		SOURCE_CMDLINE },
 	{ 's', 161, "wal-file-name",		&wal_file_name,		SOURCE_CMDLINE },
 	{ 'b', 162, "overwrite",			&file_overwrite,	SOURCE_CMDLINE },
+	/* show options */
+	{ 'f', 170, "format",				opt_show_format,	SOURCE_CMDLINE },
 	{ 0 }
 };
 
@@ -517,49 +522,31 @@ opt_log_level_file(pgut_option *opt, const char *arg)
 	log_level_file = parse_log_level(arg);
 }
 
-CompressAlg
-parse_compress_alg(const char *arg)
+static void
+opt_show_format(pgut_option *opt, const char *arg)
 {
+	const char *v = arg;
 	size_t		len;
 
 	/* Skip all spaces detected */
-	while (isspace((unsigned char)*arg))
-		arg++;
-	len = strlen(arg);
-
-	if (len == 0)
-		elog(ERROR, "compress algrorithm is empty");
-
-	if (pg_strncasecmp("zlib", arg, len) == 0)
-		return ZLIB_COMPRESS;
-	else if (pg_strncasecmp("pglz", arg, len) == 0)
-		return PGLZ_COMPRESS;
-	else if (pg_strncasecmp("none", arg, len) == 0)
-		return NONE_COMPRESS;
-	else
-		elog(ERROR, "invalid compress algorithm value \"%s\"", arg);
+	while (IsSpace(*v))
+		v++;
+	len = strlen(v);
 
-	return NOT_DEFINED_COMPRESS;
-}
-
-const char*
-deparse_compress_alg(int alg)
-{
-	switch (alg)
+	if (len > 0)
 	{
-		case NONE_COMPRESS:
-		case NOT_DEFINED_COMPRESS:
-			return "none";
-		case ZLIB_COMPRESS:
-			return "zlib";
-		case PGLZ_COMPRESS:
-			return "pglz";
+		if (pg_strncasecmp("plain", v, len) == 0)
+			show_format = SHOW_PLAIN;
+		else if (pg_strncasecmp("json", v, len) == 0)
+			show_format = SHOW_JSON;
+		else
+			elog(ERROR, "Invalid show format \"%s\"", arg);
 	}
-
-	return NULL;
+	else
+		elog(ERROR, "Invalid show format \"%s\"", arg);
 }
 
-void
+static void
 opt_compress_alg(pgut_option *opt, const char *arg)
 {
 	compress_alg = parse_compress_alg(arg);
@@ -568,8 +555,8 @@ opt_compress_alg(pgut_option *opt, const char *arg)
 /*
  * Initialize compress and sanity checks for compress.
  */
-static
-void compress_init(void)
+static void
+compress_init(void)
 {
 	/* Default algorithm is zlib */
 	if (compress_shortcut)