Управление профилем настроек

В Managed ClickHouse управлять профилями настроек можно с помощью SQL-запросов. С полным списком SQL-операторов ClickHouse вы можете ознакомиться в официальной документации ClickHouse.

Запросите список профилей из системной таблицы system.settings_profiles, которая содержит метаданные обо всех профилях настроек. Для этого используйте оператор SELECT и виртуальный движок clusterAllReplicas, который выполняет запрос к указанной таблице на всех узлах всех шардов заданного кластера.

1. Подключитесь к кластеру.

2. Выполните запрос:

   1
   SELECT hostName(), name
   2
   FROM clusterAllReplicas('{cluster}', system.settings_profiles);

   Имя кластера автоматически определяется макросом {cluster}, заданным в конфигурации.

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

Запросите данные о профиле из системных таблиц system.settings_profiles и system.settings_profile_elements по его имени. Таблица system.settings_profiles содержит метаданные профиля настроек, а таблица system.settings_profile_elements — конкретные настройки профиля. Для просмотра используйте оператор SELECT.

1. Подключитесь к кластеру.

2. Узнайте имя профиля:

   1
   SELECT hostName(), name
   2
   FROM clusterAllReplicas('{cluster}', system.settings_profiles);

   Имя кластера автоматически определяется макросом {cluster}, заданным в конфигурации.

3. Для просмотра метаданных выполните запрос:

   1
   SELECT *
   2
   FROM clusterAllReplicas('{cluster}', system.settings_profiles)
   3
   WHERE name = '<имя профиля>'
   4
   LIMIT 1;

   Здесь условие LIMIT со значением 1 возвращает первую найденную запись из таблицы system.settings_profiles.

4. Для просмотра настроек профиля выполните запрос:

   1
   SELECT
   2
       hostName(),
   3
       setting_name,
   4
       value,
   5
       min_value,
   6
       max_value,
   7
       readonly
   8
   FROM clusterAllReplicas('{cluster}', system.settings_profile_elements)
   9
   WHERE profile_name = '<имя профиля>'
   10
   ORDER BY hostName(), index;

   Здесь:

   • profile_name — имя профиля настроек;
   • setting_name — название настройки;
   • value — значение настройки;
   • min_value и max_value — допустимые границы значений (если заданы);
   • readonly — флаг, указывающий можно ли изменять настройку (1 — нельзя, 0 — можно);
   • условие ORDER BY сортирует результаты по имени узла кластера hostName() и порядковому номеру настройки в профиле index.

Запросите настройки профиля из таблицы system.settings_profile_elements по его имени. Для просмотра используйте оператор SELECT.

1. Подключитесь к кластеру.

2. Узнайте имя профиля:

   1
   SELECT hostName(), name
   2
   FROM clusterAllReplicas('{cluster}', system.settings_profiles);

   Имя кластера автоматически определяется макросом {cluster}, заданным в конфигурации.

3. Выполните запрос:

   1
   SELECT DISTINCT
   2
       hostName(),
   3
       user_name,
   4
       role_name,
   5
       profile_name
   6
   FROM clusterAllReplicas('{cluster}', system.settings_profile_elements)
   7
   WHERE profile_name = '<имя профиля>'
   8
     AND (user_name IS NOT NULL OR role_name IS NOT NULL)
   9
   ORDER BY hostName(), user_name, role_name;

   Здесь:

   • оператор DISTINCT устраняет дубликаты строк, если у пользователя или роли на разных узлах кластера одинаковый профиль;
   • условие AND (user_name IS NOT NULL OR role_name IS NOT NULL) оставляет только те строки, где профиль назначен пользователю или роли;
   • условие ORDER BY упорядочивает результаты по именам кластера, пользователя и роли.

Для создания профиля настроек используйте оператор CREATE.

1. Подключитесь к кластеру.

2. Узнайте имя пользователя:

   1
   SELECT hostName(), name
   2
   FROM clusterAllReplicas('{cluster}', system.users);

3. Узнайте имя роли:

   1
   SELECT hostName(), name
   2
   FROM clusterAllReplicas('{cluster}', system.roles);

4. Выполните запрос:

   1
   CREATE SETTINGS PROFILE [IF NOT EXISTS] <имя профиля>
   2
   ON CLUSTER '<имя кластера>'
   3
   SETTINGS
   4
     <настройка 1> = <значение 1>,
   5
     <настройка 2> = <значение 2>,
   6
     ...
   7
   TO <имя пользователя>, <имя роли>;

   Условия в запросе:

   • IF NOT EXISTS — предотвращает ошибку, если профиль с таким именем уже существует.
   • ON CLUSTER — создает профиль на всех узлах заданного кластера.
   • SETTINGS — секция, в которой задаются нужные параметры и значения.

   Также вы можете назначить профиль настроек пользователю или роли после создания.

   Пример запроса без назначения профиля роли или пользователю

   1
   CREATE SETTINGS PROFILE [IF NOT EXISTS] <имя профиля>
   2
   ON CLUSTER '<имя кластера>'
   3
   SETTINGS
   4
     max_memory_usage = 5000000000, # Максимальный объем оперативной памяти = 5000000000 Б (5 ГБ)
   5
     max_execution_time = 300, # Максимальное время выполнения запроса = 300 с
   6
     readonly = 1, # Разрешено только чтение данных
   7
     log_queries = 1; # Включено логирование всех запросов

   Пример запроса с назначением профиля роли и пользователю

   1
   CREATE SETTINGS PROFILE secure_analyst_profile
   2
   ON CLUSTER '<имя кластера>'
   3
   SETTINGS
   4
     max_memory_usage = 5000000000, # Максимальный объем оперативной памяти = 5000000000 Б (5 ГБ)
   5
     readonly = 1, # Разрешено только чтение данных
   6
   TO user_1, role_3;

Для удаления профиля используйте оператор DROP.

1. Подключитесь к кластеру.

2. Узнайте имя профиля:

   1
   SELECT hostName(), name
   2
   FROM clusterAllReplicas('{cluster}', system.settings_profiles);

   Имя кластера автоматически определяется макросом {cluster}, заданным в конфигурации.

3. Выполните запрос:

   1
   DROP SETTINGS PROFILE [IF EXISTS] <имя профиля> ON CLUSTER '<имя кластера>' SYNC;

   Условия в запросе:

   • IF EXISTS — предотвращает ошибку, если профиля с таким именем не существует.
   • ON CLUSTER — удаляет профиль на всех узлах заданного кластера.
   • SYNC — гарантирует, что команда завершится только после применения изменений на всех узлах.