settings 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] [,...]
[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 句を使用すると、クラスター上で settings profile を変更できます。詳しくは Distributed DDL を参照してください。
ALTER SETTINGS PROFILE では、プロファイルの設定や親 (継承元) プロファイルを変更する方法が2つ用意されています。これらは動作が大きく異なるため、適切な方法を選ぶことが重要です。
単独の SETTINGS 句 (ADD、MODIFY、DROP なし) は、プロファイルの設定リスト全体とすべての親プロファイルを、ここに列挙した内容に完全に置き換えます。以前存在していた項目でも、一覧に含まれていないものは警告なしで削除されます。
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.
SETTINGS 単体の形式は完全置換であるため、設定が定義済みのベースプロファイルに対して「1 つの設定だけを上書きする」つもりでこれを使うと、そのプロファイルのほかのすべての設定 (およびすべての親プロファイル) が削除されます。ほかの設定を残したまま 1 つの設定だけを変更したい場合は、以下で説明するインクリメンタルな MODIFY/ADD/DROP 形式を使用してください。
CREATE SETTINGS PROFILE における SETTINGS と同じ動作です。この句は設定の完全な一覧を定義します。
ADD、MODIFY、DROP キーワードを使うと、プロファイルのそれ以外の部分はそのままに、個々のエントリだけを変更できます。
ADD SETTINGS variable = value [constraints] — まだ存在しない設定を追加します。MODIFY SETTINGS variable = value [constraints] — 1 つの設定エントリを置き換えます。エントリ全体 (値と制約) が上書きされるため、それらを維持したい場合は MIN/MAX/READONLY/etc. を再指定してください。DROP SETTINGS variable [,...] — 指定した設定を削除します。ADD PROFILES 'profile_name' [,...] / DROP PROFILES 'profile_name' [,...] — 親 (継承元) プロファイルを追加または削除します。DROP ALL SETTINGS / DROP ALL PROFILES — すべての設定、またはすべての親プロファイルを削除します。
これらの句は、複数を 1 つのステートメントに組み合わせることもできます。たとえば DROP SETTINGS a ADD SETTINGS b = 1 のように記述できます。
設定済みのプロファイルの他の設定はそのままに、1 つの設定だけを上書きします:
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;
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;
単独の SETTINGS 句を使うと、新しい設定を適用する前に、プロファイル内の既存の設定と継承元 (親) プロファイルがすべて削除されます。
ADD SETTINGS または MODIFY SETTINGS を使用してください (以下の例を参照) 。
ADD SETTINGS と MODIFY SETTINGS はどちらも、プロファイル内の他の設定は保持しますが、同じ設定に対する既存エントリの扱いは異なります。
ADD SETTINGS variable = value ... は、まず variable の既存エントリを削除し、その後に新しいエントリを挿入します。したがって、その設定の値とすべての制約をまとめて置き換えます。variable に対して以前に定義されていた MIN、MAX、または書き込み可否 (READONLY/WRITABLE/CONST/CHANGEABLE_IN_READONLY) のうち、再度指定しなかったものは破棄されます。MODIFY SETTINGS variable = value ... は、フィールドごとにマージします。実際に指定したフィールド (値、MIN、MAX、または書き込み可否) だけを上書きし、その設定の他のフィールドは元のまま保持します。
要するに、設定の一部だけを調整したい場合 (たとえば既存の MAX は維持したまま値だけを変更する場合) は MODIFY SETTINGS を使います。設定を最初から再定義したい場合は ADD SETTINGS を使います。
CREATE SETTINGS PROFILE OR REPLACE p SETTINGS max_execution_time = 60;
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
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
ALTER SETTINGS PROFILE p DROP SETTINGS max_threads;
ALTER SETTINGS PROFILE p DROP ALL SETTINGS;
ALTER SETTINGS PROFILE p ADD PROFILES base_profile;
ALTER SETTINGS PROFILE p DROP PROFILES base_profile;
ALTER SETTINGS PROFILE p DROP ALL PROFILES;
