Перейти к основному содержимому
Перейти к основному содержимому

Настройки сессии на уровне запроса

Обзор​

Существует несколько способов выполнения операторов с конкретными настройками. Настройки конфигурируются по уровням, и каждый последующий уровень переопределяет предыдущие значения настройки.

Порядок приоритета​

Порядок приоритета для определения настройки:

  1. Применение настройки напрямую к пользователю или в рамках профиля настроек

    • SQL (рекомендуется)
    • добавление одного или нескольких XML или YAML файлов в /etc/clickhouse-server/users.d

  2. Настройки сессии

    • Отправьте SET setting=value из консоли ClickHouse Cloud SQL или clickhouse client в интерактивном режиме. Таким образом, вы можете использовать сессии ClickHouse в HTTP протоколе. Для этого необходимо указать параметр session_id в HTTP.

  3. Настройки запроса

    • При запуске clickhouse client в неинтерактивном режиме задайте параметр запуска --setting=value.
    • При использовании HTTP API передавайте параметры CGI (URL?setting_1=value&setting_2=value...).
    • Определяйте настройки в SETTINGS операторе запроса SELECT. Значение настройки применяется только к этому запросу и сбрасывается на значение по умолчанию или предыдущее значение после выполнения запроса.

Сброс настройки к значению по умолчанию​

Если вы изменили настройку и хотите вернуть её к значению по умолчанию, установите значение в DEFAULT. Синтаксис выглядит так:

SET setting_name = DEFAULT

Например, значение по умолчанию для async_insert равно 0. Предположим, вы изменили его значение на 1:

SET async_insert = 1;

SELECT value FROM system.settings where name='async_insert';

Ответ будет:

┌─value──┐
│ 1      │
└────────┘

Следующая команда сбрасывает его значение обратно на 0:

SET async_insert = DEFAULT;

SELECT value FROM system.settings where name='async_insert';

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

┌─value───┐
│ 0       │
└─────────┘

Пользовательские настройки​

В дополнение к общим настройкам пользователи могут определять пользовательские настройки.

Имя пользовательской настройки должно начинаться с одного из заранее определенных префиксов. Список этих префиксов должен быть объявлен в параметре custom_settings_prefixes в файле конфигурации сервера.

<custom_settings_prefixes>custom_</custom_settings_prefixes>

Чтобы определить пользовательскую настройку, используйте команду SET:

SET custom_a = 123;

Чтобы получить текущее значение пользовательской настройки, используйте функцию getSetting():

SELECT getSetting('custom_a');

Примеры​

Все эти примеры устанавливают значение настройки async_insert в 1 и показывают, как проверить настройки в работающей системе.

Использование SQL для прямого применения настройки к пользователю​

Это создает пользователя ingester с настройкой async_inset = 1:

CREATE USER ingester
IDENTIFIED WITH sha256_hash BY '7e099f39b84ea79559b3e85ea046804e63725fd1f46b37f281276aae20f86dc3'
-- highlight-next-line
SETTINGS async_insert = 1

Изучение профиля настроек и назначения​

SHOW ACCESS

┌─ACCESS─────────────────────────────────────────────────────────────────────────────┐
│ ...                                                                                │

# highlight-next-line
│ CREATE USER ingester IDENTIFIED WITH sha256_password SETTINGS async_insert = true  │
│ ...                                                                                │
└────────────────────────────────────────────────────────────────────────────────────┘

Использование SQL для создания профиля настроек и назначения его пользователю​

Это создает профиль log_ingest с настройкой async_inset = 1:

CREATE
SETTINGS PROFILE log_ingest SETTINGS async_insert = 1

Это создает пользователя ingester и назначает ему профиль настроек log_ingest:

CREATE USER ingester
IDENTIFIED WITH sha256_hash BY '7e099f39b84ea79559b3e85ea046804e63725fd1f46b37f281276aae20f86dc3'
-- highlight-next-line
SETTINGS PROFILE log_ingest

Использование XML для создания профиля настроек и пользователя​

<clickhouse>

# highlight-start
    <profiles>
        <log_ingest>
            <async_insert>1</async_insert>
        </log_ingest>
    </profiles>

# highlight-end

    <users>
        <ingester>
            <password_sha256_hex>7e099f39b84ea79559b3e85ea046804e63725fd1f46b37f281276aae20f86dc3</password_sha256_hex>

# highlight-start
            <profile>log_ingest</profile>

# highlight-end
        </ingester>
        <default replace="true">
            <password_sha256_hex>7e099f39b84ea79559b3e85ea046804e63725fd1f46b37f281276aae20f86dc3</password_sha256_hex>
            <access_management>1</access_management>
            <named_collection_control>1</named_collection_control>
        </default>
    </users>
</clickhouse>

Изучение профиля настроек и назначения​

SHOW ACCESS

┌─ACCESS─────────────────────────────────────────────────────────────────────────────┐
│ CREATE USER default IDENTIFIED WITH sha256_password                                │

# highlight-next-line
│ CREATE USER ingester IDENTIFIED WITH sha256_password SETTINGS PROFILE log_ingest   │
│ CREATE SETTINGS PROFILE default                                                    │

# highlight-next-line
│ CREATE SETTINGS PROFILE log_ingest SETTINGS async_insert = true                    │
│ CREATE SETTINGS PROFILE readonly SETTINGS readonly = 1                             │
│ ...                                                                                │
└────────────────────────────────────────────────────────────────────────────────────┘

Назначение настройки сессии​

SET async_insert =1;
SELECT value FROM system.settings where name='async_insert';

┌─value──┐
│ 1      │
└────────┘

Назначение настройки во время запроса​

INSERT INTO YourTable
-- highlight-next-line
SETTINGS async_insert=1
VALUES (...)

См. также​