Query-level Session Settings
特定の設定でステートメントを実行するための方法はいくつかあります。設定は層で構成されており、各層は前の設定値を再定義します。
優先順位
設定を定義するための優先順位は次のとおりです。
-
ユーザーに直接、または設定プロファイル内で設定を適用する
- SQL（推奨）
/etc/clickhouse-server/users.d に1つまたは複数のXMLまたはYAMLファイルを追加する
-
セッション設定
- ClickHouse Cloud SQLコンソールから
SET setting=value を送信するか、clickhouse client を対話モードで使用します。同様に、HTTPプロトコルのClickHouseセッションを使用できます。これを行うには、session_id HTTPパラメータを指定する必要があります。
-
クエリ設定
- 対話モードではない
clickhouse client を起動する際に、スタートアップパラメータ --setting=value を設定します。
- HTTP APIを使用する際には、CGIパラメータ（
URL?setting_1=value&setting_2=value...）を渡します。
- SELECTクエリの
SETTINGS
句で設定を定義します。設定値はそのクエリにのみ適用され、クエリの実行後にデフォルトまたは前の値にリセットされます。
設定をデフォルト値に戻す
設定を変更し、デフォルト値に戻したい場合は、値を 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 │
└─────────┘
カスタム設定
一般的な settings に加えて、ユーザーはカスタム設定を定義できます。
カスタム設定名は、あらかじめ定義されたプレフィックスのいずれかで始まる必要があります。これらのプレフィックスのリストは、サーバー設定ファイルの custom_settings_prefixes パラメータで宣言する必要があります。
<custom_settings_prefixes>custom_</custom_settings_prefixes>
カスタム設定を定義するには SET コマンドを使用します：
カスタム設定の現在の値を取得するには getSetting() 関数を使用します：
SELECT getSetting('custom_a');
これらの例では、すべて async_insert 設定の値を 1 に設定し、実行中のシステムでの設定の確認方法を示します。
SQLを使用してユーザーに直接設定を適用する
これは、設定 async_insert = 1 のユーザー ingester を作成します：
CREATE USER ingester
IDENTIFIED WITH sha256_hash BY '7e099f39b84ea79559b3e85ea046804e63725fd1f46b37f281276aae20f86dc3'
-- highlight-next-line
SETTINGS async_insert = 1
設定プロファイルと割り当てを確認する
┌─ACCESS─────────────────────────────────────────────────────────────────────────────┐
│ ... │
# highlight-next-line
│ CREATE USER ingester IDENTIFIED WITH sha256_password SETTINGS async_insert = true │
│ ... │
└────────────────────────────────────────────────────────────────────────────────────┘
SQLを使用して設定プロファイルを作成し、ユーザーに割り当てる
これは、設定 async_insert = 1 のプロファイル log_ingest を作成します：
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>
設定プロファイルと割り当てを確認する
┌─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 (...)
その他
