pg_upgrade
pg_upgrade — обновить экземпляр сервера PostgreSQL
Синтаксис
pg_upgrade -b старый_каталог_bin [-B новый_каталог_bin] -d старый_каталог_конфигурации -D новый_каталог_конфигурации [параметр...]
Описание
Программа pg_upgrade (ранее называвшаяся pg_migrator) позволяет обновить данные в каталоге базы данных PostgreSQL до последней основной версии PostgreSQL без операции выгрузки/восстановления данных, обычно необходимой при обновлениях основной версии, например, при переходе от 9.5.8 к 9.6.4 или от 10.7 к 11.2. Эти действия не требуются при установке корректирующей версии, например, при переходе от 9.6.2 к 9.6.3 или от 10.1 к 10.2.
С выходом новых основных версий в PostgreSQL регулярно добавляются новые возможности, которые часто меняют структуру системных таблиц, но внутренний формат хранения меняется редко. Учитывая этот факт, pg_upgrade позволяет выполнить быстрое обновление, создавая системные таблицы заново, но сохраняя старые файлы данных. Если при обновлении основной версии формат хранения данных изменится так, что данные в старом формате окажутся нечитаемыми, pg_upgrade не сможет произвести такое обновление. (Сообщество разработчиков постарается не допустить подобных ситуаций.)
Программа pg_upgrade делает всё возможное, чтобы убедиться в том, что старый и новый кластеры двоично-совместимы, в частности проверяя параметры времени компиляции и разрядность (32/64 бита) исполняемых файлов. Важно, чтобы и все внешние модули тоже были двоично-совместимыми, хотя это pg_upgrade проверить не может.
pg_upgrade поддерживает обновление с версии 9.0.X и новее до текущей основной версии PostgreSQL, включая бета-выпуски и сборки снимков кода.
Предупреждение
При обновлении кластера выполняется произвольный код по выбору суперпользователей исходной точки. Перед обновлением убедитесь, что суперпользователи исходной точки являются доверенными.
Параметры
pg_upgrade принимает следующие аргументы командной строки:
-bкаталог_bin--old-bindir=каталог_binкаталог с исполняемыми файлами старой версии PostgreSQL; переменная окружения
PGBINOLD-Bкаталог_bin--new-bindir=каталог_binкаталог с исполняемыми файлами новой версии PostgreSQL, по умолчанию это каталог, в котором располагается pg_upgrade; переменная окружения
PGBINNEW-c--checkтолько проверить кластеры, не изменять никакие данные
-dкаталог_конфигурации--old-datadir=каталог_конфигурациикаталог конфигурации старого кластера; переменная окружения
PGDATAOLD-Dкаталог_конфигурации--new-datadir=каталог_конфигурациикаталог конфигурации нового кластера; переменная окружения
PGDATANEW-jчисло_заданий--jobs=число_заданийчисло одновременно задействуемых процессов или потоков
-k--linkиспользовать жёсткие ссылки вместо копирования файлов в новый кластер
-oпараметры--old-optionsпараметрыпараметры, передаваемые непосредственно старой программе
postgres; несколько параметров складываются вместе-Oпараметры--new-optionsпараметрыпараметры, передаваемые непосредственно новой программе
postgres; несколько параметров складываются вместе-pпорт--old-port=портномер порта старого кластера; переменная окружения
PGPORTOLD-Pпорт--new-port=портномер порта нового кластера; переменная окружения
PGPORTNEW-r--retainсохранить SQL и журналы сообщений даже при успешном завершении
-sкаталог--socketdir=каталогкаталог, в котором будет создавать сокеты процесс postmaster во время обновления; по умолчанию выбирается текущий рабочий каталог; переменная окружения
PGSOCKETDIR-Uимя_пользователя--username=имя_пользователяимя пользователя, установившего кластер; переменная окружения
PGUSER-v--verboseвключить подробные внутренние сообщения
-V--versionпоказать версию, а затем завершиться
--cloneИспользовать эффективное клонирование файлов (в ряде систем это называется «reflink») вместо копирования файлов в новый кластер. В результате файлы данных могут копироваться практически мгновенно, как и с использованием
-k/--link, но последующие изменения не будут затрагивать старый кластер.Клонирование файлов поддерживается не во всех операционных системах и только с определёнными файловыми системами. Если этот режим выбран, но клонирование не поддерживается, при выполнении pg_upgrade произойдёт ошибка. В настоящее время оно поддерживается в Linux (с ядром 4.5 или новее) с Btrfs и XFS (если файловая система была создана с поддержкой reflink), а также в macOS с APFS.
-?--helpпоказать справку, а затем завершиться
Использование
Далее описан план обновления с использованием pg_upgrade:
Переместить старый кластер (необязательно)
Если ваш каталог инсталляции привязан к версии, например,
/opt/PostgreSQL/14, перемещать его не требуется. Все графические инсталляторы выбирают при установке каталоги, привязанные к версии.Если ваш каталог инсталляции не привязан к версии, например
/usr/local/pgsql, необходимо переместить каталог текущей инсталляции PostgreSQL, чтобы он не конфликтовал с новой инсталляцией PostgreSQL. Когда текущий сервер PostgreSQL отключён, каталог этой инсталляции PostgreSQL можно безопасно переместить; если старый каталог/usr/local/pgsql, его можно переименовать, выполнив:mv /usr/local/pgsql /usr/local/pgsql.old
Собрать новую версию при установке из исходного кода
Соберите из исходного кода новую версию PostgreSQL с флагами
configure, совместимыми с флагами старого кластера. Программа pg_upgrade проверит результатыpg_controldata, чтобы убедиться, что все параметры совместимы, прежде чем начинать обновление.Установить новые исполняемые файлы PostgreSQL
Установите новые исполняемые файлы сервера и вспомогательные файлы. Программа pg_upgrade включена в инсталляцию по умолчанию.
При установке из исходного кода, если вы хотите разместить сервер в нестандартном каталоге, воспользуйтесь переменной
prefix:make prefix=/usr/local/pgsql.new install
Инициализировать новый кластер PostgreSQL
Инициализируйте новый кластер, используя
initdb. При этом так же необходимо указать флагиinitdb, совместимые с флагами в старом кластере. Многие готовые инсталляторы выполняют это действие автоматически. Запускать новый кластер не требуется.Установить разделяемые объектные файлы расширения
Многие расширения и пользовательские модули, как из
contrib, так и из других источников, используют разделяемые объектные файлы (или библиотеки DLL), например,pgcrypto.so. Если они использовались в старом кластере, разделяемые объектные файлы, соответствующие новому исполняемому файлу сервера, должны быть установлены в новом кластере, обычно средствами операционной системы. Не загружайте определения схемы, например, выполняяCREATE EXTENSION pgcrypto, потому что они будут скопированы из старого кластера. Если доступны обновления расширений, pg_upgrade сообщит об этом и создаст скрипт, который можно будет запустить позже, чтобы обновить эти расширения.Скопировать пользовательские файлы полнотекстового поиска
Скопировать пользовательские файлы полнотекстового поиска (словари, тезаурусы, списки синонимов и стоп-слов) из старого кластера в новый.
Настроить аутентификацию
Программа
pg_upgradeбудет подключаться к новому и старому серверу несколько раз, так что имеет смысл установить режим аутентификацииpeerвpg_hba.confили использовать файл~/.pgpass(см. Раздел 34.16).Остановить оба сервера
Убедитесь в том, что оба сервера баз данных остановлены. Для этого в Unix можно выполнить:
pg_ctl -D /opt/PostgreSQL/9.6 stop pg_ctl -D /opt/PostgreSQL/14 stop
А в Windows, с соответствующими именами служб:
NET STOP postgresql-9.6 NET STOP postgresql-14
Ведомые серверы с потоковой репликацией и трансляцией журнала должны продолжать работать во время этого отключения, чтобы получить все изменения.
Подготовиться к обновлению ведомых серверов
Если вы производите обновление ведомых серверов (как описано в разделе Шаг 11), удостоверьтесь, что эти серверы находятся в актуальном состоянии, запустив pg_controldata в старых ведущем и ведомых кластерах. Убедитесь в том, что «Положение последней контрольной точки» во всех кластерах одинаковое. Также смените
wal_levelнаreplicaв файлеpostgresql.confнового ведущего кластера.Запустить pg_upgrade
Всегда запускайте программу pg_upgrade от нового сервера, а не от старого. pg_upgrade требует указания каталогов данных старого и нового кластера, а также каталогов исполняемых файлов (
bin). Вы можете также определить имя пользователя и номера портов, и нужно ли копировать файлы данных (по умолчанию), клонировать их или создавать ссылки на них.Если выбрать вариант со ссылкой на данные, обновление выполнится гораздо быстрее (так как файлы не копируются) и потребует меньше места на диске, но вы лишитесь возможности обращаться к вашему старому кластеру, запустив новый после обновления. Этот вариант также требует, чтобы каталоги данных старого и нового кластера располагались в одной файловой системе. (Табличные пространства и
pg_walмогут находиться в других файловых системах.) Вариант с клонированием работает так же быстро и экономит место на диске, но позволяет сохранить рабочее состояние старого кластера при запуске нового. Для этого варианта тоже требуется, чтобы старый и новый каталоги данных находились в одной файловой системе. Клонирование возможно только в некоторых операционных системах с определёнными файловыми системами.Параметр
--jobsпозволяет задействовать для копирования/связывания файлов и для выгрузки/восстановления схем баз данных несколько процессорных ядер. В качестве начального значения параметра стоит выбрать максимум из числа процессорных ядер и числа табличных пространств. Этот параметр может радикально сократить время обновления сервера со множеством баз данных, работающего в многопроцессорной системе.В Windows вы должны войти в систему с административными полномочиями, затем запустить командную строку от имени пользователя
postgres, задать подходящий путь:RUNAS /USER:postgres "CMD.EXE" SET PATH=%PATH%;C:\Program Files\PostgreSQL\14\bin;
Наконец, запустить pg_upgrade с путями каталогов в кавычках, например, так:
pg_upgrade.exe --old-datadir "C:/Program Files/PostgreSQL/9.6/data" --new-datadir "C:/Program Files/PostgreSQL/14/data" --old-bindir "C:/Program Files/PostgreSQL/9.6/bin" --new-bindir "C:/Program Files/PostgreSQL/14/bin"При запуске
pg_upgradeпроверит два кластера на совместимость и, если всё в порядке, выполнит обновление. Также возможно запуститьpg_upgrade --check, чтобы ограничиться только проверками (при этом старый сервер может продолжать работать). Командаpg_upgrade --checkтакже сообщит, какие коррективы вам нужно будет внести вручную после обновления. Если вы планируете использовать режим ссылок на данные или клонирования, укажите вместе с--checkили--cloneпараметр--link, чтобы были проведены специальные проверки для этого режима. Программеpg_upgradeтребуются права на запись в текущий каталог.Очевидно, никто не должен обращаться к кластерам в процессе обновления. Программа pg_upgrade по умолчанию запускает серверы с портом 50432, чтобы не допустить нежелательных клиентских подключений. В процессе обновления оба кластера могут использовать один номер порта, так как они не будут работать одновременно. Однако для проверки старого работающего сервера новый порт должен отличаться от старого.
Если при восстановлении схемы базы данных происходит ошибка,
pg_upgradeзавершает свою работу и вы должны вернуться к старому кластеру, как описывается ниже в Шаг 17. Чтобы попробоватьpg_upgradeещё раз, вы должны внести коррективы в старом кластере, чтобы pg_upgrade могла успешно восстановить схему. Если проблема возникла в модулеcontrib, может потребоваться удалить этот модульcontribв старом кластере, а затем установить его в новом после обновления (предполагается, что этот модуль не хранит пользовательские данные).Обновить ведомые серверы с потоковой репликацией и трансляцией журнала
Если вы используете режим ссылок и у вас реализована потоковая репликация (см. Подраздел 27.2.5) или трансляция журнала (см. Раздел 27.2) для ведомых серверов, вы можете быстро обновить эти серверы следующим образом. Вам не нужно будет запускать на них pg_upgrade, вместо этого вы выполните rsync на ведущем. Не запускайте никакие серверы на этом этапе.
Если вы не используете режим ссылок, либо у вас нет rsync или вы не хотите его использовать, либо если вам нужен более простой вариант, пропустите инструкции в этом разделе и просто пересоздайте ведомые серверы сразу после завершения pg_upgrade и запуска нового ведущего сервера.
Установите новые исполняемые файлы PostgreSQL на ведомых серверах
Убедитесь в том, что на всех ведомых серверах установлены новые исполняемые и вспомогательные файлы.
Убедитесь в том, что новые каталоги данных на ведомых серверах не существуют
Новые каталоги данных ведомых серверов должны отсутствовать либо быть пустыми. Если запускалась программа initdb, удалите новые каталоги данных на ведомых.
Установить разделяемые объектные файлы расширения
Установите на новых ведомых серверах те же разделяемые объектные файлы расширения, что вы установили в новом ведущем кластере.
Остановите ведомые серверы
Если ведомые серверы продолжают работу, остановите их, следуя приведённым выше инструкциям.
Сохраните файлы конфигурации
Сохраните все нужные вам файлы конфигурации из старых каталогов конфигурации ведомых серверов, в частности
postgresql.conf(и все файлы, включённые в него),postgresql.auto.confиpg_hba.conf, так как они будут перезаписаны или удалены на следующем этапе.Запустите rsync
Когда используется режим ссылок, ведомые серверы можно быстро обновить, применив rsync. Для этого в каталоге, внутри которого находятся каталоги старого и нового кластера, для каждого ведомого сервера выполните на ведущем:
rsync --archive --delete --hard-links --size-only --no-inc-recursive old_cluster new_cluster remote_dir
Здесь каталоги
old_clusterиnew_clusterзадаются относительно текущего каталога на ведущем, аremote_dirнаходится над каталогами старого и нового кластера на ведомом. Структура подкаталогов в заданных каталогах на ведущем и ведомых серверах должна быть одинаковой. Обратитесь к странице руководства rsync, где подробно описано, как указать удалённый каталог, например так:rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/9.5 \ /opt/PostgreSQL/9.6 standby.example.com:/opt/PostgreSQLПроверить, что будет делать команда, можно, воспользовавшись параметром rsync
--dry-run. Выполнить rsync на ведущем необходимо как минимум с одним ведомым, но затем, пока обновлённый ведомый остаётся остановленным, можно запускать rsync на нём для обновления других ведомых.В ходе этой операции записываются ссылки, созданные режимом ссылок pg_upgrade, связывающие файлы нового и старого кластера на ведущем сервере. Затем в старом кластере ведомого находятся соответствующие файлы и в новом кластере ведомого создаются ссылки на них. Файлы, не связанные ссылками на ведущем, копируются с него на ведомый. (Обычно их объём невелик.) Это позволяет произвести обновление ведомого быстро. К сожалению, при этом rsync будет напрасно копировать файлы, связанные с временными и нежурналируемыми таблицами, так как они обычно не будут существовать на ведомых серверах.
Если у вас есть табличные пространства, вам потребуется выполнить подобную команду rsync для каталогов всех табличных пространств, например:
rsync --archive --delete --hard-links --size-only --no-inc-recursive /vol1/pg_tblsp/PG_9.5_201510051 \ /vol1/pg_tblsp/PG_9.6_201608131 standby.example.com:/vol1/pg_tblspЕсли вы вынесли
pg_walза пределы каталогов данных, нужно будет запустить rsync и для этих каталогов.Настройте ведомые серверы с потоковой репликацией и трансляцией журнала
Настройте серверы для трансляции журнала. (Запускать
pg_start_backup()иpg_stop_backup()или делать копию файловой системы не нужно, так как ведомые серверы остаются синхронизированными с ведущим.) Слоты репликации не копируются, их нужно создавать заново.
Восстановить
pg_hba.confЕсли вы изменяли
pg_hba.conf, восстановите его исходное состояние. Также может потребоваться скорректировать другие файлы конфигурации в новом кластере, чтобы они соответствовали старому, например,postgresql.conf(и файлы, включённые в него) иpostgresql.auto.conf.Запустить новый сервер
Теперь можно безопасно запустить новый сервер, а затем ведомые серверы, синхронизированные с ним с помощью rsync.
Действия после обновления
Если после обновления требуются какие-то дополнительные действия, программа pg_upgrade выдаст предупреждения об этом по завершении работы. Она также сгенерирует файлы скриптов, которые должны запускаться администратором. Эти скрипты будут подключаться к каждой базе данных, требующей дополнительных операций. Каждый такой скрипт следует выполнять командой:
psql --username=postgres --file=script.sql postgres
Эти скрипты могут выполняться в любом порядке, а после выполнения их можно удалить.
Внимание
Обычно к таблицам, задействованным в перестраивающих базу скриптах, опасно обращаться, пока эти скрипты не сделают свою работу; при этом можно получить некорректный результат или плохую производительность. К таблицам, не задействованным в таких скриптах, можно обращаться немедленно.
Статистика
Так как статистика оптимизатора не передаётся в процессе работы
pg_upgrade, вы получите указание запустить соответствующую команду для воссоздания этой информации после обновления. Возможно, для этого вам понадобится установить параметры подключения к новому кластеру.Удалить старый кластер
Если вы удовлетворены результатами обновления, вы можете удалить каталоги данных старого кластера, запустив скрипт, упомянутый в выводе
pg_upgradeпосле обновления. (Автоматическое удаление невозможно, если в старом каталоге данных находятся дополнительные табличные пространства.) Также вы можете удалить каталоги старой инсталляции (например,bin,share).Возврат к старому кластеру
Если выполнив команду
pg_upgrade, вы захотите вернуться к старому кластеру, возможны следующие варианты:Если использовался ключ
--check, в старом кластере ничего не меняется; его можно просто перезапустить.Если не использовался ключ
--link, в старом кластере ничего не меняется; его можно просто перезапустить.Если использовался ключ
--link, у старого и нового кластера могут оказаться общие файлы данных:Если работа
pg_upgradeбыла прервана до начала расстановки ссылок, в старом кластере ничего не меняется; его можно просто перезапустить.Если вы не запускали новый кластер, старый кластер не претерпел никаких изменений, за исключением того, что при создании ссылки на данные к имени
$PGDATA/global/pg_controlбыло добавлено окончание.old. Чтобы продолжить использование старого кластера, достаточно убрать окончание.oldиз имени файла$PGDATA/global/pg_control; после этого старый кластер можно будет перезапустить.Если вы запускали новый кластер, он внёс изменения в общие файлы, и использовать старый кластер небезопасно. В этом случае старый кластер нужно будет восстановить из резервной копии.
Примечания
pg_upgrade создаёт в текущем рабочем каталоге различные временные файлы, например выгружая схему базы. В целях безопасности этот каталог не должен быть доступен для чтения и записи другим пользователям.
Программа pg_upgrade запускает на короткое время процессы postmaster со старым и новым каталогом данных. Временные файлы сокетов Unix для взаимодействия с этими процессами по умолчанию создаются в текущем рабочем каталоге. В некоторых ситуациях путь к файлу в текущем каталоге может оказаться слишком длинным для имени сокета. В этом случае вы можете передать параметр -s, чтобы файлы сокетов создавались в другом каталоге с более коротким путём. В целях безопасности этот каталог не должен быть доступен для чтения и записи другим пользователям. (В Windows это не поддерживается.)
Программа pg_upgrade сообщит обо всех актуальных для вашей инсталляции ошибках и потребностях перестроения или переиндексации базы; при этом будут созданы завершающие обновление скрипты, перестраивающие таблицы или индексы. Если вы попытаетесь автоматизировать обновление множества серверов, вы обнаружите, что для кластеров с одинаковыми схемами баз данных потребуются одинаковые действия после обновления; это объясняется тем, что эти действия диктуются схемой базы данных, а не данными пользователей.
Для проверки развёртывания новой версии создайте копию только схемы старого кластера, наполните этот кластер фиктивными данными, и попробуйте обновить его.
pg_upgrade не поддерживает обновление баз данных, в которых есть таблицы со столбцами, имеющими следующие системные типы данных reg*, ссылающиеся на OID:
regcollation |
regconfig |
regdictionary |
regnamespace |
regoper |
regoperator |
regproc |
regprocedure |
(Обновление regclass, regrole и regtype поддерживается.)
Если вы производите обновление кластера PostgreSQL версии до 9.2, в которой используется каталог только с файлами конфигурации, вы должны передать расположение собственно каталога с данными программе pg_upgrade, а расположение каталога конфигурации передать серверу, например -d /каталог-данных -o '-D /каталог-конфигурации'.
Если вы используете старый сервер версии до 9.1, работающий с нестандартным каталогом Unix-сокетов, либо его стандартное расположение отличается от принятого в новой версии, задайте в PGHOST расположение сокета старого сервера. (К Windows это не относится.)
Если вы хотите использовать режим ссылок на данные, но при этом исключить изменения в старом кластере при запуске нового, вам может подойти режим клонирования. Если же этот режим недоступен, сделайте копию старого кластера и обновите его в этом режиме. Чтобы получить рабочую копию старого кластера, воспользуйтесь командой rsync и создайте предварительную копию кластера при работающем сервере, а затем отключите старый сервер и ещё раз запустите rsync --checksum, чтобы привести эту копию в согласованное состояние. (Ключ --checksum необходим, потому что rsync различает время с точностью только до секунд.) При этом вы можете исключить некоторые файлы, например postmaster.pid, как описано в Подразделе 26.3.3. Если ваша файловая система поддерживает снимки файловой системы или копирование при записи, вы можете воспользоваться этим для создания копии старого кластера и табличных пространств; при этом важно, чтобы такие снимки и копии файлов создавались одномоментно или когда сервер баз данных отключён.
pg_upgrade
pg_upgrade — upgrade a PostgreSQL server instance
Synopsis
pg_upgrade -b oldbindir [-B newbindir] -d oldconfigdir -D newconfigdir [option...]
Description
pg_upgrade (formerly called pg_migrator) allows data stored in PostgreSQL data files to be upgraded to a later PostgreSQL major version without the data dump/restore typically required for major version upgrades, e.g., from 9.5.8 to 9.6.4 or from 10.7 to 11.2. It is not required for minor version upgrades, e.g., from 9.6.2 to 9.6.3 or from 10.1 to 10.2.
Major PostgreSQL releases regularly add new features that often change the layout of the system tables, but the internal data storage format rarely changes. pg_upgrade uses this fact to perform rapid upgrades by creating new system tables and simply reusing the old user data files. If a future major release ever changes the data storage format in a way that makes the old data format unreadable, pg_upgrade will not be usable for such upgrades. (The community will attempt to avoid such situations.)
pg_upgrade does its best to make sure the old and new clusters are binary-compatible, e.g., by checking for compatible compile-time settings, including 32/64-bit binaries. It is important that any external modules are also binary compatible, though this cannot be checked by pg_upgrade.
pg_upgrade supports upgrades from 9.0.X and later to the current major release of PostgreSQL, including snapshot and beta releases.
Warning
Upgrading a cluster causes the destination to execute arbitrary code of the source superusers' choice. Ensure that the source superusers are trusted before upgrading.
Options
pg_upgrade accepts the following command-line arguments:
-bbindir--old-bindir=bindirthe old PostgreSQL executable directory; environment variable
PGBINOLD-Bbindir--new-bindir=bindirthe new PostgreSQL executable directory; default is the directory where pg_upgrade resides; environment variable
PGBINNEW-c--checkcheck clusters only, don't change any data
-dconfigdir--old-datadir=configdirthe old database cluster configuration directory; environment variable
PGDATAOLD-Dconfigdir--new-datadir=configdirthe new database cluster configuration directory; environment variable
PGDATANEW-jnjobs--jobs=njobsnumber of simultaneous processes or threads to use
-k--linkuse hard links instead of copying files to the new cluster
-ooptions--old-optionsoptionsoptions to be passed directly to the old
postgrescommand; multiple option invocations are appended-Ooptions--new-optionsoptionsoptions to be passed directly to the new
postgrescommand; multiple option invocations are appended-pport--old-port=portthe old cluster port number; environment variable
PGPORTOLD-Pport--new-port=portthe new cluster port number; environment variable
PGPORTNEW-r--retainretain SQL and log files even after successful completion
-sdir--socketdir=dirdirectory to use for postmaster sockets during upgrade; default is current working directory; environment variable
PGSOCKETDIR-Uusername--username=usernamecluster's install user name; environment variable
PGUSER-v--verboseenable verbose internal logging
-V--versiondisplay version information, then exit
--cloneUse efficient file cloning (also known as “reflinks” on some systems) instead of copying files to the new cluster. This can result in near-instantaneous copying of the data files, giving the speed advantages of
-k/--linkwhile leaving the old cluster untouched.File cloning is only supported on some operating systems and file systems. If it is selected but not supported, the pg_upgrade run will error. At present, it is supported on Linux (kernel 4.5 or later) with Btrfs and XFS (on file systems created with reflink support), and on macOS with APFS.
-?--helpshow help, then exit
Usage
These are the steps to perform an upgrade with pg_upgrade:
Optionally move the old cluster
If you are using a version-specific installation directory, e.g.,
/opt/PostgreSQL/14, you do not need to move the old cluster. The graphical installers all use version-specific installation directories.If your installation directory is not version-specific, e.g.,
/usr/local/pgsql, it is necessary to move the current PostgreSQL install directory so it does not interfere with the new PostgreSQL installation. Once the current PostgreSQL server is shut down, it is safe to rename the PostgreSQL installation directory; assuming the old directory is/usr/local/pgsql, you can do:mv /usr/local/pgsql /usr/local/pgsql.old
to rename the directory.
For source installs, build the new version
Build the new PostgreSQL source with
configureflags that are compatible with the old cluster. pg_upgrade will checkpg_controldatato make sure all settings are compatible before starting the upgrade.Install the new PostgreSQL binaries
Install the new server's binaries and support files. pg_upgrade is included in a default installation.
For source installs, if you wish to install the new server in a custom location, use the
prefixvariable:make prefix=/usr/local/pgsql.new install
Initialize the new PostgreSQL cluster
Initialize the new cluster using
initdb. Again, use compatibleinitdbflags that match the old cluster. Many prebuilt installers do this step automatically. There is no need to start the new cluster.Install extension shared object files
Many extensions and custom modules, whether from
contribor another source, use shared object files (or DLLs), e.g.,pgcrypto.so. If the old cluster used these, shared object files matching the new server binary must be installed in the new cluster, usually via operating system commands. Do not load the schema definitions, e.g.,CREATE EXTENSION pgcrypto, because these will be duplicated from the old cluster. If extension updates are available, pg_upgrade will report this and create a script that can be run later to update them.Copy custom full-text search files
Copy any custom full text search files (dictionary, synonym, thesaurus, stop words) from the old to the new cluster.
Adjust authentication
pg_upgradewill connect to the old and new servers several times, so you might want to set authentication topeerinpg_hba.confor use a~/.pgpassfile (see Section 34.16).Stop both servers
Make sure both database servers are stopped using, on Unix, e.g.:
pg_ctl -D /opt/PostgreSQL/9.6 stop pg_ctl -D /opt/PostgreSQL/14 stop
or on Windows, using the proper service names:
NET STOP postgresql-9.6 NET STOP postgresql-14
Streaming replication and log-shipping standby servers must be running during this shutdown so they receive all changes.
Prepare for standby server upgrades
If you are upgrading standby servers using methods outlined in section Step 11, verify that the old standby servers are caught up by running pg_controldata against the old primary and standby clusters. Verify that the “Latest checkpoint location” values match in all clusters. Also, make sure
wal_levelis not set tominimalin thepostgresql.conffile on the new primary cluster.Run pg_upgrade
Always run the pg_upgrade binary of the new server, not the old one. pg_upgrade requires the specification of the old and new cluster's data and executable (
bin) directories. You can also specify user and port values, and whether you want the data files linked or cloned instead of the default copy behavior.If you use link mode, the upgrade will be much faster (no file copying) and use less disk space, but you will not be able to access your old cluster once you start the new cluster after the upgrade. Link mode also requires that the old and new cluster data directories be in the same file system. (Tablespaces and
pg_walcan be on different file systems.) Clone mode provides the same speed and disk space advantages but does not cause the old cluster to be unusable once the new cluster is started. Clone mode also requires that the old and new data directories be in the same file system. This mode is only available on certain operating systems and file systems.The
--jobsoption allows multiple CPU cores to be used for copying/linking of files and to dump and restore database schemas in parallel; a good place to start is the maximum of the number of CPU cores and tablespaces. This option can dramatically reduce the time to upgrade a multi-database server running on a multiprocessor machine.For Windows users, you must be logged into an administrative account, and then start a shell as the
postgresuser and set the proper path:RUNAS /USER:postgres "CMD.EXE" SET PATH=%PATH%;C:\Program Files\PostgreSQL\14\bin;
and then run pg_upgrade with quoted directories, e.g.:
pg_upgrade.exe --old-datadir "C:/Program Files/PostgreSQL/9.6/data" --new-datadir "C:/Program Files/PostgreSQL/14/data" --old-bindir "C:/Program Files/PostgreSQL/9.6/bin" --new-bindir "C:/Program Files/PostgreSQL/14/bin"Once started,
pg_upgradewill verify the two clusters are compatible and then do the upgrade. You can usepg_upgrade --checkto perform only the checks, even if the old server is still running.pg_upgrade --checkwill also outline any manual adjustments you will need to make after the upgrade. If you are going to be using link or clone mode, you should use the option--linkor--clonewith--checkto enable mode-specific checks.pg_upgraderequires write permission in the current directory.Obviously, no one should be accessing the clusters during the upgrade. pg_upgrade defaults to running servers on port 50432 to avoid unintended client connections. You can use the same port number for both clusters when doing an upgrade because the old and new clusters will not be running at the same time. However, when checking an old running server, the old and new port numbers must be different.
If an error occurs while restoring the database schema,
pg_upgradewill exit and you will have to revert to the old cluster as outlined in Step 17 below. To trypg_upgradeagain, you will need to modify the old cluster so the pg_upgrade schema restore succeeds. If the problem is acontribmodule, you might need to uninstall thecontribmodule from the old cluster and install it in the new cluster after the upgrade, assuming the module is not being used to store user data.Upgrade streaming replication and log-shipping standby servers
If you used link mode and have Streaming Replication (see Section 27.2.5) or Log-Shipping (see Section 27.2) standby servers, you can follow these steps to quickly upgrade them. You will not be running pg_upgrade on the standby servers, but rather rsync on the primary. Do not start any servers yet.
If you did not use link mode, do not have or do not want to use rsync, or want an easier solution, skip the instructions in this section and simply recreate the standby servers once pg_upgrade completes and the new primary is running.
Install the new PostgreSQL binaries on standby servers
Make sure the new binaries and support files are installed on all standby servers.
Make sure the new standby data directories do not exist
Make sure the new standby data directories do not exist or are empty. If initdb was run, delete the standby servers' new data directories.
Install extension shared object files
Install the same extension shared object files on the new standbys that you installed in the new primary cluster.
Stop standby servers
If the standby servers are still running, stop them now using the above instructions.
Save configuration files
Save any configuration files from the old standbys' configuration directories you need to keep, e.g.,
postgresql.conf(and any files included by it),postgresql.auto.conf,pg_hba.conf, because these will be overwritten or removed in the next step.Run rsync
When using link mode, standby servers can be quickly upgraded using rsync. To accomplish this, from a directory on the primary server that is above the old and new database cluster directories, run this on the primary for each standby server:
rsync --archive --delete --hard-links --size-only --no-inc-recursive old_cluster new_cluster remote_dir
where
old_clusterandnew_clusterare relative to the current directory on the primary, andremote_diris above the old and new cluster directories on the standby. The directory structure under the specified directories on the primary and standbys must match. Consult the rsync manual page for details on specifying the remote directory, e.g.,rsync --archive --delete --hard-links --size-only --no-inc-recursive /opt/PostgreSQL/9.5 \ /opt/PostgreSQL/9.6 standby.example.com:/opt/PostgreSQLYou can verify what the command will do using rsync's
--dry-runoption. While rsync must be run on the primary for at least one standby, it is possible to run rsync on an upgraded standby to upgrade other standbys, as long as the upgraded standby has not been started.What this does is to record the links created by pg_upgrade's link mode that connect files in the old and new clusters on the primary server. It then finds matching files in the standby's old cluster and creates links for them in the standby's new cluster. Files that were not linked on the primary are copied from the primary to the standby. (They are usually small.) This provides rapid standby upgrades. Unfortunately, rsync needlessly copies files associated with temporary and unlogged tables because these files don't normally exist on standby servers.
If you have tablespaces, you will need to run a similar rsync command for each tablespace directory, e.g.:
rsync --archive --delete --hard-links --size-only --no-inc-recursive /vol1/pg_tblsp/PG_9.5_201510051 \ /vol1/pg_tblsp/PG_9.6_201608131 standby.example.com:/vol1/pg_tblspIf you have relocated
pg_waloutside the data directories, rsync must be run on those directories too.Configure streaming replication and log-shipping standby servers
Configure the servers for log shipping. (You do not need to run
pg_start_backup()andpg_stop_backup()or take a file system backup as the standbys are still synchronized with the primary.) Replication slots are not copied and must be recreated.
Restore
pg_hba.confIf you modified
pg_hba.conf, restore its original settings. It might also be necessary to adjust other configuration files in the new cluster to match the old cluster, e.g.,postgresql.conf(and any files included by it),postgresql.auto.conf.Start the new server
The new server can now be safely started, and then any rsync'ed standby servers.
Post-upgrade processing
If any post-upgrade processing is required, pg_upgrade will issue warnings as it completes. It will also generate script files that must be run by the administrator. The script files will connect to each database that needs post-upgrade processing. Each script should be run using:
psql --username=postgres --file=script.sql postgres
The scripts can be run in any order and can be deleted once they have been run.
Caution
In general it is unsafe to access tables referenced in rebuild scripts until the rebuild scripts have run to completion; doing so could yield incorrect results or poor performance. Tables not referenced in rebuild scripts can be accessed immediately.
Statistics
Because optimizer statistics are not transferred by
pg_upgrade, you will be instructed to run a command to regenerate that information at the end of the upgrade. You might need to set connection parameters to match your new cluster.Delete old cluster
Once you are satisfied with the upgrade, you can delete the old cluster's data directories by running the script mentioned when
pg_upgradecompletes. (Automatic deletion is not possible if you have user-defined tablespaces inside the old data directory.) You can also delete the old installation directories (e.g.,bin,share).Reverting to old cluster
If, after running
pg_upgrade, you wish to revert to the old cluster, there are several options:If the
--checkoption was used, the old cluster was unmodified; it can be restarted.If the
--linkoption was not used, the old cluster was unmodified; it can be restarted.If the
--linkoption was used, the data files might be shared between the old and new cluster:If
pg_upgradeaborted before linking started, the old cluster was unmodified; it can be restarted.If you did not start the new cluster, the old cluster was unmodified except that, when linking started, a
.oldsuffix was appended to$PGDATA/global/pg_control. To reuse the old cluster, remove the.oldsuffix from$PGDATA/global/pg_control; you can then restart the old cluster.If you did start the new cluster, it has written to shared files and it is unsafe to use the old cluster. The old cluster will need to be restored from backup in this case.
Notes
pg_upgrade creates various working files, such as schema dumps, in the current working directory. For security, be sure that that directory is not readable or writable by any other users.
pg_upgrade launches short-lived postmasters in the old and new data directories. Temporary Unix socket files for communication with these postmasters are, by default, made in the current working directory. In some situations the path name for the current directory might be too long to be a valid socket name. In that case you can use the -s option to put the socket files in some directory with a shorter path name. For security, be sure that that directory is not readable or writable by any other users. (This is not supported on Windows.)
All failure, rebuild, and reindex cases will be reported by pg_upgrade if they affect your installation; post-upgrade scripts to rebuild tables and indexes will be generated automatically. If you are trying to automate the upgrade of many clusters, you should find that clusters with identical database schemas require the same post-upgrade steps for all cluster upgrades; this is because the post-upgrade steps are based on the database schemas, and not user data.
For deployment testing, create a schema-only copy of the old cluster, insert dummy data, and upgrade that.
pg_upgrade does not support upgrading of databases containing table columns using these reg* OID-referencing system data types:
regcollation |
regconfig |
regdictionary |
regnamespace |
regoper |
regoperator |
regproc |
regprocedure |
(regclass, regrole, and regtype can be upgraded.)
If you are upgrading a pre-PostgreSQL 9.2 cluster that uses a configuration-file-only directory, you must pass the real data directory location to pg_upgrade, and pass the configuration directory location to the server, e.g., -d /real-data-directory -o '-D /configuration-directory'.
If using a pre-9.1 old server that is using a non-default Unix-domain socket directory or a default that differs from the default of the new cluster, set PGHOST to point to the old server's socket location. (This is not relevant on Windows.)
If you want to use link mode and you do not want your old cluster to be modified when the new cluster is started, consider using the clone mode. If that is not available, make a copy of the old cluster and upgrade that in link mode. To make a valid copy of the old cluster, use rsync to create a dirty copy of the old cluster while the server is running, then shut down the old server and run rsync --checksum again to update the copy with any changes to make it consistent. (--checksum is necessary because rsync only has file modification-time granularity of one second.) You might want to exclude some files, e.g., postmaster.pid, as documented in Section 26.3.3. If your file system supports file system snapshots or copy-on-write file copies, you can use that to make a backup of the old cluster and tablespaces, though the snapshot and copies must be created simultaneously or while the database server is down.