Обзор синтаксиса ggcheckmigrate
Утилита ggcheckmigrate проверяет кластер Greengage DB 6 на наличие потенциальных проблем, которые могут помешать миграции на Greengage DB 7.
Утилита выводит список проблем, которые необходимо устранить перед миграцией.
Синтаксис
ggcheckmigrate [ { -d | --source-database } <string> ]
[ { -h | --source-host } <string> ]
[ { -p | --source-port } <int> ]
[ { -u | --source-user } <string> ]
[ { -H | --target-host } <string> ]
[ { -P | --target-port } <int> ]
[ { -U | --target-user } <string> ]
[ [ { -N | --exclude-schema } <schema> ] [...] ]
[ { --quiet | --debug | --verbose } ]
ggcheckmigrate -? | --help
ggcheckmigrate -v | --version
Описание
Утилита ggcheckmigrate подключается к исходному кластеру Greengage DB 6 и, при необходимости, к целевому кластеру Greengage DB 7.
Кластеры могут работать локально или удаленно.
Утилита проверяет исходный кластер на наличие потенциальных проблем миграции на Greengage DB 7. Полный список проверок приведен в разделе Проверки ниже.
Если указан целевой кластер, утилита проверяет на нем только наличие библиотек, используемых исходным кластером.
По умолчанию ggcheckmigrate проверяет все доступные для подключения базы данных исходного кластера.
Чтобы проверить только одну базу данных, используйте параметр --source-database.
Для получения списка баз данных утилита должна иметь возможность подключиться к базе данных postgres или template1.
Проверки
Проверки утилиты ggcheckmigrate позволяют выявить потенциальные проблемы совместимости, которые необходимо изучить и устранить перед миграцией.
Они не заменяют тестирование процедур резервного копирования и восстановления или проверку работоспособности приложений после миграции.
ggcheckmigrate проверяет наличие следующих потенциальных проблем, связанных с миграцией:
-
Партиционирование на основе списков (
LIST) по нескольким столбцам. -
Функции, использующие
plpython2. -
Представления, использующие удаленные операторы.
-
Представления, использующие удаленные функции.
-
Представления, использующие удаленные типы данных.
-
Использование удаленных типов данных
abstime,reltime,tintervalиunknown. -
Параметры хранения партиционированных таблиц, оптимизированных для добавления.
-
Типы возвращаемых значений функций, объявленных с
EXECUTE ON. -
Наличие в уникальных индексах партиционированных таблиц всех столбцов партиционирования.
-
Наличие границ
START EXCLUSIVEилиEND INCLUSIVEпартиций на основе диапазонов для типовfloat,textиnumeric. -
Триггеры на уровне операторов.
-
Наличие на целевом кластере необходимых библиотек, используемых исходным кластером (только если указан целевой кластер).
Дополнительную информацию об этих проблемах и возможных способах их устранения см. в статье Несовместимости SQL между Greengage DB 6 и 7.
Аутентификация
Для подключения к исходному и целевому кластерам ggcheckmigrate использует учетные записи суперпользователей, указанные в параметрах --source-user и --target-user.
Пароли можно указать в файле паролей PostgreSQL (~/.pgpass) или использовать другой поддерживаемый метод аутентификации. Например, файл ~/.pgpass может выглядеть так:
source.example.com:5432:*:source_admin:source_password target.example.com:5432:postgres:target_admin:target_password
Для передачи пароля также можно использовать переменную окружения PGPASSWORD.
Например, если для обоих кластеров используется один и тот же пароль:
$ PGPASSWORD=12345678 ggcheckmigrate \
--source-host source.example.com --source-port 5432 --source-user source_admin \
--target-host target.example.com --target-port 5432 --target-user target_admin
-
Файл ~/.pgpass должен иметь права доступа
0600(только владелец может читать и изменять файл). -
Не рекомендуется использовать
PGPASSWORDв средах, где другие пользователи могут просматривать переменные окружения процессов.
Утилита также поддерживает аутентификацию ident, peer и trust в соответствии с настройками аутентификации соответствующего кластера и хоста.
Параметры
- -h | --source-host <string>
-
Задает имя или IP-адрес мастер-хоста исходного кластера Greengage DB 6. При локальном подключении этот параметр можно не указывать; в этом случае используется доменный сокет Unix.
- -p | --source-port <int>
-
Задает порт, на котором мастер исходного кластера Greengage DB 6 принимает подключения. Если этот параметр не указан, утилита использует переменную окружения
PGPORT, если она задана, или5432в противном случае. - -u | --source-user <string>
-
Задает имя суперпользователя для подключения к исходному кластеру. Если этот параметр не указан, утилита использует переменную окружения
PGUSER, если она задана, или переменнуюUSERв противном случае. - -d | --source-database <string>
-
Проверяет только указанную базу данных исходного кластера.
- -N | --exclude-schema <schema>
-
Исключает указанную схему из проверки. Параметр можно указывать несколько раз, чтобы исключить несколько схем.
ПРИМЕЧАНИЕ-
Если некоторые конечные партиции партиционированной таблицы хранятся в исключенных схемах, а корневая таблица — нет, то
ggcheckmigrateпроверяет эти партиции. -
Библиотеки функций расширений проверяются, даже если их схемы исключены.
-
- -H | --target-host <string>
-
Задает имя или IP-адрес хоста координатора целевого кластера Greengage DB 7. Целевой кластер используется только для проверки наличия библиотек, необходимых исходному кластеру. Этот параметр необходимо указывать вместе с
--target-port. - -P | --target-port <int>
-
Задает порт, на котором целевой кластер принимает подключения. Обязателен при указании
--target-host. - -U | --target-user <string>
-
Задает имя суперпользователя для подключения к целевому кластеру. Если этот параметр не указан, утилита использует переменную окружения
PGUSER, если она задана, или переменнуюUSERв противном случае. Этот параметр можно указывать только вместе с--target-hostи--target-port. - --quiet
-
Сокращает вывод до предупреждений и ошибок.
- --debug
-
Добавляет подробные отладочные сообщения уровней
verboseиdebugв выводggcheckmigrate. - --verbose
-
Добавляет подробные сообщения уровня
verboseв выводggcheckmigrate. - -v | --version
-
Выводит версию
ggcheckmigrate. - -? | --help
-
Показывает справочную информацию о
ggcheckmigrate.
Коды возврата
ggcheckmigrate возвращает следующие коды:
-
0— проверки завершились успешно, потенциальные проблемы миграции не обнаружены. -
1— обнаружена как минимум одна проблема, связанная с миграцией. -
2— ошибка: исходный кластер не является кластером Greengage DB 6. -
3— ошибка: целевой кластер не является кластером Greengage DB 7. -
4— указаны недопустимые параметры командной строки. -
5— при выполнении проверок произошла ошибка.
Код возврата 0 не гарантирует успешность миграции.
Он означает только то, что утилита не обнаружила проблем в рамках своих проверок.
Примеры
Проверить все доступные для подключения базы данных кластера Greengage DB 6 с параметрами подключения по умолчанию (локально):
$ ggcheckmigrate
Проверить базу данных marketplace в удаленном кластере Greengage DB 6:
$ ggcheckmigrate --source-host mdw --source-port 5432 --source-database marketplace
Исключить из проверок схемы staging и legacy:
$ ggcheckmigrate --exclude-schema staging --exclude-schema legacy
Проверить возможные проблемы, включая наличие необходимых библиотек, перед миграцией в указанный целевой кластер Greengage DB 7:
$ ggcheckmigrate \
--source-host mdw --source-port 5432 --source-user source_admin \
--target-host cdw --target-port 5432 --target-user target_admin