CONFIG_SHOW

Содержание раздела
  1. Синтаксис
  2. Варианты ответа
    1. Параметры ответа
  3. Примеры
    1. Запрос с полным путем до параметра
    2. Запрос с частичным путем до параметра
    3. Запрос с полным именем переменной окружения
    4. Запрос с частичным именем переменной окружения
    5. Запрос информации обо всех параметрах

Поддерживается в версиях: 7.8 / 7.7 / 7.6 / 7.5 / 7.4 / 7.3 / 7.2 / 7.1 / 7.0 / 6.12 / 6.11 / 6.10 / 6.9 / 6.8 / 6.7 / 6.6 / 6.5 / 6.4 / 6.3 / 6.2 / 6.1 / 6.0 / 5.8 / 5.7 / 5.6 / 5.5 / 5.4 / 5.3 / 5.2.

Запрос возвращает информацию о параметрах конфигурации ноды и параметрах присоединенных датасорсов.

Доступные фильтры поиска:

  • частичный или полный путь до параметра;
  • частичное или полное имя переменной окружения.

Если заданный фильтр является частью пути или имени переменной нескольких параметров, возвращаются все совпадения. При полном совпадении возвращается только оно — частичные совпадения не ищутся. При отсутствии фильтра возвращаются все параметры.

Альтернативно конфигурацию можно запросить через /config.

Синтаксис

Запрос информации по параметрам, соответствующим указанной строке:

CONFIG_SHOW(filter_string)

Запрос информации по всем параметрам:

CONFIG_SHOW()

Аргумент запроса может быть задан как индексированный или именованный параметр.

Параметры:

filter_string (varchar | char | string)

Строковый фильтр поиска в любом регистре, который может быть:

  • частичным или полным именем соответствующей переменной окружения;
  • частичным или полным путем до параметра.

Вложенные элементы пути перечисляются через двоеточие.

Варианты ответа

В ответе возвращается:

  • объект ResultSet, где каждая строка содержит информацию об одном параметре, при успешном выполнении запроса;
  • исключение при неуспешном выполнении запроса.

Параметры ответа

По параметрам доступна следующая информация:

  • parameter_name — полный путь до параметра в дереве конфигурации;
  • parameter_value — значение параметра;
  • environment_variable — имя переменной окружения, с помощью которой можно переопределить значение параметра.

Датасорсы каждого типа в ответе пронумерованы по порядку, с 0 без пропусков. Нумерация отражает порядок их добавления в хранилище и может обновляться при изменении состава датасорсов. Например, при отсоединении ADP-датасорса номера следующих за ним ADP-датасорсов сдвигаются вверх, сохраняя сквозную нумерацию.

Значения параметров, заданные в секции конфигурации secrets, маскируются в ответе. По умолчанию маскируются логины и пароли для подключения к сервисной БД и датасорсам хранилища.

Примеры

Запрос с полным путем до параметра

Запрос параметра poolSize датасорса adp2* с указанием полного пути до этого параметра:

CONFIG_SHOW('adp:datasource[1]:poolSize')

* В примере adp2 имеет порядковый номер 1: он был добавлен вторым среди ADP-датасорсов (нумерация с 0). При изменении состава хранилища номера датасорсов могут меняться.

Пример вывода:

| parameter_name             | parameter_value | environment_variable |
|----------------------------|-----------------|----------------------|
| adp:datasource[1]:poolSize | 5               | ADP_MAX_POOL_SIZE    |

Запрос с частичным путем до параметра

Запрос всех параметров датасорса adp2 (номер датасорса в квадратных скобках может меняться при изменении состава хранилища):

CONFIG_SHOW('adp:datasource[1]')

Пример вывода:

| parameter_name                   | parameter_value | environment_variable |
|----------------------------------|-----------------|----------------------|
| adp:datasource[1]:name           | ADP2            |                      |
| adp:datasource[1]:env            | test2           | ADP2_ENV_NAME        |
| adp:datasource[1]:user           | ***             | ADP2_USERNAME        |
| adp:datasource[1]:password       | ***             | ADP2_PASS            |
| adp:datasource[1]:host           | internal.pg.ru  | ADP2_HOST            |
| adp:datasource[1]:port           | 5432            | ADP_PORT             |
| adp:datasource[1]:poolSize       | 5               | ADP_MAX_POOL_SIZE    |
| adp:datasource[1]:executorsCount | 3               | ADP_EXECUTORS_COUNT  |

Запрос с полным именем переменной окружения

Запрос параметров с переменной adp_port:

CONFIG_SHOW('adp_port')

Пример вывода:

| parameter_name             | parameter_value | environment_variable |
|----------------------------|-----------------|----------------------|
| adp:datasource[0]:poolSize | 5432            | ADP_PORT             |
| adp:datasource[1]:poolSize | 5432            | ADP_PORT             |
| adp:datasource[2]:poolSize | 5432            | ADP_PORT             |

Запрос с частичным именем переменной окружения

Запрос параметров с переменной, имя которой содержит строку adp2_:

CONFIG_SHOW('adp2_')

Пример вывода:

| parameter_name                   | parameter_value | environment_variable |
|----------------------------------|-----------------|----------------------|
| adp:datasource[1]:env            | test2           | ADP2_ENV_NAME        |
| adp:datasource[1]:user           | ***             | ADP2_USERNAME        |
| adp:datasource[1]:password       | ***             | ADP2_PASS            |
| adp:datasource[1]:host           | internal.pg.ru  | ADP2_HOST            |

Запрос информации обо всех параметрах

CONFIG_SHOW()