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

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

Получить список профилей настроек в кластере

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

В standalone-кластере
В multi-node-кластере

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

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

1
SELECT name
2
FROM system.settings_profiles
3
ORDER BY name;

Получить информацию о конкретном профиле настроек

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

В standalone-кластере
В multi-node-кластере

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

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

1
SELECT name
2
FROM system.settings_profiles
3
ORDER BY name;

Для просмотра метаданных выполните запрос:
sql
```
1
SELECT *
2
FROM system.settings_profiles
3
WHERE name = '<имя профиля>'
4
LIMIT 1;
```
Здесь условие LIMIT со значением 1 возвращает первую найденную запись из таблицы system.settings_profiles.
Для просмотра настроек профиля выполните запрос:
sql
```
1
SELECT
2
    setting_name,
3
    value,
4
    min_value,
5
    max_value,
6
    readonly
7
FROM system.settings_profile_elements
8
WHERE profile_name = '<имя профиля>'
9
ORDER BY index;
```
Здесь:
- profile_name — имя профиля настроек;
- setting_name — название настройки;
- value — значение настройки;
- min_value и max_value — допустимые границы значений (если заданы);
- readonly — флаг, указывающий, можно ли изменять настройку (1 — нельзя, 0 — можно);
- условие ORDER BY сортирует результаты по порядковому номеру настройки в профиле index.

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

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

В standalone-кластере
В multi-node-кластере

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

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

1
SELECT name
2
FROM system.settings_profiles
3
ORDER BY name;

Выполните запрос:
sql
```
1
SELECT DISTINCT
2
    user_name,
3
    role_name,
4
    profile_name
5
FROM system.settings_profile_elements
6
WHERE profile_name = '<имя профиля>'
7
  AND (user_name IS NOT NULL OR role_name IS NOT NULL)
8
ORDER BY user_name, role_name;
```
Здесь:
- Оператор DISTINCT устраняет дубликаты строк, если у пользователя или роли на разных узлах кластера одинаковый профиль.
- Условие AND (user_name IS NOT NULL OR role_name IS NOT NULL) оставляет только те строки, где профиль назначен пользователю или роли.
- Условие ORDER BY упорядочивает результаты по именам пользователя и роли.

Создать профиль настроек

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

В standalone-кластере
В multi-node-кластере

Подключитесь к кластеру.
Узнайте имя пользователя:
sql
```
1
SELECT name
2
FROM system.users
3
ORDER BY name;
```

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

1
SELECT name
2
FROM system.roles
3
ORDER BY name;

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

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

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

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

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

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

Подключитесь к кластеру.
Узнайте имя пользователя:
sql
```
1
SELECT hostName(), name
2
FROM clusterAllReplicas('{cluster}', system.users);
```
Имя кластера автоматически определяется макросом {cluster}, заданным в конфигурации.

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

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

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

1
CREATE SETTINGS PROFILE [IF NOT EXISTS] <имя профиля>
2
ON CLUSTER '{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 '{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 '{cluster}'
3
SETTINGS
4
  max_memory_usage = 5000000000, # Максимальный объем оперативной памяти = 5000000000 Б (5 ГБ)
5
  readonly = 1, # Разрешено только чтение данных
6
TO user_1, role_3;

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

Удалить профиль настроек

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

В standalone-кластере
В multi-node-кластере

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

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

1
SELECT name
2
FROM system.settings_profiles
3
ORDER BY name;

Выполните запрос:
sql
```
1
DROP SETTINGS PROFILE [IF EXISTS] <имя профиля>;
```
В запросе условие IF EXISTS предотвращает ошибку, если профиля с таким именем не существует.