Add --exclude-snapshots option, which makes exclude pg_logical/snapshots

dir.c

@@ -27,6 +27,7 @@ const char *pgdata_exclude[] =
 	NULL,			/* arclog_path will be set later */
 	NULL,			/* srvlog_path will be set later */
 	NULL,			/* 'pg_tblspc' will be set later */
+	NULL,			/* 'pg_logical' will be set later */
 	NULL,			/* sentinel */
 };
 

docs/index-ja.html

@@ -660,6 +660,12 @@ <h2>バックアップ・オプション</h2>
 <li>バックアップ済みのサーバログの保持期限を指定します。<code>--keep-srvlog-files</code> では保存ファイル数を、<code>--keep-srvlog-days</code> では保存日数を指定します。これらのオプションを明示的に指定した場合、閾値を超えたファイルがサーバログが保存されるディレクトリ (log_directory) から削除されます。 本オプションは、<code>--with-serverlog</code>、<code>--srvlog-path</code> を指定してバックアップを取得した場合に限ります。 これらのオプションを同時に指定した場合は両方の閾値を超えたファイルが削除されます。</li>
 </ul>
 </li>
+<li><strong><code>--exclude-snapshots</code></strong>
+
+<ul>
+<li>一時ファイル用に使われる <code>pgsql_tmp</code> ディレクトリ内と、ロジカルレプリケーションで使われる <code>snapshots</code> ディレクトリ内をバックアップ対象から除外します。</li>
+</ul>
+</li>
 </ul>
 
 
@@ -1071,6 +1077,14 @@ <h1 id="waytopassoptions">パラメータの指定方法</h1>
 <td>アーカイブWALのリストア方法</td>
 <td>環境変数、設定ファイルにはboolean型で指定</td>
 </tr>
+<tr>
+<td></td>
+<td>&ndash;exclude-snapshots</td>
+<td>EXCLUDE_TMPDIR</td>
+<td>指定可</td>
+<td>ロジカルスナップショットをバックアップから除外</td>
+<td>環境変数、設定ファイルにはboolean型で指定</td>
+</tr>
 </tbody>
 </table>
 
@@ -1472,4 +1486,4 @@ <h1 id="seealso">関連項目</h2>
 <p class="footer">Copyright (c) 2009-2023, NIPPON TELEGRAPH AND TELEPHONE CORPORATION</p>
 
 </body>
-</html>
+</html>

docs/index.html

@@ -651,6 +651,12 @@ <h2>Backup options</h2>
 <li>Specify how long backuped serverlog files will be kept. <code>--keep-srvlog-files</code> means number of files. <code>--keep-srvlog-days</code> means days to be kept. When you do backup, only files exceeded specified condition are deleted from server log directory (log_directory). This option works when you specify <code>--with-serverlog</code> and <code>--srvlog-path</code> options in backup command. If these two options are given toghether, pg_rman deletes files which are old enough against both conditions.</li>
 </ul>
 </li>
+<li><strong><code>--exclude-snapshots</code></strong>
+
+<ul>
+<li>Exclude <code>snapshots</code> directory, which is used for logical replication.</li>
+</ul>
+</li>
 </ul>
 
 
@@ -1062,6 +1068,14 @@ <h1 id="waytopassoptions">Way to pass options</h1>
 <td>how to restore archive WAL</td>
 <td>specify boolean type in environmental variable or configuration file</td>
 </tr>
+<tr>
+<td></td>
+<td>&ndash;exclude-snapshots</td>
+<td>EXCLUDE_TMPDIR</td>
+<td>Yes</td>
+<td>Exclude logical snapshots from backup</td>
+<td>specify boolean type in environmental variable or configuration file</td>
+</tr>
 </tbody>
 </table>
 
@@ -1462,4 +1476,4 @@ <h1 id="seealso">See Also</h2>
 <p class="footer">Copyright (c) 2009-2023, NIPPON TELEGRAPH AND TELEPHONE CORPORATION</p>
 
 </body>
-</html>
+</html>

expected/backup.out

@@ -74,3 +74,7 @@ INFO: Please execute 'pg_rman validate' to verify the files are correctly copied
 ERROR: could not start backup
 DETAIL: system identifier of target database is different from the one of initially configured database
 10
+###### BACKUP COMMAND TEST-0011 ######
+###### full backup with --exclude-snapshots option ######
+0
+2

expected/option.out

@@ -40,6 +40,7 @@ Backup options:
   --keep-srvlog-days=DAY    keep serverlog modified in DAY days
   --standby-host=HOSTNAME   standby host when taking backup from standby
   --standby-port=PORT       standby port when taking backup from standby
+  --exclude-snapshots       exclude pg_logical/snapshots
 
 Restore options:
   --recovery-target-time    time stamp up to which recovery will proceed

