Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ALTER SETTINGS PROFILE

View as MarkdownEdit this pageReport an issueSet up docs MCP

更改 profile。

语法：

ALTER SETTINGS PROFILE [IF EXISTS] name1 [RENAME TO new_name |, name2 [,...]]
    [ON CLUSTER cluster_name]
    [SETTINGS variable [= value] [MIN [=] min_value] [MAX [=] max_value] [CONST|READONLY|WRITABLE|CHANGEABLE_IN_READONLY] | INHERIT 'profile_name'] [,...]
    [ADD|MODIFY SETTINGS variable [= value] [MIN [=] min_value] [MAX [=] max_value] [CONST|READONLY|WRITABLE|CHANGEABLE_IN_READONLY] [,...]
    [SET variable [= value] [MIN [=] min_value] [MAX [=] max_value] [CONST|READONLY|WRITABLE|CHANGEABLE_IN_READONLY] [,...] ]
    [DROP SETTINGS variable [,...] ]
    [ADD PROFILES 'profile_name' [,...] ]
    [DROP PROFILES 'profile_name' [,...] ]
    [DROP ALL SETTINGS]
    [DROP ALL PROFILES]
    [TO {{role1 | user1 [, role2 | user2 ...]} | NONE | ALL | ALL EXCEPT {role1 | user1 [, role2 | user2 ...]}}]

ON CLUSTER 子句允许在集群中更改 profile，参见 Distributed DDL。

替换设置与修改设置

ALTER SETTINGS PROFILE 支持用两种不同的方式来更改某个 profile 的设置及其父级 (继承的) profile。两者的行为差异很大，因此务必选择合适的方式。

替换形式：直接使用 SETTINGS / INHERIT

直接使用 SETTINGS 子句 (不带 ADD、MODIFY 或 DROP) 会用你列出的内容完整替换该 profile 的 settings 列表及其所有父 profile。凡是之前存在但未列出的内容，都会被静默删除——不会有任何警告。

CREATE SETTINGS PROFILE OR REPLACE p
    SETTINGS max_execution_time = 10, enable_lazy_columns_replication = 1;

ALTER SETTINGS PROFILE p SETTINGS max_memory_usage = 16106127360;

SHOW CREATE SETTINGS PROFILE p;
-- → CREATE SETTINGS PROFILE p SETTINGS max_memory_usage = 16106127360
-- max_execution_time and enable_lazy_columns_replication are gone.

这与 CREATE SETTINGS PROFILE 中 SETTINGS 的行为相同：该子句定义的是完整的设置列表。

增量形式：ADD / MODIFY / DROP

ADD、MODIFY 和 DROP 关键字会修改单个条目，而不会影响 profile 中的其他内容：

  • ADD SETTINGS variable = value [constraints] — 添加尚未存在的设置。
  • MODIFY SETTINGS variable = value [constraints] — 替换单个设置条目。整个条目 (值和约束) 都会被覆盖，因此如果你想保留 MIN/MAX/READONLY/等内容，需要重新指定。
  • DROP SETTINGS variable [,...] — 删除列出的设置。
  • ADD PROFILES 'profile_name' [,...] / DROP PROFILES 'profile_name' [,...] — 添加或删除父级 (继承的) profile。
  • DROP ALL SETTINGS / DROP ALL PROFILES — 删除所有设置或所有父级 profile。

其中的多个子句可以组合在同一条语句中，例如 DROP SETTINGS a ADD SETTINGS b = 1。

SET variable = value 是 MODIFY SETTINGS variable = value 的别名。之所以提供这种写法，是因为 SET 更符合直觉，而且在本想进行增量修改时，误写成用于替换的 SETTINGS 子句是很常见的错误。

示例

在保留已填充 profile 其余设置的情况下，仅覆盖单个设置：

ALTER SETTINGS PROFILE p MODIFY SETTINGS max_memory_usage = 16106127360;

添加一个新的受限设置，并删除另一个：

ALTER SETTINGS PROFILE my_profile
    DROP SETTINGS readonly
    ADD SETTINGS max_threads = 8 MIN 4 MAX 16 WRITABLE;

对父级 profile 进行增量管理：

ALTER SETTINGS PROFILE my_profile ADD PROFILES p1;
ALTER SETTINGS PROFILE my_profile DROP PROFILES p1;

请始终使用 SHOW CREATE SETTINGS PROFILE 验证结果：

SHOW CREATE SETTINGS PROFILE my_profile;

增量与完全替换

如果想只更改某一项设置而保留其余设置，请使用 ADD SETTINGS 或 MODIFY SETTINGS (见下方示例) 。

ADD 与 MODIFY 的区别

ADD SETTINGS 和 MODIFY SETTINGS 都会保留 profile 中的其他设置，但它们对同一设置已有条目的处理方式不同：

  • ADD SETTINGS variable = value ... 会先删除 variable 的现有条目，再插入新条目。因此，它会连同该设置的所有约束一起替换其值。对于 variable，此前定义的任何 MIN、MAX 或可写性 (READONLY/WRITABLE/CONST/CHANGEABLE_IN_READONLY) ，如果你没有再次指定，都会被丢弃。
  • MODIFY SETTINGS variable = value ... 会按字段逐一合并：它只会覆盖你实际指定的字段 (值、MIN、MAX 或可写性) ，而该设置的其他字段则保持不变。

示例

创建一个将在下方示例中使用的 profile：

CREATE SETTINGS PROFILE OR REPLACE p SETTINGS max_execution_time = 60;

MODIFY SETTINGS

在保留其他设置不变的情况下，添加或修改单个设置：

ALTER SETTINGS PROFILE p MODIFY SETTINGS max_memory_usage = 20000000000;
SHOW CREATE SETTINGS PROFILE p;
-- CREATE SETTINGS PROFILE p SETTINGS
--     max_execution_time = 60,
--     max_memory_usage = 20000000000

由于 MODIFY 是按字段逐一合并的，因此如果只更改某个设置的值，就会保留其现有约束：

ALTER SETTINGS PROFILE p MODIFY SETTINGS max_memory_usage = 20000000000 MAX 30000000000;
ALTER SETTINGS PROFILE p MODIFY SETTINGS max_memory_usage = 25000000000;
SHOW CREATE SETTINGS PROFILE p;
-- ... max_memory_usage = 25000000000 MAX 30000000000  -- the MAX constraint is preserved

ADD SETTINGS

添加一个设置 (同时保留其他设置) ；如果该设置已存在，则会将其完全重新定义：

ALTER SETTINGS PROFILE p ADD SETTINGS max_threads = 8 MAX 16 READONLY;

与 MODIFY 不同，如果仅使用一个值再次运行 ADD，会删除此前为该设置定义的约束：

ALTER SETTINGS PROFILE p ADD SETTINGS max_threads = 4;
SHOW CREATE SETTINGS PROFILE p;
-- ... max_threads = 4   -- the MAX and READONLY constraints are gone

DROP SETTINGS

删除一个或多个指定名称的设置：

ALTER SETTINGS PROFILE p DROP SETTINGS max_threads;

一次删除所有设置：

ALTER SETTINGS PROFILE p DROP ALL SETTINGS;

使用继承的 profile

在不影响该 profile 自身设置的情况下，添加或移除父级 (继承的) profile：

ALTER SETTINGS PROFILE p ADD PROFILES base_profile;
ALTER SETTINGS PROFILE p DROP PROFILES base_profile;
ALTER SETTINGS PROFILE p DROP ALL PROFILES;
Navigation