gpconfig

Contents

Синтаксис
Описание
Параметры
Примеры
См. также

Задает конфигурационные параметры сервера на всех сегментах в кластере Greengage DB.

gpconfig -c <param_name> -v <value>
         [ -m <master_value> | --masteronly ]
         [ --skipvalidation ]
         [ --verbose ]
         [ --debug ]

gpconfig -r <param_name>
         [ --masteronly ]
         [ --skipvalidation ]
         [ --verbose ]
         [ --debug ]

gpconfig -l
         [ --skipvalidation ]
         [ --verbose ]
         [ --debug ]

gpconfig -s <param_name>
         [ --file | --file-compare ]
         [ --verbose ]
         [ --debug ]

gpconfig --help

Описание

Утилита gpconfig позволяет задавать, удалять и просматривать конфигурационные параметры в файлах postgresql.conf всех экземпляров кластера Greengage DB (мастер, сегменты и зеркальные сегменты). При установке параметра можно указать отдельное значение для мастера, если это требуется. Например, параметры вроде max_connections требуют разных настроек для мастера и сегментов. Чтобы задать или удалить глобальный параметр либо параметр только для мастера, используйте параметр --masteronly.

ПРИМЕЧАНИЕ

Для конфигурационных параметров типа string значения не следует заключать в одинарные кавычки при передаче через gpconfig -c.

gpconfig можно использовать только для управления поддерживаемыми параметрами. Например, утилита не подходит для задания параметра port — он должен быть уникален для каждого экземпляра сегмента. Используйте параметр -l, чтобы просмотреть полный список конфигурационных параметров, поддерживаемых gpconfig.

Когда gpconfig задает параметр в файле postgresql.conf сегмента, новое значение всегда добавляется в конец файла. При удалении настройки параметра gpconfig комментирует его во всех файлах postgresql.conf сегментов, возвращая тем самым системное значение по умолчанию. Например, если параметр был удален (закомментирован) с помощью gpconfig, а затем добавлен с новым значением, в файле окажутся два экземпляра параметра: один закомментированный и один активный в конце файла postgresql.conf.

После задания параметра необходимо перезапустить кластер Greengage DB или выполнить перезагрузку файлов postgresql.conf, чтобы изменения вступили в силу. Требуется ли перезапуск или перезагрузка, зависит от конкретного параметра.

Чтобы отобразить текущие значения параметра в системе, используйте параметр -s.

gpconfig использует следующие переменные окружения для подключения к экземпляру мастера Greengage DB и получения информации о конфигурации системы:

PGHOST
PGPORT
PGUSER
PGPASSWORD
PGDATABASE

-c | --change <param_name>: Изменяет значение конфигурационного параметра, добавляя новое значение в конец файлов postgresql.conf.
-v | --value <value>: Значение конфигурационного параметра, указанного с помощью -c. По умолчанию применяется ко всем сегментам, их зеркалам, мастеру и резервному мастеру.

Утилита автоматически заключает значение в кавычки при добавлении его в файлы postgresql.conf.

Чтобы задать пустое значение, используйте пустые одинарные кавычки ('').
-m | --mastervalue <master_value>: Значение для мастера, используемое для конфигурационного параметра, указанного с помощью -c. Если указано, применяется только к мастеру и резервному мастеру. Этот параметр может использоваться только вместе с -v.
--masteronly: Если указан, gpconfig редактирует только файл postgresql.conf мастера.
-r | --remove <param_name>: Удаляет настройку конфигурационного параметра, комментируя запись в файлах postgresql.conf.
-l | --list: Выводит список всех конфигурационных параметров, поддерживаемых утилитой gpconfig.
-s | --show <param_name>: Отображает значение конфигурационного параметра на всех экземплярах (мастере и сегментах) в кластере Greengage DB. Если значения различаются между экземплярами, утилита сообщает об ошибке. Запуск gpconfig с параметром -s считывает значения непосредственно из базы данных, а не из файла postgresql.conf. Если вы задали параметры на всех сегментах с помощью gpconfig -c, а затем запускаете gpconfig -s, вы все еще можете видеть предыдущие значения до перезагрузки конфигурации. Необходимо выполнить перезагрузку конфигурационных файлов (gpstop -u) или перезапуск кластера (gpstop -r), чтобы изменения вступили в силу.
--file: Для конфигурационного параметра показывает значение из файла postgresql.conf на всех экземплярах (мастере и сегментах) кластера Greengage DB. Если значения различаются между экземплярами, утилита сообщает об этом. Должен использоваться вместе с параметром -s.

Например, конфигурационный параметр statement_mem задан равным 64MB для пользователя командой ALTER ROLE, а значение в файле postgresql.conf равно 128MB. Запуск команды gpconfig -s statement_mem --file выводит 128MB. Команда gpconfig -s statement_mem, запущенная пользователем, выводит 64MB.

Недопустим с параметром --file-compare.
--file-compare: Сравнивает текущее значение конфигурационного параметра в Greengage DB со значением в файлах postgresql.conf на хостах (мастере и сегментах). Файловые значения отражают настройки, которые будут использоваться при следующем перезапуске Greengage DB.

Если значения не совпадают, утилита выводит значения со всех хостов. Если все хосты имеют одинаковое значение, отображается сводный отчет.

Недопустим с параметром --file.
--skipvalidation: Отключает системные проверки gpconfig и позволяет изменять любые серверные параметры, включая скрытые или ограниченные параметры, недоступные для обычного задания через gpconfig. При использовании с -l показывает список таких ограниченных параметров.

ВНИМАНИЕ

Соблюдайте крайнюю осторожность при задании конфигурационных параметров с этим параметром.
--verbose: Выводит дополнительную информацию о выполнении команды gpconfig.
--debug: Устанавливает уровень логирования debug.
-? | -h | --help: Отображает справочную информацию.

Задать значение max_connections равным 100 на всех сегментах и 10 на мастере:

$ gpconfig -c max_connections -v 100 -m 10

Примеры синтаксиса для корректной обработки строк оболочкой Bash:

$ gpconfig -c search_path -v '"\$user",public'
$ gpconfig -c dynamic_library_path -v '\$libdir'

Добавленные параметры отображаются в файле postgresql.conf:

search_path='"$user",public'
dynamic_library_path='$libdir'

Закомментировать все записи параметра default_statistics_target и восстановить системное значение по умолчанию:

$ gpconfig -r default_statistics_target

Вывести список всех конфигурационных параметров, поддерживаемых gpconfig:

$ gpconfig -l

Показать текущее значение определенного параметра конфигурации:

$ gpconfig -s max_connections

gpstop

gpcheckperf

gpdeletesystem

gpconfig

Синтаксис

Описание

Параметры

Примеры

См. также