<step>
<para>
- Write recovery parameters into the target data directory and restart the
- target server. It specifies an LSN (<xref
+ Write recovery parameters into the separate configuration file
+ <filename>pg_createsubscriber.conf</filename> that is included from
+ <filename>postgresql.auto.conf</filename> using
+ <literal>include_if_exists</literal> in the target data directory, then
+ restart the target server. It specifies an LSN (<xref
linkend="guc-recovery-target-lsn"/>) of the write-ahead log location up
to which recovery will proceed. It also specifies
<literal>promote</literal> as the action that the server should take
server ends standby mode and is accepting read-write transactions. If
<option>--recovery-timeout</option> option is set,
<application>pg_createsubscriber</application> terminates if recovery
- does not end until the given number of seconds.
+ does not end until the given number of seconds. Upon completion, the
+ included configuration file is renamed to
+ <filename>pg_createsubscriber.conf.disabled</filename> so as it is no
+ longer loaded on subsequent restarts.
</para>
</step>
#include "common/connect.h"
#include "common/controldata_utils.h"
+#include "common/file_utils.h"
#include "common/logging.h"
#include "common/pg_prng.h"
#include "common/restricted_token.h"
#define DEFAULT_SUB_PORT "50432"
#define OBJECTTYPE_PUBLICATIONS 0x0001
+/*
+ * Configuration files for recovery parameters.
+ *
+ * The recovery parameters are set in INCLUDED_CONF_FILE, itself loaded by
+ * the server through an include_if_exists in postgresql.auto.conf.
+ *
+ * INCLUDED_CONF_FILE is renamed to INCLUDED_CONF_FILE_DISABLED when exiting,
+ * so as the recovery parameters set by this tool never take effect on node
+ * restart. The contents of INCLUDED_CONF_FILE_DISABLED can be useful for
+ * debugging.
+ */
+#define PG_AUTOCONF_FILENAME "postgresql.auto.conf"
+#define INCLUDED_CONF_FILE "pg_createsubscriber.conf"
+#define INCLUDED_CONF_FILE_DISABLED INCLUDED_CONF_FILE ".disabled"
+
/* Command-line options */
struct CreateSubscriberOptions
{
static bool recovery_ended = false;
static bool standby_running = false;
+static bool recovery_params_set = false;
/*
- * Cleanup objects that were created by pg_createsubscriber if there is an
- * error.
+ * Clean up objects created by pg_createsubscriber.
+ *
+ * Publications and replication slots are created on the primary. Depending
+ * on the step where it failed, already-created objects should be removed if
+ * possible (sometimes this won't work due to a connection issue).
+ * There is no cleanup on the target server *after* its promotion, because any
+ * failure at this point means recreating the physical replica and starting
+ * again.
*
- * Publications and replication slots are created on primary. Depending on the
- * step it failed, it should remove the already created objects if it is
- * possible (sometimes it won't work due to a connection issue).
- * There is no cleanup on the target server. The steps on the target server are
- * executed *after* promotion, hence, at this point, a failure means recreate
- * the physical replica and start again.
+ * The recovery configuration is always removed, by renaming the included
+ * configuration file out of the way.
*/
static void
cleanup_objects_atexit(void)
{
+ /* Rename the included configuration file, if necessary. */
+ if (recovery_params_set)
+ {
+ char conf_filename[MAXPGPATH];
+ char conf_filename_disabled[MAXPGPATH];
+
+ snprintf(conf_filename, MAXPGPATH, "%s/%s", subscriber_dir,
+ INCLUDED_CONF_FILE);
+ snprintf(conf_filename_disabled, MAXPGPATH, "%s/%s", subscriber_dir,
+ INCLUDED_CONF_FILE_DISABLED);
+
+ if (durable_rename(conf_filename, conf_filename_disabled) != 0)
+ {
+ /* durable_rename() has already logged something. */
+ pg_log_warning_hint("A manual removal of the recovery parameters may be required.");
+ }
+ }
+
if (success)
return;
{
appendPQExpBuffer(recoveryconfcontents, "recovery_target_lsn = '%s'\n",
lsn);
- WriteRecoveryConfig(conn, datadir, recoveryconfcontents);
}
- disconnect_database(conn, false);
pg_log_debug("recovery parameters:\n%s", recoveryconfcontents->data);
+
+ if (!dry_run)
+ {
+ char conf_filename[MAXPGPATH];
+ FILE *fd;
+
+ /* Write the recovery parameters to INCLUDED_CONF_FILE */
+ snprintf(conf_filename, MAXPGPATH, "%s/%s", datadir,
+ INCLUDED_CONF_FILE);
+ fd = fopen(conf_filename, "w");
+ if (fd == NULL)
+ pg_fatal("could not open file \"%s\": %m", conf_filename);
+
+ if (fwrite(recoveryconfcontents->data, recoveryconfcontents->len, 1, fd) != 1)
+ pg_fatal("could not write to file \"%s\": %m", conf_filename);
+
+ fclose(fd);
+ recovery_params_set = true;
+
+ /* Include conditionally the recovery parameters. */
+ resetPQExpBuffer(recoveryconfcontents);
+ appendPQExpBufferStr(recoveryconfcontents,
+ "include_if_exists '" INCLUDED_CONF_FILE "'\n");
+ WriteRecoveryConfig(conn, datadir, recoveryconfcontents);
+ }
+
+ disconnect_database(conn, false);
}
/*
primary_conninfo = '$pconnstr dbname=postgres'
hot_standby_feedback = on
]);
+my $sconnstr = $node_s->connstr;
$node_s->set_standby_mode();
$node_s->start;
],
'run pg_createsubscriber on node S');
+# Check that included file is renamed after success.
+my $node_s_datadir = $node_s->data_dir;
+ok( -f "$node_s_datadir/pg_createsubscriber.conf.disabled",
+ "pg_createsubscriber.conf.disabled exists in node S");
+
# Confirm the physical replication slot has been removed
$result = $node_p->safe_psql($db1,
"SELECT count(*) FROM pg_replication_slots WHERE slot_name = '$slotname'"
$db2|{pub2}),
"subscriptions use the correct publications");
+# Verify that node K, set as a standby, is able to start correctly without
+# the recovery configuration written by pg_createsubscriber interfering.
+# This node is created from node S, where pg_createsubscriber has been run.
+
+# Create a physical standby from the promoted subscriber
+$node_s->safe_psql('postgres',
+ "SELECT pg_create_physical_replication_slot('$slotname');");
+
+# Create backup from promoted subscriber
+$node_s->backup('backup_3');
+
+# Initialize new physical standby
+my $node_k = PostgreSQL::Test::Cluster->new('node_k');
+$node_k->init_from_backup($node_s, 'backup_3', has_streaming => 1);
+
+my $node_k_datadir = $node_k->data_dir;
+ok( -f "$node_k_datadir/pg_createsubscriber.conf.disabled",
+ "pg_createsubscriber.conf.disabled exists in node K");
+
+# Configure the new standby
+$node_k->append_conf(
+ 'postgresql.conf', qq[
+primary_slot_name = '$slotname'
+primary_conninfo = '$sconnstr dbname=postgres'
+hot_standby_feedback = on
+]);
+
+$node_k->set_standby_mode();
+my $node_k_name = $node_s->name;
+command_ok(
+ [
+ 'pg_ctl', '--wait',
+ '--pgdata' => $node_k->data_dir,
+ '--log' => $node_k->logfile,
+ '--options' => "--cluster-name=$node_k_name",
+ 'start'
+ ],
+ "node K has started");
+
# clean up
$node_p->teardown_node;
$node_s->teardown_node;
$node_t->teardown_node;
$node_f->teardown_node;
+$node_k->teardown_node;
done_testing();
projects / postgresql.git / commitdiff