Модуль community.clickhouse.clickhouse_quota — создание или удаление квоты ClickHouse

apply_to

list / elements=string

Применить эту квоту к указанному списку пользователей/ролей в зависимости от apply_to_mode.

Можно указать специальные ключевые слова default и current_user, а также имя существующего пользователя или роли.

Указание этого параметра является ошибкой, если apply_to_mode=all.

apply_to_mode

string

При значении listed_only (по умолчанию) квота будет применяться только к пользователям/ролям, указанным в apply_to.

При значении all квота будет применяться ко всем пользователям/ролям.

При значении all_except_listed квота будет применяться ко всем пользователям/ролям, кроме указанных в apply_to.

Варианты:

• "listed_only" ← (по умолчанию)
• "all"
• "all_except_listed"

client_kwargs

dictionary

Любые дополнительные именованные аргументы, которые нужно передать интерфейсу Client при создании его объекта.

По умолчанию: {}

cluster

string

Выполнить команду на всех узлах кластера.

Если кластер не настроен, выполнение команды завершится с ошибкой.

keyed_by

string

Задает ключ квоты (по умолчанию ключ не используется).

Варианты:

• "user_name"
• "ip_address"
• "client_key"
• "client_key,user_name"
• "client_key,ip_address"

limits

list / elements=dictionary

Ограничения, которые должна применять эта квота.

interval

string / обязательный

Интервал, в течение которого применяются следующие квоты.

Формат: <number> <unit>.

Единицей измерения может быть second, minute, hour, day, week, month, quarter или year.

max

dictionary

Максимальные значения, применяемые к этому интервалу данной квоты.

Необходимо указать хотя бы один ключ.

Взаимоисключает limits.no_limits и limits.tracking_only.

errors

integer

Максимальное количество ошибок в этом интервале.

execution_time

float

Максимальное время выполнения в этом интервале.

failed_sequential_authentications

integer

Максимальное количество последовательных неудачных попыток аутентификации в этом интервале.

queries

integer

Максимальное количество запросов в этом интервале.

query_inserts

integer

Максимальное количество операций вставки в запросах в этом интервале.

query_selects

integer

Максимальное количество операций выборки в запросах в этом интервале.

read_bytes

integer

Максимальное количество байтов, считываемых в этом интервале.

read_rows

integer

Максимальное количество строк, считываемых в этом интервале.

result_bytes

integer

Максимальный размер результата в байтах в этом интервале.

result_rows

integer

Максимальное количество строк результата в этом интервале.

written_bytes

integer

Максимальное количество байтов, записываемых в этом интервале.

no_limits

boolean

Не применять ограничения.

Взаимоисключает limits.max и limits.tracking_only.

Варианты:

• false
• true

randomized_start

boolean

Определяет, следует ли рандомизировать начало этого интервала.

Если рандомизация не включена, интервалы всегда начинаются в одно и то же время.

Варианты:

• false ← (по умолчанию)
• true

tracking_only

boolean

Только отслеживать использование, не применяя ограничений.

Взаимоисключает limits.max и limits.no_limits.

Варианты:

• false
• true

login_db

string

То же, что аргумент Client(database='...').

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

login_host

string

То же, что аргумент Client(host='...').

По умолчанию: "localhost"

login_password

string

То же, что аргумент Client(password='...').

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

login_port

integer

То же, что аргумент Client(port='...').

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

login_user

string

То же, что аргумент Client(user='...').

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

Убедитесь, что у пользователя есть разрешения на чтение системных таблиц, перечисленных в разделе RETURN.

name

string / обязательный

Имя квоты, которую нужно добавить или удалить.

state

string

Состояние квоты.

При значении present квота создается, если она не существует.

При значении absent квота удаляется, если она существует.

Варианты:

• "present" ← (по умолчанию)
• "absent"

check_mode

Поддержка: полная

Поддерживает check_mode.

executed_statements

list / elements=string

Выполненные операторы, изменяющие данные.

Возвращается: при успешном выполнении

Пример: ["CREATE QUOTA test_quota"]