6 * Copyright (c) 2010-2012, PostgreSQL Global Development Group
7 * contrib/pg_upgrade/pg_upgrade.c
11 * To simplify the upgrade process, we force certain system values to be
12 * identical between old and new clusters:
14 * We control all assignments of pg_class.oid (and relfilenode) so toast
15 * oids are the same between old and new clusters. This is important
16 * because toast oids are stored as toast pointers in user tables.
18 * FYI, while pg_class.oid and pg_class.relfilenode are initially the same
19 * in a cluster, but they can diverge due to CLUSTER, REINDEX, or VACUUM
20 * FULL. The new cluster will have matching pg_class.oid and
21 * pg_class.relfilenode values and be based on the old oid value. This can
22 * cause the old and new pg_class.relfilenode values to differ. In summary,
23 * old and new pg_class.oid and new pg_class.relfilenode will have the
24 * same value, and old pg_class.relfilenode might differ.
26 * We control all assignments of pg_type.oid because these oids are stored
27 * in user composite type values.
29 * We control all assignments of pg_enum.oid because these oids are stored
30 * in user tables as enum values.
32 * We control all assignments of pg_authid.oid because these oids are stored
33 * in pg_largeobject_metadata.
40 #include "pg_upgrade.h"
42 #ifdef HAVE_LANGINFO_H
46 static void prepare_new_cluster(void);
47 static void prepare_new_databases(void);
48 static void create_new_objects(void);
49 static void copy_clog_xlog_xid(void);
50 static void set_frozenxids(void);
51 static void setup(char *argv0, bool live_check);
52 static void cleanup(void);
54 ClusterInfo old_cluster,
58 char *output_files[] = {
61 /* unique file for pg_ctl start */
62 SERVER_START_LOG_FILE,
72 main(int argc, char **argv)
74 char *sequence_script_file_name = NULL;
75 char *analyze_script_file_name = NULL;
76 char *deletion_script_file_name = NULL;
77 bool live_check = false;
79 parseCommandLine(argc, argv);
81 adjust_data_dir(&old_cluster);
82 adjust_data_dir(&new_cluster);
84 output_check_banner(&live_check);
86 setup(argv[0], live_check);
88 check_cluster_versions();
90 get_sock_dir(&old_cluster, live_check);
91 get_sock_dir(&new_cluster, false);
93 check_cluster_compatibility(live_check);
95 check_and_dump_old_cluster(live_check, &sequence_script_file_name);
99 start_postmaster(&new_cluster);
102 report_clusters_compatible();
104 pg_log(PG_REPORT, "\nPerforming Upgrade\n");
105 pg_log(PG_REPORT, "------------------\n");
107 prepare_new_cluster();
109 stop_postmaster(false);
112 * Destructive Changes to New Cluster
115 copy_clog_xlog_xid();
117 /* New now using xids of the old system */
120 start_postmaster(&new_cluster);
122 prepare_new_databases();
124 create_new_objects();
126 stop_postmaster(false);
129 * Most failures happen in create_new_objects(), which has completed at
130 * this point. We do this here because it is just before linking, which
131 * will link the old and new cluster data files, preventing the old
132 * cluster from being safely started once the new cluster is started.
134 if (user_opts.transfer_mode == TRANSFER_MODE_LINK)
135 disable_old_cluster();
137 transfer_all_new_dbs(&old_cluster.dbarr, &new_cluster.dbarr,
138 old_cluster.pgdata, new_cluster.pgdata);
141 * Assuming OIDs are only used in system tables, there is no need to
142 * restore the OID counter because we have not transferred any OIDs from
143 * the old system, but we do it anyway just in case. We do it late here
144 * because there is no need to have the schema load use new oids.
146 prep_status("Setting next OID for new cluster");
147 exec_prog(UTILITY_LOG_FILE, NULL, true,
148 "\"%s/pg_resetxlog\" -o %u \"%s\"",
149 new_cluster.bindir, old_cluster.controldata.chkpnt_nxtoid,
153 create_script_for_cluster_analyze(&analyze_script_file_name);
154 create_script_for_old_cluster_deletion(&deletion_script_file_name);
156 issue_warnings(sequence_script_file_name);
158 pg_log(PG_REPORT, "\nUpgrade Complete\n");
159 pg_log(PG_REPORT, "----------------\n");
161 output_completion_banner(analyze_script_file_name,
162 deletion_script_file_name);
164 pg_free(analyze_script_file_name);
165 pg_free(deletion_script_file_name);
166 pg_free(sequence_script_file_name);
175 setup(char *argv0, bool live_check)
177 char exec_path[MAXPGPATH]; /* full path to my executable */
180 * make sure the user has a clean environment, otherwise, we may confuse
181 * libpq when we connect to one (or both) of the servers.
183 check_pghost_envvar();
185 verify_directories();
187 /* no postmasters should be running */
188 if (!live_check && is_server_running(old_cluster.pgdata))
189 pg_log(PG_FATAL, "There seems to be a postmaster servicing the old cluster.\n"
190 "Please shutdown that postmaster and try again.\n");
192 /* same goes for the new postmaster */
193 if (is_server_running(new_cluster.pgdata))
194 pg_log(PG_FATAL, "There seems to be a postmaster servicing the new cluster.\n"
195 "Please shutdown that postmaster and try again.\n");
197 /* get path to pg_upgrade executable */
198 if (find_my_exec(argv0, exec_path) < 0)
199 pg_log(PG_FATAL, "Could not get path name to pg_upgrade: %s\n", getErrorText(errno));
201 /* Trim off program name and keep just path */
202 *last_dir_separator(exec_path) = '\0';
203 canonicalize_path(exec_path);
204 os_info.exec_path = pg_strdup(exec_path);
209 prepare_new_cluster(void)
212 * It would make more sense to freeze after loading the schema, but that
213 * would cause us to lose the frozenids restored by the load. We use
214 * --analyze so autovacuum doesn't update statistics later
216 prep_status("Analyzing all rows in the new cluster");
217 exec_prog(UTILITY_LOG_FILE, NULL, true,
218 "\"%s/vacuumdb\" %s --all --analyze %s",
219 new_cluster.bindir, cluster_conn_opts(&new_cluster),
220 log_opts.verbose ? "--verbose" : "");
224 * We do freeze after analyze so pg_statistic is also frozen. template0 is
225 * not frozen here, but data rows were frozen by initdb, and we set its
226 * datfrozenxid and relfrozenxids later to match the new xid counter
229 prep_status("Freezing all rows on the new cluster");
230 exec_prog(UTILITY_LOG_FILE, NULL, true,
231 "\"%s/vacuumdb\" %s --all --freeze %s",
232 new_cluster.bindir, cluster_conn_opts(&new_cluster),
233 log_opts.verbose ? "--verbose" : "");
236 get_pg_database_relfilenode(&new_cluster);
241 prepare_new_databases(void)
244 * We set autovacuum_freeze_max_age to its maximum value so autovacuum
245 * does not launch here and delete clog files, before the frozen xids are
251 prep_status("Restoring global objects in the new cluster");
254 * Install support functions in the global-object restore database to
255 * preserve pg_authid.oid. pg_dumpall uses 'template0' as its template
256 * database so objects we add into 'template1' are not propogated. They
257 * are removed on pg_upgrade exit.
259 install_support_functions_in_new_db("template1");
262 * We have to create the databases first so we can install support
263 * functions in all the other databases. Ideally we could create the
264 * support functions in template1 but pg_dumpall creates database using
265 * the template0 template.
267 exec_prog(RESTORE_LOG_FILE, NULL, true,
268 "\"%s/psql\" " EXEC_PSQL_ARGS " %s -f \"%s\"",
269 new_cluster.bindir, cluster_conn_opts(&new_cluster),
273 /* we load this to get a current list of databases */
274 get_db_and_rel_infos(&new_cluster);
279 create_new_objects(void)
283 prep_status("Adding support functions to new cluster");
286 * Technically, we only need to install these support functions in new
287 * databases that also exist in the old cluster, but for completeness
288 * we process all new databases.
290 for (dbnum = 0; dbnum < new_cluster.dbarr.ndbs; dbnum++)
292 DbInfo *new_db = &new_cluster.dbarr.dbs[dbnum];
294 /* skip db we already installed */
295 if (strcmp(new_db->db_name, "template1") != 0)
296 install_support_functions_in_new_db(new_db->db_name);
300 prep_status("Restoring database schemas in the new cluster\n");
302 for (dbnum = 0; dbnum < old_cluster.dbarr.ndbs; dbnum++)
304 char file_name[MAXPGPATH];
305 DbInfo *old_db = &old_cluster.dbarr.dbs[dbnum];
307 pg_log(PG_REPORT, OVERWRITE_MESSAGE, old_db->db_name);
308 snprintf(file_name, sizeof(file_name), DB_DUMP_FILE_MASK, old_db->db_oid);
311 * Using pg_restore --single-transaction is faster than other
312 * methods, like --jobs. pg_dump only produces its output at the
313 * end, so there is little parallelism using the pipe.
315 exec_prog(RESTORE_LOG_FILE, NULL, true,
316 "\"%s/pg_restore\" %s --exit-on-error --single-transaction --verbose --dbname \"%s\" \"%s\"",
317 new_cluster.bindir, cluster_conn_opts(&new_cluster),
318 old_db->db_name, file_name);
320 end_progress_output();
323 /* regenerate now that we have objects in the databases */
324 get_db_and_rel_infos(&new_cluster);
326 uninstall_support_functions_from_new_cluster();
330 * Delete the given subdirectory contents from the new cluster, and copy the
331 * files from the old cluster into it.
334 copy_subdir_files(char *subdir)
336 char old_path[MAXPGPATH];
337 char new_path[MAXPGPATH];
339 prep_status("Deleting files from new %s", subdir);
341 snprintf(old_path, sizeof(old_path), "%s/%s", old_cluster.pgdata, subdir);
342 snprintf(new_path, sizeof(new_path), "%s/%s", new_cluster.pgdata, subdir);
343 if (!rmtree(new_path, true))
344 pg_log(PG_FATAL, "could not delete directory \"%s\"\n", new_path);
347 prep_status("Copying old %s to new server", subdir);
349 exec_prog(UTILITY_LOG_FILE, NULL, true,
351 "cp -Rf \"%s\" \"%s\"",
353 /* flags: everything, no confirm, quiet, overwrite read-only */
354 "xcopy /e /y /q /r \"%s\" \"%s\\\"",
362 copy_clog_xlog_xid(void)
364 /* copy old commit logs to new data dir */
365 copy_subdir_files("pg_clog");
367 /* set the next transaction id of the new cluster */
368 prep_status("Setting next transaction ID for new cluster");
369 exec_prog(UTILITY_LOG_FILE, NULL, true,
370 "\"%s/pg_resetxlog\" -f -x %u \"%s\"",
371 new_cluster.bindir, old_cluster.controldata.chkpnt_nxtxid,
375 /* now reset the wal archives in the new cluster */
376 prep_status("Resetting WAL archives");
377 exec_prog(UTILITY_LOG_FILE, NULL, true,
378 "\"%s/pg_resetxlog\" -l %s \"%s\"", new_cluster.bindir,
379 old_cluster.controldata.nextxlogfile,
388 * We have frozen all xids, so set relfrozenxid and datfrozenxid
389 * to be the old cluster's xid counter, which we just set in the new
390 * cluster. User-table frozenxid values will be set by pg_dumpall
391 * --binary-upgrade, but objects not set by the pg_dump must have
392 * proper frozen counters.
406 prep_status("Setting frozenxid counters in new cluster");
408 conn_template1 = connectToServer(&new_cluster, "template1");
410 /* set pg_database.datfrozenxid */
411 PQclear(executeQueryOrDie(conn_template1,
412 "UPDATE pg_catalog.pg_database "
413 "SET datfrozenxid = '%u'",
414 old_cluster.controldata.chkpnt_nxtxid));
416 /* get database names */
417 dbres = executeQueryOrDie(conn_template1,
418 "SELECT datname, datallowconn "
419 "FROM pg_catalog.pg_database");
421 i_datname = PQfnumber(dbres, "datname");
422 i_datallowconn = PQfnumber(dbres, "datallowconn");
424 ntups = PQntuples(dbres);
425 for (dbnum = 0; dbnum < ntups; dbnum++)
427 char *datname = PQgetvalue(dbres, dbnum, i_datname);
428 char *datallowconn = PQgetvalue(dbres, dbnum, i_datallowconn);
431 * We must update databases where datallowconn = false, e.g.
432 * template0, because autovacuum increments their datfrozenxids and
433 * relfrozenxids even if autovacuum is turned off, and even though all
434 * the data rows are already frozen To enable this, we temporarily
435 * change datallowconn.
437 if (strcmp(datallowconn, "f") == 0)
438 PQclear(executeQueryOrDie(conn_template1,
439 "UPDATE pg_catalog.pg_database "
440 "SET datallowconn = true "
441 "WHERE datname = '%s'", datname));
443 conn = connectToServer(&new_cluster, datname);
445 /* set pg_class.relfrozenxid */
446 PQclear(executeQueryOrDie(conn,
447 "UPDATE pg_catalog.pg_class "
448 "SET relfrozenxid = '%u' "
449 /* only heap and TOAST are vacuumed */
450 "WHERE relkind IN ('r', 't')",
451 old_cluster.controldata.chkpnt_nxtxid));
454 /* Reset datallowconn flag */
455 if (strcmp(datallowconn, "f") == 0)
456 PQclear(executeQueryOrDie(conn_template1,
457 "UPDATE pg_catalog.pg_database "
458 "SET datallowconn = false "
459 "WHERE datname = '%s'", datname));
464 PQfinish(conn_template1);
474 fclose(log_opts.internal);
476 /* Remove dump and log files? */
477 if (!log_opts.retain)
482 for (filename = output_files; *filename != NULL; filename++)
485 /* remove dump files */
486 unlink(GLOBALS_DUMP_FILE);
488 if (old_cluster.dbarr.dbs)
489 for (dbnum = 0; dbnum < old_cluster.dbarr.ndbs; dbnum++)
491 char file_name[MAXPGPATH];
492 DbInfo *old_db = &old_cluster.dbarr.dbs[dbnum];
494 snprintf(file_name, sizeof(file_name), DB_DUMP_FILE_MASK, old_db->db_oid);