pg_rman.c

@@ -17,6 +17,7 @@
 const char *PROGRAM_VERSION	= "1.3.16";
 const char *PROGRAM_URL		= "http://github.com/ossc-db/pg_rman";
 const char *PROGRAM_ISSUES	= "http://github.com/ossc-db/pg_rman/issues";
+const char *SNAPSHOTS_DIR   = "snapshots";
 
 /* path configuration */
 char *backup_path;
@@ -32,6 +33,7 @@ bool check = false;
 
 /* directory configuration */
 pgBackup	current;
+static bool exclude_snapshots = false;
 
 /* backup configuration */
 static bool		smooth_checkpoint;
@@ -97,6 +99,7 @@ static pgut_option options[] =
 	{ 's', 10, "recovery-target-timeline"	, &target_tli_string, SOURCE_ENV },
 	{ 's', 11, "recovery-target-action"		, &target_action	, SOURCE_ENV },
 	{ 'b', 12, "hard-copy"	, &is_hard_copy		, SOURCE_ENV },
+	{ 'b', 15, "exclude-snapshots", &exclude_snapshots, SOURCE_ENV },
 	/* catalog options */
 	{ 'b', 'a', "show-all"		, &show_all },
 	{ 0 }
@@ -209,6 +212,10 @@ main(int argc, char *argv[])
 		pgdata_exclude[i++] = arclog_path;
 	if (srvlog_path)
 		pgdata_exclude[i++] = srvlog_path;
+	if (exclude_snapshots)
+	{
+		pgdata_exclude[i++] = SNAPSHOTS_DIR;
+	}
 
 	/* do actual operation */
 	if (pg_strcasecmp(cmd, "init") == 0)
@@ -289,6 +296,7 @@ pgut_help(bool details)
 	printf(_("  --keep-srvlog-days=DAY    keep serverlog modified in DAY days\n"));
 	printf(_("  --standby-host=HOSTNAME   standby host when taking backup from standby\n"));
 	printf(_("  --standby-port=PORT       standby port when taking backup from standby\n"));
+	printf(_("  --exclude-snapshots       exclude pg_logical/snapshots\n"));
 	printf(_("\nRestore options:\n"));
 	printf(_("  --recovery-target-time    time stamp up to which recovery will proceed\n"));
 	printf(_("  --recovery-target-xid     transaction ID up to which recovery will proceed\n"));

sql/backup.sh

@@ -195,9 +195,9 @@ sleep 1
 echo 'archive backup in the same situation but with --full-backup-on-error option'
 pg_rman backup -B ${BACKUP_PATH} -b archive -F -s -Z -p ${TEST_PGPORT} -d postgres;echo $?
 pg_rman validate -B ${BACKUP_PATH} --quiet
-pg_rman show detail -B ${BACKUP_PATH} > ${TEST_BASE}/TEST-0011.log 2>&1
-grep OK ${TEST_BASE}/TEST-0011.log | grep FULL | wc -l
-grep ERROR ${TEST_BASE}/TEST-0011.log | grep ARCH | wc -l
+pg_rman show detail -B ${BACKUP_PATH} > ${TEST_BASE}/TEST-0009.log 2>&1
+grep OK ${TEST_BASE}/TEST-0009.log | grep FULL | wc -l
+grep ERROR ${TEST_BASE}/TEST-0009.log | grep ARCH | wc -l
 
 echo '###### BACKUP COMMAND TEST-0010 ######'
 echo '###### failure in backup with different system identifier database ######'
@@ -206,6 +206,16 @@ pg_ctl stop -m immediate > /dev/null 2>&1
 init_database
 pg_rman backup -B ${BACKUP_PATH} -b full -p ${TEST_PGPORT} -d postgres --quiet;echo $?
 
+echo '###### BACKUP COMMAND TEST-0011 ######'
+echo '###### full backup with --exclude-snapshots option ######'
+init_catalog
+mkdir -p $PGDATA_PATH/base/pgsql_tmp
+touch $PGDATA_PATH/pg_logical/snapshots/012345
+pg_rman backup -B ${BACKUP_PATH} -b full -s --exclude-snapshots -p ${TEST_PGPORT} -d postgres --quiet;echo $?
+pg_rman validate -B ${BACKUP_PATH} --quiet
+pg_rman show detail -B ${BACKUP_PATH} > ${TEST_BASE}/TEST-0011.log 2>&1
+test -f ${BACKUP_PATH}/????????/??????/database/pg_logical/snapshots/012345 || echo OK >> ${TEST_BASE}/TEST-0011.log
+grep -c OK ${TEST_BASE}/TEST-0011.log
 
 # cleanup
 ## clean up the temporal test data