跳到主要内容
跳到主要内容

对设置的约束

概述​

在 ClickHouse 中，"对设置的约束" 指的是可以赋予设置的限制和规则。这些约束可以用于维护数据库的稳定性、安全性和可预测性行为。

定义约束​

对设置的约束可以在 user.xml 配置文件的 profiles 部分定义。它们禁止用户通过 SET 语句更改某些设置。

约束的定义如下：

<profiles>
  <user_name>
    <constraints>
      <setting_name_1>
        <min>lower_boundary</min>
      </setting_name_1>
      <setting_name_2>
        <max>upper_boundary</max>
      </setting_name_2>
      <setting_name_3>
        <min>lower_boundary</min>
        <max>upper_boundary</max>
      </setting_name_3>
      <setting_name_4>
        <readonly/>
      </setting_name_4>
      <setting_name_5>
        <min>lower_boundary</min>
        <max>upper_boundary</max>
        <changeable_in_readonly/>
      </setting_name_5>
      <setting_name_6>
        <min>lower_boundary</min>
        <max>upper_boundary</max>
        <disallowed>value1</disallowed>
        <disallowed>value2</disallowed>
        <disallowed>value3</disallowed>
        <changeable_in_readonly/>
      </setting_name_6>
    </constraints>
  </user_name>
</profiles>

如果用户试图违反这些约束，将抛出异常，并且设置保持不变。

约束类型​

ClickHouse 支持几种类型的约束：

  • min
  • max
  • disallowed
  • readonly（别名 const）
  • changeable_in_readonly

min 和 max 约束指定数值设置的上下界，并且可以组合使用。

disallowed 约束用于指定特定的值，这些值不应该被允许用于特定的设置。

readonly 或 const 约束指定用户根本不能更改相应的设置。

changeable_in_readonly 约束类型允许用户在 readonly 设置为 1 的情况下在 min/max 范围内更改设置，否则在 readonly=1 模式下不允许更改设置。

备注

changeable_in_readonly 仅在启用 settings_constraints_replace_previous 的情况下支持：

<access_control_improvements>
  <settings_constraints_replace_previous>true</settings_constraints_replace_previous>
</access_control_improvements>

多重约束配置文件​

如果一个用户同时激活多个配置文件，那么约束会被合并。合并过程依赖于 settings_constraints_replace_previous：

  • true（推荐）：同一设置的约束在合并过程中被替换，最后的约束被使用，所有先前的约束被忽略。这包括在新约束中未设置的字段。
  • false（默认）：同一设置的约束以这种方式合并：每一种未设置的约束来自先前的配置文件，而每一种已设置的约束则由新配置文件中的值替换。

只读模式​

只读模式由 readonly 设置启用，不要与 readonly 约束类型混淆：

  • readonly=0：没有只读限制。
  • readonly=1：仅允许读查询，除非设置 changeable_in_readonly，否则无法更改设置。
  • readonly=2：仅允许读查询，但可以更改设置，除了 readonly 设置本身。

示例​

让 users.xml 包含以下行：

<profiles>
  <default>
    <max_memory_usage>10000000000</max_memory_usage>
    <force_index_by_date>0</force_index_by_date>
    ...
    <constraints>
      <max_memory_usage>
        <min>5000000000</min>
        <max>20000000000</max>
      </max_memory_usage>
      <force_index_by_date>
        <readonly/>
      </force_index_by_date>
    </constraints>
  </default>
</profiles>

以下查询将抛出异常：

SET max_memory_usage=20000000001;
SET max_memory_usage=4999999999;
SET force_index_by_date=1;

Code: 452, e.displayText() = DB::Exception: Setting max_memory_usage should not be greater than 20000000000.
Code: 452, e.displayText() = DB::Exception: Setting max_memory_usage should not be less than 5000000000.
Code: 452, e.displayText() = DB::Exception: Setting force_index_by_date should not be changed.
备注

default 配置文件的处理是独特的：为 default 配置文件定义的所有约束都成为默认约束，因此它们限制所有用户，直到明确为这些用户覆盖。

MergeTree 设置的约束​

可以为 merge tree 设置 设置约束。当创建带有 MergeTree 引擎的表或其存储设置被更改时，这些约束会生效。

在 <constraints> 部分引用 MergeTree 设置时，设置名称必须带上 merge_tree_ 前缀。

示例​

您可以禁止显式指定 storage_policy 创建新表。

<profiles>
  <default>
    <constraints>
      <merge_tree_storage_policy>
        <const/>
      </merge_tree_storage_policy>
    </constraints>
  </default>
</profiles>